SHOW Signed
 

net.rim.blackberry.api.browser
Class Browser

java.lang.Object
  |
  +--net.rim.blackberry.api.browser.Browser

public final class Browser
extends Object

Provides access to the BlackBerry Browser.

To gain access to the BlackBerry Browser application, use getDefaultSession() or getSession(java.lang.String) to retrieve a BrowserSession object you can use to direct the application to load pages.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:
JDE 4.0.0

Field Summary
 Category: Signed static String CID_BROWSERCONFIG
          Describes the CID of Browser Configuration service book entries
 
Method Summary
 Category: Signed static BrowserSession getDefaultSession()
          Retrieves the default session based on the default connection settings.
 Category: Signed static BrowserSession getSession(String uid)
          Retrieves a session based on one of the defined connection types.
 Category: Signed static String getTransportUid(ServiceRecord browserConfigSr)
          Retrieves the UID for the underlying transport associated with a given service record.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CID_BROWSERCONFIG

public static String CID_BROWSERCONFIG
Describes the CID of Browser Configuration service book entries
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Method Detail

getDefaultSession

public static BrowserSession getDefaultSession()
Retrieves the default session based on the default connection settings.
Returns:
Default Session instance.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getSession

public static BrowserSession getSession(String uid)
Retrieves a session based on one of the defined connection types.

If the UID provided isn't found in the ServiceBook, this method uses CID_BROWSERCONFIG.

Parameters:
uid - A service record UID with a "BrowserConfig" CID.
Returns:
Session based on the connection specified by the service record associated with the provided UID.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getTransportUid

public static String getTransportUid(ServiceRecord browserConfigSr)
Retrieves the UID for the underlying transport associated with a given service record.

The BrowserConfig entries (CID=BrowserConfig) contain special application data that determines the actualy ServiceRecord entry used to fetch data. Using this method you can determine the UID of the service record that is used as the transport for a given BrowserConfig service record.

Using this method you can determine extra information about the connection that will be used when you invoke the browser with a given browser configuration UID.

Parameters:
browserConfigSr - Service record for the browser config entry.
Returns:
UID in String form identifying the transport used by the associated browser config entry.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.