blackberry webworks sdk for smart phones technical note 1590955 0415041754 001 2.0 us

25
BlackBerry WebWorks SDK for Smartphones Configuration Document Version: 2.0 Technical Note

Upload: anbusivan

Post on 27-Nov-2014

273 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

BlackBerry WebWorks SDK for SmartphonesConfiguration DocumentVersion: 2.0

Technical Note

Page 2: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

SWD-1590955-0420042801-001

Page 3: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Contents1 Creating a BlackBerry WebWorks configuration document............................................................................. 2

Code sample: Creating a BlackBerry WebWorks configuration document...................................................... 2

2 BlackBerry WebWorks namespace................................................................................................................... 4

3 Widget element................................................................................................................................................ 5Name element.................................................................................................................................................. 6Description element......................................................................................................................................... 6Author element................................................................................................................................................. 7License element................................................................................................................................................ 8Icon element..................................................................................................................................................... 9RIM cache element........................................................................................................................................... 10Access element................................................................................................................................................. 11Feature element............................................................................................................................................... 11Content element............................................................................................................................................... 12

RIM background element.......................................................................................................................... 13Code sample: Parsing invoke parameters................................................................................................. 13

RIM loadingScreen element.............................................................................................................................. 14RIM transitionEffect element.................................................................................................................... 16

RIM connection element.................................................................................................................................. 17Id element.................................................................................................................................................. 17

4 Glossary............................................................................................................................................................ 19

5 Provide feedback.............................................................................................................................................. 20

6 Legal notice....................................................................................................................................................... 21

Page 4: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Creating a BlackBerry WebWorks configuration document

1

The BlackBerry® WebWorks™ configuration document is an .xml file that contains the elements to define the BlackBerry WebWorks application namespace, the name of the application, application permissions, the start page, and the icons to use for the application. It also contains the elements to define information such as the author, email address, and license information. The configuration document contains the widget element at its root. The widget element provides a container for all other elements.

The configuration document must be located in the root folder of the BlackBerry WebWorks application archive.

Code sample: Creating a BlackBerry WebWorks configuration documentThe valid file name for a configuration document for a BlackBerry® WebWorks™ application is config.xml, and is case insensitive. Within the application archive, the configuration document must use this file name. The config.xml file must exist in the root folder of the application archive.

<?xml version="1.0" encoding="utf-8"?><widget xmlns=" http://www.w3.org/ns/widgets" xmlns:rim="http://www.blackberry.com/ns/widgets" version="2.0" rim:header="RIM-Widget: rim/widget">

<author href="http://www.example.com/" rim:copyright="Copyright 1998-2011 My Corp">My Corp</author> <rim:navigation mode="focus" /> <name> The example application</name>

<description> A sample application to demonstrate some of the possibilities. </description>

<rim:loadingScreen backgroundImage="background.png" foregroundImage="foreground.gif" onLocalPageLoad="true"> <rim:transitionEffect type="zoomIn" /> </rim:loadingScreen>

<icon src="icons/example.png"/> <icon src="icons/boo.png" rim:hover="true"/>

<rim:cache maxCacheSizeTotal="2048" maxCacheSizeItem ="256" />

<content src="index.html" > <rim:background src="listener.html" runOnStartup="true" /> </content>

<feature id="blackberry.ui.dialog"/> <access uri="http://www.somedomain.com" subdomains="true">

Technical Note Creating a BlackBerry WebWorks configuration document

2

Page 5: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

<feature id="blackberry.pim.memo"/> <feature id="blackberry.invoke.MemoArguments"/> </access>

<rim:connection timeout="25000"> <id>TCP_WIFI</id> <id>MDS</id> <id>BIS-B</id> <id>TCP_CELLULAR</id> <id>WAP2</id> <id>WAP</id> </rim:connection>

<license> Example license Copyright (c) 2008 My Corp. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, INSULT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

</license>

</widget>

Technical Note Code sample: Creating a BlackBerry WebWorks configuration document

3

Page 6: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

BlackBerry WebWorks namespace 2You must assign the namespace for the BlackBerry® WebWorks™ application to the widget element. If the namespace is missing, the application archive is not valid. The application namespace is http://www.w3.org/ns/widgets.

The namespace for BlackBerry WebWorks extensions is not optional. The namespace for BlackBerry specific application extensions is xmlns:rim http://www.blackberry.com/ns/widgets.

Technical Note BlackBerry WebWorks namespace

4

Page 7: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Widget element 3The widget element provides a container for all other elements, and is the root element in the configuration document for a BlackBerry® WebWorks™ application.

For all other elements within the widget element, you use the following requirements:• One <name> element• Zero or one <description> elements• Zero or more <icon> elements• Zero or one <author> elements• Zero or one <license> elements• Zero or one <rim:cache> elements• Zero or one <rim:navigation> elements• Zero or more <access> elements• One <content> element• Zero or more < feature> elements• Zero or one <rim:loadingScreen> elements• Zero or one <rim:transitionEffect> elements

Attribute Description

version The version attribute specifies a valid version for the BlackBerry WebWorks application, in one of the following formats:• x.x• x.x.x• x.x.x.x

If you specify a version number that is not valid, the application archive is not valid.

This attribute is required.rim:header The rim:header attribute specifies a header value that precedes every

request for data that the application sends. If you specify this attribute, you can distinguish application requests from BlackBerry® Browser requests.

This attribute is optional.rim:backButton The rim:backButton attribute specifies the behavior for the Back button

on the BlackBerry device. If you specify this attribute with a value of exit, the Back button exits the application.

By default, the Back button displays the previous screen.

This attribute is optional.id The id attribute specifies a unique identifier for the application.

This attribute is optional.

Technical Note Widget element

5

Page 8: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Attribute Description

xml:lang The xml:lang attribute specifies the language that is used in the element. For more information about this attribute, visit www.w3.org.

This attribute is optional.

Name elementThe name element specifies a human-readable name for a BlackBerry® WebWorks™ application that you can use, for example, in an application menu.

If you do not specify a name element, the application is not valid.

You can also specify a name by using the blackberry.app.name that is provided in the BlackBerry WebWorks API.

Attribute Description

xml:lang The xml:lang attribute specifies the language that is used in the element. For more information about this attribute, visit www.w3.org.

This attribute is optional.its:dir The its:dir attribute specifies the directionality of the language. For

example, its:dir="rtl" specifies a language that is written from right to left. For more information about this attribute, visit www.w3.org.

You can use this attribute for localization.

Code sample: Specifying a name

<name>Hello World! application</name>

Description elementThe description element specifies a human-readable description for a BlackBerry® WebWorks™ application.

You can access this element by using the blackberry.app.description that is provided in the BlackBerry WebWorks API.

Attribute Description

xml:lang The xml:lang attribute specifies the language that is used in the element. For more information about this attribute, visit www.w3.org.

This attribute is optional.

Technical Note Name element

6

Page 9: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Attribute Description

its:dir The its:dir attribute specifies the directionality of the language. For example, its:dir="rtl" specifies a language that is written from right to left. For more information about this attribute, visit www.w3.org.

You can use this attribute for localization.

Code sample: Specifying a description

<description> This application displays "Hello World" on the screen.</description>

Author elementThe author element specifies information about the people or organizations that are involved with the creation of a BlackBerry® WebWorks™ application. Author information appears in the Vendor property when BlackBerry device users view the list of applications that are installed on the BlackBerry device.

You can access this element by using the blackberry.app.author that is provided in the BlackBerry WebWorks API.

Attribute Description

href The href attribute specifies a web address that is associated with the author (for example, the web page of the author).

You can access this attribute by using the blackberry.app.authorURL that is provided in the BlackBerry WebWorks API.

