Class BearerAuthFromSessionStorage

Used for header based Authentication.

Hierarchy (View Summary)

BearerAuth
- BearerAuthFromSessionStorage

Index

Constructors

constructor

new BearerAuthFromSessionStorage(
throwIfNoTokenPresent?: boolean,
): BearerAuthFromSessionStorage
Parameters
- throwIfNoTokenPresent: boolean = true
Returns BearerAuthFromSessionStorage
Overrides BearerAuth.constructor
- Defined in packages/client/src/core/BearerAuthFromSessionStorage.ts:20

Properties

`Static` `Readonly`sessionStorageKey

sessionStorageKey: "bearerAuthToken" = 'bearerAuthToken'

Key for the session storage used to retrieve the bearer token from.

`Static` `Readonly`sessionStorageKeyToKeepToken

sessionStorageKeyToKeepToken: "bearerAuthTokenKeep" = ...

If the session storage key 'bearerAuthTokenKeep' is set to true, the token will be kept in session storage after it was found. Allows you to still refresh the page.

Methods

getCometdHandshake

getCometdHandshake(config?: { ext?: any }): { ext?: any }
Parameters
- config: { ext?: any } = {}
Returns { ext?: any }
Inherited from BearerAuth.getCometdHandshake
- Defined in packages/client/src/core/BearerAuth.ts:25

getFetchOptions

getFetchOptions(options: IFetchOptions): IFetchOptions
Parameters
- options: IFetchOptions
Returns IFetchOptions
Inherited from BearerAuth.getFetchOptions
- Defined in packages/client/src/core/BearerAuth.ts:14

logout

logout(): Promise<any>
Returns Promise<any>
Overrides BearerAuth.logout
- Defined in packages/client/src/core/BearerAuthFromSessionStorage.ts:36

updateCredentials

updateCredentials(__namedParameters: ICredentials): undefined
Parameters
- __namedParameters: ICredentials
Returns undefined
Overrides BearerAuth.updateCredentials
- Defined in packages/client/src/core/BearerAuthFromSessionStorage.ts:28

`Static`removeEntriesFromSessionStorage

removeEntriesFromSessionStorage(): void
Returns void
- Defined in packages/client/src/core/BearerAuthFromSessionStorage.ts:15

Class BearerAuthFromSessionStorage

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BearerAuthFromSessionStorage

Properties

`Static` `Readonly`sessionStorageKey

`Static` `Readonly`sessionStorageKeyToKeepToken

Methods

getCometdHandshake

Parameters

Returns { ext?: any }

getFetchOptions

Parameters

Returns IFetchOptions

logout

Returns Promise<any>

updateCredentials

Parameters

Returns undefined

`Static`removeEntriesFromSessionStorage

Returns void

Settings

On This Page

Class BearerAuthFromSessionStorage

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BearerAuthFromSessionStorage

Properties

Static ReadonlysessionStorageKey

Static ReadonlysessionStorageKeyToKeepToken

Methods

getCometdHandshake

Parameters

Returns { ext?: any }

getFetchOptions

Parameters

Returns IFetchOptions

logout

Returns Promise<any>

updateCredentials

Parameters

Returns undefined

StaticremoveEntriesFromSessionStorage

Returns void

Settings

On This Page

`Static` `Readonly`sessionStorageKey

`Static` `Readonly`sessionStorageKeyToKeepToken

`Static`removeEntriesFromSessionStorage