Console Webservice API

Browser

Other API in Package

Console

Console System

Internal Console

Method Summary
String calcHeight(int percent, int min, int max)

Returns a height as a percentage of the available screen height, confined to within min and max.

String calcWidth(int percent, int min, int max)

Returns a width as a percentage of the available screen width, confined to within min and max.

Browser createBrowser(String userAgent)

Returns a new Browser object based on the user-agent string supplied. Used for testing site compatibility with different useragents.

String getBrowser()

Returns a two character code for the browser (ie=Internet Explorer, ff=Firefox, sf=Safari). Returns 'ot' if the browser cannot be identified.

String getBrowserVersion()

Returns the browser version. Returns 'unknown' if the browser version cannot be identified. For Safari, this returns the AppleWebKit version.

String getClientAddress()

Returns the IP Address of the client.

String getHost()

Returns the public host name for this session.

String getLanguage()

Returns locale language for the request or empty string if no locale information in the request.

String getOperatingSystem()

Return a two or three character code for the operating system (win=Windows, mac=Macintosh, lnx=Linux). Returns 'ot' if the operating system cannot be identified.

String getUserAgent()

Returns the full userAgent reported by the browser.

boolean isMobile()

Returns true if the OS is determined to be a mobile operating system.

String toString()

Returns a description of this Browser object.

Method Detail


String calcHeight(int percent, int min, int max)

Returns a height as a percentage of the available screen height, confined to within min and max.

Parameters:

  • int   percent
  • int   min
  • int   max

Returns:  String

Since: 11-30-2007

top

String calcWidth(int percent, int min, int max)

Returns a width as a percentage of the available screen width, confined to within min and max.

Parameters:

  • int   percent
  • int   min
  • int   max

Returns:  String

Since: 11-30-2007

top

Browser createBrowser(String userAgent)

Returns a new Browser object based on the user-agent string supplied. Used for testing site compatibility with different useragents.

Parameters:

  • String   userAgent

Returns:  Browser

Since: 10-06-2010

top

String getBrowser()

Returns a two character code for the browser (ie=Internet Explorer, ff=Firefox, sf=Safari). Returns 'ot' if the browser cannot be identified.

Returns:  String

Since: 10-17-2007

top

String getBrowserVersion()

Returns the browser version. Returns 'unknown' if the browser version cannot be identified. For Safari, this returns the AppleWebKit version.

Returns:  String

Since: 10-17-2007

top

String getClientAddress()

Returns the IP Address of the client.

Returns:  String

Since: 11-30-2011

top

String getHost()

Returns the public host name for this session.

Returns:  String

Since: 04-08-2021

top

String getLanguage()

Returns locale language for the request or empty string if no locale information in the request.

Returns:  String

Since: 11-09-2009

top

String getOperatingSystem()

Return a two or three character code for the operating system (win=Windows, mac=Macintosh, lnx=Linux). Returns 'ot' if the operating system cannot be identified.

Returns:  String

Since: 10-17-2007

top

String getUserAgent()

Returns the full userAgent reported by the browser.

Returns:  String

Since: 10-17-2007

top

boolean isMobile()

Returns true if the OS is determined to be a mobile operating system.

Returns:  boolean

Since: 10-18-2010

top

String toString()

Returns a description of this Browser object.

Returns:  String

Since: 10-17-2007

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM