Partager via

MSSdkErrorCodes enum

  • Article

Defines the error codes that can be returned.

Signature

typedef uint32_t MSSdkErrorCodes;

Members

Member Value Description
SDK_ERROR_GENERAL
 -1
 The Security Token Service (STS) fails to accept a token or to issue a token for the REST service. An internal consumption related error; for example, formatting errors in JSON responses, publish license parsing, encryption initialization and template retrieval.
When this error is encountered you will be prompted, stating that an error has occurred and allowing you to send logging information to the Rights Management Service.
SDK_ERROR_COMMUNICATION
 -2
 The device has no connection to the network.
SDK_ERROR_DEVICE_REJECTED
-3
 The device is blocked from using RMS services.
SDK_ERROR_NO_CONSUMPTION_RIGHTS
 -4
 The user doesn't have consumption rights over the content.
SDK_ERROR_UNSUPPORTED_SDK_VERSION
 -5
 The SDK that is being used by the app is not supported.
SDK_ERROR_SERVICE_NOT_AVAILABLE
 -6
 The Rights Management Service is temporarily unable to answer.
SDK_ERROR_INVALID_PL
 -7
 The publish license provided is not valid.
When this error is encountered you will be prompted, stating that an error has occurred and allowing you to send logging information to the Rights Management Service.
SDK_ERROR_ONPREM_SERVERS_NOT_SUPPORTED
 -8
 Your local AD RMS server does not support your device so, this content can not be decrypted.
Contact your administrator for more information.
SDK_ERROR_REST_SERVICE_NOT_ENABLED
 -9
 Azure AD Rights Management is not enabled for your organization.
Contact your administrator for further details.
SDK_ERROR_NO_PUBLISHING_RIGHTS
 -10
 You do not have permission to create new protected content for this organization.
Try signing in as a different user, or contacting your administrator for additional permissions.";
SDK_ERROR_PUBLISHING_LICENSE_EXPIRED
 -11
 You can not view this content because the time limit has ended.
Contact the content owner or your administrator to renew this content.
SDK_ERROR_INVALID_SSL_CERTIFICATE
-12
 User message: "There is a problem with the service's security certificate, which may indicate an attempt to fool you or intercept any data you send to the server. If the problem continues, contact your administrator."
This error occurs when the AD RMS server s SSL certificate is incorrect or cannot be trusted by the device (e.g. no equivalent root CA on the device)
SDK_ERROR_NOT_AVAILABLE_IN_OFFLINE_MODE
 -13
 User messgage: "You can't view this content without internet connection. Please check your connection before trying again and that your app is not working in offline mode."
This error occurs when the application asked the SDK to consume content with offline access only but no cached policy (i.e. EUL) was found, thus application must request online access from the SDK.
[!Note]
In case the 3rd party application does not handle this scenario, the error message will be confusing to the user, which might have internet connection but can t access the content.


SDK_ERROR_USER_CANCELLED
 -14
 The user has canceled the consent process.
SDK_ERROR_INVALID_PARAMETER
 -1000
 Invalid input. This error is mainly for developer convenience and is not meant for the user.
When this error is encountered you will be prompted, stating that an error has occurred and allowing you to send logging information to the Rights Management Service.
SDK_ERROR_AUTH_FAILED_BAD_TOKEN
 -2000
 Authentication failed, bad access token.
SDK_ERROR_AUTHENTICATION_BUSY
 -3000
 The system detects that you are already attempting to sign in.
Complete your previous attempt before trying again.

Defined in

MSSDKErrorCodes.h

Supported Platforms
Minimum supported OS versions
 iOS 7.0 and OS X 10.8