net.rim.blackberry.web.widget.jil
Class JILWidgetRuntime

java.lang.Object
  extended by net.rim.blackberry.web.widget.jil.JILWidgetRuntime

public class JILWidgetRuntime
extends Object

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:
BlackBerry API 7.0.0

Method Summary
Category: Signed  String getComplianceLevel()
          This method will return the compliance level of JIL Handset API support by this JIL Widget Runtime
Category: Signed static JILWidgetRuntime getInstance()
          Retrieves the singleton instance of JILWidgetEngine
Category: Signed  String getJILWidgetRuntimeVersion()
          This method will return the version of the current JIL Widget Runtime.
Category: Signed  String getJILWidgetVersion()
          This method will return the version of the JIL Widget specification that this JIL Widget Runtime currently supports
Category: Signed  String getWidgetVersion(String contentId)
          The method retrieves the version of the widget specified by the provided content id
Category: Signed  void install(String widgetUrl, String contentId, AuthInfo authInfo)
          This method will install the widget specified by widgetUrl and associate that widget with the provided contentId and authInfo.
Category: Signed  boolean isInstalled(String contentId)
          This method determines whether or not a widget is installed that has the specified content id
Category: Signed  void launch(String contentId)
          This method will launch an installed widget that has the specified content id
Category: Signed  void registerStorefront(Class storefrontClass)
          This method must only be called by the ODP application in order to register its implementation of the JILWidgetStorefront interface
Category: Signed  void uninstall(String contentId)
          This method will uninstall the widget associated with the specified content id
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Method Detail

getInstance

public static JILWidgetRuntime getInstance()
Retrieves the singleton instance of JILWidgetEngine

Returns:
A unique instance of JILWidgetEngine for the current process
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:
BlackBerry API 7.0.0

registerStorefront

public void registerStorefront(Class storefrontClass)
This method must only be called by the ODP application in order to register its implementation of the JILWidgetStorefront interface

Parameters:
className - The class object of a JILWidgetStorefront implementation
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:
BlackBerry API 7.0.0

install

public void install(String widgetUrl,
                    String contentId,
                    AuthInfo authInfo)
             throws JILWidgetException
This method will install the widget specified by widgetUrl and associate that widget with the provided contentId and authInfo.

s NOTE: Invoking this method cannot be done on the event thread or while holding the event lock.

Parameters:
widgetUrl - The url at which the widget to be installed can be found. e.g. file:///SDCard/test.wgt
contentId - The contentId to associate with this widget
authInfo - The corresponding authorization info for this widget. Can be null if billing authorization is not required
Throws:
JILWidgetException - If any failure occurs while installing the specified widget
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:
BlackBerry API 7.0.0

uninstall

public void uninstall(String contentId)
               throws JILWidgetException
This method will uninstall the widget associated with the specified content id

Parameters:
contentId - The content id to use when identifying the widget to delete
Throws:
JILWidgetException - If any failure occurs while uninstalling the specified widget
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:
BlackBerry API 7.0.0

launch

public void launch(String contentId)
            throws JILWidgetException
This method will launch an installed widget that has the specified content id

Parameters:
contentId - The content id used to identify a widget
Throws:
JILWidgetException - This exception is thrown if the widget cannot be found or it fails to launch
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:
BlackBerry API 7.0.0

getWidgetVersion

public String getWidgetVersion(String contentId)
                        throws JILWidgetException
The method retrieves the version of the widget specified by the provided content id

Parameters:
contentId - The content id identifying the widget of interest
Returns:
The version of the widget if it has a specified version. Return null if no version was provided.
Throws:
JILWidgetException
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:
BlackBerry API 7.0.0

isInstalled

public boolean isInstalled(String contentId)
This method determines whether or not a widget is installed that has the specified content id

Parameters:
contentId - The content id used to identify a widget
Returns:
true if a widget is installed and false otherwise
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:
BlackBerry API 7.0.0

getJILWidgetVersion

public String getJILWidgetVersion()
This method will return the version of the JIL Widget specification that this JIL Widget Runtime currently supports

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:
BlackBerry API 7.0.0

getComplianceLevel

public String getComplianceLevel()
This method will return the compliance level of JIL Handset API support by this JIL Widget Runtime

Returns:
"bronze", "silver" or "gold"
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:
BlackBerry API 7.0.0

getJILWidgetRuntimeVersion

public String getJILWidgetRuntimeVersion()
This method will return the version of the current JIL Widget Runtime.

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:
BlackBerry API 7.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal