Namespace: Esri::GameEngine::Authentication
Class: Esri/GameEngine/Authentication/ArcGISAuthenticationChallenge
Since: 1.1.0
Summary
An ArcGIS authentication challenge.
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
Error | ArcGIS | No | Yes | The underlying error that led to this authentication challenge. |
PreviousFailureCount | uint8_t | No | Yes | The number of failed authentication attempts that occurred previously for this authentication challenge. |
RequestURL | FString | No | Yes | The URL of the request that led to this authentication challenge. |
Type | ArcGISAuthenticationChallengeType | No | Yes | The type of the challenge, indicating which type of ArcGISCredential should be created to handle it. |
Error
ArcGISException GetError() const
The underlying error that led to this authentication challenge.
PreviousFailureCount
uint8_t GetPreviousFailureCount() const
The number of failed authentication attempts that occurred previously for this authentication challenge.
The maximum number of allowed authentication attempts is 5. After reaching this limit,
the request that led to this authentication challenge may fail with an error.
RequestURL
FString GetRequestURL() const
The URL of the request that led to this authentication challenge.
Type
ArcGISAuthenticationChallengeType GetType() const
The type of the challenge, indicating which type of ArcGISCredential should be created to handle it.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Cancel() | Cancels the request that initiated the challenge. | |
Handles the challenge without a credential, causing it to fail with the original authentication error. | ||
Handles the challenge with the specified credential. |
ContinueAndFail
void ContinueAndFail()
Handles the challenge without a credential, causing it to fail with the original authentication error.
Since 1.1.0
Returns void
ContinueWithCredential
void ContinueWithCredential(const ArcGISCredential& credential)
Handles the challenge with the specified credential.
Since 1.1.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
credential | ArcGISCredential | Yes | The credential to use when retrying the request. |