UserState

public enum UserState : String

Indicates the user state.

  • The user is signed in through Cognito User Pools or a federation provider like Google, Facebook, etc.

    Declaration

    Swift

    case signedIn

  • The user is signed out and does not have guest access.

    Declaration

    Swift

    case signedOut

  • The tokens associated with the federation provider like Google or Facebook have expired and need to re-submitted to AWSMobileClient. You can do that by calling the federatedSignIn method or by showing the drop in UI. If the end user is unable to sign in, call releaseSignInWait method to return an error to the calling API.

    Declaration

    Swift

    case signedOutFederatedTokensInvalid

  • The Cognito User Pools tokens have expired and the end-user needs to sign in again. You can complete the sign in process using the signIn method or by showing the drop in UI. If the end user is unable to sign in, call releaseSignInWait method to return an error to the calling API.

    Declaration

    Swift

    case signedOutUserPoolsTokenInvalid

  • The user is signed out, but has guest access in the app.

    Declaration

    Swift

    case guest

  • The initial user state before AWSMobileClient is initialized.

    Declaration

    Swift

    case unknown