d-a-w / cordova-plugin-sign-in-with-apple Goto Github PK

View Code? Open in Web Editor NEW

DISCLAIMER: API might be changed // Thanks to your contribution! // Cordova>=9 iOS>=13

License: MIT License

JavaScript 57.54% Objective-C 42.46%

cordova-plugin-sign-in-with-apple's Introduction

cordova-plugin-sign-in-with-apple

Installation

Plugin installation

cordova plugin add cordova-plugin-sign-in-with-apple

cordova plugin add https://github.com/twogate/cordova-plugin-sign-in-with-apple.git

Usage

window.cordova.plugins.SignInWithApple.signin(
  null,
  function(succ){
    console.log(succ)
    alert(JSON.stringify(succ))
  },
  function(err){
    console.error(err)
    console.log(JSON.stringify(err))
  }
)

Success Callback Data Example

Based on ASAuthorizationAppleIDCredential.

authorizationCode: string "<short-lived token used by your app for proof of authorization when interacting with the app’s server counterpart>"
email: string "[email protected]"
fullName: object, based on NSPersonNameComponents
- familyName: string "Doe"
- givenName: string "Jane"
- namePrefix: string ""
- nameSuffix: string ""
- nickname: string ""
- phoneticRepresentation: object, based on NSPersonNameComponents
  - familyName?: string
  - givenName?: string
  - namePrefix?: string
  - nameSuffix?: string
  - nickname?: string
identityToken: string "<JSON Web Token (JWT) that securely communicates information about the user to your app>"
state: string "<arbitrary string that your app provided to the request that generated the credential>"
user: string "<identifier associated with the authenticated user>"

Failure Callback Data Example

error: string "ASAUTHORIZATION_ERROR"
code: string 1001
localizedDescription: string "The operation couldn’t be completed. (com.apple.AuthenticationServices.AuthorizationError error 1001.)"
localizedFailureReason: string ""