Class AuthClient

Implements

AuthClientInstance

Index

Constructors

Methods

deleteAccessToken getAccessToken getAccessTokenAsync getIdToken getIdTokenPayload getRefreshToken getTokenData getTokenDataAsync getTokenExpiration setAccessToken setTokenData subscribe unsubscribe

Constructors

constructor

new AuthClient(options?: AuthClientOptions): AuthClient
Parameters
- Optionaloptions: AuthClientOptions
Returns AuthClient
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:18

Methods

deleteAccessToken

deleteAccessToken(): void
Returns void
Implementation of AuthClientInstance.deleteAccessToken
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:111

getAccessToken

getAccessToken(): null | string
Returns null | string
Implementation of AuthClientInstance.getAccessToken
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:93

getAccessTokenAsync

getAccessTokenAsync(): Promise<string>
Returns the access token or waits for it to be set.

Returns Promise<string>
Implementation of AuthClientInstance.getAccessTokenAsync
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:180

getIdToken

getIdToken(): null | string
Returns null | string
Implementation of AuthClientInstance.getIdToken
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:149

getIdTokenPayload

getIdTokenPayload(): any
Returns any
Implementation of AuthClientInstance.getIdTokenPayload
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:154

getRefreshToken

getRefreshToken(): null | string
Returns null | string
Implementation of AuthClientInstance.getRefreshToken
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:145

getTokenData

getTokenData(): null | AuthTokenData
Returns null | AuthTokenData
Implementation of AuthClientInstance.getTokenData
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:121

getTokenDataAsync

getTokenDataAsync(): Promise<AuthTokenData>
Returns the token data or waits for it to be set.

Returns Promise<AuthTokenData>
Implementation of AuthClientInstance.getTokenDataAsync
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:198

getTokenExpiration

getTokenExpiration(): undefined | number
Returns undefined | number
Implementation of AuthClientInstance.getTokenExpiration
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:125

setAccessToken

setAccessToken(token?: string): boolean
Parameters
- Optionaltoken: string
Returns boolean
Implementation of AuthClientInstance.setAccessToken
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:97

setTokenData

setTokenData(data: AuthTokenData): void
Parameters
- data: AuthTokenData
Returns void
Implementation of AuthClientInstance.setTokenData
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:129

subscribe(observer: AuthClientObserver): () => void
Parameters
- observer: AuthClientObserver
Returns () => void
Implementation of AuthClientInstance.subscribe
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:158

unsubscribe

unsubscribe(observer: AuthClientObserver): void
Parameters
- observer: AuthClientObserver
Returns void
Implementation of AuthClientInstance.unsubscribe
- Defined in packages/ux-utils/src/authClient/AuthClient.ts:170