Class CredentialsManager

Index

Methods

clearCredentials getCredentials hasValidCredentials saveCredentials

Methods

clearCredentials

clearCredentials(): Promise<void>
Delete the stored credentials

Returns Promise<void>
- Defined in credentials-manager/index.ts:123

getCredentials

getCredentials(
    scope?: string,
    minTtl?: number,
    parameters?: Record<string, unknown>,
    forceRefresh?: boolean,
): Promise<Credentials>
Gets the credentials that has already been saved
Parameters
- Optionalscope: string
  
  The scope to request for the access token. If null is passed, the previous scope will be kept.
- minTtl: number = 0
  
  The minimum time in seconds that the access token should last before expiration.
- parameters: Record<string, unknown> = {}
  
  Additional parameters to send in the request to refresh expired credentials.
- forceRefresh: boolean = false
  
  Whether to force refresh the credentials. It will work only if the refresh token already exists. For iOS, doing forceRefresh will not send the scope. Since scope change already does force refresh, it is better to avoid force refresh if the scope is being changed.
Returns Promise<Credentials>

A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.
- Defined in credentials-manager/index.ts:70

hasValidCredentials

hasValidCredentials(minTtl?: number): Promise<boolean>
Returns whether this manager contains a valid non-expired pair of credentials.
Parameters
- minTtl: number = 0
  
  The minimum time in seconds that the access token should last before expiration
Returns Promise<boolean>

true if a valid set of credentials are available, or false if there are no credentials to return.
- Defined in credentials-manager/index.ts:110

saveCredentials

saveCredentials(credentials: Credentials): Promise<void>
Saves the provided credentials
Parameters
- credentials: Credentials
Returns Promise<void>
- Defined in credentials-manager/index.ts:31

Settings

Member Visibility

Theme