Interface CognitoUserType

Hierarchy

CognitoUserType

Implemented by

CognitoUser

Properties

Optional Session

Session: string

authenticationFlowType

authenticationFlowType: string

client

client: CognitoIdentityProviderClient

keyPrefix

keyPrefix: string

pool

pool: CognitoUserPoolType

Optional signInUserSession

signInUserSession: CognitoUserSessionType

storage

storage: ICognitoStorage

userDataKey

userDataKey: string

username

username: string

Methods

cache

cache(action: string): void

- Defined in src/core/types/cognito.ts:69
Parameters
- action: string
Returns void

cacheUserData

cacheUserData(userData: Record<string, unknown>): void

- Defined in src/core/types/cognito.ts:70
Parameters
- userData: Record<string, unknown>
Returns void

clearCachedUserData

clearCachedUserData(): void

- Defined in src/core/types/cognito.ts:71
Returns void

completeNewPasswordChallenge

completeNewPasswordChallenge(pass: string): void

- Defined in src/core/types/cognito.ts:73
Parameters
- pass: string
Returns void

confirmSignUp

confirmSignUp(confirmationCode: string, forceAliasCreation: boolean): Promise<ConfirmSignUpCommandOutput>

- Defined in src/core/types/cognito.ts:75
Parameters
- confirmationCode: string
- forceAliasCreation: boolean
Returns Promise<ConfirmSignUpCommandOutput>

getCognitoUserSession

getCognitoUserSession(__namedParameters: AuthenticationResultType): CognitoUserSessionType

- Defined in src/core/types/cognito.ts:79
Parameters
- __namedParameters: AuthenticationResultType
Returns CognitoUserSessionType

getSession

getSession(): Promise<CognitoUserSessionType>

- Defined in src/core/types/cognito.ts:77
Returns Promise<CognitoUserSessionType>

getSignInUserSession

getSignInUserSession(): undefined | CognitoUserSessionType

- Defined in src/core/types/cognito.ts:72
Returns undefined | CognitoUserSessionType

getUserAttributes

getUserAttributes(): Promise<AttributeType[]>

- Defined in src/core/types/cognito.ts:81
Returns Promise<AttributeType[]>

getUsername

getUsername(): string

- Defined in src/core/types/cognito.ts:74
Returns string

refreshSession

refreshSession(refreshToken: CognitoJwtTokenType): Promise<CognitoUserSessionType>

- Defined in src/core/types/cognito.ts:78
Parameters
- refreshToken: CognitoJwtTokenType
Returns Promise<CognitoUserSessionType>

setSignInUserSession

setSignInUserSession(signInUserSession: CognitoUserSessionType): void

- Defined in src/core/types/cognito.ts:76
Parameters
- signInUserSession: CognitoUserSessionType
Returns void

signOut

signOut(): void

- Defined in src/core/types/cognito.ts:80
Returns void

Generated using TypeDoc