Components

`AppleAuthenticationButton`

Type: React.FC < AppleAuthenticationButtonProps >

This component displays the proprietary "Sign In with Apple" / "Continue with Apple" button on your screen. The App Store Guidelines require you to use this component to start the authentication process instead of a custom button. Limited customization of the button is available via the provided properties.

You should only attempt to render this if AppleAuthentication.isAvailableAsync() resolves to true . This component will render nothing if it is not available, and you will get a warning in development mode ( __DEV__ === true ).

The properties of this component extend from View ; however, you should not attempt to set backgroundColor or borderRadius with the style property. This will not work and is against the App Store Guidelines. Instead, you should use the buttonStyle property to choose one of the predefined color styles and the cornerRadius property to change the border radius of the button.

Make sure to attach height and width via the style props as without these styles, the button will not appear on the screen.

`AppleAuthenticationButtonProps`

buttonStyle

Type: AppleAuthenticationButtonStyle

The Apple-defined color scheme to use to display the button.
buttonType

Type: AppleAuthenticationButtonType

The type of button text to display ("Sign In with Apple" vs. "Continue with Apple").
cornerRadius

Optional • Type: number

The border radius to use when rendering the button. This works similarly to style.borderRadius in other Views.
onPress

Type: () => void

The method to call when the user presses the button. You should call AppleAuthentication.signInAsync in here.
style

Optional • Type: StyleProp < Omit < ViewStyle , 'backgroundColor' | 'borderRadius' > >

The custom style to apply to the button. Should not include backgroundColor or borderRadius properties.

Inherited Props

ViewProps

Methods

`getCredentialStateAsync(user)`

Arguments

user ( string ) - The unique identifier for the user whose credential state you'd like to check. This should come from the user field of an AppleAuthenticationCredential object.

Queries the current state of a user credential, to determine if it is still valid or if it has been revoked.

Note: This method must be tested on a real device. On the iOS simulator it always throws an error.

Returns

Promise < AppleAuthenticationCredentialState >

A promise that fulfills with an AppleAuthenticationCredentialState value depending on the state of the credential.

`isAvailableAsync()`

Determine if the current device's operating system supports Apple authentication.

Returns

Promise < boolean >

A promise that fulfills with true if the system supports Apple authentication, and false otherwise.

`refreshAsync(options)`

Arguments

options ( AppleAuthenticationRefreshOptions )

Returns

Promise < AppleAuthenticationCredential >

`signInAsync(options)`

Arguments

options ? ( AppleAuthenticationSignInOptions ) - An optional AppleAuthenticationSignInOptions object

Sends a request to the operating system to initiate the Apple authentication flow, which will present a modal to the user over your app and allow them to sign in.

You can request access to the user's full name and email address in this method, which allows you to personalize your UI for signed in users. However, users can deny access to either or both of these options at runtime.

Additionally, you will only receive Apple Authentication Credentials the first time users sign into your app, so you must store it for later use. It's best to store this information either server-side, or using SecureStore , so that the data persists across app installs. You can use AppleAuthenticationCredential.user to identify the user, since this remains the same for apps released by the same developer.

Returns

Promise < AppleAuthenticationCredential >

A promise that fulfills with an AppleAuthenticationCredential object after a successful authentication, and rejects with ERR_CANCELED if the user cancels the sign-in operation.

`signOutAsync(options)`

Arguments

options ( AppleAuthenticationSignOutOptions )

Returns

Promise < AppleAuthenticationCredential >

Event Subscriptions

`addRevokeListener(listener)`

Arguments

listener ( () => void )

Returns

Subscription

Types

`AppleAuthenticationCredential`

The object type returned from a successful call to AppleAuthentication.signInAsync() , AppleAuthentication.refreshAsync() , or AppleAuthentication.signOutAsync() which contains all of the pertinent user and credential information.

