com.amplifyframework.auth.cognito

Class AWSCognitoAuthSession

java.lang.Object

com.amplifyframework.auth.AuthSession

com.amplifyframework.auth.cognito.AWSCognitoAuthSession

public final class AWSCognitoAuthSession
extends com.amplifyframework.auth.AuthSession

Cognito extension of AuthSession containing AWS Cognito specific tokens.

Constructor Summary

Constructors

Constructor and Description

AWSCognitoAuthSession(boolean isSignedIn, com.amplifyframework.auth.result.AuthSessionResult<java.lang.String> identityId, com.amplifyframework.auth.result.AuthSessionResult<com.amazonaws.auth.AWSCredentials> awsCredentials, com.amplifyframework.auth.result.AuthSessionResult<java.lang.String> userSub, com.amplifyframework.auth.result.AuthSessionResult<AWSCognitoUserPoolTokens> userPoolTokens) Cognito extension of AuthSession containing AWS Cognito specific tokens.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
com.amplifyframework.auth.result.AuthSessionResult<com.amazonaws.auth.AWSCredentials>	getAWSCredentials() The credentials which come from Identity Pool.
com.amplifyframework.auth.result.AuthSessionResult<java.lang.String>	getIdentityId() The id which comes from Identity Pools.
com.amplifyframework.auth.result.AuthSessionResult<AWSCognitoUserPoolTokens>	getUserPoolTokens() The tokens which come from User Pools (access, id, refresh tokens).
com.amplifyframework.auth.result.AuthSessionResult<java.lang.String>	getUserSub() The id which comes from User Pools.
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.amplifyframework.auth.AuthSession

isSignedIn

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AWSCognitoAuthSession

public AWSCognitoAuthSession(boolean isSignedIn,
                             @NonNull
                             com.amplifyframework.auth.result.AuthSessionResult<java.lang.String> identityId,
                             @NonNull
                             com.amplifyframework.auth.result.AuthSessionResult<com.amazonaws.auth.AWSCredentials> awsCredentials,
                             @NonNull
                             com.amplifyframework.auth.result.AuthSessionResult<java.lang.String> userSub,
                             @NonNull
                             com.amplifyframework.auth.result.AuthSessionResult<AWSCognitoUserPoolTokens> userPoolTokens)

Cognito extension of AuthSession containing AWS Cognito specific tokens.

Parameters:

isSignedIn - Are you currently in a signed in state (an AuthN indicator to be technical)

awsCredentials - The credentials which come from Identity Pool

userSub - The id which comes from User Pools

identityId - The id which comes from Identity Pools

userPoolTokens - The tokens which come from User Pools (access, id, refresh tokens)

Method Detail

getAWSCredentials

@NonNull
public com.amplifyframework.auth.result.AuthSessionResult<com.amazonaws.auth.AWSCredentials> getAWSCredentials()

The credentials which come from Identity Pool.

Returns:

the credentials which come from Identity Pool

getUserSub

@NonNull
public com.amplifyframework.auth.result.AuthSessionResult<java.lang.String> getUserSub()

The id which comes from User Pools.

Returns:

the id which comes from User Pools

getIdentityId

@NonNull
public com.amplifyframework.auth.result.AuthSessionResult<java.lang.String> getIdentityId()

The id which comes from Identity Pools.

Returns:

the id which comes from Identity Pools

getUserPoolTokens

@NonNull
public com.amplifyframework.auth.result.AuthSessionResult<AWSCognitoUserPoolTokens> getUserPoolTokens()

The tokens which come from User Pools (access, id, refresh tokens).

Returns:

the tokens which come from User Pools (access, id, refresh tokens)

hashCode

public int hashCode()

Overrides:

hashCode in class com.amplifyframework.auth.AuthSession

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class com.amplifyframework.auth.AuthSession

toString

public java.lang.String toString()

Overrides:

toString in class com.amplifyframework.auth.AuthSession