BrowserAuthError class

new BrowserAuthError(errorCode: string, errorMessage?: string)

Parameters

CorrelationId associated with the error

correlationId: string

Property Value

Inherited From AuthError.correlationId

Short string denoting error

errorCode: string

Property Value

Inherited From AuthError.errorCode

Detailed description of error

errorMessage: string

Property Value

Inherited From AuthError.errorMessage

message: string

Property Value

Inherited From Error.message

name: string

Property Value

Inherited From Error.name

stack?: string

Property Value

Inherited From Error.stack

Describes the subclass of an error

subError: string

Property Value

Inherited From AuthError.subError

Create an error when an authorization code or native account ID is required but not provided

static function createAuthCodeOrNativeAccountIdRequiredError(): BrowserAuthError

Returns

Create an error when an authorization code is required but not provided

static function createAuthCodeRequiredError(): BrowserAuthError

Returns

Creates an error thrown when handleCodeResponse is called before initiateAuthRequest (InteractionHandler)

static function createAuthRequestNotSetError(): BrowserAuthError

Returns

Creates an error thrown when a popup attempts to call an acquireToken API

static function createBlockAcquireTokenInPopupsError(): BrowserAuthError

Returns

Creates an error thrown when an auth reload is done inside an iframe.

static function createBlockReloadInHiddenIframeError(): BrowserAuthError

Returns

Creates an error thrown when the crypto object is unavailable.

static function createCryptoNotAvailableError(errDetail: string): BrowserAuthError

Parameters

Returns

Create an error thrown when indexDB database is not open

static function createDatabaseNotOpenError(): BrowserAuthError

Returns

Create an error when IndexedDB is unavailable

static function createDatabaseUnavailableError(): BrowserAuthError

Returns

Creates an error thrown when the hash string value is unexpectedly empty.

static function createEmptyHashError(hashValue: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when the navigation URI is empty.

static function createEmptyNavigationUriError(): BrowserAuthError

Returns

Creates an error thrown when window.open returns an empty window object.

static function createEmptyWindowCreatedError(): BrowserAuthError

Returns

Create an error thrown when network client fails to parse network response

static function createFailedToParseNetworkResponseError(endpoint: string): BrowserAuthError

Parameters

Returns

Create an error thrown when get request fails due to reasons other than internet connectivity

static function createGetRequestFailedError(errorDesc: string, endpoint: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when the hash string value does not contain known properties

static function createHashDoesNotContainKnownPropertiesError(): BrowserAuthError

Returns

Creates an error thrown when the hash string value is unexpectedly empty.

static function createHashDoesNotContainStateError(): BrowserAuthError

Returns

Creates an error thrown when an HTTP method hasn't been implemented by the browser class.

static function createHttpMethodNotImplementedError(method: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when an iframe is found to be closed before the timeout is reached.

static function createIframeClosedPrematurelyError(): BrowserAuthError

Returns

Creates an error thrown when a browser interaction (redirect or popup) is in progress.

static function createInteractionInProgressError(): BrowserAuthError

Returns

Creates an error thrown if cache type is invalid.

static function createInvalidCacheTypeError(): BrowserAuthError

Returns

Creates an error thrown when monitorIframeFromHash times out for a given iframe.

static function createMonitorIframeTimeoutError(): BrowserAuthError

Returns

Creates an error thrown when monitorPopupFromHash times out for a given popup.

static function createMonitorPopupTimeoutError(): BrowserAuthError

Returns

Create an error thrown when the initialize function hasn't been called

static function createNativeBrokerCalledBeforeInitialize(): BrowserAuthError

Returns

Create an error when native connection has not been established

static function createNativeConnectionNotEstablishedError(): BrowserAuthError

Returns

Create an error thrown when browser extension is not installed

static function createNativeExtensionNotInstalledError(): BrowserAuthError

Returns

Create an error thrown when Handshake with browser extension times out

static function createNativeHandshakeTimeoutError(): BrowserAuthError

Returns

Create an error thrown when requesting a token directly from the native platform with an unsupported prompt parameter e.g. select_account, login or create These requests must go through eSTS to ensure eSTS is aware of the new account

static function createNativePromptParameterNotSupportedError(): BrowserAuthError

Returns

Creates an error thrown when the account object is not provided in the acquireTokenSilent API.

static function createNoAccountError(): BrowserAuthError

Returns

Creates an error thrown when the authority could not be retrieved from the cache

static function createNoCachedAuthorityError(): BrowserAuthError

Returns

Create an error thrown when login and token requests are made from a non-browser environment

static function createNonBrowserEnvironmentError(): BrowserAuthError

Returns

Create an error thrown when token fetch fails due to no internet

static function createNoNetworkConnectivityError(): BrowserAuthError

Returns

Creates an error thrown when the token request could not be retrieved from the cache

static function createNoTokenRequestCacheError(): BrowserAuthError

Returns

Creates an error thrown when PKCE is not implemented.

static function createPkceNotGeneratedError(errDetail: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when the popup window could not be opened.

static function createPopupWindowError(errDetail?: string): BrowserAuthError

Parameters

Returns

Create an error thrown when token fetch fails due to reasons other than internet connectivity

static function createPostRequestFailedError(errorDesc: string, endpoint: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when navigateWindow is called inside an iframe or brokered applications.

static function createRedirectInIframeError(windowParentCheck: boolean): BrowserAuthError

Parameters

Returns

Create an error thrown when the queried cryptographic key is not found in IndexedDB

static function createSigningKeyNotFoundInStorageError(keyId: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when the logout API is called on any of the silent interaction clients

static function createSilentLogoutUnsupportedError(): BrowserAuthError

Returns

Creates an error thrown when a given prompt value is invalid for silent requests.

static function createSilentPromptValueError(givenPrompt: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when the state value in the hash does not match the interaction type of the API attempting to consume it.

static function createStateInteractionTypeMismatchError(): BrowserAuthError

Returns

Create an error when native token acquisition is not possible

static function createUnableToAcquireTokenFromNativePlatformError(): BrowserAuthError

Returns

Create an error thrown when the necessary information is not available to sideload tokens

static function createUnableToLoadTokenError(errorDetail: string): BrowserAuthError

Parameters

Returns

Creates an error thrown when the hash string value is unexpectedly empty.

static function createUnableToParseStateError(): BrowserAuthError

Returns

Creates an error thrown when the cached token request could not be retrieved from the cache

static function createUnableToParseTokenRequestCacheError(): BrowserAuthError

Returns

Creates an error thrown when the user closes a popup.

static function createUserCancelledError(): BrowserAuthError

Returns

Creates an error for post request failures.

static function createPostRequestFailed(errDesc: string): AuthError

Parameters

Returns

Inherited From AuthError.createPostRequestFailed

Creates an error that is thrown when something unexpected happens in the library.

static function createUnexpectedError(errDesc: string): AuthError

Parameters

Returns

Inherited From AuthError.createUnexpectedError

function setCorrelationId(correlationId: string)

Parameters

Inherited From AuthError.setCorrelationId