Interface CognitoUserPoolTokenProviderType

interface CognitoUserPoolTokenProviderType {
    getTokens(
        options?: { forceRefresh?: boolean },
    ): Promise<AuthTokens | null>;
    setAuthConfig(authConfig: AuthConfig): void;
    setClientMetadataProvider(
        clientMetadataProvider: ClientMetadataProvider,
    ): void;
    setKeyValueStorage(keyValueStorage: KeyValueStorageInterface): void;
}

Hierarchy (View Summary)

TokenProvider
- CognitoUserPoolTokenProviderType

Index

Methods

getTokens setAuthConfig setClientMetadataProvider setKeyValueStorage

Methods

getTokens

getTokens(options?: { forceRefresh?: boolean }): Promise<AuthTokens | null>
Parameters
- Optionaloptions: { forceRefresh?: boolean }
Returns Promise<AuthTokens | null>
Inherited from TokenProvider.getTokens

setAuthConfig

setAuthConfig(authConfig: AuthConfig): void
Parameters
- authConfig: AuthConfig
Returns void

setClientMetadataProvider

setClientMetadataProvider(clientMetadataProvider: ClientMetadataProvider): void
Parameters
- clientMetadataProvider: ClientMetadataProvider
Returns void

setKeyValueStorage

setKeyValueStorage(keyValueStorage: KeyValueStorageInterface): void
Parameters
- keyValueStorage: KeyValueStorageInterface
Returns void