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