API reference

UsersStatusCode Enum

UsersStatusCode represents the set of status codes returned by the users API.

Signature

enum UsersStatusCode : Enum<UsersStatusCode> 

Enumeration Constants

MemberDescription
Success
The operation completed successfully. This is a common status code. It can be returned by any Platform SDK method.
InternalError
An internal error occurred. This is a common status code. It can be returned by any Platform SDK method.
NotInitialized
The platform is not initialized. This is a common status code. It can be returned by any Platform SDK method.
EntitlementFailure
Entitlement check failed. This is a common status code. It can be returned by any Platform SDK method.
RateLimitExceeded
Rate limit exceeded. This is a common status code. It can be returned by any Platform SDK method.
Forbidden
Feature is disabled for the current user. This is a common status code. It can be returned by any Platform SDK method.
NetworkUnavailable
No network connection available. This is a common status code. It can be returned by any Platform SDK method.
ProviderUnknownError
Unknown error. This is a common status code. It can be returned by any Platform SDK method.
ProviderFeatureNotEnabled
Feature is disabled for the current user. This is a common status code. It can be returned by any Platform SDK method.
ProviderOperationNotSupported
Operation is not supported. This is a common status code. It can be returned by any Platform SDK method.
ProviderInitializationFailed
Failed to initialize provider. This is a common status code. It can be returned by any Platform SDK method.
ProviderGraphApiError
Graph API error. This is a common status code. It can be returned by any Platform SDK method.
LaunchDeeplinkIntentError
Launch deeplink intent error. This error occurs when there is a failure launching a deeplink intent for user-related flows such as friend request flows, block flows, or report flows. This typically happens when the required activity cannot be found or the intent fails to start.
QueryFailedError
Query failed error. This error occurs when a content provider query fails while attempting to retrieve user-related data such as linked accounts, user capabilities, or logged-in user information. Common causes include database errors, permission issues, or content provider unavailability.
CursorNotFoundError
Cursor not found error. This error occurs when a content provider query returns a null cursor or the cursor cannot be accessed. This typically happens when the content provider is not available, the query parameters are invalid, or the requested data does not exist.
JsonParseError
JSON parse error. This error occurs when there is a failure parsing JSON data during user operations, such as when converting user data retrieved from a content provider into a JSON representation. This can happen due to malformed data or serialization issues.
InvalidUrl
Invalid URL error. This error occurs when a provided URL is invalid or does not meet security requirements. For example, this is returned when an authentication URL is not a valid HTTPS URL in the send_auth_url operation.
UserAccessTokenNotAvailable
User access token not available error. This error occurs when the user access token is not available or is null/empty when required for an operation. The user access token is needed for making authenticated requests on behalf of the user.

Properties

value : Int
[Get]
Signature
val value: Int