Class InteractionRequiredAuthError

Error thrown when user interaction is required.

Hierarchy

AuthError
- InteractionRequiredAuthError

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InteractionRequiredAuthError(errorCode?: string, errorMessage?: string, subError?: string): InteractionRequiredAuthError

Overrides AuthError.constructor
- Defined in msal-common/src/error/InteractionRequiredAuthError.ts:38
Parameters
- Optional errorCode: string
- Optional errorMessage: string
- Optional subError: string
Returns InteractionRequiredAuthError

Properties

correlationId

correlationId: string

CorrelationId associated with the error

errorCode

errorCode: string

Short string denoting error

errorMessage

errorMessage: string

Detailed description of error

subError

subError: string

Describes the subclass of an error

Methods

setCorrelationId

setCorrelationId(correlationId: string): void

Inherited from AuthError.setCorrelationId
- Defined in msal-common/src/error/AuthError.ts:54
Parameters
- correlationId: string
Returns void

Static createNoTokensFoundError

createNoTokensFoundError(): InteractionRequiredAuthError

- Defined in msal-common/src/error/InteractionRequiredAuthError.ts:66
Creates an error thrown when the authorization code required for a token request is null or empty.

Returns InteractionRequiredAuthError

Static createUnexpectedError

createUnexpectedError(errDesc: string): AuthError

Inherited from AuthError.createUnexpectedError
- Defined in msal-common/src/error/AuthError.ts:62
Creates an error that is thrown when something unexpected happens in the library.

Parameters
- errDesc: string
Returns AuthError

Static isInteractionRequiredError

isInteractionRequiredError(errorCode?: string, errorString?: string, subError?: string): boolean

- Defined in msal-common/src/error/InteractionRequiredAuthError.ts:53
Helper function used to determine if an error thrown by the server requires interaction to resolve

Parameters
- Optional errorCode: string
- Optional errorString: string
- Optional subError: string
Returns boolean

Generated using TypeDoc