net.rim.blackberry.api.bbm.platform
Class BBMPlatformManager

java.lang.Object
  |
  +--net.rim.blackberry.api.bbm.platform.BBMPlatformManager

public abstract class BBMPlatformManager

extends Object

The BBMPlatformManager class contains the entry point for accessing the BBM Social SDK and provides methods to register the application with the BBM Platform, access BBMContactList and UserProfile, and to send and receive messages. You must call the register(BBMPlatformApplication application) method to gain access to the BBM Social SDK.

Method Summary

static BBMPlatformContext

register(BBMPlatformApplication application) In order to access the BBM Social SDK, your application should register with the BBMPlatformManager by calling register(BBMPlatformApplication application) to obtain a BBMPlatformContext object.

Method Detail

register

public static BBMPlatformContext register(BBMPlatformApplication application)

In order to access the BBM Social SDK, your application should register with the BBMPlatformManager by calling register(BBMPlatformApplication application) to obtain a BBMPlatformContext object. This call is blocking and will present the user with a dialog to complete the registration. The method will be executed on the caller's event thread. Ensure that you call this method after you have created your event thread through net.rim.device.api.system.Application#enterEventDispatcher().

BBMPlatformContext can be used to determine the registration and platform access status of your application. To receive a notification of any status changes, the application must set a BBMPlatformContextListener on the BBMPlatformContext.

You can invoke this method from a background process (non-Ui application). If any user interaction is required to complete the registration process, you will get a BBMPlatformContext.ACCESS_REGISTER_WITH_UI_APPLICATION access status.

Parameters:

application - application information

Returns:

BBMPlatformContext through which the BBM Social SDK can be accessed

Throws:

IllegalArgumentException - if application is null

IllegalArgumentException - if application.getInvocableModuleHandle() refers to an invalid module handle

IllegalArgumentException - if application.getInvocableApplicationDescriptorIndex() refers to an invalid application descriptor index

ControlledAccessException - if BBM Social SDK is disabled

PersistentContentException - when Content Protection is enabled and device is locked.

Since:

BBM SDK 1.0