Class CognitoUser

Hierarchy

CognitoUser

Implements

CognitoUserType

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CognitoUser(__namedParameters: ICognitoUserData): CognitoUser

- Defined in src/core/cognito.ts:174
Parameters
- __namedParameters: ICognitoUserData
Returns CognitoUser

Properties

attributes

attributes: AttributeType[]

authenticationFlowType

authenticationFlowType: string

client

client: CognitoIdentityProviderClient

credentials

credentials: CognitoIdentityCredentials

isLoggedIn

isLoggedIn: boolean

keyPrefix

keyPrefix: string

pool

pool: CognitoUserPoolType

signInUserSession

signInUserSession: undefined | CognitoUserSessionType

storage

storage: ICognitoStorage

userDataKey

userDataKey: string

username

username: string

Methods

cache

cache(action: string): void

Implementation of CognitoUserType.cache
- Defined in src/core/cognito.ts:224
Parameters
- action: string
Returns void

cacheUserData

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

Implementation of CognitoUserType.cacheUserData
- Defined in src/core/cognito.ts:199
Parameters
- userData: Record<string, unknown>
Returns void

clearCachedUserData

clearCachedUserData(): void

Implementation of CognitoUserType.clearCachedUserData
- Defined in src/core/cognito.ts:203
Returns void

completeNewPasswordChallenge

completeNewPasswordChallenge(pass: string): string

Implementation of CognitoUserType.completeNewPasswordChallenge
- Defined in src/core/cognito.ts:351
Parameters
- pass: string
Returns string

confirmSignUp

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

Implementation of CognitoUserType.confirmSignUp
- Defined in src/core/cognito.ts:215
Parameters
- confirmationCode: string
- forceAliasCreation: boolean
Returns Promise<ConfirmSignUpCommandOutput>

getCognitoUserSession

getCognitoUserSession(__namedParameters: AuthenticationResultType): CognitoUserSession

Implementation of CognitoUserType.getCognitoUserSession
- Defined in src/core/cognito.ts:325
Parameters
- __namedParameters: AuthenticationResultType
Returns CognitoUserSession

getSession

getSession(): Promise<CognitoUserSessionType>

Implementation of CognitoUserType.getSession
- Defined in src/core/cognito.ts:255
Returns Promise<CognitoUserSessionType>

getSignInUserSession

getSignInUserSession(): undefined | CognitoUserSessionType

Implementation of CognitoUserType.getSignInUserSession
- Defined in src/core/cognito.ts:207
Returns undefined | CognitoUserSessionType

getUserAttributes

getUserAttributes(): Promise<AttributeType[]>

Implementation of CognitoUserType.getUserAttributes
- Defined in src/core/cognito.ts:342
Returns Promise<AttributeType[]>

getUsername

getUsername(): string

Implementation of CognitoUserType.getUsername
- Defined in src/core/cognito.ts:211
Returns string

refreshSession

refreshSession(refreshToken: CognitoRefreshToken): Promise<CognitoUserSessionType>

Implementation of CognitoUserType.refreshSession
- Defined in src/core/cognito.ts:295
Parameters
- refreshToken: CognitoRefreshToken
Returns Promise<CognitoUserSessionType>

setSignInUserSession

setSignInUserSession(signInUserSession: CognitoUserSession): void

Implementation of CognitoUserType.setSignInUserSession
- Defined in src/core/cognito.ts:249
Parameters
- signInUserSession: CognitoUserSession
Returns void

signOut

signOut(): void

Implementation of CognitoUserType.signOut
- Defined in src/core/cognito.ts:337
Returns void

Generated using TypeDoc