Interface AuthManager

interface AuthManager {
    getAuthToken(): Promise<string>;
    getRefreshToken(): Promise<string>;
    refreshAuthToken(authToken): Promise<string>;
}

Index

Methods

getAuthToken getRefreshToken refreshAuthToken

Methods

getAuthToken

getAuthToken(): Promise<string>
Returns the user's authorisation token.

Returns Promise<string>
- Defined in src/types/AuthManager.ts:5

getRefreshToken

getRefreshToken(): Promise<string>
Returns the user's refresh token.

Returns Promise<string>
- Defined in src/types/AuthManager.ts:10

refreshAuthToken

refreshAuthToken(authToken): Promise<string>
Called by the SDK when the authorisation token expires and an API called failed. The host application is expected to refresh the user's token and return the newly refreshed one.
Parameters
- authToken: string
  The expired authorisation token
Returns Promise<string>
The newly refreshed authorisation token
- Defined in src/types/AuthManager.ts:20