public IAsyncOperation<IList<GDServiceProvider>> GetServiceProvidersAsync()

public:
virtual IAsyncOperation<IList<GDServiceProvider^>^>^ GetServiceProvidersAsync() sealed

function GetServiceProvidersAsync();

Return Value

Return Value

This method returns a list of all available providers of shared services. The list contains both application-based and server-based service providers.

The returned list is based on the BlackBerry Dynamics Application Identifier (BlackBerry Dynamics Entitlement ID) configuration in the enterprise BlackBerry Dynamics management console and in the central BlackBerry Dynamics Catalog. The list includes an entry for each BlackBerry Dynamics Entitlement ID and Entitlement Version pair that meets all the following conditions:

• The BlackBerry Dynamics Entitlement ID and Entitlement Version is registered as the provider of one or more shared services. Registrations are stored in the enterprise BlackBerry Dynamics management console or in the BlackBerry Dynamics Catalog.
• The end user of the current application is entitled to the BlackBerry Dynamics Entitlement ID and Entitlement Version. Entitlements are stored in the enterprise BlackBerry Dynamics management console only.
• For application-based service providers, the mobile application has been installed and activated for the same end user, and on the same mobile device, as the current application. The application could be already uninstalled from the system, so it is up to developer to check if this application is still available.

The BlackBerry Dynamics Catalog is a server within the BlackBerry Dynamics infrastructure. Developers may register their BlackBerry Dynamics applications as providers of one or more shared services. Registration of the services provided by a BlackBerry Dynamics application can be carried out in the enterprise the BlackBerry Dynamics management console user interface. Registrations are then stored in the BlackBerry Dynamics Catalog. The creation of individual shared service definitions is also carried out in the enterprise BlackBerry Dynamics management console.

The BlackBerry Dynamics runtime retrieves the information used to generate the list of service providers from the BlackBerry Dynamics Catalog, and from the enterprise BlackBerry Dynamics management console. Retrieval can take place when the application is authorized, or when another application activates on the same device, or when the configuration is changed in the enterprise BlackBerry Dynamics management console. Note that retrieval is not triggered by calling this method.

For each BlackBerry Dynamics Entitlement ID and Entitlement Version that satisfies the conditions, this method returns a GDServiceProvider object.

The returned details for an application-based provider can be used to send a service request to the service provider using BlackBerry Inter-Container Communication. See the GDService for details of the API. See under Service Provider Requirements on that page for information on service-provider registration, which is a prerequisite for an application to be on the list returned by this function.

The returned details for a server-based provider can be used to establish HTTP or TCP socket communications with a server instance.

A single service could have multiple providers. A single provider could provide multiple services, and multiple versions of services.

When changed details have been retrieved by the runtime, a GDAppEventServicesUpdate event will be dispatched to the application. See also .

ICON IMAGES

The objects returned by this methods can include icon images for service provider applications. Utilization of icon images is optional. If the application does utilize icon images, then make a setting in the settings.json file as follows:

"GDFetchResources": true

If the setting is missing or the value is false, this indicates that the application does not utilize icon images.

The data for icon images would be retrieved by the SDK, from a BlackBerry Dynamics Catalog service. BlackBerry Limited may switch off the icon image service at the BlackBerry Dynamics Catalog from time to time, for operational reasons. If the icon image service is switched off then all icon lists in the returned objects will be empty.

This method returns a list of all available providers of shared services. The list contains both application-based and server-based service providers.

The returned list is based on the BlackBerry Dynamics Application Identifier (BlackBerry Dynamics Entitlement ID) configuration in the enterprise BlackBerry Dynamics management console and in the central BlackBerry Dynamics Catalog. The list includes an entry for each BlackBerry Dynamics Entitlement ID and Entitlement Version pair that meets all the following conditions:

• The BlackBerry Dynamics Entitlement ID and Entitlement Version is registered as the provider of one or more shared services. Registrations are stored in the enterprise BlackBerry Dynamics management console or in the BlackBerry Dynamics Catalog.
• The end user of the current application is entitled to the BlackBerry Dynamics Entitlement ID and Entitlement Version. Entitlements are stored in the enterprise BlackBerry Dynamics management console only.
• For application-based service providers, the mobile application has been installed and activated for the same end user, and on the same mobile device, as the current application.

The BlackBerry Dynamics Catalog is a server within the BlackBerry Dynamics infrastructure. Developers may register their BlackBerry Dynamics applications as providers of one or more shared services. Registration of the services provided by a BlackBerry Dynamics application can be carried out in the enterprise BlackBerry Dynamics management console user interface. Registrations are then stored in the BlackBerry Dynamics Catalog. The creation of individual shared service definitions is also carried out in the enterprise BlackBerry Dynamics management console.

The SDK retrieves the information used to generate the list of service providers from the BlackBerry Dynamics Catalog, and from the enterprise BlackBerry Dynamics management console. Retrieval can take place when the application is authorized, or when another application activates on the same device, or when the configuration is changed in the enterprise BlackBerry Dynamics management console. Note that retrieval is not triggered by calling this method.

For each BlackBerry Dynamics Entitlement ID and Entitlement Version that satisfies the conditions, this method returns a GDServiceProvider object.

The returned details for an application-based provider can be used to send a service request to the service provider using BlackBerry Inter-Container Communication. See the GDService for details of the API. See under Service Provider Requirements on that page for information on service-provider registration, which is a prerequisite for an application to be on the list returned by this function.

The returned details for a server-based provider can be used to establish HTTP or TCP socket communications with a server instance.

A single service could have multiple providers. A single provider could provide multiple services, and multiple versions of services.

When changed details have been retrieved by the runtime, a GDAppEventServicesUpdate event will be dispatched to the application. See also .

ICON IMAGES

The objects returned by this methods can include icon images for service provider applications. Utilization of icon images is optional. If the application does utilize icon images, then make a setting in the settings.json file as follows:

"GDFetchResources": true

If the setting is missing or the value is false, this indicates that the application does not utilize icon images.

The data for icon images would be retrieved by the SDK, from a BlackBerry Dynamics Catalog service. BlackBerry Limited may switch off the icon image service at the BlackBerry Dynamics Catalog from time to time, for operational reasons. If the icon image service is switched off then all icon lists in the returned objects will be empty.

Reference