Analytics Response Types. More...
These constants can be used for handling errors returned by methods within the BlackBerryAnalytics class.
Public Member Functions | |
int | getResponseCode () |
String | getDescription () |
Public Attributes | |
ANALYTICS_NOT_INITIALIZED =(2000, "Analytics not initialized, please check API document.") | |
ANALYTICS_DISABLED =(2001, "Analytics not enabled, please check with admin.") | |
INVALID_EVENT =(2002, "Event is not supported by this API. Please check for Analytics updates.") | |
LIMIT_EXCEEDED =(2003, "Maximum " + EventAttributes.EVENT_DATA_MAX_LENGTH + " characters allowed, please try to enter within limit.") | |
INVALID_FEATURE_NAME =(2004, "Invalid Feature name, it should not be empty or null.") | |
INVALID_EVENT_VALUE =(2005, "Invalid Event value, it should not be empty or null.") | |
INVALID_EVENT_KEY =(2006, "Invalid Event key, it should not be empty or null.") | |
INACTIVE_APP_STATE =(2007, "Application is not active, unable to store events now.") | |
FEATURE_NOT_FOUND =(2008, "Corresponding active feature not found or already recorded.") | |
FEATURE_UNAVAILABLE =(2009, "This feature is unavailable for this version. It will be available in future release.") | |
UNKNOWN_API_VERSION =(2010, "Unknown API version.") | |
BIS_DISABLED =(2011, "BIS entitlement is not enabled, please check with admin.") | |
CA_PARTICIPATION_DISABLED =(2012, "Continuous auth participation is not enabled, please check with admin.") | |
BIS_BB_PERSONA_METADATA_DISABLED =(2013, "Blackberry Persona metadata not available in com.blackberry.dynamics.settings.json file or disabled.") | |
RECORD_SUCCESS =(2099, "Event recorded successfully.") | |
int getResponseCode | ( | ) |
To get the response code of received BIS/ Analytics API response.
String getDescription | ( | ) |
Will provide the description message, for received BIS/ Analytics API response.
ANALYTICS_NOT_INITIALIZED =(2000, "Analytics not initialized, please check API document.") |
This response is deprecated.
ANALYTICS_DISABLED =(2001, "Analytics not enabled, please check with admin.") |
The authorized user is not entitled to use BlackBerry Analytics.
INVALID_EVENT =(2002, "Event is not supported by this API. Please check for Analytics updates.") |
If the provided event type is not supported
LIMIT_EXCEEDED =(2003, "Maximum " + EventAttributes.EVENT_DATA_MAX_LENGTH + " characters allowed, please try to enter within limit.") |
Will be returned when data fields exceeds the desired limit.
INVALID_FEATURE_NAME =(2004, "Invalid Feature name, it should not be empty or null.") |
Returned if the provided feature name is blank or null itself.
INVALID_EVENT_VALUE =(2005, "Invalid Event value, it should not be empty or null.") |
This to be returned when value of event is empty or null in case of Adoption eventType.
INVALID_EVENT_KEY =(2006, "Invalid Event key, it should not be empty or null.") |
This response will be returned when the provided event key is null in case of an Application eventType.
INACTIVE_APP_STATE =(2007, "Application is not active, unable to store events now.") |
This response will be returned if the application currently is in background state.
FEATURE_NOT_FOUND =(2008, "Corresponding active feature not found or already recorded.") |
Returned if the corresponding ats is not available or can say that feature is not yet active or already inactivated.
FEATURE_UNAVAILABLE =(2009, "This feature is unavailable for this version. It will be available in future release.") |
Will be returned if the Feature is not available for the current release.
UNKNOWN_API_VERSION =(2010, "Unknown API version.") |
Returned if the provided API version is not supported.
BIS_DISABLED =(2011, "BIS entitlement is not enabled, please check with admin.") |
The authorized user is not entitled to use BlackBerry Persona.
CA_PARTICIPATION_DISABLED =(2012, "Continuous auth participation is not enabled, please check with admin.") |
Will be returned when continuous authentication participation is disabled in BlackBerry Personal console.
BIS_BB_PERSONA_METADATA_DISABLED =(2013, "Blackberry Persona metadata not available in com.blackberry.dynamics.settings.json file or disabled.") |
Indicates BB persona metadata is not available or disabled.
RECORD_SUCCESS =(2099, "Event recorded successfully.") |
Returned when event is successfully recorded.