IF_CLIENT_INFO Interface (SAP Library

IF_CLIENT_INFO Interface

Definition

The IF_CLIENT_INFO interface provides a range of methods that take into account the different display options for Web applications on different browsers, along with other device-specific properties – such as screen size or input method.

Use

In this way, you can use the methods of the IF_CLIENT_INFO interface when you create Web applications like BSP application, and thus take the – often substantial – differences in the display of Web pages on different devices into account.

Note

You can also use this Device Recognition Process and the comparable ClientInfo Interface when developing Java applications.

So that you can estimate the significance for your Web application of the methods described in the following table, some of them have been assigned a priority. For those device properties not assigned a priority, you can decide yourself whether or not you want to use them in your Web application.

Device properties can be categorized by their significance as follows:

Prio.	Title	Description
1	Prerequisite	This property is prerequisite for running the mobile application at all. In general, these conditions are fulfilled by all "real" devices that fulfil the HTML or WAP standard. Emulators, however, do not fulfil these prerequisites. Thus this property need not be checked in the application. At most, you need a check program that ascertains whether or not an emulator is suitable for executing the application
2	Application does not work	If this property is not assigned a value, the application may crash on some devices – that is, may not be executable
3	Loss of information	If this property is not assigned a value, the application may not show all its information For example, a loss of information may occur if the paragraph attribute for automatic line breaks is switched off (<p mode=nowrap>) and the paragraph (in a WML page) contains text that does not fit on one line. If the mobile device does not support the GET_MARQUEE_TEXT_SUPPORTED property, it is possible that the end of the text is simply truncated. For this reason we advise you to think carefully before switching off the automatic line break property – even if doing so would allow you, for example, to make better use of a small screen on a mobile telephone.
4	Unacceptable display	If this property is not assigned a value, the application may be displayed in a way that does not do justice to the look and feel of the device
5	Inappropriate display	If this property is not assigned a value, the application may not be displayed at its best. However, the display should not actually disturb the user significantly.

Similarly, some properties are assigned to the markup languages WML (Wireless Markup Language) and HTML (Hypertext Markup Language) – that is, you specify the markup language for which each method is relevant and thus how it can meaningfully be used. For example, the method GET_FRAMES_SUPPORTED is only significant in HTML, since only HTML-enabled browsers can interpret frames. In general, it is HTML browsers on handheld devices like PDAs and pocket PCs, WAP-enabled mobile telephones with small screens cannot display frames, because of their screen interfaces. If the appropriate table column does not contain a value, the method can be used in both markup languages.

The following source code fragment shows how you can access the methods of the IF_CLIENT_INFO interface:

<%@page language="abap"%>
<%
...
data client_info type ref to IF_CLIENT_INFO.
client_info = runtime->client_info.
if client_info->get_title_supported( ) = ‘X’.
...
%>

Note

To obtain more information on using some of the methods of the IF_CLIENT_INFO interface in your Web application, use the links in the table.

Methods

Method	Signature	Description	Possible values	Content type	Prio.
GET_ACCEPT	method get_accept returning value type string	Equivalent to the HTTP request-header "userAgent".
GET_ALERTING_SUPPORTED	method get_alerting_supported returning value type flag	Specifies whether or not the device supports messaging – for example, using SMS.	"X" or space		1
GET_ANCHOR_SUPPORTED	method get_anchor_supported returning value type flag	Specifies whether or not the <anchor> tag is supported	"X" or space	WML	1
GET_ANCHOR_PREV_SUPPORTED	method get_anchor_prev_supported returning value type flag	Specifies whether or not the anchor tag supports a "Back" action	"X" or space	WML
GET_APP_LINKS_SUPPORTED	method get_app_links_supported returning value type flag	Specifies whether or not you can call a local application on a device using a special link	"X" or space	HTML	3
GET_APP_LINK_TYPES	method get_app_link_types returning value type string	Specifies what type of application links the device supports		HTML
GET_BACK_HARD_WIRED	method get_back_hard_wired returning value type flag	Specifies whether or not you can execute the "Back" function using a fixed key without an associated tag	"X" or space	WML	4
GET_BACK_LABEL	method get_back_label returning value type flag	Specifies whether or not a label attribute must be specified in the <do type=prev> tag to display a label	"X" or space	WML	3
GET_BACK_TO_ANY_URL_SUPPORTED	method get_back_to_any_url_supported returning value type flag	Specifies whether the <do type="prev"> tag can lead to any Web address	"X" or space	WML	1
GET_BIG_SUPPORTED	method get_big_supported returning value type flag	Specifies whether or not text can be formatted as "large"	"X" or space	WML
GET_BOLD_SUPPORTED	method get_bold_supported returning value type flag	Specifies whether or not text can be formatted as "bold"	"X" or space	WML
GET_BREAKING_SPACE	method get_breaking_space returning value type string	Returns the smallest character string for an empty space
GET_BROWSER_CATEGORY	method get_browser_category returning value type string	Returns the browser category	„unknown" „pocketie" „avantgo" „imode" „palm" „wap" „epoc"
GET_BROWSER_NAME	method get_browser_name returning value type string	Returns the browser name	„unknown" „InternetExplorer" „NetscapeNavigator" „mobile"
GET_BROWSER_NAME	method get_browser_os returning value type string	Returns the operating system running on the device	„unknown" „HPUX" „Linux" „MacPPC" „SunOS" „Win32" „mobile"
GET_BROWSER_VERSION	method get_browser_version returning value type int4	Returns the browser version, for example 5.5
GET_CACHE_ENABLED_BY_DEFAULT	method get_cache_enabled_by_default returning value type flag	Specifies whether or not cache memory on the browser is activated by default	"X" or space
GET_CERTIFICATES_SUPPORTED	method get_certificates_supported returning value type flag	Specifies whether or not the device supports client certificates	"X" or space
GET_CHAR_HEIGHT	method get_char_height returning value type int4	Returns the screen height in rows			4
GET_CHAR_WIDTH	method get_char_width returning value type int4	Returns the screen width in characters			4
GET_COLOR_DEPTH	method get_color_depth returning value type float	Returns the color depth, for example 256 colors		HTML
GET_COLOR_SUPPORTED	method get_color_supported returning value type flag	Specifies whether or not the device has a color screen	"X" or space	HTML
GET_CONTENT_TYPE	method get_content_type returning value type string	Returns the content type, for example HTML or WML			2
GET_CONTENT_TYPE_VERSION	method get_content_type_version returning value type int2	Returns the version of the content type – for example, 3.2 for HTML 3.2 or 1.1 for WML 1.1
GET_COOKIES_SUPPORTED	method get_cookies_supported returning value type flag	Specifies whether or not browser cookies are supported	"X" or space		1
GET_CSS_SUPPORTED	method get_css_supported returning value type flag	Specifies whether or not the browser supports CSSs (Cascading Style Sheets).	"X" or space	HTML	4
GET_CSS_VERSION	method get_css_version returning value type int4	Returns the CSS version		HTML
GET_DEFAULT_ACTION_DESIGN	method get_default_action_design returning value type string	Returns the default design for user interface elements representing an action	„link" „button" „softkey" „linkAndSoftkey"	WML	3
GET_DEFAULT_BLOCK_SEPARATOR	method get_default_block_separator returning value type string	Returns the default string used to separate paragraphs			5
GET_DEFAULT_BULLET	method get_default_bullet returning value type string	Returns the default symbol used to indicate points in a list		WML	5
GET_DEFAULT_FORM_STYLE	method get_default_form_style returning value type string	Returns the default display type for input masks	„onePage" „menu" „wizard"	WML
GET_DEFAULT_MENU_STYLE	method get_default_menu_style returning value type string	Returns the default display type for menus	„selectionList" „linkList"	WML	4
GET_DEVICE_CATEGORY	method get_device_category returning value type string	Returns the device category	„unknown" „Phone" „PDA" „Voice" „PC"
GET_DEVICE_NAME	method get_device_name returning value type string	Returns the device name Unique ID for a set of device properties
GET_DOM_SUPPORTED	method get_dom_supported returning value type flag	Specifies whether or not the browser supports a Document Object Model (DOM)	"X" or space	HTML
GET_DOM_VERSION	method get_dom_version returning value type int4	Returns the Document Object Model (DOM) version supported		HTML
GET_EMPHASIZED_SUPPORTED	method get_emphasized_supported returning value type flag	Specifies whether or not text can be formatted as "highlighted"	"X" or space	WML	5
GET_EMULATOR	method get_emulator returning value type flag	Specifies whether or not the device is to be categorized as an emulator	"X" or space
GET_FIELDSET_LAYOUT	method get_fieldset_layout returning value type string	Specifies how input fields that belong together are to be laid out using the <fieldset> tag	„notSupported" „ignored" „beneath" „beneathWithIndent" „sideBySide"	WML	3
GET_FIELDSET_TITLE_VISIBLE	method get_fieldset_title_visible returning value type boolean	Specifies whether or not the title attribute of the <fieldset> tag is used as label.	"X" or space	WML	3
GET_FONT_PROPORTIONAL	method get_font_proportional returning value type flag	Specifies whether or not the default font of the device is a proportional font	"X" or space
GET_FORM_FACTOR	method get_form_factor returning value type string	Returns the screen format of the device	„PC" „VGA" „halfVGA" „mediumLandscape" „mediumPortrait" „phone" „unknown		3
GET_FORM_MENU_SUPPORTED	method get_form_menu_supported returning value type flag	Specifies whether or not the browser supports the technique of displaying a selection menu with the input mask	"X" or space	WML	4
GET_FRAMES_SUPPORTED	method get_frames_supported returning value type flag	Specifies whether or not frames are supported	"X" or space	HTML	2
GET_GRAY_LEVEL	method get_gray_level returning value type float	Returns the number of shades of gray supported in grayscale pictures	"X" or space
GET_HORZ_SCROLLING_SUPPORTED	method get_horz_scrolling_supported returning value type flag	Specifies whether or not the device has a horizontal scroll bar	"X" or space
GET_HREF_WITH_PARAMS_SUPPORTED	method get_href_with_params_supported returning value type flag	Specifies whether or not an Href attribute in a link can contain URL parameters.	"X" or space	WML	2
GET_HTTP_GET_SUPPORTED	method get_http_get_supported returning value type flag	Specifies whether or not the HTTP GET is supported	"X" or space	WML	1
GET_HTTP_POST_SUPPORTED	method get_http_post_supported returning value type flag	Specifies whether or not the HTTP POST is supported	"X" or space	WML	1
GET_IMAGE_ALIGNMENT_SUPPORTED	method get_image_alignment_supported returning value type flag	Specifies whether or not a graphic can be aligned (left, right, or centered)	"X" or space	WML
GET_IMAGE_LINKS_SUPPORTED	method get_image_links_supported returning value type flag	Specifies whether or not a graphic can be used as link.	"X" or space		2
GET_IMAGE_SIZE_MAX	method get_image_size_max returning value type float	Returns the maximum memory size of a graphic		WML
GET_INPUT_FORMAT_DATE	method get_input_format_date returning value type string	Returns the character string used to format date values		WML
GET_INPUT_FORMAT_NUMERIC	method get_input_format_numeric returning value type string	Returns the character string used to format numeric values		WML
GET_INPUT_METHOD_HAND_WRITING	method get_input_method_hand_writing returning value type flag	Specifies whether or not the device supports handwritten input	"X" or space
GET_INPUT_METHOD_KEYBOARD	method get_input_method_keyboard returning value type flag	Specifies whether or not the device supports input using a keyboard	"X" or space
GET_INPUT_METHOD_KEYPAD	method get_input_method_keypad returning value type flag	Specifies whether or not the device supports input using a telephone keypad	"X" or space
GET_INPUT_METHOD_KEYPAD_INTELL	method get_input_method_keypad_intell returning value type flag	Specifies whether or not the device supports input using T9 text input or similar	"X" or space
GET_INPUT_METHOD_VOICE	method get_input_method_voice returning value type flag	Specifies whether or not the device supports speech input	"X" or space
GET_INPUT_SHOWN_WITH_CAPTION	method get_input_shown_with_caption returning value type flag	Specifies whether or not the browser uses the title attribute of the <input> tag is used as a label	"X" or space	WML	3
GET_ITALIC_SUPPORTED	method get_italic_supported returning value type flag	Specifies whether or not text can be formatted as "ítalic"	"X" or space	WML	5
GET_JAVA_SUPPORTED	method get_java_supported returning value type flag	Specifies whether or not the device supports the Java programming language	"X" or space	HTML	1
GET_JAVA_VERSION	method get_java_version returning value type int4	Returns the Java version supported		HTML
GET_LINKS_SEPARATED	method get_links_separated returning value type flag	Specifies whether or not two consecutive links are visibly separated	"X" or space	WML	4
GET_LINK_DECORATION	method get_link_decoration returning value type string	Returns the delimiters that are automatically added to the link text by the device – for example [ ] or < >.		WML
GET_LINK_TEXT_WIDTH	method get_link_text_width returning value type int2	Returns the maximum number of characters that a link can have to fit into one line.		WML	3
GET_LOCAL_IMAGES_SUPPORTED	method get_local_images_supported returning value type flag	Specifies whether or not the device supports locally stored graphics or symbols	"X" or space		3
GET_LOCAL_VARIABLES_SUPPORTED	method get_local_variables_supported returning value type flag	Specifies whether or not the browser supports local variables	"X" or space	WML	1
GET_MARQUEE_LINK_SUPPORTED	method get_marquee_link_supported returning value type flag	Specifies whether or not a long link can be displayed in one line, for example as a ticker-tape.	"X" or space	WML	3
GET_MARQUEE_TEXT_SUPPORTED	method get_marquee_text_supported returning value type flag	Specifies whether or not a long text can be displayed in one line, for example as a ticker-tape.	"X" or space	WML	3
GET_MAX_LINK_LENGTH	method get_max_link_length returning value type int4	Returns the maximum size of the Href attributes of a link.			1
GET_MEDIA_FORMATS	method get_media_formats returning value type string	Returns the list of multimedia formats supported – such as .agif (animated .gif format), .gif, .jpg, .png, .wbmp			3
GET_MEMORY	method get_memory returning value type float	Returns the maximum memory capacity of the device		HTML
GET_MODEL	method get_model returning value type string	Returns the name of the device type – such as 7110 for the Nokia 7110 mobile telephone
GET_NBSP_SUPPORTED	method get_nbsp_supported returning value type flag	Specifies whether or not the device supports non-breaking blank characters	"X" or space	WML	4
GET_NESTED_TABLES_SUPPORTED	method get_nested_tables_supported returning value type flag	Specifies whether or not the browser supports nested tables	"X" or space	HTML	2
GET_NEWLINE_AFTER_IMAGE	method get_newline_after_image returning value type flag	Specifies whether or not a line break is inserted automatically after an <img> tag.	"X" or space	WML	4
GET_NEWLINE_AFTER_INPUT	method get_newline_after_input returning value type flag	Specifies whether or not a line break is inserted automatically after an <input> tag on a specific mobile device.	"X" or space	WML	4
GET_NEWLINE_AFTER_LINK	method get_newline_after_link returning value type flag	Specifies whether or not a line break is inserted automatically after a link	"X" or space	WML	4
GET_NEWLINE_AFTER_SELECT	method get_newline_after_select returning value type flag	Specifies whether or not a line break is inserted automatically after an <select> tag.	"X" or space	WML	4
GET_NEWLINE_BEFORE_IMAGE	method get_newline_before_image returning value type flag	Specifies whether or not a line break is inserted automatically before an <img> tag.	"X" or space	WML	4
GET_NEWLINE_BEFORE_INPUT	method get_newline_before_input returning value type flag	Specifies whether or not a line break is inserted automatically before an <input> tag.	"X" or space	WML	4
GET_NEWLINE_BEFORE_LINK	method get_newline_before_link returning value type flag	Specifies whether or not a line break is inserted automatically before a link	"X" or space	WML	4
GET_NEWLINE_BEFORE_SELECT	method get_newline_before_select returning value type flag	Specifies whether or not a line break is inserted automatically before an <select> tag.	"X" or space	WML	4
GET_NEWLINE_BETWEEN_IMAGES	method get_newline_between_images returning value type flag	Specifies whether or not a line break is inserted automatically after an <image> tag	"X" or space	WML	3
GET_NEWLINE_BETWEEN_LINKS	method get_newline_between_links returning value type flag	Specifies whether or not a line break is inserted automatically between two <image> tags	"X" or space	WML	4
GET_NEWLINE_BETW_LINK_AND_TAG	method get_newline_betw_link_and_tag returning value type flag	Specifies whether or not a line break is inserted automatically between a link and a tag	"X" or space	WML	4
GET_OFFLINE_BROWSING_SUPPORTED	method get_offline_browsing_supported returning value type flag	Specifies whether or not the browser supports offline browsing through locally stored pages (that is, cached pages)	"X" or space	HTML	2
GET_OFFLINE_FORMS_SUPPORTED	method get_offline_forms_supported returning value type flag	Specifies whether or not the browser allows the user to fill out input forms offline on the device	"X" or space	HTML	2
GET_PAGE_SIZE_MAX	method get_page_size_max returning value type float	Returns the maximum page size that can be processed in a mobile device.			2
GET_PIXEL_HEIGHT	method get_pixel_height returning value type float	Specifies the screen height in pixels.
GET_PIXEL_WIDTH	method get_pixel_width returning value type float	Specifies the screen width in pixels.
GET_REDIR_ABSOLUTE_SUPPORTED	method get_redir_absolute_supported returning value type flag	Specifies whether or not the browser supports the redirection of an absolute URL address.	"X" or space		1
GET_REDIR_RELATIVE_SUPPORTED	method get_redir_relative_supported returning value type flag	Specifies whether or not the browser supports the redirection of a relative URL address.	"X" or space		2
GET_SCRIPT_SUPPORTED	method get_script_supported returning value type flag	Specifies whether or not the browser supports scripting	"X" or space		2
GET_SCRIPT_VERSION	method get_script_version returning value type int4	Returns the script version supported
GET_SECURE_PROTOCOLS_SUPPORTED	method get_secure_protocols_supported returning value type flag	Specifies whether or not the browser supports SSL (Secure Socket Layer) or WTLS (Wireless Transport Layer Security)	"X" or space
GET_SECURE_PROTOCOLS_NAMES	method get_secure_protocols_names returning value type string	Returns the names of the security protocols supported The names are separated by semicolons
GET_SELECTION_MENU_SUPPORTED	method get_selection_menu_supported returning value type flag	Specifies whether or not the menu layout type "selectionList" is supported	"X" or space	WML	4
GET_SETVAR_ON_EVENT_SUPPORTED	method get_setvar_on_event_supported returning value type flag	Specifies whether or not the <setvar> tag can be used within the <onevent type="onenterforward"> event handler	"X" or space	WML	1
GET_SKIPPING_TO_INPUT	method get_skipping_to_input returning value type flag	Specifies whether or not the browser automatically skips to the first <input> tag and displays a screen extract starting from this tag	"X" or space	WML	4
GET_SMALL_SUPPORTED	method get_small_supported returning value type flag	Specifies whether or not text can be formatted as "small"	"X" or space	WML	5
GET_SOFTKEY_NUM	method get_softkey_num returning value type int1	Returns the number of Soft Keys supported by the device		WML	3
GET_SOFTKEY_STYLE1	method get_softkey_style1 returning value type string	Specifies how soft key 1 is displayed on the screen	„notShown" „key" „menu" „screen"	WML	5
GET_SOFTKEY_STYLE2	method get_softkey_style2 returning value type string	Specifies how soft key 2 is displayed on the screen	„notShown" „key" „menu" „screen"	WML	5
GET_SOFTKEY_TITLE_WIDTH	method get_softkey_title_width returning value type int2	Returns the number of displayed characters for a soft key title.		WML	3
GET_SOUND_SUPPORTED	method get_sound_supported returning value type flag	Specifies whether or not the device can play sounds	"X" or space	HTML
GET_STRONG_SUPPORTED	method get_strong_supported returning value type flag	Specifies whether or not text with the <strong>can be formatted as "highlighted"	"X" or space	WML	5
GET_SUBMIT_ONEVENT_SUPPORTED	method get_submit_onevent_supported returning value type flag	Specifies whether or not "Submit" is supported within the <onevent type="onenterforward"> event handler	"X" or space		1
GET_SUB_CATEGORY	method get_sub_category returning value type string	Allows you to split devices into different sub-categories	Any text
GET_TABLE_HAS_BORDERS	method get_table_has_borders returning value type flag	Specifies whether or not tables are displayed with gridlines	"X" or space		4
GET_TABLE_SUPPORTED	method get_table_supported returning value type flag	Specifies whether or not the browser supports tables with several columns	"X" or space		3
GET_TELEPHONY_LINKS_SUPPORTED	method get_telephony_links_supported returning value type flag	Specifies whether or not a telephone can be dialed directly using a link	"X" or space		4
GET_TEXT_ALIGNMENT_SUPPORTED	method get_text_alignment_supported returning value type flag	Specifies whether or not text within a paragraph can be aligned left, right, or centered	"X" or space	WML	5
GET_TEXT_STYLES_SUPPORTED	method get_text_styles_supported returning value type flag	Specifies whether or not the browser can format text using tags such as <b> or <small>	"X" or space	WML	5
GET_TITLE_SUPPORTED	method get_title_supported returning value type flag	Specifies whether or not a label is to appear on the top of the screen using the "title" property of the <card> WML tag.	"X" or space	WML	3
GET_TITLE_WIDTH	method get_title_width returning value type int2	Returns the maximum number of characters of the title			3
GET_UNDERLINE_SUPPORTED	method get_underline_supported returning value type flag	Specifies whether or not text can be formatted as "underlined"	"X" or space	WML	5
GET_USER_AGENT	method get_user_agent returning value type string	Equivalent to the HTTP request header "userAgent"
GET_VARS_ACROSS_CARD_SUPPORTED	method get_vars_across_card_supported returning value type flag	Specifies whether or not browser variables passed to a card can also be used for different cards	"X" or space	WML	1
GET_VENDOR	method get_vendor returning value type string	Returns the manufacturer’s name
GET_XSL_SUPPORTED	method get_xsl_supported returning value type flag	Specifies whether or not the browser supports Extensible Stylesheet Language (XSL)	"X" or space	HTML
GET_XSL_VERSION	method get_xsl_version returning value type int4	Returns the XSL version supported		HTML