modules.md

@invertase/react-native-apple-authentication

Table of contents

References

• default

Enumerations

• AndroidResponseType
• AndroidScope
• AppleButtonStyle
• AppleButtonType
• AppleCredentialState
• AppleError
• AppleRealUserStatus
• AppleRequestOperation
• AppleRequestScope

Interfaces

• AndroidConfig
• AndroidSigninResponse
• AppleAuthAndroid
• AppleButtonProps
• AppleRequestOptions
• AppleRequestResponse
• AppleRequestResponseFullName

Type aliases

• AndroidError

Variables

• AppleButton
• appleAuth
• appleAuthAndroid

References

default

Renames and re-exports appleAuth

Type aliases

AndroidError

Ƭ AndroidError: Object

Android

Type declaration

Name	Type	Description
NOT_CONFIGURED	string	Apple auth for Android wasn't configured. Be sure to call appleAuthAndroid.configure(options).
SIGNIN_CANCELLED	string	User cancelled (closed the browser window) the sign in request.
SIGNIN_FAILED	string	-

Defined in

index.d.ts:486

Variables

AppleButton

• AppleButton: { Style: typeof AppleButtonStyle ; Type: typeof AppleButtonType } & React.FC<AppleButtonProps>

Defined in

index.d.ts:118

---

appleAuth

• appleAuth: Object

Type declaration

Name	Type	Description
Error	typeof AppleError	Errors that can occur during authorization. url https://developer.apple.com/documentation/authenticationservices/asauthorizationerror/code
Operation	typeof AppleRequestOperation	Operation to be executed by the request. Request option used as part of AppleRequestOptions requestedOperation
Scope	typeof AppleRequestScope	The contact information to be requested from the user. Only scopes for which this app was authorized for will be returned. Scopes used as part of AppleRequestOptions requestedScopes
State	typeof AppleCredentialState	The current Apple Authorization state.
UserStatus	typeof AppleRealUserStatus	Possible values for the real user indicator. url https://developer.apple.com/documentation/authenticationservices/asuserdetectionstatus
isSignUpButtonSupported	boolean	A boolean value of whether the 'SignUp' Type variant of the Apple Authentication Button is supported. This will always return false for Android, and false for iOS devices running iOS versions less than 13.2
isSupported	boolean	A boolean value of whether Apple Authentication is supported on this device & platform version. This will always return false for Android, and false for iOS devices running iOS versions less than 13.
getCredentialStateForUser	(user: string) => Promise<AppleCredentialState>	-
onCredentialRevoked	(listener: Function) => () => undefined | void	-
performRequest	(options?: AppleRequestOptions) => Promise<AppleRequestResponse>	-

Defined in

index.d.ts:408

---

appleAuthAndroid

• appleAuthAndroid: AppleAuthAndroid

Defined in

index.d.ts:623