Skip to main content

IAMState

Datalayer Core

Datalayer Core / IAMState

Type Alias: IAMState

IAMState = IIAMState & object

Defined in: src/state/substates/IAMState.ts:85

Type Declaration​

addIAMProviderAuthorizationURL​

addIAMProviderAuthorizationURL: (provider, authorizationURL) => void

Parameters​

provider​

IIAMProviderName

authorizationURL​

IAMProviderAuthorizationURL

Returns​

void

checkIAMToken​

checkIAMToken: (token) => Promise<void>

Parameters​

token​

string

Returns​

Promise<void>

getIAMProviderAccessToken​

getIAMProviderAccessToken: (user, provider) => string | undefined

Parameters​

user​

IUser

provider​

IIAMProviderName

Returns​

string | undefined

login​

login: (token) => Promise<void>

Parameters​

token​

string

Returns​

Promise<void>

logout​

logout: () => void

Returns​

void

refreshCredits​

refreshCredits: () => Promise<void>

Refresh user credits. It also warn if any reservation is getting close to the end.

Returns​

Promise<void>

refreshUser​

refreshUser: () => Promise<void>

Returns​

Promise<void>

refreshUserByToken​

refreshUserByToken: (token) => Promise<void>

Parameters​

token​

string

Returns​

Promise<void>

refreshUserByTokenStored​

refreshUserByTokenStored: () => Promise<void>

Returns​

Promise<void>

setExternalToken​

setExternalToken: (externalToken) => void

Parameters​

externalToken​

string

Returns​

void

setIAMProviderAccessToken​

setIAMProviderAccessToken: (provider, accessToken?) => void

Parameters​

provider​

IIAMProviderName

accessToken?​

string | null

Returns​

void

setLogin​

setLogin: (user, token) => void

Set the token and the user.

The user detail will be automatically retrieve to avoid inconsistency.

Parameters​

user​

IUser

token​

string

User token

Returns​

void

setVersion​

setVersion: (version) => void

Parameters​

version​

string

Returns​

void

updateUser​

updateUser: (user) => void

Parameters​

user​

Partial<Omit<IUser, "handle">>

Returns​

void