1// Jest Snapshot v1, https://goo.gl/fbAQLP 2 3exports[`APISection expo-apple-authentication 1`] = ` 4<div> 5 <h2 6 class="css-1v5aebx-h2-h2-STYLES_H2" 7 data-heading="true" 8 > 9 <div 10 class="css-1rh3o5q-STYLES_PERMALINK" 11 > 12 <span 13 class="css-zonpcr-STYLES_PERMALINK_TARGET" 14 id="components" 15 /> 16 <a 17 class="css-15lh5hg-STYLES_PERMALINK_LINK" 18 href="#components" 19 > 20 <span 21 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 22 > 23 Components 24 </span> 25 <span 26 class="css-10vdcw8-STYLES_PERMALINK_ICON" 27 > 28 <svg 29 aria-label="permalink" 30 class="anchor-icon" 31 fill="none" 32 height="24" 33 viewBox="0 0 24 24" 34 width="24" 35 xmlns="http://www.w3.org/2000/svg" 36 > 37 <path 38 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 39 stroke="#9B9B9B" 40 stroke-linecap="round" 41 stroke-linejoin="round" 42 stroke-width="2" 43 /> 44 <path 45 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 46 stroke="#9B9B9B" 47 stroke-linecap="round" 48 stroke-linejoin="round" 49 stroke-width="2" 50 /> 51 </svg> 52 </span> 53 </a> 54 </div> 55 </h2> 56 <div> 57 <h3 58 class="css-icxoph-h3-h3-STYLES_H3" 59 data-heading="true" 60 > 61 <div 62 class="css-1rh3o5q-STYLES_PERMALINK" 63 > 64 <span 65 class="css-zonpcr-STYLES_PERMALINK_TARGET" 66 id="appleauthenticationbutton" 67 /> 68 <a 69 class="css-15lh5hg-STYLES_PERMALINK_LINK" 70 href="#appleauthenticationbutton" 71 > 72 <span 73 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 74 > 75 <code 76 class="inline css-nuv12a-STYLES_INLINE_CODE" 77 > 78 AppleAuthenticationButton 79 </code> 80 </span> 81 <span 82 class="css-10vdcw8-STYLES_PERMALINK_ICON" 83 > 84 <svg 85 aria-label="permalink" 86 class="anchor-icon" 87 fill="none" 88 height="24" 89 viewBox="0 0 24 24" 90 width="24" 91 xmlns="http://www.w3.org/2000/svg" 92 > 93 <path 94 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 95 stroke="#9B9B9B" 96 stroke-linecap="round" 97 stroke-linejoin="round" 98 stroke-width="2" 99 /> 100 <path 101 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 102 stroke="#9B9B9B" 103 stroke-linecap="round" 104 stroke-linejoin="round" 105 stroke-width="2" 106 /> 107 </svg> 108 </span> 109 </a> 110 </div> 111 </h3> 112 <p 113 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 114 data-text="true" 115 > 116 <strong 117 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 118 > 119 Type: 120 </strong> 121 122 <code 123 class="inline css-nuv12a-STYLES_INLINE_CODE" 124 > 125 React.FC 126 < 127 <span> 128 <a 129 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 130 href="/#appleauthenticationbuttonprops" 131 > 132 AppleAuthenticationButtonProps 133 </a> 134 </span> 135 > 136 </code> 137 </p> 138 <p 139 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 140 data-text="true" 141 > 142 This component displays the proprietary "Sign In with Apple" / "Continue with Apple" button on 143your screen. The App Store Guidelines require you to use this component to start the 144authentication process instead of a custom button. Limited customization of the button is 145available via the provided properties. 146 </p> 147 <p 148 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 149 data-text="true" 150 > 151 You should only attempt to render this if 152 <a 153 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 154 href="/#isavailableasync" 155 > 156 <code 157 class="inline css-nuv12a-STYLES_INLINE_CODE" 158 > 159 AppleAuthentication.isAvailableAsync() 160 </code> 161 </a> 162 163resolves to 164 <code 165 class="inline css-nuv12a-STYLES_INLINE_CODE" 166 > 167 true 168 </code> 169 . This component will render nothing if it is not available, and you will get 170a warning in development mode ( 171 <code 172 class="inline css-nuv12a-STYLES_INLINE_CODE" 173 > 174 __DEV__ === true 175 </code> 176 ). 177 </p> 178 179 180 <p 181 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 182 data-text="true" 183 > 184 The properties of this component extend from 185 <code 186 class="inline css-nuv12a-STYLES_INLINE_CODE" 187 > 188 View 189 </code> 190 ; however, you should not attempt to set 191 192 <code 193 class="inline css-nuv12a-STYLES_INLINE_CODE" 194 > 195 backgroundColor 196 </code> 197 or 198 <code 199 class="inline css-nuv12a-STYLES_INLINE_CODE" 200 > 201 borderRadius 202 </code> 203 with the 204 <code 205 class="inline css-nuv12a-STYLES_INLINE_CODE" 206 > 207 style 208 </code> 209 property. This will not work and is against 210the App Store Guidelines. Instead, you should use the 211 <code 212 class="inline css-nuv12a-STYLES_INLINE_CODE" 213 > 214 buttonStyle 215 </code> 216 property to choose one of the 217predefined color styles and the 218 <code 219 class="inline css-nuv12a-STYLES_INLINE_CODE" 220 > 221 cornerRadius 222 </code> 223 property to change the border radius of the 224button. 225 </p> 226 227 228 <p 229 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 230 data-text="true" 231 > 232 Make sure to attach height and width via the style props as without these styles, the button will 233not appear on the screen. 234 </p> 235 <h3 236 class="css-icxoph-h3-h3-STYLES_H3" 237 data-heading="true" 238 > 239 <div 240 class="css-1rh3o5q-STYLES_PERMALINK" 241 > 242 <span 243 class="css-zonpcr-STYLES_PERMALINK_TARGET" 244 id="appleauthenticationbuttonprops" 245 /> 246 <a 247 class="css-15lh5hg-STYLES_PERMALINK_LINK" 248 href="#appleauthenticationbuttonprops" 249 > 250 <span 251 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 252 > 253 <code 254 class="inline css-nuv12a-STYLES_INLINE_CODE" 255 > 256 AppleAuthenticationButtonProps 257 </code> 258 </span> 259 <span 260 class="css-10vdcw8-STYLES_PERMALINK_ICON" 261 > 262 <svg 263 aria-label="permalink" 264 class="anchor-icon" 265 fill="none" 266 height="24" 267 viewBox="0 0 24 24" 268 width="24" 269 xmlns="http://www.w3.org/2000/svg" 270 > 271 <path 272 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 273 stroke="#9B9B9B" 274 stroke-linecap="round" 275 stroke-linejoin="round" 276 stroke-width="2" 277 /> 278 <path 279 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 280 stroke="#9B9B9B" 281 stroke-linecap="round" 282 stroke-linejoin="round" 283 stroke-width="2" 284 /> 285 </svg> 286 </span> 287 </a> 288 </div> 289 </h3> 290 <br /> 291 <div> 292 <ul 293 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 294 data-text="true" 295 > 296 <li 297 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 298 > 299 <h4 300 class="css-1j2s5xo-h4-h4-STYLES_H4" 301 data-heading="true" 302 > 303 buttonStyle 304 </h4> 305 <p 306 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 307 data-text="true" 308 > 309 <span 310 class="css-t865as-STYLES_SECONDARY" 311 > 312 Type: 313 </span> 314 315 <code 316 class="inline css-nuv12a-STYLES_INLINE_CODE" 317 > 318 <a 319 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 320 href="/#appleauthenticationbuttonstyle" 321 > 322 AppleAuthenticationButtonStyle 323 </a> 324 </code> 325 </p> 326 <p 327 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 328 data-text="true" 329 > 330 The Apple-defined color scheme to use to display the button. 331 </p> 332 </li> 333 <li 334 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 335 > 336 <h4 337 class="css-1j2s5xo-h4-h4-STYLES_H4" 338 data-heading="true" 339 > 340 buttonType 341 </h4> 342 <p 343 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 344 data-text="true" 345 > 346 <span 347 class="css-t865as-STYLES_SECONDARY" 348 > 349 Type: 350 </span> 351 352 <code 353 class="inline css-nuv12a-STYLES_INLINE_CODE" 354 > 355 <a 356 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 357 href="/#appleauthenticationbuttontype" 358 > 359 AppleAuthenticationButtonType 360 </a> 361 </code> 362 </p> 363 <p 364 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 365 data-text="true" 366 > 367 The type of button text to display ("Sign In with Apple" vs. "Continue with Apple"). 368 </p> 369 </li> 370 <li 371 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 372 > 373 <h4 374 class="css-1j2s5xo-h4-h4-STYLES_H4" 375 data-heading="true" 376 > 377 cornerRadius 378 </h4> 379 <p 380 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 381 data-text="true" 382 > 383 <span 384 class="css-t865as-STYLES_SECONDARY" 385 > 386 Optional • 387 </span> 388 <span 389 class="css-t865as-STYLES_SECONDARY" 390 > 391 Type: 392 </span> 393 394 <code 395 class="inline css-nuv12a-STYLES_INLINE_CODE" 396 > 397 number 398 </code> 399 </p> 400 <p 401 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 402 data-text="true" 403 > 404 The border radius to use when rendering the button. This works similarly to 405 406 <code 407 class="inline css-nuv12a-STYLES_INLINE_CODE" 408 > 409 style.borderRadius 410 </code> 411 in other Views. 412 </p> 413 </li> 414 <li 415 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 416 > 417 <h4 418 class="css-1j2s5xo-h4-h4-STYLES_H4" 419 data-heading="true" 420 > 421 style 422 </h4> 423 <p 424 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 425 data-text="true" 426 > 427 <span 428 class="css-t865as-STYLES_SECONDARY" 429 > 430 Optional • 431 </span> 432 <span 433 class="css-t865as-STYLES_SECONDARY" 434 > 435 Type: 436 </span> 437 438 <code 439 class="inline css-nuv12a-STYLES_INLINE_CODE" 440 > 441 StyleProp 442 < 443 <span> 444 <a 445 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 446 href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" 447 rel="noopener noreferrer" 448 > 449 Omit 450 </a> 451 < 452 <span> 453 <a 454 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 455 href="/react-native/view-style-props" 456 > 457 ViewStyle 458 </a> 459 , 460 </span> 461 <span> 462 <span> 463 'backgroundColor' 464 | 465 </span> 466 <span> 467 'borderRadius' 468 </span> 469 </span> 470 > 471 </span> 472 > 473 </code> 474 </p> 475 <p 476 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 477 data-text="true" 478 > 479 The custom style to apply to the button. Should not include 480 <code 481 class="inline css-nuv12a-STYLES_INLINE_CODE" 482 > 483 backgroundColor 484 </code> 485 or 486 <code 487 class="inline css-nuv12a-STYLES_INLINE_CODE" 488 > 489 borderRadius 490 </code> 491 492properties. 493 </p> 494 </li> 495 <li 496 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 497 > 498 <h4 499 class="css-1j2s5xo-h4-h4-STYLES_H4" 500 data-heading="true" 501 > 502 onPress 503 </h4> 504 <p 505 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 506 data-text="true" 507 > 508 <span 509 class="css-t865as-STYLES_SECONDARY" 510 > 511 Type: 512 </span> 513 514 <code 515 class="inline css-nuv12a-STYLES_INLINE_CODE" 516 > 517 ( 518 519 ) => 520 void 521 </code> 522 </p> 523 <p 524 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 525 data-text="true" 526 > 527 The method to call when the user presses the button. You should call 528 <a 529 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 530 href="/#isavailableasync" 531 > 532 <code 533 class="inline css-nuv12a-STYLES_INLINE_CODE" 534 > 535 AppleAuthentication.signInAsync 536 </code> 537 </a> 538 539in here. 540 </p> 541 </li> 542 </ul> 543 <h4 544 class="css-1j2s5xo-h4-h4-STYLES_H4" 545 data-heading="true" 546 > 547 Inherited Props 548 </h4> 549 <ul 550 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 551 data-text="true" 552 > 553 <li 554 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 555 > 556 <code 557 class="inline css-nuv12a-STYLES_INLINE_CODE" 558 > 559 <a 560 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 561 href="/react-native/view#props" 562 > 563 ViewProps 564 </a> 565 </code> 566 </li> 567 </ul> 568 </div> 569 </div> 570 <h2 571 class="css-1v5aebx-h2-h2-STYLES_H2" 572 data-heading="true" 573 > 574 <div 575 class="css-1rh3o5q-STYLES_PERMALINK" 576 > 577 <span 578 class="css-zonpcr-STYLES_PERMALINK_TARGET" 579 id="methods" 580 /> 581 <a 582 class="css-15lh5hg-STYLES_PERMALINK_LINK" 583 href="#methods" 584 > 585 <span 586 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 587 > 588 Methods 589 </span> 590 <span 591 class="css-10vdcw8-STYLES_PERMALINK_ICON" 592 > 593 <svg 594 aria-label="permalink" 595 class="anchor-icon" 596 fill="none" 597 height="24" 598 viewBox="0 0 24 24" 599 width="24" 600 xmlns="http://www.w3.org/2000/svg" 601 > 602 <path 603 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 604 stroke="#9B9B9B" 605 stroke-linecap="round" 606 stroke-linejoin="round" 607 stroke-width="2" 608 /> 609 <path 610 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 611 stroke="#9B9B9B" 612 stroke-linecap="round" 613 stroke-linejoin="round" 614 stroke-width="2" 615 /> 616 </svg> 617 </span> 618 </a> 619 </div> 620 </h2> 621 <div> 622 <h3 623 class="css-icxoph-h3-h3-STYLES_H3" 624 data-heading="true" 625 > 626 <div 627 class="css-1rh3o5q-STYLES_PERMALINK" 628 > 629 <span 630 class="css-zonpcr-STYLES_PERMALINK_TARGET" 631 id="getcredentialstateasyncuser" 632 /> 633 <a 634 class="css-15lh5hg-STYLES_PERMALINK_LINK" 635 href="#getcredentialstateasyncuser" 636 > 637 <span 638 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 639 > 640 <code 641 class="inline css-nuv12a-STYLES_INLINE_CODE" 642 > 643 getCredentialStateAsync(user) 644 </code> 645 </span> 646 <span 647 class="css-10vdcw8-STYLES_PERMALINK_ICON" 648 > 649 <svg 650 aria-label="permalink" 651 class="anchor-icon" 652 fill="none" 653 height="24" 654 viewBox="0 0 24 24" 655 width="24" 656 xmlns="http://www.w3.org/2000/svg" 657 > 658 <path 659 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 660 stroke="#9B9B9B" 661 stroke-linecap="round" 662 stroke-linejoin="round" 663 stroke-width="2" 664 /> 665 <path 666 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 667 stroke="#9B9B9B" 668 stroke-linecap="round" 669 stroke-linejoin="round" 670 stroke-width="2" 671 /> 672 </svg> 673 </span> 674 </a> 675 </div> 676 </h3> 677 <h4 678 class=" css-1j2s5xo-h4-h4-STYLES_H4" 679 data-components-heading="true" 680 data-heading="true" 681 > 682 <div 683 class="css-1rh3o5q-STYLES_PERMALINK" 684 > 685 <span 686 class="css-zonpcr-STYLES_PERMALINK_TARGET" 687 id="arguments" 688 /> 689 <a 690 class="css-15lh5hg-STYLES_PERMALINK_LINK" 691 href="#arguments" 692 > 693 <span 694 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 695 > 696 Arguments 697 </span> 698 <span 699 class="css-10vdcw8-STYLES_PERMALINK_ICON" 700 > 701 <svg 702 aria-label="permalink" 703 class="anchor-icon" 704 fill="none" 705 height="24" 706 viewBox="0 0 24 24" 707 width="24" 708 xmlns="http://www.w3.org/2000/svg" 709 > 710 <path 711 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 712 stroke="#9B9B9B" 713 stroke-linecap="round" 714 stroke-linejoin="round" 715 stroke-width="2" 716 /> 717 <path 718 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 719 stroke="#9B9B9B" 720 stroke-linecap="round" 721 stroke-linejoin="round" 722 stroke-width="2" 723 /> 724 </svg> 725 </span> 726 </a> 727 </div> 728 </h4> 729 <ul 730 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 731 data-text="true" 732 > 733 <li 734 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 735 > 736 <strong 737 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 738 > 739 user 740 ( 741 <code 742 class="inline css-nuv12a-STYLES_INLINE_CODE" 743 > 744 string 745 </code> 746 ) 747 </strong> 748 - 749 <span> 750 The unique identifier for the user whose credential state you'd like to check. 751This should come from the user field of an 752 <a 753 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 754 href="/#appleauthenticationcredentialstate" 755 > 756 <code 757 class="inline css-nuv12a-STYLES_INLINE_CODE" 758 > 759 AppleAuthenticationCredential 760 </code> 761 </a> 762 object. 763 </span> 764 </li> 765 </ul> 766 <p 767 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 768 data-text="true" 769 > 770 Queries the current state of a user credential, to determine if it is still valid or if it has been revoked. 771 </p> 772 773 774 <blockquote 775 class="css-e76wiv-paragraph-STYLES_BLOCKQUOTE" 776 data-text="true" 777 > 778 <div> 779 <div 780 style="margin-top: 2px;" 781 > 782 <svg 783 aria-label="check" 784 fill="none" 785 height="16" 786 viewBox="0 0 24 24" 787 width="16" 788 xmlns="http://www.w3.org/2000/svg" 789 > 790 <path 791 d="M12 0C5.373 0 0 5.373 0 12s5.373 12 12 12c6.628 0 12-5.373 12-12S18.628 0 12 0zm-.015 5.419c.269-.292.596-.44.973-.44.306 0 .575.11.776.317.203.207.306.472.306.786 0 .394-.137.745-.409 1.042-.279.306-.605.462-.968.462-.3 0-.566-.113-.768-.326-.201-.208-.304-.48-.304-.809 0-.401.133-.749.394-1.032zm1.999 11.305c-.995.936-1.705 1.52-2.17 1.784-.496.284-.905.423-1.25.423-.342 0-.621-.114-.83-.338-.202-.218-.305-.51-.305-.87 0-.92.521-3.058 1.595-6.534a1.47 1.47 0 00.042-.166c-.04.017-.087.041-.14.075-.088.055-.356.265-1.14 1.03a.334.334 0 01-.438.025l-.463-.358a.334.334 0 01-.043-.49c.722-.794 1.395-1.371 2.002-1.714.636-.358 1.173-.533 1.643-.533.303 0 .548.076.729.225.196.164.3.391.3.658 0 .175-.084.63-.697 2.686-.875 2.937-1.084 4.003-1.099 4.372.166-.098.558-.376 1.395-1.162a.334.334 0 01.462.003l.411.4a.334.334 0 01-.004.484z" 792 fill="var(--expo-theme-icon-default)" 793 /> 794 </svg> 795 </div> 796 </div> 797 <div> 798 799 800 <strong 801 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 802 > 803 Note: 804 </strong> 805 This method must be tested on a real device. On the iOS simulator it always throws an error. 806 807 808 </div> 809 </blockquote> 810 <div> 811 <h4 812 class=" css-1j2s5xo-h4-h4-STYLES_H4" 813 data-components-heading="true" 814 data-heading="true" 815 > 816 <div 817 class="css-1rh3o5q-STYLES_PERMALINK" 818 > 819 <span 820 class="css-zonpcr-STYLES_PERMALINK_TARGET" 821 id="returns" 822 /> 823 <a 824 class="css-15lh5hg-STYLES_PERMALINK_LINK" 825 href="#returns" 826 > 827 <span 828 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 829 > 830 Returns 831 </span> 832 <span 833 class="css-10vdcw8-STYLES_PERMALINK_ICON" 834 > 835 <svg 836 aria-label="permalink" 837 class="anchor-icon" 838 fill="none" 839 height="24" 840 viewBox="0 0 24 24" 841 width="24" 842 xmlns="http://www.w3.org/2000/svg" 843 > 844 <path 845 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 846 stroke="#9B9B9B" 847 stroke-linecap="round" 848 stroke-linejoin="round" 849 stroke-width="2" 850 /> 851 <path 852 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 853 stroke="#9B9B9B" 854 stroke-linecap="round" 855 stroke-linejoin="round" 856 stroke-width="2" 857 /> 858 </svg> 859 </span> 860 </a> 861 </div> 862 </h4> 863 <ul 864 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 865 data-text="true" 866 > 867 <li 868 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 869 > 870 <code 871 class="inline css-nuv12a-STYLES_INLINE_CODE" 872 > 873 <a 874 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 875 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 876 rel="noopener noreferrer" 877 > 878 Promise 879 </a> 880 < 881 <span> 882 <a 883 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 884 href="/#appleauthenticationcredentialstate" 885 > 886 AppleAuthenticationCredentialState 887 </a> 888 </span> 889 > 890 </code> 891 </li> 892 </ul> 893 <p 894 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 895 data-text="true" 896 > 897 A promise that fulfills with an 898 <a 899 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 900 href="/#appleauthenticationcredentialstate" 901 > 902 <code 903 class="inline css-nuv12a-STYLES_INLINE_CODE" 904 > 905 AppleAuthenticationCredentialState 906 </code> 907 </a> 908 909value depending on the state of the credential. 910 </p> 911 </div> 912 <hr /> 913 </div> 914 <div> 915 <h3 916 class="css-icxoph-h3-h3-STYLES_H3" 917 data-heading="true" 918 > 919 <div 920 class="css-1rh3o5q-STYLES_PERMALINK" 921 > 922 <span 923 class="css-zonpcr-STYLES_PERMALINK_TARGET" 924 id="isavailableasync" 925 /> 926 <a 927 class="css-15lh5hg-STYLES_PERMALINK_LINK" 928 href="#isavailableasync" 929 > 930 <span 931 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 932 > 933 <code 934 class="inline css-nuv12a-STYLES_INLINE_CODE" 935 > 936 isAvailableAsync() 937 </code> 938 </span> 939 <span 940 class="css-10vdcw8-STYLES_PERMALINK_ICON" 941 > 942 <svg 943 aria-label="permalink" 944 class="anchor-icon" 945 fill="none" 946 height="24" 947 viewBox="0 0 24 24" 948 width="24" 949 xmlns="http://www.w3.org/2000/svg" 950 > 951 <path 952 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 953 stroke="#9B9B9B" 954 stroke-linecap="round" 955 stroke-linejoin="round" 956 stroke-width="2" 957 /> 958 <path 959 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 960 stroke="#9B9B9B" 961 stroke-linecap="round" 962 stroke-linejoin="round" 963 stroke-width="2" 964 /> 965 </svg> 966 </span> 967 </a> 968 </div> 969 </h3> 970 <p 971 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 972 data-text="true" 973 > 974 Determine if the current device's operating system supports Apple authentication. 975 </p> 976 <div> 977 <h4 978 class=" css-1j2s5xo-h4-h4-STYLES_H4" 979 data-components-heading="true" 980 data-heading="true" 981 > 982 <div 983 class="css-1rh3o5q-STYLES_PERMALINK" 984 > 985 <span 986 class="css-zonpcr-STYLES_PERMALINK_TARGET" 987 id="returns-1" 988 /> 989 <a 990 class="css-15lh5hg-STYLES_PERMALINK_LINK" 991 href="#returns-1" 992 > 993 <span 994 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 995 > 996 Returns 997 </span> 998 <span 999 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1000 > 1001 <svg 1002 aria-label="permalink" 1003 class="anchor-icon" 1004 fill="none" 1005 height="24" 1006 viewBox="0 0 24 24" 1007 width="24" 1008 xmlns="http://www.w3.org/2000/svg" 1009 > 1010 <path 1011 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1012 stroke="#9B9B9B" 1013 stroke-linecap="round" 1014 stroke-linejoin="round" 1015 stroke-width="2" 1016 /> 1017 <path 1018 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1019 stroke="#9B9B9B" 1020 stroke-linecap="round" 1021 stroke-linejoin="round" 1022 stroke-width="2" 1023 /> 1024 </svg> 1025 </span> 1026 </a> 1027 </div> 1028 </h4> 1029 <ul 1030 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1031 data-text="true" 1032 > 1033 <li 1034 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 1035 > 1036 <code 1037 class="inline css-nuv12a-STYLES_INLINE_CODE" 1038 > 1039 <a 1040 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1041 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1042 rel="noopener noreferrer" 1043 > 1044 Promise 1045 </a> 1046 < 1047 <span> 1048 boolean 1049 </span> 1050 > 1051 </code> 1052 </li> 1053 </ul> 1054 <p 1055 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 1056 data-text="true" 1057 > 1058 A promise that fulfills with 1059 <code 1060 class="inline css-nuv12a-STYLES_INLINE_CODE" 1061 > 1062 true 1063 </code> 1064 if the system supports Apple authentication, and 1065 <code 1066 class="inline css-nuv12a-STYLES_INLINE_CODE" 1067 > 1068 false 1069 </code> 1070 otherwise. 1071 </p> 1072 </div> 1073 <hr /> 1074 </div> 1075 <div> 1076 <h3 1077 class="css-icxoph-h3-h3-STYLES_H3" 1078 data-heading="true" 1079 > 1080 <div 1081 class="css-1rh3o5q-STYLES_PERMALINK" 1082 > 1083 <span 1084 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1085 id="refreshasyncoptions" 1086 /> 1087 <a 1088 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1089 href="#refreshasyncoptions" 1090 > 1091 <span 1092 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1093 > 1094 <code 1095 class="inline css-nuv12a-STYLES_INLINE_CODE" 1096 > 1097 refreshAsync(options) 1098 </code> 1099 </span> 1100 <span 1101 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1102 > 1103 <svg 1104 aria-label="permalink" 1105 class="anchor-icon" 1106 fill="none" 1107 height="24" 1108 viewBox="0 0 24 24" 1109 width="24" 1110 xmlns="http://www.w3.org/2000/svg" 1111 > 1112 <path 1113 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1114 stroke="#9B9B9B" 1115 stroke-linecap="round" 1116 stroke-linejoin="round" 1117 stroke-width="2" 1118 /> 1119 <path 1120 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1121 stroke="#9B9B9B" 1122 stroke-linecap="round" 1123 stroke-linejoin="round" 1124 stroke-width="2" 1125 /> 1126 </svg> 1127 </span> 1128 </a> 1129 </div> 1130 </h3> 1131 <h4 1132 class=" css-1j2s5xo-h4-h4-STYLES_H4" 1133 data-components-heading="true" 1134 data-heading="true" 1135 > 1136 <div 1137 class="css-1rh3o5q-STYLES_PERMALINK" 1138 > 1139 <span 1140 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1141 id="arguments-1" 1142 /> 1143 <a 1144 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1145 href="#arguments-1" 1146 > 1147 <span 1148 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1149 > 1150 Arguments 1151 </span> 1152 <span 1153 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1154 > 1155 <svg 1156 aria-label="permalink" 1157 class="anchor-icon" 1158 fill="none" 1159 height="24" 1160 viewBox="0 0 24 24" 1161 width="24" 1162 xmlns="http://www.w3.org/2000/svg" 1163 > 1164 <path 1165 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1166 stroke="#9B9B9B" 1167 stroke-linecap="round" 1168 stroke-linejoin="round" 1169 stroke-width="2" 1170 /> 1171 <path 1172 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1173 stroke="#9B9B9B" 1174 stroke-linecap="round" 1175 stroke-linejoin="round" 1176 stroke-width="2" 1177 /> 1178 </svg> 1179 </span> 1180 </a> 1181 </div> 1182 </h4> 1183 <ul 1184 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1185 data-text="true" 1186 > 1187 <li 1188 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 1189 > 1190 <strong 1191 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 1192 > 1193 options 1194 ( 1195 <code 1196 class="inline css-nuv12a-STYLES_INLINE_CODE" 1197 > 1198 <a 1199 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1200 href="/#appleauthenticationrefreshoptions" 1201 > 1202 AppleAuthenticationRefreshOptions 1203 </a> 1204 </code> 1205 ) 1206 </strong> 1207 </li> 1208 </ul> 1209 <div> 1210 <h4 1211 class=" css-1j2s5xo-h4-h4-STYLES_H4" 1212 data-components-heading="true" 1213 data-heading="true" 1214 > 1215 <div 1216 class="css-1rh3o5q-STYLES_PERMALINK" 1217 > 1218 <span 1219 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1220 id="returns-2" 1221 /> 1222 <a 1223 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1224 href="#returns-2" 1225 > 1226 <span 1227 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1228 > 1229 Returns 1230 </span> 1231 <span 1232 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1233 > 1234 <svg 1235 aria-label="permalink" 1236 class="anchor-icon" 1237 fill="none" 1238 height="24" 1239 viewBox="0 0 24 24" 1240 width="24" 1241 xmlns="http://www.w3.org/2000/svg" 1242 > 1243 <path 1244 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1245 stroke="#9B9B9B" 1246 stroke-linecap="round" 1247 stroke-linejoin="round" 1248 stroke-width="2" 1249 /> 1250 <path 1251 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1252 stroke="#9B9B9B" 1253 stroke-linecap="round" 1254 stroke-linejoin="round" 1255 stroke-width="2" 1256 /> 1257 </svg> 1258 </span> 1259 </a> 1260 </div> 1261 </h4> 1262 <ul 1263 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1264 data-text="true" 1265 > 1266 <li 1267 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 1268 > 1269 <code 1270 class="inline css-nuv12a-STYLES_INLINE_CODE" 1271 > 1272 <a 1273 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1274 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1275 rel="noopener noreferrer" 1276 > 1277 Promise 1278 </a> 1279 < 1280 <span> 1281 <a 1282 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1283 href="/#appleauthenticationcredential" 1284 > 1285 AppleAuthenticationCredential 1286 </a> 1287 </span> 1288 > 1289 </code> 1290 </li> 1291 </ul> 1292 </div> 1293 <hr /> 1294 </div> 1295 <div> 1296 <h3 1297 class="css-icxoph-h3-h3-STYLES_H3" 1298 data-heading="true" 1299 > 1300 <div 1301 class="css-1rh3o5q-STYLES_PERMALINK" 1302 > 1303 <span 1304 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1305 id="signinasyncoptions" 1306 /> 1307 <a 1308 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1309 href="#signinasyncoptions" 1310 > 1311 <span 1312 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1313 > 1314 <code 1315 class="inline css-nuv12a-STYLES_INLINE_CODE" 1316 > 1317 signInAsync(options) 1318 </code> 1319 </span> 1320 <span 1321 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1322 > 1323 <svg 1324 aria-label="permalink" 1325 class="anchor-icon" 1326 fill="none" 1327 height="24" 1328 viewBox="0 0 24 24" 1329 width="24" 1330 xmlns="http://www.w3.org/2000/svg" 1331 > 1332 <path 1333 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1334 stroke="#9B9B9B" 1335 stroke-linecap="round" 1336 stroke-linejoin="round" 1337 stroke-width="2" 1338 /> 1339 <path 1340 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1341 stroke="#9B9B9B" 1342 stroke-linecap="round" 1343 stroke-linejoin="round" 1344 stroke-width="2" 1345 /> 1346 </svg> 1347 </span> 1348 </a> 1349 </div> 1350 </h3> 1351 <h4 1352 class=" css-1j2s5xo-h4-h4-STYLES_H4" 1353 data-components-heading="true" 1354 data-heading="true" 1355 > 1356 <div 1357 class="css-1rh3o5q-STYLES_PERMALINK" 1358 > 1359 <span 1360 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1361 id="arguments-2" 1362 /> 1363 <a 1364 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1365 href="#arguments-2" 1366 > 1367 <span 1368 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1369 > 1370 Arguments 1371 </span> 1372 <span 1373 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1374 > 1375 <svg 1376 aria-label="permalink" 1377 class="anchor-icon" 1378 fill="none" 1379 height="24" 1380 viewBox="0 0 24 24" 1381 width="24" 1382 xmlns="http://www.w3.org/2000/svg" 1383 > 1384 <path 1385 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1386 stroke="#9B9B9B" 1387 stroke-linecap="round" 1388 stroke-linejoin="round" 1389 stroke-width="2" 1390 /> 1391 <path 1392 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1393 stroke="#9B9B9B" 1394 stroke-linecap="round" 1395 stroke-linejoin="round" 1396 stroke-width="2" 1397 /> 1398 </svg> 1399 </span> 1400 </a> 1401 </div> 1402 </h4> 1403 <ul 1404 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1405 data-text="true" 1406 > 1407 <li 1408 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 1409 > 1410 <strong 1411 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 1412 > 1413 options 1414 ? 1415 ( 1416 <code 1417 class="inline css-nuv12a-STYLES_INLINE_CODE" 1418 > 1419 <a 1420 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1421 href="/#appleauthenticationsigninoptions" 1422 > 1423 AppleAuthenticationSignInOptions 1424 </a> 1425 </code> 1426 ) 1427 </strong> 1428 - 1429 <span> 1430 An optional 1431 <a 1432 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1433 href="/#appleauthenticationsigninoptions" 1434 > 1435 <code 1436 class="inline css-nuv12a-STYLES_INLINE_CODE" 1437 > 1438 AppleAuthenticationSignInOptions 1439 </code> 1440 </a> 1441 object 1442 </span> 1443 </li> 1444 </ul> 1445 <p 1446 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 1447 data-text="true" 1448 > 1449 Sends a request to the operating system to initiate the Apple authentication flow, which will 1450present a modal to the user over your app and allow them to sign in. 1451 </p> 1452 <p 1453 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 1454 data-text="true" 1455 > 1456 You can request access to the user's full name and email address in this method, which allows you 1457to personalize your UI for signed in users. However, users can deny access to either or both 1458of these options at runtime. 1459 </p> 1460 1461 1462 <p 1463 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 1464 data-text="true" 1465 > 1466 Additionally, you will only receive Apple Authentication Credentials the first time users sign 1467into your app, so you must store it for later use. It's best to store this information either 1468server-side, or using 1469 <a 1470 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1471 href="/securestore" 1472 > 1473 SecureStore 1474 </a> 1475 , so that the data persists across app installs. 1476You can use 1477 <a 1478 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1479 href="/#appleauthenticationcredential" 1480 > 1481 <code 1482 class="inline css-nuv12a-STYLES_INLINE_CODE" 1483 > 1484 AppleAuthenticationCredential.user 1485 </code> 1486 </a> 1487 to identify 1488the user, since this remains the same for apps released by the same developer. 1489 </p> 1490 <div> 1491 <h4 1492 class=" css-1j2s5xo-h4-h4-STYLES_H4" 1493 data-components-heading="true" 1494 data-heading="true" 1495 > 1496 <div 1497 class="css-1rh3o5q-STYLES_PERMALINK" 1498 > 1499 <span 1500 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1501 id="returns-3" 1502 /> 1503 <a 1504 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1505 href="#returns-3" 1506 > 1507 <span 1508 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1509 > 1510 Returns 1511 </span> 1512 <span 1513 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1514 > 1515 <svg 1516 aria-label="permalink" 1517 class="anchor-icon" 1518 fill="none" 1519 height="24" 1520 viewBox="0 0 24 24" 1521 width="24" 1522 xmlns="http://www.w3.org/2000/svg" 1523 > 1524 <path 1525 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1526 stroke="#9B9B9B" 1527 stroke-linecap="round" 1528 stroke-linejoin="round" 1529 stroke-width="2" 1530 /> 1531 <path 1532 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1533 stroke="#9B9B9B" 1534 stroke-linecap="round" 1535 stroke-linejoin="round" 1536 stroke-width="2" 1537 /> 1538 </svg> 1539 </span> 1540 </a> 1541 </div> 1542 </h4> 1543 <ul 1544 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1545 data-text="true" 1546 > 1547 <li 1548 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 1549 > 1550 <code 1551 class="inline css-nuv12a-STYLES_INLINE_CODE" 1552 > 1553 <a 1554 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1555 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1556 rel="noopener noreferrer" 1557 > 1558 Promise 1559 </a> 1560 < 1561 <span> 1562 <a 1563 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1564 href="/#appleauthenticationcredential" 1565 > 1566 AppleAuthenticationCredential 1567 </a> 1568 </span> 1569 > 1570 </code> 1571 </li> 1572 </ul> 1573 <p 1574 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 1575 data-text="true" 1576 > 1577 A promise that fulfills with an 1578 <a 1579 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1580 href="/#appleauthenticationcredential" 1581 > 1582 <code 1583 class="inline css-nuv12a-STYLES_INLINE_CODE" 1584 > 1585 AppleAuthenticationCredential 1586 </code> 1587 </a> 1588 1589object after a successful authentication, and rejects with 1590 <code 1591 class="inline css-nuv12a-STYLES_INLINE_CODE" 1592 > 1593 ERR_CANCELED 1594 </code> 1595 if the user cancels the 1596sign-in operation. 1597 </p> 1598 </div> 1599 <hr /> 1600 </div> 1601 <div> 1602 <h3 1603 class="css-icxoph-h3-h3-STYLES_H3" 1604 data-heading="true" 1605 > 1606 <div 1607 class="css-1rh3o5q-STYLES_PERMALINK" 1608 > 1609 <span 1610 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1611 id="signoutasyncoptions" 1612 /> 1613 <a 1614 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1615 href="#signoutasyncoptions" 1616 > 1617 <span 1618 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1619 > 1620 <code 1621 class="inline css-nuv12a-STYLES_INLINE_CODE" 1622 > 1623 signOutAsync(options) 1624 </code> 1625 </span> 1626 <span 1627 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1628 > 1629 <svg 1630 aria-label="permalink" 1631 class="anchor-icon" 1632 fill="none" 1633 height="24" 1634 viewBox="0 0 24 24" 1635 width="24" 1636 xmlns="http://www.w3.org/2000/svg" 1637 > 1638 <path 1639 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1640 stroke="#9B9B9B" 1641 stroke-linecap="round" 1642 stroke-linejoin="round" 1643 stroke-width="2" 1644 /> 1645 <path 1646 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1647 stroke="#9B9B9B" 1648 stroke-linecap="round" 1649 stroke-linejoin="round" 1650 stroke-width="2" 1651 /> 1652 </svg> 1653 </span> 1654 </a> 1655 </div> 1656 </h3> 1657 <h4 1658 class=" css-1j2s5xo-h4-h4-STYLES_H4" 1659 data-components-heading="true" 1660 data-heading="true" 1661 > 1662 <div 1663 class="css-1rh3o5q-STYLES_PERMALINK" 1664 > 1665 <span 1666 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1667 id="arguments-3" 1668 /> 1669 <a 1670 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1671 href="#arguments-3" 1672 > 1673 <span 1674 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1675 > 1676 Arguments 1677 </span> 1678 <span 1679 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1680 > 1681 <svg 1682 aria-label="permalink" 1683 class="anchor-icon" 1684 fill="none" 1685 height="24" 1686 viewBox="0 0 24 24" 1687 width="24" 1688 xmlns="http://www.w3.org/2000/svg" 1689 > 1690 <path 1691 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1692 stroke="#9B9B9B" 1693 stroke-linecap="round" 1694 stroke-linejoin="round" 1695 stroke-width="2" 1696 /> 1697 <path 1698 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1699 stroke="#9B9B9B" 1700 stroke-linecap="round" 1701 stroke-linejoin="round" 1702 stroke-width="2" 1703 /> 1704 </svg> 1705 </span> 1706 </a> 1707 </div> 1708 </h4> 1709 <ul 1710 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1711 data-text="true" 1712 > 1713 <li 1714 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 1715 > 1716 <strong 1717 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 1718 > 1719 options 1720 ( 1721 <code 1722 class="inline css-nuv12a-STYLES_INLINE_CODE" 1723 > 1724 <a 1725 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1726 href="/#appleauthenticationsignoutoptions" 1727 > 1728 AppleAuthenticationSignOutOptions 1729 </a> 1730 </code> 1731 ) 1732 </strong> 1733 </li> 1734 </ul> 1735 <div> 1736 <h4 1737 class=" css-1j2s5xo-h4-h4-STYLES_H4" 1738 data-components-heading="true" 1739 data-heading="true" 1740 > 1741 <div 1742 class="css-1rh3o5q-STYLES_PERMALINK" 1743 > 1744 <span 1745 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1746 id="returns-4" 1747 /> 1748 <a 1749 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1750 href="#returns-4" 1751 > 1752 <span 1753 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1754 > 1755 Returns 1756 </span> 1757 <span 1758 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1759 > 1760 <svg 1761 aria-label="permalink" 1762 class="anchor-icon" 1763 fill="none" 1764 height="24" 1765 viewBox="0 0 24 24" 1766 width="24" 1767 xmlns="http://www.w3.org/2000/svg" 1768 > 1769 <path 1770 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1771 stroke="#9B9B9B" 1772 stroke-linecap="round" 1773 stroke-linejoin="round" 1774 stroke-width="2" 1775 /> 1776 <path 1777 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1778 stroke="#9B9B9B" 1779 stroke-linecap="round" 1780 stroke-linejoin="round" 1781 stroke-width="2" 1782 /> 1783 </svg> 1784 </span> 1785 </a> 1786 </div> 1787 </h4> 1788 <ul 1789 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1790 data-text="true" 1791 > 1792 <li 1793 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 1794 > 1795 <code 1796 class="inline css-nuv12a-STYLES_INLINE_CODE" 1797 > 1798 <a 1799 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1800 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1801 rel="noopener noreferrer" 1802 > 1803 Promise 1804 </a> 1805 < 1806 <span> 1807 <a 1808 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 1809 href="/#appleauthenticationcredential" 1810 > 1811 AppleAuthenticationCredential 1812 </a> 1813 </span> 1814 > 1815 </code> 1816 </li> 1817 </ul> 1818 </div> 1819 </div> 1820 <h2 1821 class="css-1v5aebx-h2-h2-STYLES_H2" 1822 data-heading="true" 1823 > 1824 <div 1825 class="css-1rh3o5q-STYLES_PERMALINK" 1826 > 1827 <span 1828 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1829 id="event-subscriptions" 1830 /> 1831 <a 1832 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1833 href="#event-subscriptions" 1834 > 1835 <span 1836 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1837 > 1838 Event Subscriptions 1839 </span> 1840 <span 1841 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1842 > 1843 <svg 1844 aria-label="permalink" 1845 class="anchor-icon" 1846 fill="none" 1847 height="24" 1848 viewBox="0 0 24 24" 1849 width="24" 1850 xmlns="http://www.w3.org/2000/svg" 1851 > 1852 <path 1853 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1854 stroke="#9B9B9B" 1855 stroke-linecap="round" 1856 stroke-linejoin="round" 1857 stroke-width="2" 1858 /> 1859 <path 1860 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1861 stroke="#9B9B9B" 1862 stroke-linecap="round" 1863 stroke-linejoin="round" 1864 stroke-width="2" 1865 /> 1866 </svg> 1867 </span> 1868 </a> 1869 </div> 1870 </h2> 1871 <div> 1872 <h3 1873 class="css-icxoph-h3-h3-STYLES_H3" 1874 data-heading="true" 1875 > 1876 <div 1877 class="css-1rh3o5q-STYLES_PERMALINK" 1878 > 1879 <span 1880 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1881 id="addrevokelistenerlistener" 1882 /> 1883 <a 1884 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1885 href="#addrevokelistenerlistener" 1886 > 1887 <span 1888 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1889 > 1890 <code 1891 class="inline css-nuv12a-STYLES_INLINE_CODE" 1892 > 1893 addRevokeListener(listener) 1894 </code> 1895 </span> 1896 <span 1897 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1898 > 1899 <svg 1900 aria-label="permalink" 1901 class="anchor-icon" 1902 fill="none" 1903 height="24" 1904 viewBox="0 0 24 24" 1905 width="24" 1906 xmlns="http://www.w3.org/2000/svg" 1907 > 1908 <path 1909 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1910 stroke="#9B9B9B" 1911 stroke-linecap="round" 1912 stroke-linejoin="round" 1913 stroke-width="2" 1914 /> 1915 <path 1916 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1917 stroke="#9B9B9B" 1918 stroke-linecap="round" 1919 stroke-linejoin="round" 1920 stroke-width="2" 1921 /> 1922 </svg> 1923 </span> 1924 </a> 1925 </div> 1926 </h3> 1927 <h4 1928 class=" css-1j2s5xo-h4-h4-STYLES_H4" 1929 data-components-heading="true" 1930 data-heading="true" 1931 > 1932 <div 1933 class="css-1rh3o5q-STYLES_PERMALINK" 1934 > 1935 <span 1936 class="css-zonpcr-STYLES_PERMALINK_TARGET" 1937 id="arguments-4" 1938 /> 1939 <a 1940 class="css-15lh5hg-STYLES_PERMALINK_LINK" 1941 href="#arguments-4" 1942 > 1943 <span 1944 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 1945 > 1946 Arguments 1947 </span> 1948 <span 1949 class="css-10vdcw8-STYLES_PERMALINK_ICON" 1950 > 1951 <svg 1952 aria-label="permalink" 1953 class="anchor-icon" 1954 fill="none" 1955 height="24" 1956 viewBox="0 0 24 24" 1957 width="24" 1958 xmlns="http://www.w3.org/2000/svg" 1959 > 1960 <path 1961 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1962 stroke="#9B9B9B" 1963 stroke-linecap="round" 1964 stroke-linejoin="round" 1965 stroke-width="2" 1966 /> 1967 <path 1968 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1969 stroke="#9B9B9B" 1970 stroke-linecap="round" 1971 stroke-linejoin="round" 1972 stroke-width="2" 1973 /> 1974 </svg> 1975 </span> 1976 </a> 1977 </div> 1978 </h4> 1979 <ul 1980 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 1981 data-text="true" 1982 > 1983 <li 1984 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 1985 > 1986 <strong 1987 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 1988 > 1989 listener 1990 ( 1991 <code 1992 class="inline css-nuv12a-STYLES_INLINE_CODE" 1993 > 1994 () => 1995 1996 void 1997 </code> 1998 ) 1999 </strong> 2000 </li> 2001 </ul> 2002 <div> 2003 <h4 2004 class=" css-1j2s5xo-h4-h4-STYLES_H4" 2005 data-components-heading="true" 2006 data-heading="true" 2007 > 2008 <div 2009 class="css-1rh3o5q-STYLES_PERMALINK" 2010 > 2011 <span 2012 class="css-zonpcr-STYLES_PERMALINK_TARGET" 2013 id="returns-5" 2014 /> 2015 <a 2016 class="css-15lh5hg-STYLES_PERMALINK_LINK" 2017 href="#returns-5" 2018 > 2019 <span 2020 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 2021 > 2022 Returns 2023 </span> 2024 <span 2025 class="css-10vdcw8-STYLES_PERMALINK_ICON" 2026 > 2027 <svg 2028 aria-label="permalink" 2029 class="anchor-icon" 2030 fill="none" 2031 height="24" 2032 viewBox="0 0 24 24" 2033 width="24" 2034 xmlns="http://www.w3.org/2000/svg" 2035 > 2036 <path 2037 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2038 stroke="#9B9B9B" 2039 stroke-linecap="round" 2040 stroke-linejoin="round" 2041 stroke-width="2" 2042 /> 2043 <path 2044 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2045 stroke="#9B9B9B" 2046 stroke-linecap="round" 2047 stroke-linejoin="round" 2048 stroke-width="2" 2049 /> 2050 </svg> 2051 </span> 2052 </a> 2053 </div> 2054 </h4> 2055 <ul 2056 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 2057 data-text="true" 2058 > 2059 <li 2060 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 2061 > 2062 <code 2063 class="inline css-nuv12a-STYLES_INLINE_CODE" 2064 > 2065 <a 2066 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2067 href="/#subscription" 2068 > 2069 Subscription 2070 </a> 2071 </code> 2072 </li> 2073 </ul> 2074 </div> 2075 </div> 2076 <h2 2077 class="css-1v5aebx-h2-h2-STYLES_H2" 2078 data-heading="true" 2079 > 2080 <div 2081 class="css-1rh3o5q-STYLES_PERMALINK" 2082 > 2083 <span 2084 class="css-zonpcr-STYLES_PERMALINK_TARGET" 2085 id="types" 2086 /> 2087 <a 2088 class="css-15lh5hg-STYLES_PERMALINK_LINK" 2089 href="#types" 2090 > 2091 <span 2092 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 2093 > 2094 Types 2095 </span> 2096 <span 2097 class="css-10vdcw8-STYLES_PERMALINK_ICON" 2098 > 2099 <svg 2100 aria-label="permalink" 2101 class="anchor-icon" 2102 fill="none" 2103 height="24" 2104 viewBox="0 0 24 24" 2105 width="24" 2106 xmlns="http://www.w3.org/2000/svg" 2107 > 2108 <path 2109 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2110 stroke="#9B9B9B" 2111 stroke-linecap="round" 2112 stroke-linejoin="round" 2113 stroke-width="2" 2114 /> 2115 <path 2116 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2117 stroke="#9B9B9B" 2118 stroke-linecap="round" 2119 stroke-linejoin="round" 2120 stroke-width="2" 2121 /> 2122 </svg> 2123 </span> 2124 </a> 2125 </div> 2126 </h2> 2127 <div> 2128 <h3 2129 class="css-icxoph-h3-h3-STYLES_H3" 2130 data-heading="true" 2131 > 2132 <div 2133 class="css-1rh3o5q-STYLES_PERMALINK" 2134 > 2135 <span 2136 class="css-zonpcr-STYLES_PERMALINK_TARGET" 2137 id="appleauthenticationcredential" 2138 /> 2139 <a 2140 class="css-15lh5hg-STYLES_PERMALINK_LINK" 2141 href="#appleauthenticationcredential" 2142 > 2143 <span 2144 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 2145 > 2146 <code 2147 class="inline css-nuv12a-STYLES_INLINE_CODE" 2148 > 2149 AppleAuthenticationCredential 2150 2151 </code> 2152 </span> 2153 <span 2154 class="css-10vdcw8-STYLES_PERMALINK_ICON" 2155 > 2156 <svg 2157 aria-label="permalink" 2158 class="anchor-icon" 2159 fill="none" 2160 height="24" 2161 viewBox="0 0 24 24" 2162 width="24" 2163 xmlns="http://www.w3.org/2000/svg" 2164 > 2165 <path 2166 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2167 stroke="#9B9B9B" 2168 stroke-linecap="round" 2169 stroke-linejoin="round" 2170 stroke-width="2" 2171 /> 2172 <path 2173 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2174 stroke="#9B9B9B" 2175 stroke-linecap="round" 2176 stroke-linejoin="round" 2177 stroke-width="2" 2178 /> 2179 </svg> 2180 </span> 2181 </a> 2182 </div> 2183 </h3> 2184 <p 2185 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 2186 data-text="true" 2187 > 2188 The object type returned from a successful call to 2189 <a 2190 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2191 href="/#appleauthenticationsigninasyncoptions" 2192 > 2193 <code 2194 class="inline css-nuv12a-STYLES_INLINE_CODE" 2195 > 2196 AppleAuthentication.signInAsync() 2197 </code> 2198 </a> 2199 , 2200 2201 <a 2202 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2203 href="/#appleauthenticationrefreshasyncoptions" 2204 > 2205 <code 2206 class="inline css-nuv12a-STYLES_INLINE_CODE" 2207 > 2208 AppleAuthentication.refreshAsync() 2209 </code> 2210 </a> 2211 , or 2212 <a 2213 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2214 href="/#appleauthenticationsignoutasyncoptions" 2215 > 2216 <code 2217 class="inline css-nuv12a-STYLES_INLINE_CODE" 2218 > 2219 AppleAuthentication.signOutAsync() 2220 </code> 2221 </a> 2222 2223which contains all of the pertinent user and credential information. 2224 </p> 2225 <table> 2226 <thead> 2227 <tr> 2228 <th> 2229 Name 2230 </th> 2231 <th> 2232 Type 2233 </th> 2234 <th> 2235 Description 2236 </th> 2237 </tr> 2238 </thead> 2239 <tbody> 2240 <tr> 2241 <td> 2242 <strong 2243 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2244 > 2245 authorizationCode 2246 </strong> 2247 </td> 2248 <td> 2249 <code 2250 class="inline css-nuv12a-STYLES_INLINE_CODE" 2251 > 2252 <span> 2253 string 2254 | 2255 </span> 2256 <span> 2257 null 2258 </span> 2259 </code> 2260 </td> 2261 <td> 2262 <span> 2263 A short-lived session token used by your app for proof of authorization when interacting with 2264the app's server counterpart. Unlike 2265 <code 2266 class="inline css-nuv12a-STYLES_INLINE_CODE" 2267 > 2268 user 2269 </code> 2270 , this is ephemeral and will change each session. 2271 </span> 2272 </td> 2273 </tr> 2274 <tr> 2275 <td> 2276 <strong 2277 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2278 > 2279 email 2280 </strong> 2281 </td> 2282 <td> 2283 <code 2284 class="inline css-nuv12a-STYLES_INLINE_CODE" 2285 > 2286 <span> 2287 string 2288 | 2289 </span> 2290 <span> 2291 null 2292 </span> 2293 </code> 2294 </td> 2295 <td> 2296 <span> 2297 The user's email address. Might not be present if you didn't request the 2298 <code 2299 class="inline css-nuv12a-STYLES_INLINE_CODE" 2300 > 2301 EMAIL 2302 </code> 2303 scope. May 2304also be null if this is not the first time the user has signed into your app. If the user chose 2305to withhold their email address, this field will instead contain an obscured email address with 2306an Apple domain. 2307 </span> 2308 </td> 2309 </tr> 2310 <tr> 2311 <td> 2312 <strong 2313 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2314 > 2315 fullName 2316 </strong> 2317 </td> 2318 <td> 2319 <code 2320 class="inline css-nuv12a-STYLES_INLINE_CODE" 2321 > 2322 <span> 2323 <a 2324 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2325 href="/#appleauthenticationfullname" 2326 > 2327 AppleAuthenticationFullName 2328 </a> 2329 | 2330 </span> 2331 <span> 2332 null 2333 </span> 2334 </code> 2335 </td> 2336 <td> 2337 <span> 2338 The user's name. May be 2339 <code 2340 class="inline css-nuv12a-STYLES_INLINE_CODE" 2341 > 2342 null 2343 </code> 2344 or contain 2345 <code 2346 class="inline css-nuv12a-STYLES_INLINE_CODE" 2347 > 2348 null 2349 </code> 2350 values if you didn't request the 2351 <code 2352 class="inline css-nuv12a-STYLES_INLINE_CODE" 2353 > 2354 FULL_NAME 2355 </code> 2356 2357scope, if the user denied access, or if this is not the first time the user has signed into 2358your app. 2359 </span> 2360 </td> 2361 </tr> 2362 <tr> 2363 <td> 2364 <strong 2365 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2366 > 2367 identityToken 2368 </strong> 2369 </td> 2370 <td> 2371 <code 2372 class="inline css-nuv12a-STYLES_INLINE_CODE" 2373 > 2374 <span> 2375 string 2376 | 2377 </span> 2378 <span> 2379 null 2380 </span> 2381 </code> 2382 </td> 2383 <td> 2384 <span> 2385 A JSON Web Token (JWT) that securely communicates information about the user to your app. 2386 </span> 2387 </td> 2388 </tr> 2389 <tr> 2390 <td> 2391 <strong 2392 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2393 > 2394 realUserStatus 2395 </strong> 2396 </td> 2397 <td> 2398 <code 2399 class="inline css-nuv12a-STYLES_INLINE_CODE" 2400 > 2401 <a 2402 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2403 href="/#appleauthenticationuserdetectionstatus" 2404 > 2405 AppleAuthenticationUserDetectionStatus 2406 </a> 2407 </code> 2408 </td> 2409 <td> 2410 <span> 2411 A value that indicates whether the user appears to the system to be a real person. 2412 </span> 2413 </td> 2414 </tr> 2415 <tr> 2416 <td> 2417 <strong 2418 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2419 > 2420 state 2421 </strong> 2422 </td> 2423 <td> 2424 <code 2425 class="inline css-nuv12a-STYLES_INLINE_CODE" 2426 > 2427 <span> 2428 string 2429 | 2430 </span> 2431 <span> 2432 null 2433 </span> 2434 </code> 2435 </td> 2436 <td> 2437 <span> 2438 An arbitrary string that your app provided as 2439 <code 2440 class="inline css-nuv12a-STYLES_INLINE_CODE" 2441 > 2442 state 2443 </code> 2444 in the request that generated the 2445credential. Used to verify that the response was from the request you made. Can be used to 2446avoid replay attacks. If you did not provide 2447 <code 2448 class="inline css-nuv12a-STYLES_INLINE_CODE" 2449 > 2450 state 2451 </code> 2452 when making the sign-in request, this field 2453will be 2454 <code 2455 class="inline css-nuv12a-STYLES_INLINE_CODE" 2456 > 2457 null 2458 </code> 2459 . 2460 </span> 2461 </td> 2462 </tr> 2463 <tr> 2464 <td> 2465 <strong 2466 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2467 > 2468 user 2469 </strong> 2470 </td> 2471 <td> 2472 <code 2473 class="inline css-nuv12a-STYLES_INLINE_CODE" 2474 > 2475 string 2476 </code> 2477 </td> 2478 <td> 2479 <span> 2480 An identifier associated with the authenticated user. You can use this to check if the user is 2481still authenticated later. This is stable and can be shared across apps released under the same 2482development team. The same user will have a different identifier for apps released by other 2483developers. 2484 </span> 2485 </td> 2486 </tr> 2487 </tbody> 2488 </table> 2489 </div> 2490 <div> 2491 <h3 2492 class="css-icxoph-h3-h3-STYLES_H3" 2493 data-heading="true" 2494 > 2495 <div 2496 class="css-1rh3o5q-STYLES_PERMALINK" 2497 > 2498 <span 2499 class="css-zonpcr-STYLES_PERMALINK_TARGET" 2500 id="appleauthenticationfullname" 2501 /> 2502 <a 2503 class="css-15lh5hg-STYLES_PERMALINK_LINK" 2504 href="#appleauthenticationfullname" 2505 > 2506 <span 2507 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 2508 > 2509 <code 2510 class="inline css-nuv12a-STYLES_INLINE_CODE" 2511 > 2512 AppleAuthenticationFullName 2513 2514 </code> 2515 </span> 2516 <span 2517 class="css-10vdcw8-STYLES_PERMALINK_ICON" 2518 > 2519 <svg 2520 aria-label="permalink" 2521 class="anchor-icon" 2522 fill="none" 2523 height="24" 2524 viewBox="0 0 24 24" 2525 width="24" 2526 xmlns="http://www.w3.org/2000/svg" 2527 > 2528 <path 2529 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2530 stroke="#9B9B9B" 2531 stroke-linecap="round" 2532 stroke-linejoin="round" 2533 stroke-width="2" 2534 /> 2535 <path 2536 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2537 stroke="#9B9B9B" 2538 stroke-linecap="round" 2539 stroke-linejoin="round" 2540 stroke-width="2" 2541 /> 2542 </svg> 2543 </span> 2544 </a> 2545 </div> 2546 </h3> 2547 <p 2548 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 2549 data-text="true" 2550 > 2551 An object representing the tokenized portions of the user's full name. Any of all of the fields 2552may be 2553 <code 2554 class="inline css-nuv12a-STYLES_INLINE_CODE" 2555 > 2556 null 2557 </code> 2558 . Only applicable fields that the user has allowed your app to access will be nonnull. 2559 </p> 2560 <table> 2561 <thead> 2562 <tr> 2563 <th> 2564 Name 2565 </th> 2566 <th> 2567 Type 2568 </th> 2569 <th> 2570 Description 2571 </th> 2572 </tr> 2573 </thead> 2574 <tbody> 2575 <tr> 2576 <td> 2577 <strong 2578 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2579 > 2580 familyName 2581 </strong> 2582 </td> 2583 <td> 2584 <code 2585 class="inline css-nuv12a-STYLES_INLINE_CODE" 2586 > 2587 <span> 2588 string 2589 | 2590 </span> 2591 <span> 2592 null 2593 </span> 2594 </code> 2595 </td> 2596 <td> 2597 - 2598 </td> 2599 </tr> 2600 <tr> 2601 <td> 2602 <strong 2603 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2604 > 2605 givenName 2606 </strong> 2607 </td> 2608 <td> 2609 <code 2610 class="inline css-nuv12a-STYLES_INLINE_CODE" 2611 > 2612 <span> 2613 string 2614 | 2615 </span> 2616 <span> 2617 null 2618 </span> 2619 </code> 2620 </td> 2621 <td> 2622 - 2623 </td> 2624 </tr> 2625 <tr> 2626 <td> 2627 <strong 2628 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2629 > 2630 middleName 2631 </strong> 2632 </td> 2633 <td> 2634 <code 2635 class="inline css-nuv12a-STYLES_INLINE_CODE" 2636 > 2637 <span> 2638 string 2639 | 2640 </span> 2641 <span> 2642 null 2643 </span> 2644 </code> 2645 </td> 2646 <td> 2647 - 2648 </td> 2649 </tr> 2650 <tr> 2651 <td> 2652 <strong 2653 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2654 > 2655 namePrefix 2656 </strong> 2657 </td> 2658 <td> 2659 <code 2660 class="inline css-nuv12a-STYLES_INLINE_CODE" 2661 > 2662 <span> 2663 string 2664 | 2665 </span> 2666 <span> 2667 null 2668 </span> 2669 </code> 2670 </td> 2671 <td> 2672 - 2673 </td> 2674 </tr> 2675 <tr> 2676 <td> 2677 <strong 2678 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2679 > 2680 nameSuffix 2681 </strong> 2682 </td> 2683 <td> 2684 <code 2685 class="inline css-nuv12a-STYLES_INLINE_CODE" 2686 > 2687 <span> 2688 string 2689 | 2690 </span> 2691 <span> 2692 null 2693 </span> 2694 </code> 2695 </td> 2696 <td> 2697 - 2698 </td> 2699 </tr> 2700 <tr> 2701 <td> 2702 <strong 2703 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2704 > 2705 nickname 2706 </strong> 2707 </td> 2708 <td> 2709 <code 2710 class="inline css-nuv12a-STYLES_INLINE_CODE" 2711 > 2712 <span> 2713 string 2714 | 2715 </span> 2716 <span> 2717 null 2718 </span> 2719 </code> 2720 </td> 2721 <td> 2722 - 2723 </td> 2724 </tr> 2725 </tbody> 2726 </table> 2727 </div> 2728 <div> 2729 <h3 2730 class="css-icxoph-h3-h3-STYLES_H3" 2731 data-heading="true" 2732 > 2733 <div 2734 class="css-1rh3o5q-STYLES_PERMALINK" 2735 > 2736 <span 2737 class="css-zonpcr-STYLES_PERMALINK_TARGET" 2738 id="appleauthenticationrefreshoptions" 2739 /> 2740 <a 2741 class="css-15lh5hg-STYLES_PERMALINK_LINK" 2742 href="#appleauthenticationrefreshoptions" 2743 > 2744 <span 2745 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 2746 > 2747 <code 2748 class="inline css-nuv12a-STYLES_INLINE_CODE" 2749 > 2750 AppleAuthenticationRefreshOptions 2751 2752 </code> 2753 </span> 2754 <span 2755 class="css-10vdcw8-STYLES_PERMALINK_ICON" 2756 > 2757 <svg 2758 aria-label="permalink" 2759 class="anchor-icon" 2760 fill="none" 2761 height="24" 2762 viewBox="0 0 24 24" 2763 width="24" 2764 xmlns="http://www.w3.org/2000/svg" 2765 > 2766 <path 2767 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2768 stroke="#9B9B9B" 2769 stroke-linecap="round" 2770 stroke-linejoin="round" 2771 stroke-width="2" 2772 /> 2773 <path 2774 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2775 stroke="#9B9B9B" 2776 stroke-linecap="round" 2777 stroke-linejoin="round" 2778 stroke-width="2" 2779 /> 2780 </svg> 2781 </span> 2782 </a> 2783 </div> 2784 </h3> 2785 <p 2786 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 2787 data-text="true" 2788 > 2789 The options you can supply when making a call to 2790 <a 2791 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2792 href="/#appleauthenticationrefreshasyncoptions" 2793 > 2794 <code 2795 class="inline css-nuv12a-STYLES_INLINE_CODE" 2796 > 2797 AppleAuthentication.refreshAsync() 2798 </code> 2799 </a> 2800 . 2801You must include the ID string of the user whose credentials you'd like to refresh. 2802 </p> 2803 <table> 2804 <thead> 2805 <tr> 2806 <th> 2807 Name 2808 </th> 2809 <th> 2810 Type 2811 </th> 2812 <th> 2813 Description 2814 </th> 2815 </tr> 2816 </thead> 2817 <tbody> 2818 <tr> 2819 <td> 2820 <strong 2821 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2822 > 2823 requestedScopes 2824 </strong> 2825 <br /> 2826 <span 2827 class="css-fbbx5x-STYLES_OPTIONAL" 2828 > 2829 (optional) 2830 </span> 2831 </td> 2832 <td> 2833 <code 2834 class="inline css-nuv12a-STYLES_INLINE_CODE" 2835 > 2836 <a 2837 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2838 href="/#appleauthenticationscope" 2839 > 2840 AppleAuthenticationScope 2841 [] 2842 </a> 2843 </code> 2844 </td> 2845 <td> 2846 <span> 2847 Array of user information scopes to which your app is requesting access. Note that the user can 2848choose to deny your app access to any scope at the time of logging in. You will still need to 2849handle 2850 <code 2851 class="inline css-nuv12a-STYLES_INLINE_CODE" 2852 > 2853 null 2854 </code> 2855 values for any scopes you request. Additionally, note that the requested scopes 2856will only be provided to you the first time each user signs into your app; in subsequent 2857requests they will be 2858 <code 2859 class="inline css-nuv12a-STYLES_INLINE_CODE" 2860 > 2861 null 2862 </code> 2863 . Defaults to 2864 <code 2865 class="inline css-nuv12a-STYLES_INLINE_CODE" 2866 > 2867 [] 2868 </code> 2869 (no scopes). 2870 </span> 2871 </td> 2872 </tr> 2873 <tr> 2874 <td> 2875 <strong 2876 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2877 > 2878 state 2879 </strong> 2880 <br /> 2881 <span 2882 class="css-fbbx5x-STYLES_OPTIONAL" 2883 > 2884 (optional) 2885 </span> 2886 </td> 2887 <td> 2888 <code 2889 class="inline css-nuv12a-STYLES_INLINE_CODE" 2890 > 2891 string 2892 </code> 2893 </td> 2894 <td> 2895 <span> 2896 An arbitrary string that is returned unmodified in the corresponding credential after a 2897successful authentication. This can be used to verify that the response was from the request 2898you made and avoid replay attacks. More information on this property is available in the 2899OAuth 2.0 protocol 2900 <a 2901 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2902 href="https://tools.ietf.org/html/rfc6749#section-10.12" 2903 rel="noopener noreferrer" 2904 > 2905 RFC6749 2906 </a> 2907 . 2908 </span> 2909 </td> 2910 </tr> 2911 <tr> 2912 <td> 2913 <strong 2914 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 2915 > 2916 user 2917 </strong> 2918 </td> 2919 <td> 2920 <code 2921 class="inline css-nuv12a-STYLES_INLINE_CODE" 2922 > 2923 string 2924 </code> 2925 </td> 2926 <td> 2927 - 2928 </td> 2929 </tr> 2930 </tbody> 2931 </table> 2932 </div> 2933 <div> 2934 <h3 2935 class="css-icxoph-h3-h3-STYLES_H3" 2936 data-heading="true" 2937 > 2938 <div 2939 class="css-1rh3o5q-STYLES_PERMALINK" 2940 > 2941 <span 2942 class="css-zonpcr-STYLES_PERMALINK_TARGET" 2943 id="appleauthenticationsigninoptions" 2944 /> 2945 <a 2946 class="css-15lh5hg-STYLES_PERMALINK_LINK" 2947 href="#appleauthenticationsigninoptions" 2948 > 2949 <span 2950 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 2951 > 2952 <code 2953 class="inline css-nuv12a-STYLES_INLINE_CODE" 2954 > 2955 AppleAuthenticationSignInOptions 2956 2957 </code> 2958 </span> 2959 <span 2960 class="css-10vdcw8-STYLES_PERMALINK_ICON" 2961 > 2962 <svg 2963 aria-label="permalink" 2964 class="anchor-icon" 2965 fill="none" 2966 height="24" 2967 viewBox="0 0 24 24" 2968 width="24" 2969 xmlns="http://www.w3.org/2000/svg" 2970 > 2971 <path 2972 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2973 stroke="#9B9B9B" 2974 stroke-linecap="round" 2975 stroke-linejoin="round" 2976 stroke-width="2" 2977 /> 2978 <path 2979 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2980 stroke="#9B9B9B" 2981 stroke-linecap="round" 2982 stroke-linejoin="round" 2983 stroke-width="2" 2984 /> 2985 </svg> 2986 </span> 2987 </a> 2988 </div> 2989 </h3> 2990 <p 2991 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 2992 data-text="true" 2993 > 2994 The options you can supply when making a call to 2995 <a 2996 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 2997 href="/#appleauthenticationsigninasyncoptions" 2998 > 2999 <code 3000 class="inline css-nuv12a-STYLES_INLINE_CODE" 3001 > 3002 AppleAuthentication.signInAsync() 3003 </code> 3004 </a> 3005 . 3006None of these options are required. 3007 </p> 3008 <table> 3009 <thead> 3010 <tr> 3011 <th> 3012 Name 3013 </th> 3014 <th> 3015 Type 3016 </th> 3017 <th> 3018 Description 3019 </th> 3020 </tr> 3021 </thead> 3022 <tbody> 3023 <tr> 3024 <td> 3025 <strong 3026 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 3027 > 3028 nonce 3029 </strong> 3030 <br /> 3031 <span 3032 class="css-fbbx5x-STYLES_OPTIONAL" 3033 > 3034 (optional) 3035 </span> 3036 </td> 3037 <td> 3038 <code 3039 class="inline css-nuv12a-STYLES_INLINE_CODE" 3040 > 3041 string 3042 </code> 3043 </td> 3044 <td> 3045 <span> 3046 An arbitrary string that is used to prevent replay attacks. See more information on this in the 3047 3048 <a 3049 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3050 href="https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowSteps" 3051 rel="noopener noreferrer" 3052 > 3053 OpenID Connect specification 3054 </a> 3055 . 3056 </span> 3057 </td> 3058 </tr> 3059 <tr> 3060 <td> 3061 <strong 3062 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 3063 > 3064 requestedScopes 3065 </strong> 3066 <br /> 3067 <span 3068 class="css-fbbx5x-STYLES_OPTIONAL" 3069 > 3070 (optional) 3071 </span> 3072 </td> 3073 <td> 3074 <code 3075 class="inline css-nuv12a-STYLES_INLINE_CODE" 3076 > 3077 <a 3078 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3079 href="/#appleauthenticationscope" 3080 > 3081 AppleAuthenticationScope 3082 [] 3083 </a> 3084 </code> 3085 </td> 3086 <td> 3087 <span> 3088 Array of user information scopes to which your app is requesting access. Note that the user can 3089choose to deny your app access to any scope at the time of logging in. You will still need to 3090handle 3091 <code 3092 class="inline css-nuv12a-STYLES_INLINE_CODE" 3093 > 3094 null 3095 </code> 3096 values for any scopes you request. Additionally, note that the requested scopes 3097will only be provided to you the first time each user signs into your app; in subsequent 3098requests they will be 3099 <code 3100 class="inline css-nuv12a-STYLES_INLINE_CODE" 3101 > 3102 null 3103 </code> 3104 . Defaults to 3105 <code 3106 class="inline css-nuv12a-STYLES_INLINE_CODE" 3107 > 3108 [] 3109 </code> 3110 (no scopes). 3111 </span> 3112 </td> 3113 </tr> 3114 <tr> 3115 <td> 3116 <strong 3117 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 3118 > 3119 state 3120 </strong> 3121 <br /> 3122 <span 3123 class="css-fbbx5x-STYLES_OPTIONAL" 3124 > 3125 (optional) 3126 </span> 3127 </td> 3128 <td> 3129 <code 3130 class="inline css-nuv12a-STYLES_INLINE_CODE" 3131 > 3132 string 3133 </code> 3134 </td> 3135 <td> 3136 <span> 3137 An arbitrary string that is returned unmodified in the corresponding credential after a 3138successful authentication. This can be used to verify that the response was from the request 3139you made and avoid replay attacks. More information on this property is available in the 3140OAuth 2.0 protocol 3141 <a 3142 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3143 href="https://tools.ietf.org/html/rfc6749#section-10.12" 3144 rel="noopener noreferrer" 3145 > 3146 RFC6749 3147 </a> 3148 . 3149 </span> 3150 </td> 3151 </tr> 3152 </tbody> 3153 </table> 3154 </div> 3155 <div> 3156 <h3 3157 class="css-icxoph-h3-h3-STYLES_H3" 3158 data-heading="true" 3159 > 3160 <div 3161 class="css-1rh3o5q-STYLES_PERMALINK" 3162 > 3163 <span 3164 class="css-zonpcr-STYLES_PERMALINK_TARGET" 3165 id="appleauthenticationsignoutoptions" 3166 /> 3167 <a 3168 class="css-15lh5hg-STYLES_PERMALINK_LINK" 3169 href="#appleauthenticationsignoutoptions" 3170 > 3171 <span 3172 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 3173 > 3174 <code 3175 class="inline css-nuv12a-STYLES_INLINE_CODE" 3176 > 3177 AppleAuthenticationSignOutOptions 3178 3179 </code> 3180 </span> 3181 <span 3182 class="css-10vdcw8-STYLES_PERMALINK_ICON" 3183 > 3184 <svg 3185 aria-label="permalink" 3186 class="anchor-icon" 3187 fill="none" 3188 height="24" 3189 viewBox="0 0 24 24" 3190 width="24" 3191 xmlns="http://www.w3.org/2000/svg" 3192 > 3193 <path 3194 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3195 stroke="#9B9B9B" 3196 stroke-linecap="round" 3197 stroke-linejoin="round" 3198 stroke-width="2" 3199 /> 3200 <path 3201 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3202 stroke="#9B9B9B" 3203 stroke-linecap="round" 3204 stroke-linejoin="round" 3205 stroke-width="2" 3206 /> 3207 </svg> 3208 </span> 3209 </a> 3210 </div> 3211 </h3> 3212 <p 3213 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 3214 data-text="true" 3215 > 3216 The options you can supply when making a call to 3217 <a 3218 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3219 href="/#appleauthenticationsignoutasyncoptions" 3220 > 3221 <code 3222 class="inline css-nuv12a-STYLES_INLINE_CODE" 3223 > 3224 AppleAuthentication.signOutAsync() 3225 </code> 3226 </a> 3227 . 3228You must include the ID string of the user to sign out. 3229 </p> 3230 <table> 3231 <thead> 3232 <tr> 3233 <th> 3234 Name 3235 </th> 3236 <th> 3237 Type 3238 </th> 3239 <th> 3240 Description 3241 </th> 3242 </tr> 3243 </thead> 3244 <tbody> 3245 <tr> 3246 <td> 3247 <strong 3248 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 3249 > 3250 state 3251 </strong> 3252 <br /> 3253 <span 3254 class="css-fbbx5x-STYLES_OPTIONAL" 3255 > 3256 (optional) 3257 </span> 3258 </td> 3259 <td> 3260 <code 3261 class="inline css-nuv12a-STYLES_INLINE_CODE" 3262 > 3263 string 3264 </code> 3265 </td> 3266 <td> 3267 <span> 3268 An arbitrary string that is returned unmodified in the corresponding credential after a 3269successful authentication. This can be used to verify that the response was from the request 3270you made and avoid replay attacks. More information on this property is available in the 3271OAuth 2.0 protocol 3272 <a 3273 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3274 href="https://tools.ietf.org/html/rfc6749#section-10.12" 3275 rel="noopener noreferrer" 3276 > 3277 RFC6749 3278 </a> 3279 . 3280 </span> 3281 </td> 3282 </tr> 3283 <tr> 3284 <td> 3285 <strong 3286 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 3287 > 3288 user 3289 </strong> 3290 </td> 3291 <td> 3292 <code 3293 class="inline css-nuv12a-STYLES_INLINE_CODE" 3294 > 3295 string 3296 </code> 3297 </td> 3298 <td> 3299 - 3300 </td> 3301 </tr> 3302 </tbody> 3303 </table> 3304 </div> 3305 <div> 3306 <h3 3307 class="css-icxoph-h3-h3-STYLES_H3" 3308 data-heading="true" 3309 > 3310 <div 3311 class="css-1rh3o5q-STYLES_PERMALINK" 3312 > 3313 <span 3314 class="css-zonpcr-STYLES_PERMALINK_TARGET" 3315 id="subscription" 3316 /> 3317 <a 3318 class="css-15lh5hg-STYLES_PERMALINK_LINK" 3319 href="#subscription" 3320 > 3321 <span 3322 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 3323 > 3324 <code 3325 class="inline css-nuv12a-STYLES_INLINE_CODE" 3326 > 3327 Subscription 3328 3329 </code> 3330 </span> 3331 <span 3332 class="css-10vdcw8-STYLES_PERMALINK_ICON" 3333 > 3334 <svg 3335 aria-label="permalink" 3336 class="anchor-icon" 3337 fill="none" 3338 height="24" 3339 viewBox="0 0 24 24" 3340 width="24" 3341 xmlns="http://www.w3.org/2000/svg" 3342 > 3343 <path 3344 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3345 stroke="#9B9B9B" 3346 stroke-linecap="round" 3347 stroke-linejoin="round" 3348 stroke-width="2" 3349 /> 3350 <path 3351 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3352 stroke="#9B9B9B" 3353 stroke-linecap="round" 3354 stroke-linejoin="round" 3355 stroke-width="2" 3356 /> 3357 </svg> 3358 </span> 3359 </a> 3360 </div> 3361 </h3> 3362 <table> 3363 <thead> 3364 <tr> 3365 <th> 3366 Name 3367 </th> 3368 <th> 3369 Type 3370 </th> 3371 <th> 3372 Description 3373 </th> 3374 </tr> 3375 </thead> 3376 <tbody> 3377 <tr> 3378 <td> 3379 <strong 3380 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 3381 > 3382 remove 3383 </strong> 3384 </td> 3385 <td> 3386 <code 3387 class="inline css-nuv12a-STYLES_INLINE_CODE" 3388 > 3389 ( 3390 3391 ) => 3392 void 3393 </code> 3394 </td> 3395 <td> 3396 <span> 3397 A method to unsubscribe the listener. 3398 </span> 3399 </td> 3400 </tr> 3401 </tbody> 3402 </table> 3403 </div> 3404 <h2 3405 class="css-1v5aebx-h2-h2-STYLES_H2" 3406 data-heading="true" 3407 > 3408 <div 3409 class="css-1rh3o5q-STYLES_PERMALINK" 3410 > 3411 <span 3412 class="css-zonpcr-STYLES_PERMALINK_TARGET" 3413 id="enums" 3414 /> 3415 <a 3416 class="css-15lh5hg-STYLES_PERMALINK_LINK" 3417 href="#enums" 3418 > 3419 <span 3420 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 3421 > 3422 Enums 3423 </span> 3424 <span 3425 class="css-10vdcw8-STYLES_PERMALINK_ICON" 3426 > 3427 <svg 3428 aria-label="permalink" 3429 class="anchor-icon" 3430 fill="none" 3431 height="24" 3432 viewBox="0 0 24 24" 3433 width="24" 3434 xmlns="http://www.w3.org/2000/svg" 3435 > 3436 <path 3437 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3438 stroke="#9B9B9B" 3439 stroke-linecap="round" 3440 stroke-linejoin="round" 3441 stroke-width="2" 3442 /> 3443 <path 3444 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3445 stroke="#9B9B9B" 3446 stroke-linecap="round" 3447 stroke-linejoin="round" 3448 stroke-width="2" 3449 /> 3450 </svg> 3451 </span> 3452 </a> 3453 </div> 3454 </h2> 3455 <div> 3456 <h3 3457 class="css-icxoph-h3-h3-STYLES_H3" 3458 data-heading="true" 3459 > 3460 <div 3461 class="css-1rh3o5q-STYLES_PERMALINK" 3462 > 3463 <span 3464 class="css-zonpcr-STYLES_PERMALINK_TARGET" 3465 id="appleauthenticationbuttonstyle" 3466 /> 3467 <a 3468 class="css-15lh5hg-STYLES_PERMALINK_LINK" 3469 href="#appleauthenticationbuttonstyle" 3470 > 3471 <span 3472 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 3473 > 3474 <code 3475 class="inline css-nuv12a-STYLES_INLINE_CODE" 3476 > 3477 AppleAuthenticationButtonStyle 3478 </code> 3479 </span> 3480 <span 3481 class="css-10vdcw8-STYLES_PERMALINK_ICON" 3482 > 3483 <svg 3484 aria-label="permalink" 3485 class="anchor-icon" 3486 fill="none" 3487 height="24" 3488 viewBox="0 0 24 24" 3489 width="24" 3490 xmlns="http://www.w3.org/2000/svg" 3491 > 3492 <path 3493 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3494 stroke="#9B9B9B" 3495 stroke-linecap="round" 3496 stroke-linejoin="round" 3497 stroke-width="2" 3498 /> 3499 <path 3500 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3501 stroke="#9B9B9B" 3502 stroke-linecap="round" 3503 stroke-linejoin="round" 3504 stroke-width="2" 3505 /> 3506 </svg> 3507 </span> 3508 </a> 3509 </div> 3510 </h3> 3511 <p 3512 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 3513 data-text="true" 3514 > 3515 An enum whose values control which pre-defined color scheme to use when rendering an 3516 <a 3517 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3518 href="/#appleauthenticationappleauthenticationbutton" 3519 > 3520 <code 3521 class="inline css-nuv12a-STYLES_INLINE_CODE" 3522 > 3523 AppleAuthenticationButton 3524 </code> 3525 </a> 3526 . 3527 </p> 3528 <ul 3529 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 3530 data-text="true" 3531 > 3532 <li 3533 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3534 > 3535 <code 3536 class="inline css-nuv12a-STYLES_INLINE_CODE" 3537 > 3538 AppleAuthenticationButtonStyle 3539 . 3540 WHITE 3541 </code> 3542 : 3543 <code 3544 class="inline css-nuv12a-STYLES_INLINE_CODE" 3545 > 3546 0 3547 </code> 3548 - 3549 <span> 3550 White button with black text. 3551 </span> 3552 </li> 3553 <li 3554 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3555 > 3556 <code 3557 class="inline css-nuv12a-STYLES_INLINE_CODE" 3558 > 3559 AppleAuthenticationButtonStyle 3560 . 3561 WHITE_OUTLINE 3562 </code> 3563 : 3564 <code 3565 class="inline css-nuv12a-STYLES_INLINE_CODE" 3566 > 3567 1 3568 </code> 3569 - 3570 <span> 3571 White button with a black outline and black text. 3572 </span> 3573 </li> 3574 <li 3575 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3576 > 3577 <code 3578 class="inline css-nuv12a-STYLES_INLINE_CODE" 3579 > 3580 AppleAuthenticationButtonStyle 3581 . 3582 BLACK 3583 </code> 3584 : 3585 <code 3586 class="inline css-nuv12a-STYLES_INLINE_CODE" 3587 > 3588 2 3589 </code> 3590 - 3591 <span> 3592 Black button with white text. 3593 </span> 3594 </li> 3595 </ul> 3596 </div> 3597 <div> 3598 <h3 3599 class="css-icxoph-h3-h3-STYLES_H3" 3600 data-heading="true" 3601 > 3602 <div 3603 class="css-1rh3o5q-STYLES_PERMALINK" 3604 > 3605 <span 3606 class="css-zonpcr-STYLES_PERMALINK_TARGET" 3607 id="appleauthenticationbuttontype" 3608 /> 3609 <a 3610 class="css-15lh5hg-STYLES_PERMALINK_LINK" 3611 href="#appleauthenticationbuttontype" 3612 > 3613 <span 3614 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 3615 > 3616 <code 3617 class="inline css-nuv12a-STYLES_INLINE_CODE" 3618 > 3619 AppleAuthenticationButtonType 3620 </code> 3621 </span> 3622 <span 3623 class="css-10vdcw8-STYLES_PERMALINK_ICON" 3624 > 3625 <svg 3626 aria-label="permalink" 3627 class="anchor-icon" 3628 fill="none" 3629 height="24" 3630 viewBox="0 0 24 24" 3631 width="24" 3632 xmlns="http://www.w3.org/2000/svg" 3633 > 3634 <path 3635 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3636 stroke="#9B9B9B" 3637 stroke-linecap="round" 3638 stroke-linejoin="round" 3639 stroke-width="2" 3640 /> 3641 <path 3642 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3643 stroke="#9B9B9B" 3644 stroke-linecap="round" 3645 stroke-linejoin="round" 3646 stroke-width="2" 3647 /> 3648 </svg> 3649 </span> 3650 </a> 3651 </div> 3652 </h3> 3653 <p 3654 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 3655 data-text="true" 3656 > 3657 An enum whose values control which pre-defined text to use when rendering an 3658 <a 3659 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3660 href="/#appleauthenticationappleauthenticationbutton" 3661 > 3662 <code 3663 class="inline css-nuv12a-STYLES_INLINE_CODE" 3664 > 3665 AppleAuthenticationButton 3666 </code> 3667 </a> 3668 . 3669 </p> 3670 <ul 3671 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 3672 data-text="true" 3673 > 3674 <li 3675 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3676 > 3677 <code 3678 class="inline css-nuv12a-STYLES_INLINE_CODE" 3679 > 3680 AppleAuthenticationButtonType 3681 . 3682 SIGN_IN 3683 </code> 3684 : 3685 <code 3686 class="inline css-nuv12a-STYLES_INLINE_CODE" 3687 > 3688 0 3689 </code> 3690 - 3691 <span> 3692 "Sign in with Apple" 3693 </span> 3694 </li> 3695 <li 3696 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3697 > 3698 <code 3699 class="inline css-nuv12a-STYLES_INLINE_CODE" 3700 > 3701 AppleAuthenticationButtonType 3702 . 3703 CONTINUE 3704 </code> 3705 : 3706 <code 3707 class="inline css-nuv12a-STYLES_INLINE_CODE" 3708 > 3709 1 3710 </code> 3711 - 3712 <span> 3713 "Continue with Apple" 3714 </span> 3715 </li> 3716 <li 3717 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3718 > 3719 <code 3720 class="inline css-nuv12a-STYLES_INLINE_CODE" 3721 > 3722 AppleAuthenticationButtonType 3723 . 3724 SIGN_UP 3725 </code> 3726 : 3727 <code 3728 class="inline css-nuv12a-STYLES_INLINE_CODE" 3729 > 3730 2 3731 </code> 3732 - 3733 <span> 3734 "Sign up with Apple" 3735 <em> 3736 (requires iOS 13.2 or higher) 3737 </em> 3738 </span> 3739 </li> 3740 </ul> 3741 </div> 3742 <div> 3743 <h3 3744 class="css-icxoph-h3-h3-STYLES_H3" 3745 data-heading="true" 3746 > 3747 <div 3748 class="css-1rh3o5q-STYLES_PERMALINK" 3749 > 3750 <span 3751 class="css-zonpcr-STYLES_PERMALINK_TARGET" 3752 id="appleauthenticationcredentialstate" 3753 /> 3754 <a 3755 class="css-15lh5hg-STYLES_PERMALINK_LINK" 3756 href="#appleauthenticationcredentialstate" 3757 > 3758 <span 3759 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 3760 > 3761 <code 3762 class="inline css-nuv12a-STYLES_INLINE_CODE" 3763 > 3764 AppleAuthenticationCredentialState 3765 </code> 3766 </span> 3767 <span 3768 class="css-10vdcw8-STYLES_PERMALINK_ICON" 3769 > 3770 <svg 3771 aria-label="permalink" 3772 class="anchor-icon" 3773 fill="none" 3774 height="24" 3775 viewBox="0 0 24 24" 3776 width="24" 3777 xmlns="http://www.w3.org/2000/svg" 3778 > 3779 <path 3780 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3781 stroke="#9B9B9B" 3782 stroke-linecap="round" 3783 stroke-linejoin="round" 3784 stroke-width="2" 3785 /> 3786 <path 3787 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3788 stroke="#9B9B9B" 3789 stroke-linecap="round" 3790 stroke-linejoin="round" 3791 stroke-width="2" 3792 /> 3793 </svg> 3794 </span> 3795 </a> 3796 </div> 3797 </h3> 3798 <p 3799 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 3800 data-text="true" 3801 > 3802 An enum whose values specify state of the credential when checked with 3803 <a 3804 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 3805 href="/#appleauthenticationgetcredentialstateasyncuser" 3806 > 3807 <code 3808 class="inline css-nuv12a-STYLES_INLINE_CODE" 3809 > 3810 AppleAuthentication.getCredentialStateAsync() 3811 </code> 3812 </a> 3813 . 3814 </p> 3815 <ul 3816 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 3817 data-text="true" 3818 > 3819 <li 3820 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3821 > 3822 <code 3823 class="inline css-nuv12a-STYLES_INLINE_CODE" 3824 > 3825 AppleAuthenticationCredentialState 3826 . 3827 REVOKED 3828 </code> 3829 : 3830 <code 3831 class="inline css-nuv12a-STYLES_INLINE_CODE" 3832 > 3833 0 3834 </code> 3835 </li> 3836 <li 3837 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3838 > 3839 <code 3840 class="inline css-nuv12a-STYLES_INLINE_CODE" 3841 > 3842 AppleAuthenticationCredentialState 3843 . 3844 AUTHORIZED 3845 </code> 3846 : 3847 <code 3848 class="inline css-nuv12a-STYLES_INLINE_CODE" 3849 > 3850 1 3851 </code> 3852 </li> 3853 <li 3854 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3855 > 3856 <code 3857 class="inline css-nuv12a-STYLES_INLINE_CODE" 3858 > 3859 AppleAuthenticationCredentialState 3860 . 3861 NOT_FOUND 3862 </code> 3863 : 3864 <code 3865 class="inline css-nuv12a-STYLES_INLINE_CODE" 3866 > 3867 2 3868 </code> 3869 </li> 3870 <li 3871 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3872 > 3873 <code 3874 class="inline css-nuv12a-STYLES_INLINE_CODE" 3875 > 3876 AppleAuthenticationCredentialState 3877 . 3878 TRANSFERRED 3879 </code> 3880 : 3881 <code 3882 class="inline css-nuv12a-STYLES_INLINE_CODE" 3883 > 3884 3 3885 </code> 3886 </li> 3887 </ul> 3888 </div> 3889 <div> 3890 <h3 3891 class="css-icxoph-h3-h3-STYLES_H3" 3892 data-heading="true" 3893 > 3894 <div 3895 class="css-1rh3o5q-STYLES_PERMALINK" 3896 > 3897 <span 3898 class="css-zonpcr-STYLES_PERMALINK_TARGET" 3899 id="appleauthenticationoperation" 3900 /> 3901 <a 3902 class="css-15lh5hg-STYLES_PERMALINK_LINK" 3903 href="#appleauthenticationoperation" 3904 > 3905 <span 3906 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 3907 > 3908 <code 3909 class="inline css-nuv12a-STYLES_INLINE_CODE" 3910 > 3911 AppleAuthenticationOperation 3912 </code> 3913 </span> 3914 <span 3915 class="css-10vdcw8-STYLES_PERMALINK_ICON" 3916 > 3917 <svg 3918 aria-label="permalink" 3919 class="anchor-icon" 3920 fill="none" 3921 height="24" 3922 viewBox="0 0 24 24" 3923 width="24" 3924 xmlns="http://www.w3.org/2000/svg" 3925 > 3926 <path 3927 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3928 stroke="#9B9B9B" 3929 stroke-linecap="round" 3930 stroke-linejoin="round" 3931 stroke-width="2" 3932 /> 3933 <path 3934 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3935 stroke="#9B9B9B" 3936 stroke-linecap="round" 3937 stroke-linejoin="round" 3938 stroke-width="2" 3939 /> 3940 </svg> 3941 </span> 3942 </a> 3943 </div> 3944 </h3> 3945 <ul 3946 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 3947 data-text="true" 3948 > 3949 <li 3950 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3951 > 3952 <code 3953 class="inline css-nuv12a-STYLES_INLINE_CODE" 3954 > 3955 AppleAuthenticationOperation 3956 . 3957 IMPLICIT 3958 </code> 3959 : 3960 <code 3961 class="inline css-nuv12a-STYLES_INLINE_CODE" 3962 > 3963 0 3964 </code> 3965 - 3966 <span> 3967 An operation that depends on the particular kind of credential provider. 3968 </span> 3969 </li> 3970 <li 3971 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3972 > 3973 <code 3974 class="inline css-nuv12a-STYLES_INLINE_CODE" 3975 > 3976 AppleAuthenticationOperation 3977 . 3978 LOGIN 3979 </code> 3980 : 3981 <code 3982 class="inline css-nuv12a-STYLES_INLINE_CODE" 3983 > 3984 1 3985 </code> 3986 </li> 3987 <li 3988 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 3989 > 3990 <code 3991 class="inline css-nuv12a-STYLES_INLINE_CODE" 3992 > 3993 AppleAuthenticationOperation 3994 . 3995 REFRESH 3996 </code> 3997 : 3998 <code 3999 class="inline css-nuv12a-STYLES_INLINE_CODE" 4000 > 4001 2 4002 </code> 4003 </li> 4004 <li 4005 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4006 > 4007 <code 4008 class="inline css-nuv12a-STYLES_INLINE_CODE" 4009 > 4010 AppleAuthenticationOperation 4011 . 4012 LOGOUT 4013 </code> 4014 : 4015 <code 4016 class="inline css-nuv12a-STYLES_INLINE_CODE" 4017 > 4018 3 4019 </code> 4020 </li> 4021 </ul> 4022 </div> 4023 <div> 4024 <h3 4025 class="css-icxoph-h3-h3-STYLES_H3" 4026 data-heading="true" 4027 > 4028 <div 4029 class="css-1rh3o5q-STYLES_PERMALINK" 4030 > 4031 <span 4032 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4033 id="appleauthenticationscope" 4034 /> 4035 <a 4036 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4037 href="#appleauthenticationscope" 4038 > 4039 <span 4040 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4041 > 4042 <code 4043 class="inline css-nuv12a-STYLES_INLINE_CODE" 4044 > 4045 AppleAuthenticationScope 4046 </code> 4047 </span> 4048 <span 4049 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4050 > 4051 <svg 4052 aria-label="permalink" 4053 class="anchor-icon" 4054 fill="none" 4055 height="24" 4056 viewBox="0 0 24 24" 4057 width="24" 4058 xmlns="http://www.w3.org/2000/svg" 4059 > 4060 <path 4061 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4062 stroke="#9B9B9B" 4063 stroke-linecap="round" 4064 stroke-linejoin="round" 4065 stroke-width="2" 4066 /> 4067 <path 4068 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4069 stroke="#9B9B9B" 4070 stroke-linecap="round" 4071 stroke-linejoin="round" 4072 stroke-width="2" 4073 /> 4074 </svg> 4075 </span> 4076 </a> 4077 </div> 4078 </h3> 4079 <p 4080 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 4081 data-text="true" 4082 > 4083 An enum whose values specify scopes you can request when calling 4084 <a 4085 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4086 href="/#appleauthenticationsigninasyncoptions" 4087 > 4088 <code 4089 class="inline css-nuv12a-STYLES_INLINE_CODE" 4090 > 4091 AppleAuthentication.signInAsync() 4092 </code> 4093 </a> 4094 . 4095 </p> 4096 <blockquote 4097 class="css-e76wiv-paragraph-STYLES_BLOCKQUOTE" 4098 data-text="true" 4099 > 4100 <div> 4101 <div 4102 style="margin-top: 2px;" 4103 > 4104 <svg 4105 aria-label="check" 4106 fill="none" 4107 height="16" 4108 viewBox="0 0 24 24" 4109 width="16" 4110 xmlns="http://www.w3.org/2000/svg" 4111 > 4112 <path 4113 d="M12 0C5.373 0 0 5.373 0 12s5.373 12 12 12c6.628 0 12-5.373 12-12S18.628 0 12 0zm-.015 5.419c.269-.292.596-.44.973-.44.306 0 .575.11.776.317.203.207.306.472.306.786 0 .394-.137.745-.409 1.042-.279.306-.605.462-.968.462-.3 0-.566-.113-.768-.326-.201-.208-.304-.48-.304-.809 0-.401.133-.749.394-1.032zm1.999 11.305c-.995.936-1.705 1.52-2.17 1.784-.496.284-.905.423-1.25.423-.342 0-.621-.114-.83-.338-.202-.218-.305-.51-.305-.87 0-.92.521-3.058 1.595-6.534a1.47 1.47 0 00.042-.166c-.04.017-.087.041-.14.075-.088.055-.356.265-1.14 1.03a.334.334 0 01-.438.025l-.463-.358a.334.334 0 01-.043-.49c.722-.794 1.395-1.371 2.002-1.714.636-.358 1.173-.533 1.643-.533.303 0 .548.076.729.225.196.164.3.391.3.658 0 .175-.084.63-.697 2.686-.875 2.937-1.084 4.003-1.099 4.372.166-.098.558-.376 1.395-1.162a.334.334 0 01.462.003l.411.4a.334.334 0 01-.004.484z" 4114 fill="var(--expo-theme-icon-default)" 4115 /> 4116 </svg> 4117 </div> 4118 </div> 4119 <div> 4120 4121 4122 Note that it is possible that you will not be granted all of the scopes which you request. 4123You will still need to handle null values for any fields you request. 4124 4125 4126 </div> 4127 </blockquote> 4128 <ul 4129 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 4130 data-text="true" 4131 > 4132 <li 4133 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4134 > 4135 <code 4136 class="inline css-nuv12a-STYLES_INLINE_CODE" 4137 > 4138 AppleAuthenticationScope 4139 . 4140 FULL_NAME 4141 </code> 4142 : 4143 <code 4144 class="inline css-nuv12a-STYLES_INLINE_CODE" 4145 > 4146 0 4147 </code> 4148 </li> 4149 <li 4150 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4151 > 4152 <code 4153 class="inline css-nuv12a-STYLES_INLINE_CODE" 4154 > 4155 AppleAuthenticationScope 4156 . 4157 EMAIL 4158 </code> 4159 : 4160 <code 4161 class="inline css-nuv12a-STYLES_INLINE_CODE" 4162 > 4163 1 4164 </code> 4165 </li> 4166 </ul> 4167 </div> 4168 <div> 4169 <h3 4170 class="css-icxoph-h3-h3-STYLES_H3" 4171 data-heading="true" 4172 > 4173 <div 4174 class="css-1rh3o5q-STYLES_PERMALINK" 4175 > 4176 <span 4177 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4178 id="appleauthenticationuserdetectionstatus" 4179 /> 4180 <a 4181 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4182 href="#appleauthenticationuserdetectionstatus" 4183 > 4184 <span 4185 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4186 > 4187 <code 4188 class="inline css-nuv12a-STYLES_INLINE_CODE" 4189 > 4190 AppleAuthenticationUserDetectionStatus 4191 </code> 4192 </span> 4193 <span 4194 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4195 > 4196 <svg 4197 aria-label="permalink" 4198 class="anchor-icon" 4199 fill="none" 4200 height="24" 4201 viewBox="0 0 24 24" 4202 width="24" 4203 xmlns="http://www.w3.org/2000/svg" 4204 > 4205 <path 4206 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4207 stroke="#9B9B9B" 4208 stroke-linecap="round" 4209 stroke-linejoin="round" 4210 stroke-width="2" 4211 /> 4212 <path 4213 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4214 stroke="#9B9B9B" 4215 stroke-linecap="round" 4216 stroke-linejoin="round" 4217 stroke-width="2" 4218 /> 4219 </svg> 4220 </span> 4221 </a> 4222 </div> 4223 </h3> 4224 <p 4225 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 4226 data-text="true" 4227 > 4228 An enum whose values specify the system's best guess for how likely the current user is a real person. 4229 </p> 4230 <ul 4231 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 4232 data-text="true" 4233 > 4234 <li 4235 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4236 > 4237 <code 4238 class="inline css-nuv12a-STYLES_INLINE_CODE" 4239 > 4240 AppleAuthenticationUserDetectionStatus 4241 . 4242 UNSUPPORTED 4243 </code> 4244 : 4245 <code 4246 class="inline css-nuv12a-STYLES_INLINE_CODE" 4247 > 4248 0 4249 </code> 4250 - 4251 <span> 4252 The system does not support this determination and there is no data. 4253 </span> 4254 </li> 4255 <li 4256 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4257 > 4258 <code 4259 class="inline css-nuv12a-STYLES_INLINE_CODE" 4260 > 4261 AppleAuthenticationUserDetectionStatus 4262 . 4263 UNKNOWN 4264 </code> 4265 : 4266 <code 4267 class="inline css-nuv12a-STYLES_INLINE_CODE" 4268 > 4269 1 4270 </code> 4271 - 4272 <span> 4273 The system has not determined whether the user might be a real person. 4274 </span> 4275 </li> 4276 <li 4277 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4278 > 4279 <code 4280 class="inline css-nuv12a-STYLES_INLINE_CODE" 4281 > 4282 AppleAuthenticationUserDetectionStatus 4283 . 4284 LIKELY_REAL 4285 </code> 4286 : 4287 <code 4288 class="inline css-nuv12a-STYLES_INLINE_CODE" 4289 > 4290 2 4291 </code> 4292 - 4293 <span> 4294 The user appears to be a real person. 4295 </span> 4296 </li> 4297 </ul> 4298 </div> 4299</div> 4300`; 4301 4302exports[`APISection expo-pedometer 1`] = ` 4303<div> 4304 <h2 4305 class="css-1v5aebx-h2-h2-STYLES_H2" 4306 data-heading="true" 4307 > 4308 <div 4309 class="css-1rh3o5q-STYLES_PERMALINK" 4310 > 4311 <span 4312 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4313 id="methods" 4314 /> 4315 <a 4316 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4317 href="#methods" 4318 > 4319 <span 4320 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4321 > 4322 Methods 4323 </span> 4324 <span 4325 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4326 > 4327 <svg 4328 aria-label="permalink" 4329 class="anchor-icon" 4330 fill="none" 4331 height="24" 4332 viewBox="0 0 24 24" 4333 width="24" 4334 xmlns="http://www.w3.org/2000/svg" 4335 > 4336 <path 4337 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4338 stroke="#9B9B9B" 4339 stroke-linecap="round" 4340 stroke-linejoin="round" 4341 stroke-width="2" 4342 /> 4343 <path 4344 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4345 stroke="#9B9B9B" 4346 stroke-linecap="round" 4347 stroke-linejoin="round" 4348 stroke-width="2" 4349 /> 4350 </svg> 4351 </span> 4352 </a> 4353 </div> 4354 </h2> 4355 <div> 4356 <h3 4357 class="css-icxoph-h3-h3-STYLES_H3" 4358 data-heading="true" 4359 > 4360 <div 4361 class="css-1rh3o5q-STYLES_PERMALINK" 4362 > 4363 <span 4364 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4365 id="getpermissionsasync" 4366 /> 4367 <a 4368 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4369 href="#getpermissionsasync" 4370 > 4371 <span 4372 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4373 > 4374 <code 4375 class="inline css-nuv12a-STYLES_INLINE_CODE" 4376 > 4377 getPermissionsAsync() 4378 </code> 4379 </span> 4380 <span 4381 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4382 > 4383 <svg 4384 aria-label="permalink" 4385 class="anchor-icon" 4386 fill="none" 4387 height="24" 4388 viewBox="0 0 24 24" 4389 width="24" 4390 xmlns="http://www.w3.org/2000/svg" 4391 > 4392 <path 4393 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4394 stroke="#9B9B9B" 4395 stroke-linecap="round" 4396 stroke-linejoin="round" 4397 stroke-width="2" 4398 /> 4399 <path 4400 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4401 stroke="#9B9B9B" 4402 stroke-linecap="round" 4403 stroke-linejoin="round" 4404 stroke-width="2" 4405 /> 4406 </svg> 4407 </span> 4408 </a> 4409 </div> 4410 </h3> 4411 <div> 4412 <h4 4413 class=" css-1j2s5xo-h4-h4-STYLES_H4" 4414 data-components-heading="true" 4415 data-heading="true" 4416 > 4417 <div 4418 class="css-1rh3o5q-STYLES_PERMALINK" 4419 > 4420 <span 4421 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4422 id="returns" 4423 /> 4424 <a 4425 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4426 href="#returns" 4427 > 4428 <span 4429 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4430 > 4431 Returns 4432 </span> 4433 <span 4434 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4435 > 4436 <svg 4437 aria-label="permalink" 4438 class="anchor-icon" 4439 fill="none" 4440 height="24" 4441 viewBox="0 0 24 24" 4442 width="24" 4443 xmlns="http://www.w3.org/2000/svg" 4444 > 4445 <path 4446 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4447 stroke="#9B9B9B" 4448 stroke-linecap="round" 4449 stroke-linejoin="round" 4450 stroke-width="2" 4451 /> 4452 <path 4453 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4454 stroke="#9B9B9B" 4455 stroke-linecap="round" 4456 stroke-linejoin="round" 4457 stroke-width="2" 4458 /> 4459 </svg> 4460 </span> 4461 </a> 4462 </div> 4463 </h4> 4464 <ul 4465 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 4466 data-text="true" 4467 > 4468 <li 4469 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 4470 > 4471 <code 4472 class="inline css-nuv12a-STYLES_INLINE_CODE" 4473 > 4474 <a 4475 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4476 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 4477 rel="noopener noreferrer" 4478 > 4479 Promise 4480 </a> 4481 < 4482 <span> 4483 <a 4484 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4485 href="/#permissionresponse" 4486 > 4487 PermissionResponse 4488 </a> 4489 </span> 4490 > 4491 </code> 4492 </li> 4493 </ul> 4494 </div> 4495 <hr /> 4496 </div> 4497 <div> 4498 <h3 4499 class="css-icxoph-h3-h3-STYLES_H3" 4500 data-heading="true" 4501 > 4502 <div 4503 class="css-1rh3o5q-STYLES_PERMALINK" 4504 > 4505 <span 4506 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4507 id="getstepcountasyncstart-end" 4508 /> 4509 <a 4510 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4511 href="#getstepcountasyncstart-end" 4512 > 4513 <span 4514 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4515 > 4516 <code 4517 class="inline css-nuv12a-STYLES_INLINE_CODE" 4518 > 4519 getStepCountAsync(start, end) 4520 </code> 4521 </span> 4522 <span 4523 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4524 > 4525 <svg 4526 aria-label="permalink" 4527 class="anchor-icon" 4528 fill="none" 4529 height="24" 4530 viewBox="0 0 24 24" 4531 width="24" 4532 xmlns="http://www.w3.org/2000/svg" 4533 > 4534 <path 4535 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4536 stroke="#9B9B9B" 4537 stroke-linecap="round" 4538 stroke-linejoin="round" 4539 stroke-width="2" 4540 /> 4541 <path 4542 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4543 stroke="#9B9B9B" 4544 stroke-linecap="round" 4545 stroke-linejoin="round" 4546 stroke-width="2" 4547 /> 4548 </svg> 4549 </span> 4550 </a> 4551 </div> 4552 </h3> 4553 <h4 4554 class=" css-1j2s5xo-h4-h4-STYLES_H4" 4555 data-components-heading="true" 4556 data-heading="true" 4557 > 4558 <div 4559 class="css-1rh3o5q-STYLES_PERMALINK" 4560 > 4561 <span 4562 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4563 id="arguments" 4564 /> 4565 <a 4566 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4567 href="#arguments" 4568 > 4569 <span 4570 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4571 > 4572 Arguments 4573 </span> 4574 <span 4575 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4576 > 4577 <svg 4578 aria-label="permalink" 4579 class="anchor-icon" 4580 fill="none" 4581 height="24" 4582 viewBox="0 0 24 24" 4583 width="24" 4584 xmlns="http://www.w3.org/2000/svg" 4585 > 4586 <path 4587 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4588 stroke="#9B9B9B" 4589 stroke-linecap="round" 4590 stroke-linejoin="round" 4591 stroke-width="2" 4592 /> 4593 <path 4594 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4595 stroke="#9B9B9B" 4596 stroke-linecap="round" 4597 stroke-linejoin="round" 4598 stroke-width="2" 4599 /> 4600 </svg> 4601 </span> 4602 </a> 4603 </div> 4604 </h4> 4605 <ul 4606 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 4607 data-text="true" 4608 > 4609 <li 4610 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4611 > 4612 <strong 4613 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 4614 > 4615 start 4616 ( 4617 <code 4618 class="inline css-nuv12a-STYLES_INLINE_CODE" 4619 > 4620 <a 4621 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4622 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" 4623 rel="noopener noreferrer" 4624 > 4625 Date 4626 </a> 4627 </code> 4628 ) 4629 </strong> 4630 - 4631 <span> 4632 A date indicating the start of the range over which to measure steps. 4633 </span> 4634 </li> 4635 <li 4636 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 4637 > 4638 <strong 4639 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 4640 > 4641 end 4642 ( 4643 <code 4644 class="inline css-nuv12a-STYLES_INLINE_CODE" 4645 > 4646 <a 4647 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4648 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" 4649 rel="noopener noreferrer" 4650 > 4651 Date 4652 </a> 4653 </code> 4654 ) 4655 </strong> 4656 - 4657 <span> 4658 A date indicating the end of the range over which to measure steps. 4659 </span> 4660 </li> 4661 </ul> 4662 <p 4663 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 4664 data-text="true" 4665 > 4666 Get the step count between two dates. 4667 </p> 4668 <div> 4669 <h4 4670 class=" css-1j2s5xo-h4-h4-STYLES_H4" 4671 data-components-heading="true" 4672 data-heading="true" 4673 > 4674 <div 4675 class="css-1rh3o5q-STYLES_PERMALINK" 4676 > 4677 <span 4678 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4679 id="returns-1" 4680 /> 4681 <a 4682 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4683 href="#returns-1" 4684 > 4685 <span 4686 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4687 > 4688 Returns 4689 </span> 4690 <span 4691 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4692 > 4693 <svg 4694 aria-label="permalink" 4695 class="anchor-icon" 4696 fill="none" 4697 height="24" 4698 viewBox="0 0 24 24" 4699 width="24" 4700 xmlns="http://www.w3.org/2000/svg" 4701 > 4702 <path 4703 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4704 stroke="#9B9B9B" 4705 stroke-linecap="round" 4706 stroke-linejoin="round" 4707 stroke-width="2" 4708 /> 4709 <path 4710 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4711 stroke="#9B9B9B" 4712 stroke-linecap="round" 4713 stroke-linejoin="round" 4714 stroke-width="2" 4715 /> 4716 </svg> 4717 </span> 4718 </a> 4719 </div> 4720 </h4> 4721 <ul 4722 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 4723 data-text="true" 4724 > 4725 <li 4726 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 4727 > 4728 <code 4729 class="inline css-nuv12a-STYLES_INLINE_CODE" 4730 > 4731 <a 4732 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4733 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 4734 rel="noopener noreferrer" 4735 > 4736 Promise 4737 </a> 4738 < 4739 <span> 4740 <a 4741 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4742 href="/#pedometerresult" 4743 > 4744 PedometerResult 4745 </a> 4746 </span> 4747 > 4748 </code> 4749 </li> 4750 </ul> 4751 <p 4752 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 4753 data-text="true" 4754 > 4755 Returns a promise that fulfills with a 4756 <a 4757 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4758 href="/#pedometerresult" 4759 > 4760 <code 4761 class="inline css-nuv12a-STYLES_INLINE_CODE" 4762 > 4763 PedometerResult 4764 </code> 4765 </a> 4766 . 4767 </p> 4768 4769 4770 <p 4771 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 4772 data-text="true" 4773 > 4774 As 4775 <a 4776 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4777 href="https://developer.apple.com/documentation/coremotion/cmpedometer/1613946-querypedometerdatafromdate?language=objc" 4778 rel="noopener noreferrer" 4779 > 4780 Apple documentation states 4781 </a> 4782 : 4783 </p> 4784 4785 4786 <blockquote 4787 class="css-e76wiv-paragraph-STYLES_BLOCKQUOTE" 4788 data-text="true" 4789 > 4790 <div> 4791 <div 4792 style="margin-top: 2px;" 4793 > 4794 <svg 4795 aria-label="check" 4796 fill="none" 4797 height="16" 4798 viewBox="0 0 24 24" 4799 width="16" 4800 xmlns="http://www.w3.org/2000/svg" 4801 > 4802 <path 4803 d="M12 0C5.373 0 0 5.373 0 12s5.373 12 12 12c6.628 0 12-5.373 12-12S18.628 0 12 0zm-.015 5.419c.269-.292.596-.44.973-.44.306 0 .575.11.776.317.203.207.306.472.306.786 0 .394-.137.745-.409 1.042-.279.306-.605.462-.968.462-.3 0-.566-.113-.768-.326-.201-.208-.304-.48-.304-.809 0-.401.133-.749.394-1.032zm1.999 11.305c-.995.936-1.705 1.52-2.17 1.784-.496.284-.905.423-1.25.423-.342 0-.621-.114-.83-.338-.202-.218-.305-.51-.305-.87 0-.92.521-3.058 1.595-6.534a1.47 1.47 0 00.042-.166c-.04.017-.087.041-.14.075-.088.055-.356.265-1.14 1.03a.334.334 0 01-.438.025l-.463-.358a.334.334 0 01-.043-.49c.722-.794 1.395-1.371 2.002-1.714.636-.358 1.173-.533 1.643-.533.303 0 .548.076.729.225.196.164.3.391.3.658 0 .175-.084.63-.697 2.686-.875 2.937-1.084 4.003-1.099 4.372.166-.098.558-.376 1.395-1.162a.334.334 0 01.462.003l.411.4a.334.334 0 01-.004.484z" 4804 fill="var(--expo-theme-icon-default)" 4805 /> 4806 </svg> 4807 </div> 4808 </div> 4809 <div> 4810 4811 4812 Only the past seven days worth of data is stored and available for you to retrieve. Specifying 4813a start date that is more than seven days in the past returns only the available data. 4814 4815 4816 </div> 4817 </blockquote> 4818 </div> 4819 <hr /> 4820 </div> 4821 <div> 4822 <h3 4823 class="css-icxoph-h3-h3-STYLES_H3" 4824 data-heading="true" 4825 > 4826 <div 4827 class="css-1rh3o5q-STYLES_PERMALINK" 4828 > 4829 <span 4830 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4831 id="isavailableasync" 4832 /> 4833 <a 4834 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4835 href="#isavailableasync" 4836 > 4837 <span 4838 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4839 > 4840 <code 4841 class="inline css-nuv12a-STYLES_INLINE_CODE" 4842 > 4843 isAvailableAsync() 4844 </code> 4845 </span> 4846 <span 4847 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4848 > 4849 <svg 4850 aria-label="permalink" 4851 class="anchor-icon" 4852 fill="none" 4853 height="24" 4854 viewBox="0 0 24 24" 4855 width="24" 4856 xmlns="http://www.w3.org/2000/svg" 4857 > 4858 <path 4859 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4860 stroke="#9B9B9B" 4861 stroke-linecap="round" 4862 stroke-linejoin="round" 4863 stroke-width="2" 4864 /> 4865 <path 4866 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4867 stroke="#9B9B9B" 4868 stroke-linecap="round" 4869 stroke-linejoin="round" 4870 stroke-width="2" 4871 /> 4872 </svg> 4873 </span> 4874 </a> 4875 </div> 4876 </h3> 4877 <p 4878 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 4879 data-text="true" 4880 > 4881 Returns whether the pedometer is enabled on the device. 4882 </p> 4883 <div> 4884 <h4 4885 class=" css-1j2s5xo-h4-h4-STYLES_H4" 4886 data-components-heading="true" 4887 data-heading="true" 4888 > 4889 <div 4890 class="css-1rh3o5q-STYLES_PERMALINK" 4891 > 4892 <span 4893 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4894 id="returns-2" 4895 /> 4896 <a 4897 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4898 href="#returns-2" 4899 > 4900 <span 4901 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4902 > 4903 Returns 4904 </span> 4905 <span 4906 class="css-10vdcw8-STYLES_PERMALINK_ICON" 4907 > 4908 <svg 4909 aria-label="permalink" 4910 class="anchor-icon" 4911 fill="none" 4912 height="24" 4913 viewBox="0 0 24 24" 4914 width="24" 4915 xmlns="http://www.w3.org/2000/svg" 4916 > 4917 <path 4918 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4919 stroke="#9B9B9B" 4920 stroke-linecap="round" 4921 stroke-linejoin="round" 4922 stroke-width="2" 4923 /> 4924 <path 4925 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4926 stroke="#9B9B9B" 4927 stroke-linecap="round" 4928 stroke-linejoin="round" 4929 stroke-width="2" 4930 /> 4931 </svg> 4932 </span> 4933 </a> 4934 </div> 4935 </h4> 4936 <ul 4937 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 4938 data-text="true" 4939 > 4940 <li 4941 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 4942 > 4943 <code 4944 class="inline css-nuv12a-STYLES_INLINE_CODE" 4945 > 4946 <a 4947 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 4948 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 4949 rel="noopener noreferrer" 4950 > 4951 Promise 4952 </a> 4953 < 4954 <span> 4955 boolean 4956 </span> 4957 > 4958 </code> 4959 </li> 4960 </ul> 4961 <p 4962 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 4963 data-text="true" 4964 > 4965 Returns a promise that fulfills with a 4966 <code 4967 class="inline css-nuv12a-STYLES_INLINE_CODE" 4968 > 4969 boolean 4970 </code> 4971 , indicating whether the pedometer is 4972available on this device. 4973 </p> 4974 </div> 4975 <hr /> 4976 </div> 4977 <div> 4978 <h3 4979 class="css-icxoph-h3-h3-STYLES_H3" 4980 data-heading="true" 4981 > 4982 <div 4983 class="css-1rh3o5q-STYLES_PERMALINK" 4984 > 4985 <span 4986 class="css-zonpcr-STYLES_PERMALINK_TARGET" 4987 id="requestpermissionsasync" 4988 /> 4989 <a 4990 class="css-15lh5hg-STYLES_PERMALINK_LINK" 4991 href="#requestpermissionsasync" 4992 > 4993 <span 4994 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 4995 > 4996 <code 4997 class="inline css-nuv12a-STYLES_INLINE_CODE" 4998 > 4999 requestPermissionsAsync() 5000 </code> 5001 </span> 5002 <span 5003 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5004 > 5005 <svg 5006 aria-label="permalink" 5007 class="anchor-icon" 5008 fill="none" 5009 height="24" 5010 viewBox="0 0 24 24" 5011 width="24" 5012 xmlns="http://www.w3.org/2000/svg" 5013 > 5014 <path 5015 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5016 stroke="#9B9B9B" 5017 stroke-linecap="round" 5018 stroke-linejoin="round" 5019 stroke-width="2" 5020 /> 5021 <path 5022 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5023 stroke="#9B9B9B" 5024 stroke-linecap="round" 5025 stroke-linejoin="round" 5026 stroke-width="2" 5027 /> 5028 </svg> 5029 </span> 5030 </a> 5031 </div> 5032 </h3> 5033 <div> 5034 <h4 5035 class=" css-1j2s5xo-h4-h4-STYLES_H4" 5036 data-components-heading="true" 5037 data-heading="true" 5038 > 5039 <div 5040 class="css-1rh3o5q-STYLES_PERMALINK" 5041 > 5042 <span 5043 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5044 id="returns-3" 5045 /> 5046 <a 5047 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5048 href="#returns-3" 5049 > 5050 <span 5051 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5052 > 5053 Returns 5054 </span> 5055 <span 5056 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5057 > 5058 <svg 5059 aria-label="permalink" 5060 class="anchor-icon" 5061 fill="none" 5062 height="24" 5063 viewBox="0 0 24 24" 5064 width="24" 5065 xmlns="http://www.w3.org/2000/svg" 5066 > 5067 <path 5068 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5069 stroke="#9B9B9B" 5070 stroke-linecap="round" 5071 stroke-linejoin="round" 5072 stroke-width="2" 5073 /> 5074 <path 5075 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5076 stroke="#9B9B9B" 5077 stroke-linecap="round" 5078 stroke-linejoin="round" 5079 stroke-width="2" 5080 /> 5081 </svg> 5082 </span> 5083 </a> 5084 </div> 5085 </h4> 5086 <ul 5087 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 5088 data-text="true" 5089 > 5090 <li 5091 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 5092 > 5093 <code 5094 class="inline css-nuv12a-STYLES_INLINE_CODE" 5095 > 5096 <a 5097 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5098 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 5099 rel="noopener noreferrer" 5100 > 5101 Promise 5102 </a> 5103 < 5104 <span> 5105 <a 5106 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5107 href="/#permissionresponse" 5108 > 5109 PermissionResponse 5110 </a> 5111 </span> 5112 > 5113 </code> 5114 </li> 5115 </ul> 5116 </div> 5117 <hr /> 5118 </div> 5119 <div> 5120 <h3 5121 class="css-icxoph-h3-h3-STYLES_H3" 5122 data-heading="true" 5123 > 5124 <div 5125 class="css-1rh3o5q-STYLES_PERMALINK" 5126 > 5127 <span 5128 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5129 id="watchstepcountcallback" 5130 /> 5131 <a 5132 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5133 href="#watchstepcountcallback" 5134 > 5135 <span 5136 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5137 > 5138 <code 5139 class="inline css-nuv12a-STYLES_INLINE_CODE" 5140 > 5141 watchStepCount(callback) 5142 </code> 5143 </span> 5144 <span 5145 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5146 > 5147 <svg 5148 aria-label="permalink" 5149 class="anchor-icon" 5150 fill="none" 5151 height="24" 5152 viewBox="0 0 24 24" 5153 width="24" 5154 xmlns="http://www.w3.org/2000/svg" 5155 > 5156 <path 5157 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5158 stroke="#9B9B9B" 5159 stroke-linecap="round" 5160 stroke-linejoin="round" 5161 stroke-width="2" 5162 /> 5163 <path 5164 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5165 stroke="#9B9B9B" 5166 stroke-linecap="round" 5167 stroke-linejoin="round" 5168 stroke-width="2" 5169 /> 5170 </svg> 5171 </span> 5172 </a> 5173 </div> 5174 </h3> 5175 <h4 5176 class=" css-1j2s5xo-h4-h4-STYLES_H4" 5177 data-components-heading="true" 5178 data-heading="true" 5179 > 5180 <div 5181 class="css-1rh3o5q-STYLES_PERMALINK" 5182 > 5183 <span 5184 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5185 id="arguments-1" 5186 /> 5187 <a 5188 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5189 href="#arguments-1" 5190 > 5191 <span 5192 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5193 > 5194 Arguments 5195 </span> 5196 <span 5197 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5198 > 5199 <svg 5200 aria-label="permalink" 5201 class="anchor-icon" 5202 fill="none" 5203 height="24" 5204 viewBox="0 0 24 24" 5205 width="24" 5206 xmlns="http://www.w3.org/2000/svg" 5207 > 5208 <path 5209 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5210 stroke="#9B9B9B" 5211 stroke-linecap="round" 5212 stroke-linejoin="round" 5213 stroke-width="2" 5214 /> 5215 <path 5216 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5217 stroke="#9B9B9B" 5218 stroke-linecap="round" 5219 stroke-linejoin="round" 5220 stroke-width="2" 5221 /> 5222 </svg> 5223 </span> 5224 </a> 5225 </div> 5226 </h4> 5227 <ul 5228 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 5229 data-text="true" 5230 > 5231 <li 5232 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 5233 > 5234 <strong 5235 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 5236 > 5237 callback 5238 ( 5239 <code 5240 class="inline css-nuv12a-STYLES_INLINE_CODE" 5241 > 5242 <a 5243 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5244 href="/#pedometerupdatecallback" 5245 > 5246 PedometerUpdateCallback 5247 </a> 5248 </code> 5249 ) 5250 </strong> 5251 - 5252 <span> 5253 A callback that is invoked when new step count data is available. The callback is 5254provided with a single argument that is 5255 <a 5256 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5257 href="/#pedometerresult" 5258 > 5259 <code 5260 class="inline css-nuv12a-STYLES_INLINE_CODE" 5261 > 5262 PedometerResult 5263 </code> 5264 </a> 5265 . 5266 </span> 5267 </li> 5268 </ul> 5269 <p 5270 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 5271 data-text="true" 5272 > 5273 Subscribe to pedometer updates. 5274 </p> 5275 <div> 5276 <h4 5277 class=" css-1j2s5xo-h4-h4-STYLES_H4" 5278 data-components-heading="true" 5279 data-heading="true" 5280 > 5281 <div 5282 class="css-1rh3o5q-STYLES_PERMALINK" 5283 > 5284 <span 5285 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5286 id="returns-4" 5287 /> 5288 <a 5289 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5290 href="#returns-4" 5291 > 5292 <span 5293 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5294 > 5295 Returns 5296 </span> 5297 <span 5298 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5299 > 5300 <svg 5301 aria-label="permalink" 5302 class="anchor-icon" 5303 fill="none" 5304 height="24" 5305 viewBox="0 0 24 24" 5306 width="24" 5307 xmlns="http://www.w3.org/2000/svg" 5308 > 5309 <path 5310 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5311 stroke="#9B9B9B" 5312 stroke-linecap="round" 5313 stroke-linejoin="round" 5314 stroke-width="2" 5315 /> 5316 <path 5317 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5318 stroke="#9B9B9B" 5319 stroke-linecap="round" 5320 stroke-linejoin="round" 5321 stroke-width="2" 5322 /> 5323 </svg> 5324 </span> 5325 </a> 5326 </div> 5327 </h4> 5328 <ul 5329 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 5330 data-text="true" 5331 > 5332 <li 5333 class="docs-list-item css-npeppb-STYLES_LIST_ITEM-STYLE_RETURN_LIST-LI" 5334 > 5335 <code 5336 class="inline css-nuv12a-STYLES_INLINE_CODE" 5337 > 5338 <a 5339 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5340 href="/#subscription" 5341 > 5342 Subscription 5343 </a> 5344 </code> 5345 </li> 5346 </ul> 5347 <p 5348 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 5349 data-text="true" 5350 > 5351 Returns a 5352 <a 5353 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5354 href="/#subscription" 5355 > 5356 <code 5357 class="inline css-nuv12a-STYLES_INLINE_CODE" 5358 > 5359 Subscription 5360 </code> 5361 </a> 5362 that enables you to call 5363 5364 <code 5365 class="inline css-nuv12a-STYLES_INLINE_CODE" 5366 > 5367 remove() 5368 </code> 5369 when you would like to unsubscribe the listener. 5370 </p> 5371 </div> 5372 </div> 5373 <h2 5374 class="css-1v5aebx-h2-h2-STYLES_H2" 5375 data-heading="true" 5376 > 5377 <div 5378 class="css-1rh3o5q-STYLES_PERMALINK" 5379 > 5380 <span 5381 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5382 id="types" 5383 /> 5384 <a 5385 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5386 href="#types" 5387 > 5388 <span 5389 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5390 > 5391 Types 5392 </span> 5393 <span 5394 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5395 > 5396 <svg 5397 aria-label="permalink" 5398 class="anchor-icon" 5399 fill="none" 5400 height="24" 5401 viewBox="0 0 24 24" 5402 width="24" 5403 xmlns="http://www.w3.org/2000/svg" 5404 > 5405 <path 5406 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5407 stroke="#9B9B9B" 5408 stroke-linecap="round" 5409 stroke-linejoin="round" 5410 stroke-width="2" 5411 /> 5412 <path 5413 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5414 stroke="#9B9B9B" 5415 stroke-linecap="round" 5416 stroke-linejoin="round" 5417 stroke-width="2" 5418 /> 5419 </svg> 5420 </span> 5421 </a> 5422 </div> 5423 </h2> 5424 <div> 5425 <h3 5426 class="css-icxoph-h3-h3-STYLES_H3" 5427 data-heading="true" 5428 > 5429 <div 5430 class="css-1rh3o5q-STYLES_PERMALINK" 5431 > 5432 <span 5433 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5434 id="pedometerresult" 5435 /> 5436 <a 5437 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5438 href="#pedometerresult" 5439 > 5440 <span 5441 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5442 > 5443 <code 5444 class="inline css-nuv12a-STYLES_INLINE_CODE" 5445 > 5446 PedometerResult 5447 5448 </code> 5449 </span> 5450 <span 5451 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5452 > 5453 <svg 5454 aria-label="permalink" 5455 class="anchor-icon" 5456 fill="none" 5457 height="24" 5458 viewBox="0 0 24 24" 5459 width="24" 5460 xmlns="http://www.w3.org/2000/svg" 5461 > 5462 <path 5463 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5464 stroke="#9B9B9B" 5465 stroke-linecap="round" 5466 stroke-linejoin="round" 5467 stroke-width="2" 5468 /> 5469 <path 5470 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5471 stroke="#9B9B9B" 5472 stroke-linecap="round" 5473 stroke-linejoin="round" 5474 stroke-width="2" 5475 /> 5476 </svg> 5477 </span> 5478 </a> 5479 </div> 5480 </h3> 5481 <table> 5482 <thead> 5483 <tr> 5484 <th> 5485 Name 5486 </th> 5487 <th> 5488 Type 5489 </th> 5490 <th> 5491 Description 5492 </th> 5493 </tr> 5494 </thead> 5495 <tbody> 5496 <tr> 5497 <td> 5498 <strong 5499 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 5500 > 5501 steps 5502 </strong> 5503 </td> 5504 <td> 5505 <code 5506 class="inline css-nuv12a-STYLES_INLINE_CODE" 5507 > 5508 number 5509 </code> 5510 </td> 5511 <td> 5512 <span> 5513 Number of steps taken between the given dates. 5514 </span> 5515 </td> 5516 </tr> 5517 </tbody> 5518 </table> 5519 </div> 5520 <div> 5521 <h3 5522 class="css-icxoph-h3-h3-STYLES_H3" 5523 data-heading="true" 5524 > 5525 <div 5526 class="css-1rh3o5q-STYLES_PERMALINK" 5527 > 5528 <span 5529 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5530 id="pedometerupdatecallback" 5531 /> 5532 <a 5533 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5534 href="#pedometerupdatecallback" 5535 > 5536 <span 5537 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5538 > 5539 <code 5540 class="inline css-nuv12a-STYLES_INLINE_CODE" 5541 > 5542 PedometerUpdateCallback 5543 () 5544 </code> 5545 </span> 5546 <span 5547 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5548 > 5549 <svg 5550 aria-label="permalink" 5551 class="anchor-icon" 5552 fill="none" 5553 height="24" 5554 viewBox="0 0 24 24" 5555 width="24" 5556 xmlns="http://www.w3.org/2000/svg" 5557 > 5558 <path 5559 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5560 stroke="#9B9B9B" 5561 stroke-linecap="round" 5562 stroke-linejoin="round" 5563 stroke-width="2" 5564 /> 5565 <path 5566 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5567 stroke="#9B9B9B" 5568 stroke-linecap="round" 5569 stroke-linejoin="round" 5570 stroke-width="2" 5571 /> 5572 </svg> 5573 </span> 5574 </a> 5575 </div> 5576 </h3> 5577 <div> 5578 <h4 5579 class=" css-1j2s5xo-h4-h4-STYLES_H4" 5580 data-components-heading="true" 5581 data-heading="true" 5582 > 5583 <div 5584 class="css-1rh3o5q-STYLES_PERMALINK" 5585 > 5586 <span 5587 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5588 id="arguments-2" 5589 /> 5590 <a 5591 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5592 href="#arguments-2" 5593 > 5594 <span 5595 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5596 > 5597 Arguments 5598 </span> 5599 <span 5600 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5601 > 5602 <svg 5603 aria-label="permalink" 5604 class="anchor-icon" 5605 fill="none" 5606 height="24" 5607 viewBox="0 0 24 24" 5608 width="24" 5609 xmlns="http://www.w3.org/2000/svg" 5610 > 5611 <path 5612 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5613 stroke="#9B9B9B" 5614 stroke-linecap="round" 5615 stroke-linejoin="round" 5616 stroke-width="2" 5617 /> 5618 <path 5619 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5620 stroke="#9B9B9B" 5621 stroke-linecap="round" 5622 stroke-linejoin="round" 5623 stroke-width="2" 5624 /> 5625 </svg> 5626 </span> 5627 </a> 5628 </div> 5629 </h4> 5630 <ul 5631 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 5632 data-text="true" 5633 > 5634 <li 5635 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 5636 > 5637 <strong 5638 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 5639 > 5640 result 5641 ( 5642 <code 5643 class="inline css-nuv12a-STYLES_INLINE_CODE" 5644 > 5645 <a 5646 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5647 href="/#pedometerresult" 5648 > 5649 PedometerResult 5650 </a> 5651 </code> 5652 ) 5653 </strong> 5654 </li> 5655 </ul> 5656 </div> 5657 </div> 5658 <div> 5659 <h3 5660 class="css-icxoph-h3-h3-STYLES_H3" 5661 data-heading="true" 5662 > 5663 <div 5664 class="css-1rh3o5q-STYLES_PERMALINK" 5665 > 5666 <span 5667 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5668 id="permissionexpiration" 5669 /> 5670 <a 5671 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5672 href="#permissionexpiration" 5673 > 5674 <span 5675 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5676 > 5677 <code 5678 class="inline css-nuv12a-STYLES_INLINE_CODE" 5679 > 5680 PermissionExpiration 5681 </code> 5682 </span> 5683 <span 5684 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5685 > 5686 <svg 5687 aria-label="permalink" 5688 class="anchor-icon" 5689 fill="none" 5690 height="24" 5691 viewBox="0 0 24 24" 5692 width="24" 5693 xmlns="http://www.w3.org/2000/svg" 5694 > 5695 <path 5696 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5697 stroke="#9B9B9B" 5698 stroke-linecap="round" 5699 stroke-linejoin="round" 5700 stroke-width="2" 5701 /> 5702 <path 5703 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5704 stroke="#9B9B9B" 5705 stroke-linecap="round" 5706 stroke-linejoin="round" 5707 stroke-width="2" 5708 /> 5709 </svg> 5710 </span> 5711 </a> 5712 </div> 5713 </h3> 5714 <p 5715 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 5716 data-text="true" 5717 > 5718 Acceptable values are: 5719 5720 <span> 5721 <code 5722 class="inline css-nuv12a-STYLES_INLINE_CODE" 5723 > 5724 'never' 5725 </code> 5726 , 5727 </span> 5728 <span> 5729 <code 5730 class="inline css-nuv12a-STYLES_INLINE_CODE" 5731 > 5732 number 5733 </code> 5734 . 5735 </span> 5736 </p> 5737 </div> 5738 <div> 5739 <h3 5740 class="css-icxoph-h3-h3-STYLES_H3" 5741 data-heading="true" 5742 > 5743 <div 5744 class="css-1rh3o5q-STYLES_PERMALINK" 5745 > 5746 <span 5747 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5748 id="subscription" 5749 /> 5750 <a 5751 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5752 href="#subscription" 5753 > 5754 <span 5755 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5756 > 5757 <code 5758 class="inline css-nuv12a-STYLES_INLINE_CODE" 5759 > 5760 Subscription 5761 5762 </code> 5763 </span> 5764 <span 5765 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5766 > 5767 <svg 5768 aria-label="permalink" 5769 class="anchor-icon" 5770 fill="none" 5771 height="24" 5772 viewBox="0 0 24 24" 5773 width="24" 5774 xmlns="http://www.w3.org/2000/svg" 5775 > 5776 <path 5777 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5778 stroke="#9B9B9B" 5779 stroke-linecap="round" 5780 stroke-linejoin="round" 5781 stroke-width="2" 5782 /> 5783 <path 5784 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5785 stroke="#9B9B9B" 5786 stroke-linecap="round" 5787 stroke-linejoin="round" 5788 stroke-width="2" 5789 /> 5790 </svg> 5791 </span> 5792 </a> 5793 </div> 5794 </h3> 5795 <table> 5796 <thead> 5797 <tr> 5798 <th> 5799 Name 5800 </th> 5801 <th> 5802 Type 5803 </th> 5804 <th> 5805 Description 5806 </th> 5807 </tr> 5808 </thead> 5809 <tbody> 5810 <tr> 5811 <td> 5812 <strong 5813 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 5814 > 5815 remove 5816 </strong> 5817 </td> 5818 <td> 5819 <code 5820 class="inline css-nuv12a-STYLES_INLINE_CODE" 5821 > 5822 () => 5823 5824 void 5825 </code> 5826 </td> 5827 <td> 5828 <span> 5829 A method to unsubscribe the listener. 5830 </span> 5831 </td> 5832 </tr> 5833 </tbody> 5834 </table> 5835 </div> 5836 <h2 5837 class="css-1v5aebx-h2-h2-STYLES_H2" 5838 data-heading="true" 5839 > 5840 <div 5841 class="css-1rh3o5q-STYLES_PERMALINK" 5842 > 5843 <span 5844 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5845 id="interfaces" 5846 /> 5847 <a 5848 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5849 href="#interfaces" 5850 > 5851 <span 5852 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5853 > 5854 Interfaces 5855 </span> 5856 <span 5857 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5858 > 5859 <svg 5860 aria-label="permalink" 5861 class="anchor-icon" 5862 fill="none" 5863 height="24" 5864 viewBox="0 0 24 24" 5865 width="24" 5866 xmlns="http://www.w3.org/2000/svg" 5867 > 5868 <path 5869 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5870 stroke="#9B9B9B" 5871 stroke-linecap="round" 5872 stroke-linejoin="round" 5873 stroke-width="2" 5874 /> 5875 <path 5876 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5877 stroke="#9B9B9B" 5878 stroke-linecap="round" 5879 stroke-linejoin="round" 5880 stroke-width="2" 5881 /> 5882 </svg> 5883 </span> 5884 </a> 5885 </div> 5886 </h2> 5887 <div> 5888 <h3 5889 class="css-icxoph-h3-h3-STYLES_H3" 5890 data-heading="true" 5891 > 5892 <div 5893 class="css-1rh3o5q-STYLES_PERMALINK" 5894 > 5895 <span 5896 class="css-zonpcr-STYLES_PERMALINK_TARGET" 5897 id="permissionresponse" 5898 /> 5899 <a 5900 class="css-15lh5hg-STYLES_PERMALINK_LINK" 5901 href="#permissionresponse" 5902 > 5903 <span 5904 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 5905 > 5906 <code 5907 class="inline css-nuv12a-STYLES_INLINE_CODE" 5908 > 5909 PermissionResponse 5910 </code> 5911 </span> 5912 <span 5913 class="css-10vdcw8-STYLES_PERMALINK_ICON" 5914 > 5915 <svg 5916 aria-label="permalink" 5917 class="anchor-icon" 5918 fill="none" 5919 height="24" 5920 viewBox="0 0 24 24" 5921 width="24" 5922 xmlns="http://www.w3.org/2000/svg" 5923 > 5924 <path 5925 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5926 stroke="#9B9B9B" 5927 stroke-linecap="round" 5928 stroke-linejoin="round" 5929 stroke-width="2" 5930 /> 5931 <path 5932 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5933 stroke="#9B9B9B" 5934 stroke-linecap="round" 5935 stroke-linejoin="round" 5936 stroke-width="2" 5937 /> 5938 </svg> 5939 </span> 5940 </a> 5941 </div> 5942 </h3> 5943 <table> 5944 <thead> 5945 <tr> 5946 <th> 5947 Name 5948 </th> 5949 <th> 5950 Type 5951 </th> 5952 <th> 5953 Description 5954 </th> 5955 </tr> 5956 </thead> 5957 <tbody> 5958 <tr> 5959 <td> 5960 <strong 5961 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 5962 > 5963 canAskAgain 5964 5965 </strong> 5966 </td> 5967 <td> 5968 <code 5969 class="inline css-nuv12a-STYLES_INLINE_CODE" 5970 > 5971 boolean 5972 </code> 5973 </td> 5974 <td> 5975 - 5976 </td> 5977 </tr> 5978 <tr> 5979 <td> 5980 <strong 5981 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 5982 > 5983 expires 5984 5985 </strong> 5986 </td> 5987 <td> 5988 <code 5989 class="inline css-nuv12a-STYLES_INLINE_CODE" 5990 > 5991 <a 5992 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 5993 href="/#permissionexpiration" 5994 > 5995 PermissionExpiration 5996 </a> 5997 </code> 5998 </td> 5999 <td> 6000 - 6001 </td> 6002 </tr> 6003 <tr> 6004 <td> 6005 <strong 6006 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 6007 > 6008 granted 6009 6010 </strong> 6011 </td> 6012 <td> 6013 <code 6014 class="inline css-nuv12a-STYLES_INLINE_CODE" 6015 > 6016 boolean 6017 </code> 6018 </td> 6019 <td> 6020 - 6021 </td> 6022 </tr> 6023 <tr> 6024 <td> 6025 <strong 6026 class="css-kkqcgt-paragraph-STYLES_BOLD_PARAGRAPH" 6027 > 6028 status 6029 6030 </strong> 6031 </td> 6032 <td> 6033 <code 6034 class="inline css-nuv12a-STYLES_INLINE_CODE" 6035 > 6036 <a 6037 class="css-12zqqiz-STYLES_EXTERNAL_LINK" 6038 href="/#permissionstatus" 6039 > 6040 PermissionStatus 6041 </a> 6042 </code> 6043 </td> 6044 <td> 6045 - 6046 </td> 6047 </tr> 6048 </tbody> 6049 </table> 6050 </div> 6051 <h2 6052 class="css-1v5aebx-h2-h2-STYLES_H2" 6053 data-heading="true" 6054 > 6055 <div 6056 class="css-1rh3o5q-STYLES_PERMALINK" 6057 > 6058 <span 6059 class="css-zonpcr-STYLES_PERMALINK_TARGET" 6060 id="enums" 6061 /> 6062 <a 6063 class="css-15lh5hg-STYLES_PERMALINK_LINK" 6064 href="#enums" 6065 > 6066 <span 6067 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 6068 > 6069 Enums 6070 </span> 6071 <span 6072 class="css-10vdcw8-STYLES_PERMALINK_ICON" 6073 > 6074 <svg 6075 aria-label="permalink" 6076 class="anchor-icon" 6077 fill="none" 6078 height="24" 6079 viewBox="0 0 24 24" 6080 width="24" 6081 xmlns="http://www.w3.org/2000/svg" 6082 > 6083 <path 6084 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6085 stroke="#9B9B9B" 6086 stroke-linecap="round" 6087 stroke-linejoin="round" 6088 stroke-width="2" 6089 /> 6090 <path 6091 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6092 stroke="#9B9B9B" 6093 stroke-linecap="round" 6094 stroke-linejoin="round" 6095 stroke-width="2" 6096 /> 6097 </svg> 6098 </span> 6099 </a> 6100 </div> 6101 </h2> 6102 <div> 6103 <h3 6104 class="css-icxoph-h3-h3-STYLES_H3" 6105 data-heading="true" 6106 > 6107 <div 6108 class="css-1rh3o5q-STYLES_PERMALINK" 6109 > 6110 <span 6111 class="css-zonpcr-STYLES_PERMALINK_TARGET" 6112 id="permissionstatus" 6113 /> 6114 <a 6115 class="css-15lh5hg-STYLES_PERMALINK_LINK" 6116 href="#permissionstatus" 6117 > 6118 <span 6119 class="css-1icvi79-STYLED_PERMALINK_CONTENT" 6120 > 6121 <code 6122 class="inline css-nuv12a-STYLES_INLINE_CODE" 6123 > 6124 PermissionStatus 6125 </code> 6126 </span> 6127 <span 6128 class="css-10vdcw8-STYLES_PERMALINK_ICON" 6129 > 6130 <svg 6131 aria-label="permalink" 6132 class="anchor-icon" 6133 fill="none" 6134 height="24" 6135 viewBox="0 0 24 24" 6136 width="24" 6137 xmlns="http://www.w3.org/2000/svg" 6138 > 6139 <path 6140 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6141 stroke="#9B9B9B" 6142 stroke-linecap="round" 6143 stroke-linejoin="round" 6144 stroke-width="2" 6145 /> 6146 <path 6147 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6148 stroke="#9B9B9B" 6149 stroke-linecap="round" 6150 stroke-linejoin="round" 6151 stroke-width="2" 6152 /> 6153 </svg> 6154 </span> 6155 </a> 6156 </div> 6157 </h3> 6158 <ul 6159 class="css-1a9yu92-paragraph-STYLES_UNORDERED_LIST-UL" 6160 data-text="true" 6161 > 6162 <li 6163 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 6164 > 6165 <code 6166 class="inline css-nuv12a-STYLES_INLINE_CODE" 6167 > 6168 PermissionStatus 6169 . 6170 DENIED 6171 </code> 6172 : 6173 <code 6174 class="inline css-nuv12a-STYLES_INLINE_CODE" 6175 > 6176 "denied" 6177 </code> 6178 </li> 6179 <li 6180 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 6181 > 6182 <code 6183 class="inline css-nuv12a-STYLES_INLINE_CODE" 6184 > 6185 PermissionStatus 6186 . 6187 GRANTED 6188 </code> 6189 : 6190 <code 6191 class="inline css-nuv12a-STYLES_INLINE_CODE" 6192 > 6193 "granted" 6194 </code> 6195 </li> 6196 <li 6197 class="docs-list-item css-aulog8-STYLES_LIST_ITEM-LI" 6198 > 6199 <code 6200 class="inline css-nuv12a-STYLES_INLINE_CODE" 6201 > 6202 PermissionStatus 6203 . 6204 UNDETERMINED 6205 </code> 6206 : 6207 <code 6208 class="inline css-nuv12a-STYLES_INLINE_CODE" 6209 > 6210 "undetermined" 6211 </code> 6212 </li> 6213 </ul> 6214 </div> 6215</div> 6216`; 6217 6218exports[`APISection no data 1`] = ` 6219<div> 6220 <p 6221 class="css-1xnkoxs-paragraph-STYLES_PARAGRAPH" 6222 data-text="true" 6223 > 6224 No API data file found, sorry! 6225 </p> 6226</div> 6227`; 6228