API reference

ConsentStatusCode Enum

ConsentStatusCode represents the set of status codes returned by the consent API.

Signature

enum ConsentStatusCode : Enum<ConsentStatusCode> 

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.
LaunchFailed
Launch consent failed error. This error occurs when attempting to launch a consent flow but the launch operation fails. This can happen due to various issues during the consent flow launch process.
UnsupportedConsentFlowType
Unsupported consent flow type error. This error occurs when the specified consent flow name is not supported or recognized.
NoConsentStatusFound
No consent status found error. This error occurs when querying consent status but no status results are returned.

Properties

value : Int
[Get]
Signature
val value: Int