Library Documentation
NPM
GitHub
Preparing search index...
The search index is not available
Amplify JS API Documentation
Amplify JS API Documentation
aws-amplify
auth/cognito
TokenOrchestrator
Class TokenOrchestrator
Implements
AuthTokenOrchestrator
Index
Constructors
constructor
Properties
inflight
Promise
token
Refresher?
token
Store?
wait
For
InflightOAuth
Methods
clear
Device
Metadata
clear
Tokens
get
Device
Metadata
getOAuth
Metadata
get
Token
Refresher
get
Token
Store
get
Tokens
set
Auth
Config
set
Auth
Token
Store
setOAuth
Metadata
set
Token
Refresher
set
Tokens
Constructors
constructor
new
Token
Orchestrator
(
)
:
TokenOrchestrator
Returns
TokenOrchestrator
Properties
inflight
Promise
inflight
Promise
:
undefined
|
Promise
<
void
>
Optional
token
Refresher
token
Refresher
?:
TokenRefresher
Optional
token
Store
token
Store
?:
AuthTokenStore
wait
For
InflightOAuth
wait
For
InflightOAuth
:
(
(
)
=>
Promise
<
void
>
)
Type declaration
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Methods
clear
Device
Metadata
clear
Device
Metadata
(
username
?
)
:
Promise
<
void
>
Parameters
Optional
username
:
string
Returns
Promise
<
void
>
clear
Tokens
clear
Tokens
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Device
Metadata
get
Device
Metadata
(
username
?
)
:
Promise
<
null
|
DeviceMetadata
>
Parameters
Optional
username
:
string
Returns
Promise
<
null
|
DeviceMetadata
>
getOAuth
Metadata
getOAuth
Metadata
(
)
:
Promise
<
null
|
OAuthMetadata
>
Returns
Promise
<
null
|
OAuthMetadata
>
get
Token
Refresher
get
Token
Refresher
(
)
:
TokenRefresher
Returns
TokenRefresher
get
Token
Store
get
Token
Store
(
)
:
AuthTokenStore
Returns
AuthTokenStore
get
Tokens
get
Tokens
(
options
?
)
:
Promise
<
null
|
AuthTokens
&
{
signInDetails
?:
CognitoAuthSignInDetails
;
}
>
Parameters
Optional
options
:
FetchAuthSessionOptions
Returns
Promise
<
null
|
AuthTokens
&
{
signInDetails
?:
CognitoAuthSignInDetails
;
}
>
set
Auth
Config
set
Auth
Config
(
authConfig
)
:
void
Parameters
authConfig
:
AuthConfig
Returns
void
set
Auth
Token
Store
set
Auth
Token
Store
(
tokenStore
)
:
void
Parameters
tokenStore
:
AuthTokenStore
Returns
void
setOAuth
Metadata
setOAuth
Metadata
(
metadata
)
:
Promise
<
void
>
Parameters
metadata
:
OAuthMetadata
Returns
Promise
<
void
>
set
Token
Refresher
set
Token
Refresher
(
tokenRefresher
)
:
void
Parameters
tokenRefresher
:
TokenRefresher
Returns
void
set
Tokens
set
Tokens
(
__namedParameters
)
:
Promise
<
void
>
Parameters
__namedParameters
:
{
tokens
:
CognitoAuthTokens
;
}
tokens
:
CognitoAuthTokens
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
inflight
Promise
token
Refresher
token
Store
wait
For
InflightOAuth
clear
Device
Metadata
clear
Tokens
get
Device
Metadata
getOAuth
Metadata
get
Token
Refresher
get
Token
Store
get
Tokens
set
Auth
Config
set
Auth
Token
Store
setOAuth
Metadata
set
Token
Refresher
set
Tokens
Amplify JS API Documentation
aws-amplify
@aws-amplify
geo
interactions
predictions
pubsub
adapter-nextjs
datastore-storage-adapter