rim:copyright The rim:copyright attribute specifies copyright information that appears on the About screen in the application and in the copyright area in the applications list on the BlackBerry device. An example of typical copyright text is Copyright 1998-2009 My Company Inc .

You can access this attribute by using the blackberry.app.copyright that is provided in the BlackBerry WebWorks API.

This attribute is optional.email The email attribute specifies the email address that is associated with the

author.

You can access this attribute by using the blackberry.app.authorEmail that is provided in the BlackBerry WebWorks API.

This attribute is optional.

Technical Note Author element

7

Page 10: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Attribute Description

xml:lang The xml:lang attribute specifies the language that is used in the element. For more information about this attribute, visit www.w3.org.

This attribute is optional.its:dir The its:dir attribute specifies the directionality of the language. For

example, its:dir="rtl" specifies a language that is written from right to left. For more information about this attribute, visit www.w3.org.

You can use this attribute for localization.

Code sample: Specifying author information

<author href="http://www.example.com/" rim:copyright="Copyright 1998-2011 My Corp">My Corp</author>

License elementThe license element specifies the end user license agreement or a copyright statement for a BlackBerry® WebWorks™ application. This element is optional. If you specify this element, you can implement a feature to prompt BlackBerry device users to accept or decline the license agreement when they run the application for the first time. After users agree to the license agreement, the prompt does not appear when they run the application again.

The contents of the license agreement are also available on the About screen in the application.

Attribute Description

xml:lang The xml:lang attribute specifies the language that is used in the element. For more information about this attribute, visit www.w3.org.

This attribute is optional.its:dir The its:dir attribute specifies the directionality of the language. For

example, its:dir="rtl" specifies a language that is written from right to left. For more information about this attribute, visit www.w3.org.

You can use this attribute for localization.href The href attribute specifies a web address for a web page that contains

content or license information.

This attribute is optional.

Code sample: Providing a license agreement

<license> Example license Copyright © 2008 My Corp.

Technical Note License element

8

Page 11: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, INSULT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</license>

Icon elementThe icon element specifies a custom icon for a BlackBerry® WebWorks™ application. You can specify one or more icon elements. The first icon that you specify that does not have the rim:hover attribute set to True is the icon that appears for the application on the Home screen of the BlackBerry device. The icon must meet the requirements for custom or default icons. This element is optional.

If you do not specify the icon element, the BlackBerry® WebWorks™ Packager uses the default icon from the application archive. If the BlackBerry WebWorks Packager does not find the default icon in the archive, it uses the default device application icon.

You can also specify an icon by invoking the blackberry.app.setHomeScreenIcon(src, rim:hover) that is provided in the BlackBerry WebWorks API.

Attribute Description

src The src attribute specifies the path for an image file in the application archive.

This attribute is required.rim:hover The rim:hover attribute is a Boolean value that specifies whether the icon

is used as the hover icon. The first hover icon in the configuration document is used as the hover icon for the application.

By default, if you do not specify a value for the rim:hover attribute, the value is set to False.

This attribute is optional.

Code sample: Specifying an application icon

<icon src="icons/appicon.png"/><icon src="icon/hovicon.png rim:hover="true"/>

Technical Note Icon element

9

Page 12: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

RIM cache elementThe rim:cache element specifies the limits for caching BlackBerry® WebWorks™ application content. This element is optional.

Attribute Description

disableAllCache The disableAllCache attribute specifies whether caching is disabled for the application. This attribute must contain a Boolean value.

By default, if you do not specify this attribute, caching is enabled.

This attribute is optional.aggressiveCacheAge The aggressiveCacheAge attribute specifies the amount of time, in

seconds, to cache items that are not governed by directives in the HTTP header.

By default, if you do not specify this attribute, these items are kept for 2592000 seconds (30 days). Settings higher than this value are ignored.

This attribute is optional.maxCacheSizeTotal The maxCacheSizeTotal attribute specifies the maximum amount of

storage space, in kilobytes, to use for the cache.

By default, 1024 kilobytes of storage space is allocated for the cache. The maximum value is 2048 kilobytes.

This attribute is optional.maxCacheSizeItem The maxCacheSizeItem attribute specifies the maximum amount of

storage space, in kilobytes, for individual items that can be cached.

By default, items up to 128 kilobytes are cached. The maximum cache size is the value set for the maxCacheSizeTotal attribute.

This attribute is optional.

Code sample: Specifying the maximum cache size for the application and individual items

<rim:cache maxCacheSizeTotal="2048" maxCacheSizeItem ="256" />

Technical Note RIM cache element

10

Page 13: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Access elementThe access element specifies that a BlackBerry® WebWorks™ application can access external network resources. By default, if you do not specify an access element, an application has access to all local resources. Local resources include any resources in the application archive file. If you specify more than one access element, the most specific definition is used. For example, if you use http://somedomain.com and http://specific.somedomain.com, the access element that uses the first definition (and any features defined under it) is ignored.

If your application makes calls to APIs on an external server, the external server must be declared in the access list.

Attribute Description

uri The uri attribute defines the web address for the access request.

This attribute is required.subdomains The subdomains attribute is a Boolean value that specifies whether the

host component in the access request applies to subdomains of the domain that is specified in the URI attribute.

This attribute is optional.

By default, if you do not specify the value of the subdomains attribute, the value is set to False and no access to subdomains is requested.

Code sample: Allowing access to external network resources and features

<access uri="http://www.mydomain.com" subdomains="true"> <feature id="blackberry.pim.memo" required="true" version="1.0.0"/></access>

Feature elementThe feature element specifies a BlackBerry® API that a BlackBerry® WebWorks™ application can use. You can use the feature element within the access element to access a feature under the external domain. You can also use the feature element at the root of the configuration document, before any access elements, for access to the local web page.

If you do not specify an access element above the feature element, the local domain is used. If you do not specify an API, the application cannot use the API for the specified domain.

Attribute Description

id The id attribute specifies the name of the BlackBerry API. The value must match the name of the API, but is not case sensitive. You cannot use a wildcard (*) to use multiple namespaces at the same time.

Technical Note Access element

11

Page 14: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Attribute Description

This attribute is required.required The required attribute is provided to conform to the W3C® specification.

This attribute is optional.version The version attribute specifies the library version of the API.

This attribute is optional.

Code sample: Specifying access to a feature

<feature id="blackberry.ui.dialog" required="true" version="1.0.0"/><access uri="http://www.somedomain.com" subdomains="true"> <feature id="blackberry.pim.memo" required="true" version="1.0.0"/> <feature id="blackberry.invoke.MemoArguments" required="true" version="1.0.0"/></access>

Content elementThe content element specifies the start page that the BlackBerry® WebWorks™ application displays when it runs. The start page can contain the web address of a file that is located outside of the application archive.

Attribute Description

src The src attribute specifies the source HTML file in the application archive.

This attribute is required.rim:allowInvokeParams The rim:allowInvokeParams attribute specifies that parameters can be

passed to your application when it is invoked from another application.

By default, parameters cannot be passed to your application.

This attribute is optional.type The type attribute specifies the MIME type of the file that is specified in

the src attribute.

This attribute is optional.charset The charset attribute specifies the character set that is used by the file

that is specified in the src attribute.

This attribute is optional.

Code sample: Specifying a start page

<content src="startpage.html" rim:allowInvokeParams="true" />

Technical Note Content element

12

Page 15: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

RIM background elementThe RIM:background element specifies a background start page for your BlackBerry® WebWorks™ application. You cannot use this element without specifying a valid src attribute.

Attribute Description

src The src attribute specifies the source HTML file in the application archive.

This attribute is required.runOnStartup The runOnStartup attribute specifies whether the background start page

should appear when the BlackBerry device starts and when the application is installed.

By default, the background start page appears when the device starts.

This attribute is optional.charset The charset attribute specifies the character set that is used by the file

that is specified in the src attribute.

