ids_result_t

IDS result codes returned to the application.

Synopsis:

#include <ids.h>
 
typedef enum {
      IDS_FAILURE = -1   
      IDS_SUCCESS = 0   
      IDS_DEFAULT_ERROR = 49999   
      IDS_NAME_TOO_LONG = 50002   
      IDS_ACCOUNT_LOCALLY_LOCKED_OUT = 50003   
      IDS_USER_COULD_NOT_BE_AUTHENTICATED = 50004   
      IDS_TOO_MANY_NAMES_PASSED = 50005   
      IDS_INVALID_REQUEST = 50006   
      IDS_DOES_NOT_EXIST = 50007   
      IDS_UNKNOWN_TOKEN_TYPE = 50008   
      IDS_UNKNOWN_APPLIES_TO = 50009   
      IDS_NOT_ENOUGH_RESOURCES = 50010   
      IDS_CANNOT_GET_TOKEN_WHILE_OFFLINE = 50011   
      IDS_ERROR_WHILE_CONTACTING_SERVICE = 50012   
      IDS_NULL_OR_UNKNOWN_PARAMETERS = 50015   
      IDS_NOT_ALLOWED = 50017   
      IDS_VALUE_TOO_LARGE = 50107   
      IDS_ALREADY_EXISTS = 50159   
      IDS_NOT_READY = 50207   
      IDS_QUOTA_EXCEEDED = 50018   
      IDS_PROPERTY_DOES_NOT_EXIST = 50007   
      IDS_PROPERTY_NOT_AUTHORIZED = 50017   
      IDS_CLEAR_TOKEN_FAIL = 50016   
      IDS_NAME_MUST_BE_SET = 50107   
} ids_result_t;

Since:

BlackBerry 10.2.0

Data:

IDS_FAILURE

The IDS API call did not complete successfully; check the value of errno for additional information.

IDS_SUCCESS

The IDS API call completed successfully. In asynchronous calls, the request has been sent and either the success or failure callback is called when the response arrives.

IDS_DEFAULT_ERROR

Error code 49999 is the default error code, and indicates that an internal error occurred while processing the request.

IDS_NAME_TOO_LONG

The name provided is too long. The maximum number of allowed characters is determined by the identity provider.

IDS_ACCOUNT_LOCALLY_LOCKED_OUT

User authentication could not complete because the user account is locked out.

IDS_USER_COULD_NOT_BE_AUTHENTICATED

The identity provider could not authenticate the user. There are a variety of possible causes for this error, including technical reasons, the user canceled the authentication request, and failure to meet other conditions that the identity provider requires.

IDS_TOO_MANY_NAMES_PASSED

The number of entries provided exceeds what the identity provider can handle.

IDS_INVALID_REQUEST

The request is malformed or not supported.

IDS_DOES_NOT_EXIST

The requested item does not exist.

IDS_UNKNOWN_TOKEN_TYPE

This error may be returned with the ids_get_token() function, and indicates that the identity provider is unable to determine, or does not support, the type of token that was requested. This error is specific to the identity provider.

IDS_UNKNOWN_APPLIES_TO

This error may be returned with the ids_get_token() function, and indicates that the identity provider is unable to determine the application or service that the token applies to. This error is specific to the identity provider.

IDS_NOT_ENOUGH_RESOURCES

This is a general error that could refer to a variety of causes. For example, the queue might be full and unable to process the request, there's insufficient memory to process the request, or other conditions established by the identity provider are preventing the request from completing successfully.

IDS_CANNOT_GET_TOKEN_WHILE_OFFLINE

This error is returned with the ids_get_token() function, and indicates that a token could not be obtained because the identity provider's user authentication service is offline.

IDS_ERROR_WHILE_CONTACTING_SERVICE

An error occurred while contacting the identity service, which could include network issues.

IDS_NULL_OR_UNKNOWN_PARAMETERS

This is a general error that indicates that the parameters provided are not valid.

IDS_NOT_ALLOWED

This error is specific to the identity provider, and is returned if their security model does not allow the request by the application.

IDS_VALUE_TOO_LARGE

This error is specific to the identity provider, and is returned if the value exceeds the size that the identity provider allows.

IDS_ALREADY_EXISTS

The requested item cannot be created because it already exists.

IDS_NOT_READY

The request could not be completed because the provider is not ready to process the request.

IDS_QUOTA_EXCEEDED

This error is specific to the identity provider, and is returned if the quota has been exceeded as set by the identity provider.

IDS_PROPERTY_DOES_NOT_EXIST

Deprecated, use IDS_DOES_NOT_EXIST.

IDS_PROPERTY_NOT_AUTHORIZED

Deprecated, use IDS_NOT_ALLOWED.

IDS_CLEAR_TOKEN_FAIL

Deprecated, use IDS_DEFAULT_ERROR.

IDS_NAME_MUST_BE_SET

Deprecated, use IDS_NULL_OR_UNKNOWN_PARAMETERS.

Library:

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

Description:

Each result code is applicable to some, but not all, of the IDS APIs. Please refer to the documentation for each API to determine which errors are applicable to that specific API, and how they can be interpreted for that specific API.