sign_in_with_apple_platform_interface library

Classes

AppleIDAuthorizationRequest
An AuthorizationRequest which authenticates a user based on their Apple ID.
AuthorizationCredentialAppleID
Authorization details from a successful Sign in with Apple flow.
AuthorizationCredentialPassword
Authorization details retrieved from the user's Keychain for the current app's website.
AuthorizationRequest
A base class which describes an authorization request that we will make on the native side.
PasswordAuthorizationRequest
An AuthorizationRequest that uses credentials which are stored in the users Keychain.
SignInWithApplePlatform
The interface that implementations of sign_in_with_apple must implement.
WebAuthenticationOptions
Parameters required for web-based authentication flows

Enums

AppleIDAuthorizationScopes
The scopes that will be requested with the AppleIDAuthorizationRequest. This allows you to request additional information from the user upon sign up.
AuthorizationErrorCode
A description of why the authorization failed on the native side.
CredentialState
State of a credential of a particular user.

Functions

generateNonce({int length = 32}) String
Generate a cryptographically secure random nonce
parseAuthorizationCredentialAppleID(Map response) AuthorizationCredentialAppleID
parseAuthorizationCredentialPassword(Map response) AuthorizationCredentialPassword
parseCredentialState(String? credentialState) CredentialState
Parses the string represenation of a CredentialState to its enum value.

Exceptions / Errors

SignInWithAppleAuthorizationException
A SignInWithAppleException indicating something went wrong while authenticating.
SignInWithAppleCredentialsException
SignInWithAppleException
A more specific PlatformException which describes any potential native errors that occur within the Sign in with Apple plugin.
SignInWithAppleNotSupportedException
An SignInWithAppleException which will be thrown in case Sign in with Apple is not supported.
UnknownSignInWithAppleException
An SignInWithAppleException which will be thrown if a PlatformException can't be mapped to a more specific SignInWithAppleException.