docs(sign-in-with-apple): updated documentation

Author: patrickbussmann

src/@ionic-native/plugins/sign-in-with-apple/index.ts

@@ -1,6 +1,16 @@
 import { Injectable } from '@angular/core';
 import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
 
+/**
+ * @see https://developer.apple.com/documentation/authenticationservices/asauthorizationappleidrequest
+ */
+export class ASAuthorizationAppleIDRequest {
+  static readonly ASAuthorizationScopeFullName = 0;
+  static readonly ASAuthorizationScopeEmail = 1;
+
+  requestedScopes?: number[];
+}
+
 /**
  * @see https://developer.apple.com/documentation/foundation/nspersonnamecomponents/1412193-phoneticrepresentation
  */
@@ -116,15 +126,20 @@ export interface AppleSignInErrorResponse extends NSError {
  *
  * @usage
  * ```typescript
- * import { SignInWithApple, AppleSignInResponse, AppleSignInErrorResponse } from '@ionic-native/sign-in-with-apple/ngx';
+ * import { SignInWithApple, AppleSignInResponse, AppleSignInErrorResponse, ASAuthorizationAppleIDRequest } from '@ionic-native/sign-in-with-apple/ngx';
  *
  *
  * constructor(private signInWithApple: SignInWithApple) { }
  *
  * ...
  *
  *
- * this.signInWithApple.signin()
+ *   this.signInWithApple.signin({
+ *     requestedScopes: [
+ *       ASAuthorizationAppleIDRequest.ASAuthorizationScopeFullName,
+ *       ASAuthorizationAppleIDRequest.ASAuthorizationScopeEmail
+ *     ]
+ *   })
  *   .then((res: AppleSignInResponse) => {
  *     // https://developer.apple.com/documentation/signinwithapplerestapi/verifying_a_user
  *     alert('Send token to apple for verification: ' + res.identityToken);
@@ -151,11 +166,11 @@ export class SignInWithApple extends IonicNativePlugin {
    * Starts the authorization flows named during controller initialization
    * @see https://developer.apple.com/documentation/authenticationservices/asauthorizationcontroller/3153047-performrequests
    * @return {Promise<AppleSignInResponse>} Returns a promise when authorization succeeds
-   * @param arg0
+   * @param {ASAuthorizationAppleIDRequest} options
    * @throws AppleSignInErrorResponse
    */
   @Cordova()
-  signin(arg0: object = null): Promise<AppleSignInResponse> {
+  signin(options: ASAuthorizationAppleIDRequest = {}): Promise<AppleSignInResponse> {
     return;
   }