bbmsp_access_error_codes_t

The access status codes that indicate whether your app can access the BBM Social Platform.

Synopsis:

#include <bbmsp/bbmsp_context.h>
 
typedef enum {
      BBMSP_ACCESS_ALLOWED = 0   
      BBMSP_ACCESS_UNKNOWN = 1   
      BBMSP_ACCESS_UNREGISTERED = 2   
      BBMSP_ACCESS_PENDING = 3   
      BBMSP_ACCESS_BLOCKED_BY_USER = 4   
      BBMSP_ACCESS_BLOCKED_BY_RIM = 5   
      BBMSP_ACCESS_NO_DATA_CONNECTION = 6   
      BBMSP_ACCESS_UNEXPECTED_ERROR = 7   
      BBMSP_ACCESS_INVALID_UUID = 8   
      BBMSP_ACCESS_TEMPORARY_ERROR = 9   
      BBMSP_ACCESS_MAX_DOWNLOADS_REACHED = 10   
      BBMSP_ACCESS_EXPIRED = 11   
      BBMSP_ACCESS_CANCELLED_BY_USER = 12   
      BBMSP_ACCESS_MAX_APPS_REACHED = 13   
      BBMSP_ACCESS_BLOCKED_BBM_DISABLED = 14   
      BBMSP_ACCESS_BLOCKED_ENTERPRISE_PERIMETER = 15   
} bbmsp_access_error_codes_t;

Since:

BlackBerry 10.0.0

Data:

BBMSP_ACCESS_ALLOWED
Indicates that access to the BBM Social Platform is allowed and your app has successfully registered.
Once registered, the app does not have to call bbmsp_register() again.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_UNKNOWN
The BBM Social Platform has not yet retrieved the access code for this app.
Wait to receive an event with category BBMSP_REGISTRATION and type BBMSP_SP_EVENT_ACCESS_CHANGED. This event will return the current access code.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_UNREGISTERED
Your app is not registered with the BBM Social Platform.
Call bbmsp_register() to start the registration process. You cannot use the BBM Social Platform APIs until the app has successfully registered.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_PENDING
Your app has initiated the registration process and it is currently in progress.
You do not yet have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_BLOCKED_BY_USER
Your app was blocked by the user.
Your app does not have access to the BBM Social Platform APIs. The user can unblock the app through the global settings for the app.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_BLOCKED_BY_RIM
Your app was blocked by BlackBerry.
Your app does not have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_NO_DATA_CONNECTION
A data connection could not be established to complete registration.
You can call bbmsp_register() again once a data connection has been established. You do not yet have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_UNEXPECTED_ERROR
Your app could not register due to a general error.
You do not have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_INVALID_UUID
Your app could not register because an invalid UUID was provided.
Call bbmsp_register() with a valid UUID. You do not yet have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_TEMPORARY_ERROR
Your app could not register due to a temporary error.
Call bbmsp_register() at a later time. You do not have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_MAX_DOWNLOADS_REACHED
Your app has reached the maximum allowed users.
This limit is not applied to apps that are downloaded from BlackBerry World. You can submit your app to BlackBerry World to remove this limitation. You do not have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_EXPIRED
Your app's access to the BBM Social Platform has expired.
This limit is not applied to apps that are downloaded from BlackBerry World. You can submit your app to BlackBerry World to remove this limitation. You do not have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_CANCELLED_BY_USER
The registration process has been cancelled by the user.
You do not have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_MAX_APPS_REACHED
Your app cannot register on this device because the maximum allowable number of apps has been reached.
You do not have access to the BBM Social Platform APIs.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_BLOCKED_BBM_DISABLED
Your app does not have access to the BBM Social Platform because BBM has been disabled.
The user needs to follow the instructions specified in the BBM application to re-enable BBM. Once BBM is re-enabled, your application will receive a new access status.

Since: BlackBerry 10.0.0

BBMSP_ACCESS_BLOCKED_ENTERPRISE_PERIMETER
Your app does not have access to the BBM Social Platform because it is installed in the Work perimeter.

To connect to BBM you must install your app in the Personal perimeter.

Since: BlackBerry 10.2.0

Library:

libbbmsp (For the qcc command, use the -l bbmsp option to link against this library)

Description:

Your app must be registered with the BBM Social Platform before you can use any of its APIs. After you call bbmsp_request_events() to initialize the BBM Social Platform, wait to receive an event with category BBMSP_REGISTRATION and type BBMSP_SP_EVENT_ACCESS_CHANGED. This event will return the current access status of your app. If the access status is BBMSP_ACCESS_UNREGISTERED, call bbmsp_register() to register the app. If the access status is BBMSP_ACCESS_ALLOWED, the app has successfully registered and you can start using other BBM Social Platform APIs.

Last modified: 2014-05-14



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus