Skip to content

Latest commit

 

History

History
104 lines (56 loc) · 2.52 KB

File metadata and controls

104 lines (56 loc) · 2.52 KB

Interface: AppleAuthAndroid

Table of contents

Properties

Methods

Properties

Error

Error: AndroidError

Defined in

index.d.ts:610


ResponseType

ResponseType: typeof AndroidResponseType

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

Defined in

index.d.ts:621


Scope

Scope: typeof AndroidScope

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

Defined in

index.d.ts:616


isSupported

isSupported: boolean

A boolean value of whether Apple Authentication is supported on this API version.

The Apple authentication process requires API 19+ to work correctly.

Defined in

index.d.ts:596

Methods

configure

configure(configObject): void

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

Defined in

index.d.ts:603


signIn

signIn(): Promise<AndroidSigninResponse>

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

Returns

Promise<AndroidSigninResponse>

Defined in

index.d.ts:608