• BlackBerry Dynamics
  • Runtime library for Android applications
  • 9.2.0.99
GDServiceProvider Class Reference

Service provider details. More...

Description

This class is used to return information about a service provider. See GDAndroid.getServiceProvidersFor. An instance of this class either represents an application or a server.

The information returned for an application could be used to send a service request to the service provider using AppKinetics. See the icc package reference for details of AppKinetics.

The information returned for a server could be used to establish HTTP or TCP socket communications with an instance of the server.

Public Member Functions

String getIdentifier ()
 Get the BlackBerry Dynamics entitlement identifier of the service provider. More...
 
String getVersion ()
 Get the BlackBerry Dynamics entitlement version of the service provider. More...
 
String getName ()
 Get the display name of the service provider. More...
 
String getAddress ()
 Get the native application identifier of the service provider. More...
 
Bitmap getIcon ()
 Get the application icon of the service provider, if it has been retrieved. More...
 
boolean getIconPending ()
 Check whether there is an application icon that has not yet been retrieved. More...
 
Vector< GDAppServergetServerCluster ()
 Get server details. More...
 
Vector< GDServiceDetailgetServices ()
 Get details of provided services. More...
 

Member Function Documentation

◆ getIdentifier()

String getIdentifier ( )
Returns
String containing the BlackBerry Dynamics entitlement identifier of the service provider.

◆ getVersion()

String getVersion ( )
Returns
String containing the BlackBerry Dynamics entitlement version of the service provider.

◆ getName()

String getName ( )
Returns
String containing the display name of the service provider.

◆ getAddress()

String getAddress ( )

Call this method to get the native application identifier of the service provider, if it is an application. The returned address is the value that would be passed as the application parameter in a call to sendTo (GDServiceClient) .

Returns
String containing the native application identifier.

◆ getIcon()

Bitmap getIcon ( )

Call this method to get the application icon of the service provider. This method returns a Bitmap object if all the following conditions are met.

  • The service provider is an application.
  • An icon has been uploaded by the application developer.
  • The icon has been retrieved by the BlackBerry Dynamics runtime.

Otherwise, this method returns null.

See also the getIconPending method, below.

Returns
Bitmap containing the application icon, or null.

◆ getIconPending()

boolean getIconPending ( )

Call this method to check whether there is application icon that hasn't yet been retrieved, if getIcon returns null.

If there is an icon for the service provider that has not yet been retrieved by the BlackBerry Dynamics runtime, this method returns true. A GDAppEvent of type GDAppEventServicesUpdate event will be dispatched when the icon has been retrieved.

If getIcon returns null, and this method returns false, it means that there is no application icon.

Returns
true if there is an icon for the service provider that hasn't yet been retrieved.
false otherwise.

◆ getServerCluster()

Vector<GDAppServer> getServerCluster ( )
Returns
Vector of GDAppServer objects, each representing an instance of a server that provides the service. If there is more than one then the application should use a server selection algorithm, such as that outlined under the Application Server Selection heading in the GDAndroid.getApplicationConfig documentation.

◆ getServices()

Vector<GDServiceDetail> getServices ( )
Returns
Vector of GDServiceDetail objects, each representing a provided shared service.