_lib_index_d_.appleauthandroid.md

Interface: AppleAuthAndroid

Hierarchy

• AppleAuthAndroid

Index

Properties

• Error
• ResponseType
• Scope

Methods

• configure
• signIn

Properties

isSupported

• isSupported: boolean

Defined in lib/index.d.ts:591

A boolean value of whether Apple Authentication is supported on this API version. The Apple authentication process requires API 19+ to work correctly.

---

Error

• Error: AndroidError

Defined in lib/index.d.ts:605

---

ResponseType

• ResponseType: typeof AndroidResponseType

Defined in lib/index.d.ts:616

The type of response requested. Valid values are code and id_token. You can request one or both.

---

Scope

• Scope: typeof AndroidScope

Defined in lib/index.d.ts:611

The amount of user information requested from Apple. Valid values are name and email. You can request one, both, or none.

Methods

configure

▸ configure(configObject: AndroidConfig): void

Defined in lib/index.d.ts:598

Prepare the module for sign in. This must be called before appleAuthAndroid.signIn();

see https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_js/incorporating_sign_in_with_apple_into_other_platforms#3332113

Parameters:

Name	Type
configObject	AndroidConfig

Returns: void

---

signIn

▸ signIn(): Promise‹AndroidSigninResponse›

Defined in lib/index.d.ts:603

Open browser window to begin user sign in. Must call appleAuthAndroid.configure(options) first.

Returns: Promise‹AndroidSigninResponse›