Name	Type	Description
authorizationCode	`string \| null`	A short-lived session token used by your app for proof of authorization when interacting with the app's server counterpart. Unlike `user` , this is ephemeral and will change each session.
email	`string \| null`	The user's email address. Might not be present if you didn't request the `EMAIL` scope. May also be null if this is not the first time the user has signed into your app. If the user chose to withhold their email address, this field will instead contain an obscured email address with an Apple domain.
fullName	`AppleAuthenticationFullName \| null`	The user's name. May be `null` or contain `null` values if you didn't request the `FULL_NAME` scope, if the user denied access, or if this is not the first time the user has signed into your app.
identityToken	`string \| null`	A JSON Web Token (JWT) that securely communicates information about the user to your app.
realUserStatus	`AppleAuthenticationUserDetectionStatus`	A value that indicates whether the user appears to the system to be a real person.
state	`string \| null`	An arbitrary string that your app provided as `state` in the request that generated the credential. Used to verify that the response was from the request you made. Can be used to avoid replay attacks. If you did not provide `state` when making the sign-in request, this field will be `null` .
user	`string`	An identifier associated with the authenticated user. You can use this to check if the user is still authenticated later. This is stable and can be shared across apps released under the same development team. The same user will have a different identifier for apps released by other developers.

`AppleAuthenticationFullName`

An object representing the tokenized portions of the user's full name. Any of all of the fields may be null . Only applicable fields that the user has allowed your app to access will be nonnull.

Name	Type	Description
familyName	`string \| null`	-
givenName	`string \| null`	-
middleName	`string \| null`	-
namePrefix	`string \| null`	-
nameSuffix	`string \| null`	-
nickname	`string \| null`	-

`AppleAuthenticationRefreshOptions`

The options you can supply when making a call to AppleAuthentication.refreshAsync() . You must include the ID string of the user whose credentials you'd like to refresh.

Name	Type	Description
requestedScopes (optional)	`AppleAuthenticationScope []`	Array of user information scopes to which your app is requesting access. Note that the user can choose to deny your app access to any scope at the time of logging in. You will still need to handle `null` values for any scopes you request. Additionally, note that the requested scopes will only be provided to you the first time each user signs into your app; in subsequent requests they will be `null` . Defaults to `[]` (no scopes).
state (optional)	`string`	An arbitrary string that is returned unmodified in the corresponding credential after a successful authentication. This can be used to verify that the response was from the request you made and avoid replay attacks. More information on this property is available in the OAuth 2.0 protocol RFC6749 .
user	`string`	-

`AppleAuthenticationSignInOptions`

The options you can supply when making a call to AppleAuthentication.signInAsync() . None of these options are required.

Name	Type	Description
nonce (optional)	`string`	An arbitrary string that is used to prevent replay attacks. See more information on this in the OpenID Connect specification .
requestedScopes (optional)	`AppleAuthenticationScope []`	Array of user information scopes to which your app is requesting access. Note that the user can choose to deny your app access to any scope at the time of logging in. You will still need to handle `null` values for any scopes you request. Additionally, note that the requested scopes will only be provided to you the first time each user signs into your app; in subsequent requests they will be `null` . Defaults to `[]` (no scopes).
state (optional)	`string`	An arbitrary string that is returned unmodified in the corresponding credential after a successful authentication. This can be used to verify that the response was from the request you made and avoid replay attacks. More information on this property is available in the OAuth 2.0 protocol RFC6749 .

`AppleAuthenticationSignOutOptions`

The options you can supply when making a call to AppleAuthentication.signOutAsync() . You must include the ID string of the user to sign out.

Name	Type	Description
state (optional)	`string`	An arbitrary string that is returned unmodified in the corresponding credential after a successful authentication. This can be used to verify that the response was from the request you made and avoid replay attacks. More information on this property is available in the OAuth 2.0 protocol RFC6749 .
user	`string`	-

`Subscription`

Name	Type	Description
remove	`() => void`	A method to unsubscribe the listener.

Enums

`AppleAuthenticationButtonStyle`

An enum whose values control which pre-defined color scheme to use when rendering an AppleAuthenticationButton .

AppleAuthenticationButtonStyle . WHITE : 0 - White button with black text.
AppleAuthenticationButtonStyle . WHITE_OUTLINE : 1 - White button with a black outline and black text.
AppleAuthenticationButtonStyle . BLACK : 2 - Black button with white text.

