Enumerations

The following enumerations are available globally.

  • Indicates the user state.

    • signedIn: The user is signed in through Cognito User Pools or a federation provider like Google, Facebook, etc.
    • signedOut: The user is signed out and does not have guest access.
    • signedOutFederatedTokensInvalid: 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.
    • signedOutUserPoolsTokenInvalid: 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.
    • guest: The user is signed out, but has guest access in the app.
    • unknown: The initial user state before AWSMobileClient is initialized.
    See more

    Declaration

    Swift

    public enum UserState : String
  • Represents identity provider keys.

    • facebook: The provider key for Facebook.
    • google: The provider key for Google.
    • twitter: The provider key for Twitter.
    • amazon: The provider key for Amazon.
    • developer: The provider key for Developer Authenticated Identities.
    See more

    Declaration

    Swift

    public enum IdentityProvider : String
  • The error enum for AWSMobileClient errors.

    See more

    Declaration

    Swift

    public enum AWSMobileClientError : Error
  • Indicates sign in state of the user in the sign in process.

    See more

    Declaration

    Swift

    public enum SignInState : String
  • Indicates the state of forgot password operation.

    See more

    Declaration

    Swift

    public enum ForgotPasswordState
  • Indicates the state of user during the sign up operation.

    See more

    Declaration

    Swift

    public enum SignUpConfirmationState
  • Describes the medium through which a code was sent to the user.

    See more

    Declaration

    Swift

    public enum UserCodeDeliveryMedium