This attribute is optional.

Code sample: Specifying a foreground and background start pageYou can start the application from an icon and also run the background start page when the device starts and when the application is installed.

<content src="index.html" > <rim:background src="listener.html" runOnStartup="true" /></content>

Code sample: Specifying a background start page onlyYou can start the application when the device starts and when the application is installed.

<content> <rim:background src="listener.html" runOnStartup="true" /></content>

Code sample: Parsing invoke parametersWhen you enable the rim:allowInvokeParams parameter, the start up parameters for the application are available to the start page as a query string. You can parse the query string using JavaScript®.

function parseQueryString() {

// Create result container

Technical Note Content element

13

Page 16: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

var queryParamResult; // Start at 1 to skip the leading '?' var query = window.location.search.substring(1); // Split the string on key-value pairs var params = query.split('&'); // Loop through the pairs for ( var i = 0 ; i < params.length ; i++ ) { // Locate the '=' var position = params[i].indexOf('='); if ( position > 0 ) { // Text before the '=' is the key var key = params[i].substring( 0, position ); // Text after the '=' is the value var value = params[i].substring( position + 1 ); // Add to result container queryParamResult[key] = value; } } return queryParamResult;}

RIM loadingScreen elementThe rim:loadingScreen element specifies the properties of the screen that appears when the BlackBerry® WebWorks™ application is loading, before the start page appears and when you navigate between pages. You can determine when the loading screen displays by using the onRemotePageLoad, onLocalPageLoad, and onFirstLaunch attributes. This element is optional.

When you define an external URL for your application start page, the loading screen might not appear.

Attribute Description

backgroundColor The backgroundColor attribute specifies the hexadecimal color value to display as the background before the start page appears.

By default, if you do not specify a color, the background is set to white.

This attribute is optional.backgroundImage The backgroundImage attribute specifies the path for a local image to

display as the background. You can specify .png or .jpg files. The image is scaled to fit the entire screen.

This attribute is optional.

Technical Note RIM loadingScreen element

14

Page 17: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Attribute Description

foregroundImage The foregroundImage attribute specifies the path for a local image to display as the foreground. You can specify .bmp, .jpg, .gif, .png, animated .gif, and transparent .png files. The image is centered on the screen.

This attribute is optional.onRemotePageLoad The onRemotePageLoad attribute specifies whether to display the loading

screen when the application transitions to a web page from a remote location, including web pages with URLs that begin with http or https. The value for this attribute is either true or false.

This attribute is optional.onLocalPageLoad The onLocalPageLoad attribute specifies whether to display the loading

screen when the application transitions to a local page, including pages with URLs that begin with local:/// or file:///. The value for this attribute is either true or false.

This attribute is optional.onFirstLaunch The onFirstLaunch attribute specifies whether to display the loading

screen each time you start the application. The value for this attribute is either true or false.

This attribute is optional.

Code sample: Specifying the background color for the loading screen

<rim:loadingScreen backgroundColor="#FFFFFF" />

Code sample: Displaying a background image when the application starts

<rim:loadingScreen backgroundImage="background.png" onFirstLaunch="true" />

Code sample: Displaying a background image on transitions from remote pagesYou can display a background image when the application starts, and display a background image with a transition effect when the application transitions from a remote page.

<rim:loadingScreen backgroundColor="#FFFFFF" backgroundImage="background.png" onFirstLaunch="true" onRemotePageLaunch="true"> <rim:transitionEffect type="fadeIn" direction="left" /></rim:loadingScreen>

Technical Note RIM loadingScreen element

15

Page 18: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

RIM transitionEffect elementThe rim:transitionEffect element specifies the type and properties of a transition effect that appears when the BlackBerry® WebWorks™ application transitions between screens. The transition effect is not used for the initial loading screen, but you must define it within the rim:loadingScreen element. This element is optional.

Attribute Description

type The type attribute specifies the transition effect to use between screens in the application.

You can specify the following values for this attribute:• slidePush• slideOver• fadeIn• fadeOut• wipeIn• wipeOut• zoomIn• zoomOut

Note that slideOver, wipeIn, and wipeOut behave the same. fadeIn and fadeOut also behave the same. This attribute is required.

duration The duration attribute specifies the time it takes, in milliseconds, to complete the transition.

The value for this attribute must be an integer between 250 and 1000. If you specify a value greater than 1000, the value is set to 1000. If you specify a value less than 250, the value is set to 250.

If you do not specify a value, the value is set to 250.

This attribute is optional.direction The direction attribute specifies the direction of the screen effect. Values

for this attribute include left, right, up, and down. This attribute is valid for the following effects:• slideIn• slideOut• wipeIn• wipeOut

If you do not specify a direction, the transition moves toward the left side of the screen.

This attribute is optional.

Technical Note RIM loadingScreen element

16

Page 19: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Code sample: Specifying a transition effect

<rim:loadingScreen backgroundColor="#AAA000" onLocalPageLoad="true"> <rim:transitionEffect type="zoomIn" /></rim:loadingScreen>

RIM connection elementThe RIM connection element specifies the amount of time the BlackBerry® device can use to make a connection to the wireless network.

Attribute Description

timeout The timeout attribute overrides the default timeout when the device attempts to connect to the wireless network by using a particular transport method. If you do not specify a value for this attribute, the device uses the timeout that the BlackBerry® Device Software applications use.

You specify the value for this attribute in milliseconds. If you do not specify a valid numeric value, the timeout that you specify is ignored.

The default timeout is 30000 ms.

Code sample: Specifying the connection timeout

<rim:connection timeout="25000" />

Id elementThe id element specifies the type and the order of the transport methods that you want to use for a BlackBerry® WebWorks™ application. This element is optional. If you specify more than one transport method, the BlackBerry device attempts to use the transport methods that you specify, in order. By default, if you do not specify an id element, the connection manager uses the following order:• MDS: BlackBerry® Enterprise Server• BIS-B: BlackBerry® Internet Service• TCP_WIFI: Wi-Fi® network• TCP_CELLULAR: Direct TCP stack• WAP2: WAP 2.0 gateway for a wireless service provider• WAP: WAP 1.0 gateway for a wireless service provider

If you are using the BlackBerry® Push Service, you must specify the BlackBerry Internet Service transport method.

Technical Note RIM connection element

17

Page 20: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Code sample: Specifying transport methods

<rim:connection timeout="25000"> <id>MDS</id> <id>BIS-B</id> <id>TCP_WIFI</id> <id>TCP_CELLULAR</id> <id>WAP2</id> <id>WAP</id></rim:connection>

Technical Note RIM connection element

18

Page 21: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Glossary 4API

application programming interface

BlackBerry MDSBlackBerry® Mobile Data System

HTMLHypertext Markup Language

HTTPHypertext Transfer Protocol

HTTPSHypertext Transfer Protocol over Secure Sockets Layer

TCPTransmission Control Protocol

URIUniform Resource Identifier

WAPWireless Application Protocol

XMLExtensible Markup Language

Technical Note Glossary

19

Page 22: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Provide feedback 5To provide feedback on this deliverable, visit www.blackberry.com/docsfeedback.

Technical Note Provide feedback

20

Page 23: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

Legal notice 6©2011 Research In Motion Limited. All rights reserved. BlackBerry®, RIM®, Research In Motion®, and related trademarks, names, and logos are the property of Research In Motion Limited and are registered and/or used in the U.S. and countries around the world.

Wi-Fi is a trademark of the Wi-Fi Alliance. All other trademarks are the property of their respective owners.

This documentation including all documentation incorporated by reference herein such as documentation provided or made available at www.blackberry.com/go/docs is provided or made accessible "AS IS" and "AS AVAILABLE" and without condition, endorsement, guarantee, representation, or warranty of any kind by Research In Motion Limited and its affiliated companies ("RIM") and RIM assumes no responsibility for any typographical, technical, or other inaccuracies, errors, or omissions in this documentation. In order to protect RIM proprietary and confidential information and/or trade secrets, this documentation may describe some aspects of RIM technology in generalized terms. RIM reserves the right to periodically change information that is contained in this documentation; however, RIM makes no commitment to provide any such changes, updates, enhancements, or other additions to this documentation to you in a timely manner or at all.

This documentation might contain references to third-party sources of information, hardware or software, products or services including components and content such as content protected by copyright and/or third-party web sites (collectively the "Third Party Products and Services"). RIM does not control, and is not responsible for, any Third Party Products and Services including, without limitation the content, accuracy, copyright compliance, compatibility, performance, trustworthiness, legality, decency, links, or any other aspect of Third Party Products and Services. The inclusion of a reference to Third Party Products and Services in this documentation does not imply endorsement by RIM of the Third Party Products and Services or the third party in any way.

EXCEPT TO THE EXTENT SPECIFICALLY PROHIBITED BY APPLICABLE LAW IN YOUR JURISDICTION, ALL CONDITIONS, ENDORSEMENTS, GUARANTEES, REPRESENTATIONS, OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY CONDITIONS, ENDORSEMENTS, GUARANTEES, REPRESENTATIONS OR WARRANTIES OF DURABILITY, FITNESS FOR A PARTICULAR PURPOSE OR USE, MERCHANTABILITY, MERCHANTABLE QUALITY, NON-INFRINGEMENT, SATISFACTORY QUALITY, OR TITLE, OR ARISING FROM A STATUTE OR CUSTOM OR A COURSE OF DEALING OR USAGE OF TRADE, OR RELATED TO THE DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES REFERENCED HEREIN, ARE HEREBY EXCLUDED. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY BY STATE OR PROVINCE. SOME JURISDICTIONS MAY NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES AND CONDITIONS. TO THE EXTENT PERMITTED BY LAW, ANY IMPLIED WARRANTIES OR CONDITIONS RELATING TO THE DOCUMENTATION TO THE EXTENT THEY CANNOT BE EXCLUDED AS SET OUT ABOVE, BUT CAN BE LIMITED, ARE HEREBY LIMITED TO NINETY (90) DAYS FROM THE DATE YOU FIRST ACQUIRED THE DOCUMENTATION OR THE ITEM THAT IS THE SUBJECT OF THE CLAIM.

TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, IN NO EVENT SHALL RIM BE LIABLE FOR ANY TYPE OF DAMAGES RELATED TO THIS DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES REFERENCED HEREIN INCLUDING WITHOUT LIMITATION ANY OF THE FOLLOWING DAMAGES: DIRECT, CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, INDIRECT, SPECIAL, PUNITIVE, OR AGGRAVATED DAMAGES, DAMAGES FOR LOSS OF PROFITS OR REVENUES, FAILURE TO REALIZE ANY EXPECTED SAVINGS, BUSINESS INTERRUPTION, LOSS

Technical Note Legal notice

21

Page 24: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

OF BUSINESS INFORMATION, LOSS OF BUSINESS OPPORTUNITY, OR CORRUPTION OR LOSS OF DATA, FAILURES TO TRANSMIT OR RECEIVE ANY DATA, PROBLEMS ASSOCIATED WITH ANY APPLICATIONS USED IN CONJUNCTION WITH RIM PRODUCTS OR SERVICES, DOWNTIME COSTS, LOSS OF THE USE OF RIM PRODUCTS OR SERVICES OR ANY PORTION THEREOF OR OF ANY AIRTIME SERVICES, COST OF SUBSTITUTE GOODS, COSTS OF COVER, FACILITIES OR SERVICES, COST OF CAPITAL, OR OTHER SIMILAR PECUNIARY LOSSES, WHETHER OR NOT SUCH DAMAGES WERE FORESEEN OR UNFORESEEN, AND EVEN IF RIM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, RIM SHALL HAVE NO OTHER OBLIGATION, DUTY, OR LIABILITY WHATSOEVER IN CONTRACT, TORT, OR OTHERWISE TO YOU INCLUDING ANY LIABILITY FOR NEGLIGENCE OR STRICT LIABILITY.

THE LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS HEREIN SHALL APPLY: (A) IRRESPECTIVE OF THE NATURE OF THE CAUSE OF ACTION, DEMAND, OR ACTION BY YOU INCLUDING BUT NOT LIMITED TO BREACH OF CONTRACT, NEGLIGENCE, TORT, STRICT LIABILITY OR ANY OTHER LEGAL THEORY AND SHALL SURVIVE A FUNDAMENTAL BREACH OR BREACHES OR THE FAILURE OF THE ESSENTIAL PURPOSE OF THIS AGREEMENT OR OF ANY REMEDY CONTAINED HEREIN; AND (B) TO RIM AND ITS AFFILIATED COMPANIES, THEIR SUCCESSORS, ASSIGNS, AGENTS, SUPPLIERS (INCLUDING AIRTIME SERVICE PROVIDERS), AUTHORIZED RIM DISTRIBUTORS (ALSO INCLUDING AIRTIME SERVICE PROVIDERS) AND THEIR RESPECTIVE DIRECTORS, EMPLOYEES, AND INDEPENDENT CONTRACTORS.

IN ADDITION TO THE LIMITATIONS AND EXCLUSIONS SET OUT ABOVE, IN NO EVENT SHALL ANY DIRECTOR, EMPLOYEE, AGENT, DISTRIBUTOR, SUPPLIER, INDEPENDENT CONTRACTOR OF RIM OR ANY AFFILIATES OF RIM HAVE ANY LIABILITY ARISING FROM OR RELATED TO THE DOCUMENTATION.

Prior to subscribing for, installing, or using any Third Party Products and Services, it is your responsibility to ensure that your airtime service provider has agreed to support all of their features. Some airtime service providers might not offer Internet browsing functionality with a subscription to the BlackBerry® Internet Service. Check with your service provider for availability, roaming arrangements, service plans and features. Installation or use of Third Party Products and Services with RIM's products and services may require one or more patent, trademark, copyright, or other licenses in order to avoid infringement or violation of third party rights. You are solely responsible for determining whether to use Third Party Products and Services and if any third party licenses are required to do so. If required you are responsible for acquiring them. You should not install or use Third Party Products and Services until all necessary licenses have been acquired. Any Third Party Products and Services that are provided with RIM's products and services are provided as a convenience to you and are provided "AS IS" with no express or implied conditions, endorsements, guarantees, representations, or warranties of any kind by RIM and RIM assumes no liability whatsoever, in relation thereto. Your use of Third Party Products and Services shall be governed by and subject to you agreeing to the terms of separate licenses and other agreements applicable thereto with third parties, except to the extent expressly covered by a license or other agreement with RIM.

Certain features outlined in this documentation require a minimum version of BlackBerry® Enterprise Server, BlackBerry® Desktop Software, and/or BlackBerry® Device Software.

Technical Note Legal notice

22

Page 25: Blackberry WebWorks SDK for Smart Phones Technical Note 1590955 0415041754 001 2.0 US

The terms of use of any RIM product or service are set out in a separate license or other agreement with RIM applicable thereto. NOTHING IN THIS DOCUMENTATION IS INTENDED TO SUPERSEDE ANY EXPRESS WRITTEN AGREEMENTS OR WARRANTIES PROVIDED BY RIM FOR PORTIONS OF ANY RIM PRODUCT OR SERVICE OTHER THAN THIS DOCUMENTATION.

Research In Motion Limited295 Phillip StreetWaterloo, ON N2L 3W8Canada

Research In Motion UK Limited Centrum House 36 Station Road Egham, Surrey TW20 9LF United Kingdom

Published in Canada

Technical Note Legal notice

23