`AppleAuthenticationButtonType`

An enum whose values control which pre-defined text to use when rendering an AppleAuthenticationButton .

AppleAuthenticationButtonType . SIGN_IN : 0 - "Sign in with Apple"
AppleAuthenticationButtonType . CONTINUE : 1 - "Continue with Apple"
AppleAuthenticationButtonType . SIGN_UP : 2 - "Sign up with Apple" (requires iOS 13.2 or higher)

`AppleAuthenticationCredentialState`

An enum whose values specify state of the credential when checked with AppleAuthentication.getCredentialStateAsync() .

AppleAuthenticationCredentialState . REVOKED : 0
AppleAuthenticationCredentialState . AUTHORIZED : 1
AppleAuthenticationCredentialState . NOT_FOUND : 2
AppleAuthenticationCredentialState . TRANSFERRED : 3

`AppleAuthenticationOperation`

AppleAuthenticationOperation . IMPLICIT : 0 - An operation that depends on the particular kind of credential provider.
AppleAuthenticationOperation . LOGIN : 1
AppleAuthenticationOperation . REFRESH : 2
AppleAuthenticationOperation . LOGOUT : 3

`AppleAuthenticationScope`

An enum whose values specify scopes you can request when calling AppleAuthentication.signInAsync() .

Note that it is possible that you will not be granted all of the scopes which you request. You will still need to handle null values for any fields you request.

AppleAuthenticationScope . FULL_NAME : 0
AppleAuthenticationScope . EMAIL : 1

`AppleAuthenticationUserDetectionStatus`

An enum whose values specify the system's best guess for how likely the current user is a real person.

AppleAuthenticationUserDetectionStatus . UNSUPPORTED : 0 - The system does not support this determination and there is no data.
AppleAuthenticationUserDetectionStatus . UNKNOWN : 1 - The system has not determined whether the user might be a real person.
AppleAuthenticationUserDetectionStatus . LIKELY_REAL : 2 - The user appears to be a real person.

Methods

`getPermissionsAsync()`

Returns

Promise < PermissionResponse >

`getStepCountAsync(start, end)`

Arguments

start ( Date ) - A date indicating the start of the range over which to measure steps.
end ( Date ) - A date indicating the end of the range over which to measure steps.

Get the step count between two dates.

Returns

Promise < PedometerResult >

Returns a promise that fulfills with a PedometerResult .

As Apple documentation states :

Only the past seven days worth of data is stored and available for you to retrieve. Specifying a start date that is more than seven days in the past returns only the available data.

`isAvailableAsync()`

Returns whether the pedometer is enabled on the device.

Returns

Promise < boolean >

Returns a promise that fulfills with a boolean , indicating whether the pedometer is available on this device.

`requestPermissionsAsync()`

Returns

Promise < PermissionResponse >

`watchStepCount(callback)`

Arguments

callback ( PedometerUpdateCallback ) - A callback that is invoked when new step count data is available. The callback is provided with a single argument that is PedometerResult .

Subscribe to pedometer updates.

Returns

Subscription

Returns a Subscription that enables you to call remove() when you would like to unsubscribe the listener.

Types

`PedometerResult`

Name	Type	Description
steps	`number`	Number of steps taken between the given dates.

`PedometerUpdateCallback ()`

Arguments

result ( PedometerResult )

`PermissionExpiration`

Acceptable values are: 'never' , number .

`Subscription`

Name	Type	Description
remove	`() => void`	A method to unsubscribe the listener.

Interfaces

`PermissionResponse`

Name	Type	Description
canAskAgain	`boolean`	-
expires	`PermissionExpiration`	-
granted	`boolean`	-
status	`PermissionStatus`	-

Enums

`PermissionStatus`

PermissionStatus . DENIED : "denied"
PermissionStatus . GRANTED : "granted"
PermissionStatus . UNDETERMINED : "undetermined"

buttonStyle

buttonType

cornerRadius

onPress

style

Inherited Props