1// Jest Snapshot v1, https://goo.gl/fbAQLP 2 3exports[`APISection expo-apple-authentication 1`] = ` 4<div> 5 <h2 6 class=" css-1qsxz84-TextComponent" 7 data-heading="true" 8 > 9 <a 10 class="css-1y48vg3" 11 href="#component" 12 > 13 <span 14 class="css-s3qkfm" 15 id="component" 16 /> 17 <span 18 class="css-6n7j50" 19 > 20 Component 21 </span> 22 <span 23 class="css-15j1jyt-PermalinkCopyIcon" 24 id="docs-anchor-permalink-component" 25 > 26 <svg 27 aria-label="permalink" 28 class="anchor-icon" 29 fill="none" 30 height="24" 31 viewBox="0 0 24 24" 32 width="24" 33 xmlns="http://www.w3.org/2000/svg" 34 > 35 <path 36 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 37 stroke="#9B9B9B" 38 stroke-linecap="round" 39 stroke-linejoin="round" 40 stroke-width="2" 41 /> 42 <path 43 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 44 stroke="#9B9B9B" 45 stroke-linecap="round" 46 stroke-linejoin="round" 47 stroke-width="2" 48 /> 49 </svg> 50 </span> 51 </a> 52 </h2> 53 <div 54 class="css-1fultt1" 55 > 56 <h3 57 class=" css-wbzzgj-TextComponent" 58 data-heading="true" 59 > 60 <a 61 class="css-1y48vg3" 62 href="#appleauthenticationbutton" 63 > 64 <span 65 class="css-s3qkfm" 66 id="appleauthenticationbutton" 67 /> 68 <span 69 class="css-6n7j50" 70 > 71 <code 72 class="css-yd3r23-TextComponent" 73 data-text="true" 74 > 75 AppleAuthenticationButton 76 </code> 77 </span> 78 <span 79 class="css-15j1jyt-PermalinkCopyIcon" 80 id="docs-anchor-permalink-appleauthenticationbutton" 81 > 82 <svg 83 aria-label="permalink" 84 class="anchor-icon" 85 fill="none" 86 height="24" 87 viewBox="0 0 24 24" 88 width="24" 89 xmlns="http://www.w3.org/2000/svg" 90 > 91 <path 92 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 93 stroke="#9B9B9B" 94 stroke-linecap="round" 95 stroke-linejoin="round" 96 stroke-width="2" 97 /> 98 <path 99 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 100 stroke="#9B9B9B" 101 stroke-linecap="round" 102 stroke-linejoin="round" 103 stroke-width="2" 104 /> 105 </svg> 106 </span> 107 </a> 108 </h3> 109 <p 110 class="mb-4 css-1kfqm4n-TextComponent" 111 data-text="true" 112 > 113 <strong 114 class="css-bvflvn-TextComponent" 115 > 116 Type: 117 </strong> 118 119 <code 120 class="css-iwb7ur-TextComponent" 121 data-text="true" 122 > 123 React.Element 124 < 125 <a 126 class="css-1na8e0o-A" 127 href="#appleauthenticationbuttonprops" 128 > 129 AppleAuthenticationButtonProps 130 </a> 131 > 132 </code> 133 </p> 134 <p 135 class="mb-4 css-1kfqm4n-TextComponent" 136 data-text="true" 137 > 138 This component displays the proprietary "Sign In with Apple" / "Continue with Apple" button on 139your screen. The App Store Guidelines require you to use this component to start the 140authentication process instead of a custom button. Limited customization of the button is 141available via the provided properties. 142 </p> 143 144 145 <p 146 class="mb-4 css-1kfqm4n-TextComponent" 147 data-text="true" 148 > 149 You should only attempt to render this if 150 <a 151 class="css-1na8e0o-A" 152 href="#isavailableasync" 153 > 154 <code 155 class="css-1a6y07t-TextComponent" 156 data-text="true" 157 > 158 AppleAuthentication.isAvailableAsync() 159 </code> 160 </a> 161 162resolves to 163 <code 164 class="css-1a6y07t-TextComponent" 165 data-text="true" 166 > 167 true 168 </code> 169 . This component will render nothing if it is not available, and you will get 170a warning in development mode ( 171 <code 172 class="css-1a6y07t-TextComponent" 173 data-text="true" 174 > 175 __DEV__ === true 176 </code> 177 ). 178 </p> 179 180 181 <p 182 class="mb-4 css-1kfqm4n-TextComponent" 183 data-text="true" 184 > 185 The properties of this component extend from 186 <code 187 class="css-1a6y07t-TextComponent" 188 data-text="true" 189 > 190 View 191 </code> 192 ; however, you should not attempt to set 193 194 <code 195 class="css-1a6y07t-TextComponent" 196 data-text="true" 197 > 198 backgroundColor 199 </code> 200 or 201 <code 202 class="css-1a6y07t-TextComponent" 203 data-text="true" 204 > 205 borderRadius 206 </code> 207 with the 208 <code 209 class="css-1a6y07t-TextComponent" 210 data-text="true" 211 > 212 style 213 </code> 214 property. This will not work and is against 215the App Store Guidelines. Instead, you should use the 216 <code 217 class="css-1a6y07t-TextComponent" 218 data-text="true" 219 > 220 buttonStyle 221 </code> 222 property to choose one of the 223predefined color styles and the 224 <code 225 class="css-1a6y07t-TextComponent" 226 data-text="true" 227 > 228 cornerRadius 229 </code> 230 property to change the border radius of the 231button. 232 </p> 233 234 235 <p 236 class="mb-4 css-1kfqm4n-TextComponent" 237 data-text="true" 238 > 239 Make sure to attach height and width via the style props as without these styles, the button will 240not appear on the screen. 241 </p> 242 <blockquote 243 class="css-zknray-Callout" 244 data-testid="callout-container" 245 > 246 <div 247 class="css-7jywx8-Callout" 248 > 249 <svg 250 class="icon-sm text-icon-default" 251 fill="currentColor" 252 role="img" 253 viewBox="0 0 24 24" 254 xmlns="http://www.w3.org/2000/svg" 255 > 256 <g 257 id="info-circle" 258 > 259 <path 260 clip-rule="evenodd" 261 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 262 fill-rule="evenodd" 263 id="Solid" 264 /> 265 </g> 266 </svg> 267 </div> 268 <div 269 class="css-1m74yfi-Callout" 270 > 271 <p 272 class="mb-4 css-1kfqm4n-TextComponent" 273 data-text="true" 274 > 275 <strong 276 class="css-bvflvn-TextComponent" 277 > 278 See: 279 </strong> 280 281 <a 282 class="css-1na8e0o-A" 283 href="https://developer.apple.com/documentation/authenticationservices/asauthorizationappleidbutton" 284 rel="noopener noreferrer" 285 target="_blank" 286 > 287 Apple 288Documentation 289 </a> 290 291for more details. 292 </p> 293 </div> 294 </blockquote> 295 <h2 296 class=" css-1qsxz84-TextComponent" 297 data-heading="true" 298 > 299 <a 300 class="css-1y48vg3" 301 href="#props" 302 > 303 <span 304 class="css-s3qkfm" 305 id="props" 306 /> 307 <span 308 class="css-6n7j50" 309 > 310 Props 311 </span> 312 <span 313 class="css-15j1jyt-PermalinkCopyIcon" 314 id="docs-anchor-permalink-props" 315 > 316 <svg 317 aria-label="permalink" 318 class="anchor-icon" 319 fill="none" 320 height="24" 321 viewBox="0 0 24 24" 322 width="24" 323 xmlns="http://www.w3.org/2000/svg" 324 > 325 <path 326 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 327 stroke="#9B9B9B" 328 stroke-linecap="round" 329 stroke-linejoin="round" 330 stroke-width="2" 331 /> 332 <path 333 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 334 stroke="#9B9B9B" 335 stroke-linecap="round" 336 stroke-linejoin="round" 337 stroke-width="2" 338 /> 339 </svg> 340 </span> 341 </a> 342 </h2> 343 <div> 344 <div 345 class="css-11xr3cd" 346 > 347 <h3 348 class=" css-wbzzgj-TextComponent" 349 data-heading="true" 350 > 351 <a 352 class="css-1y48vg3" 353 href="#buttonstyle" 354 > 355 <span 356 class="css-s3qkfm" 357 id="buttonstyle" 358 /> 359 <span 360 class="css-6n7j50" 361 > 362 <code 363 class="css-s0csg4-TextComponent" 364 data-text="true" 365 > 366 buttonStyle 367 </code> 368 </span> 369 <span 370 class="css-15j1jyt-PermalinkCopyIcon" 371 id="docs-anchor-permalink-buttonstyle" 372 > 373 <svg 374 aria-label="permalink" 375 class="anchor-icon" 376 fill="none" 377 height="24" 378 viewBox="0 0 24 24" 379 width="24" 380 xmlns="http://www.w3.org/2000/svg" 381 > 382 <path 383 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 384 stroke="#9B9B9B" 385 stroke-linecap="round" 386 stroke-linejoin="round" 387 stroke-width="2" 388 /> 389 <path 390 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 391 stroke="#9B9B9B" 392 stroke-linecap="round" 393 stroke-linejoin="round" 394 stroke-width="2" 395 /> 396 </svg> 397 </span> 398 </a> 399 </h3> 400 <p 401 class="mb-4 css-1kfqm4n-TextComponent" 402 data-text="true" 403 > 404 <span 405 class="css-1lk0cux" 406 > 407 Type: 408 </span> 409 410 <code 411 class="css-iwb7ur-TextComponent" 412 data-text="true" 413 > 414 <a 415 class="css-1na8e0o-A" 416 href="#appleauthenticationbuttonstyle" 417 > 418 AppleAuthenticationButtonStyle 419 </a> 420 </code> 421 </p> 422 <p 423 class="mb-4 css-1kfqm4n-TextComponent" 424 data-text="true" 425 > 426 The Apple-defined color scheme to use to display the button. 427 </p> 428 </div> 429 <div 430 class="css-11xr3cd" 431 > 432 <h3 433 class=" css-wbzzgj-TextComponent" 434 data-heading="true" 435 > 436 <a 437 class="css-1y48vg3" 438 href="#buttontype" 439 > 440 <span 441 class="css-s3qkfm" 442 id="buttontype" 443 /> 444 <span 445 class="css-6n7j50" 446 > 447 <code 448 class="css-s0csg4-TextComponent" 449 data-text="true" 450 > 451 buttonType 452 </code> 453 </span> 454 <span 455 class="css-15j1jyt-PermalinkCopyIcon" 456 id="docs-anchor-permalink-buttontype" 457 > 458 <svg 459 aria-label="permalink" 460 class="anchor-icon" 461 fill="none" 462 height="24" 463 viewBox="0 0 24 24" 464 width="24" 465 xmlns="http://www.w3.org/2000/svg" 466 > 467 <path 468 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 469 stroke="#9B9B9B" 470 stroke-linecap="round" 471 stroke-linejoin="round" 472 stroke-width="2" 473 /> 474 <path 475 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 476 stroke="#9B9B9B" 477 stroke-linecap="round" 478 stroke-linejoin="round" 479 stroke-width="2" 480 /> 481 </svg> 482 </span> 483 </a> 484 </h3> 485 <p 486 class="mb-4 css-1kfqm4n-TextComponent" 487 data-text="true" 488 > 489 <span 490 class="css-1lk0cux" 491 > 492 Type: 493 </span> 494 495 <code 496 class="css-iwb7ur-TextComponent" 497 data-text="true" 498 > 499 <a 500 class="css-1na8e0o-A" 501 href="#appleauthenticationbuttontype" 502 > 503 AppleAuthenticationButtonType 504 </a> 505 </code> 506 </p> 507 <p 508 class="mb-4 css-1kfqm4n-TextComponent" 509 data-text="true" 510 > 511 The type of button text to display ("Sign In with Apple" vs. "Continue with Apple"). 512 </p> 513 </div> 514 <div 515 class="css-11xr3cd" 516 > 517 <h3 518 class=" css-wbzzgj-TextComponent" 519 data-heading="true" 520 > 521 <a 522 class="css-1y48vg3" 523 href="#cornerradius" 524 > 525 <span 526 class="css-s3qkfm" 527 id="cornerradius" 528 /> 529 <span 530 class="css-6n7j50" 531 > 532 <code 533 class="css-s0csg4-TextComponent" 534 data-text="true" 535 > 536 cornerRadius 537 </code> 538 </span> 539 <span 540 class="css-15j1jyt-PermalinkCopyIcon" 541 id="docs-anchor-permalink-cornerradius" 542 > 543 <svg 544 aria-label="permalink" 545 class="anchor-icon" 546 fill="none" 547 height="24" 548 viewBox="0 0 24 24" 549 width="24" 550 xmlns="http://www.w3.org/2000/svg" 551 > 552 <path 553 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 554 stroke="#9B9B9B" 555 stroke-linecap="round" 556 stroke-linejoin="round" 557 stroke-width="2" 558 /> 559 <path 560 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 561 stroke="#9B9B9B" 562 stroke-linecap="round" 563 stroke-linejoin="round" 564 stroke-width="2" 565 /> 566 </svg> 567 </span> 568 </a> 569 </h3> 570 <p 571 class="mb-4 css-1kfqm4n-TextComponent" 572 data-text="true" 573 > 574 <span 575 class="css-1lk0cux" 576 > 577 Optional • 578 </span> 579 <span 580 class="css-1lk0cux" 581 > 582 Type: 583 </span> 584 585 <code 586 class="css-iwb7ur-TextComponent" 587 data-text="true" 588 > 589 number 590 </code> 591 </p> 592 <p 593 class="mb-4 css-1kfqm4n-TextComponent" 594 data-text="true" 595 > 596 The border radius to use when rendering the button. This works similarly to 597 598 <code 599 class="css-1a6y07t-TextComponent" 600 data-text="true" 601 > 602 style.borderRadius 603 </code> 604 in other Views. 605 </p> 606 </div> 607 <div 608 class="css-11xr3cd" 609 > 610 <h3 611 class=" css-wbzzgj-TextComponent" 612 data-heading="true" 613 > 614 <a 615 class="css-1y48vg3" 616 href="#onpress" 617 > 618 <span 619 class="css-s3qkfm" 620 id="onpress" 621 /> 622 <span 623 class="css-6n7j50" 624 > 625 <code 626 class="css-s0csg4-TextComponent" 627 data-text="true" 628 > 629 onPress 630 </code> 631 </span> 632 <span 633 class="css-15j1jyt-PermalinkCopyIcon" 634 id="docs-anchor-permalink-onpress" 635 > 636 <svg 637 aria-label="permalink" 638 class="anchor-icon" 639 fill="none" 640 height="24" 641 viewBox="0 0 24 24" 642 width="24" 643 xmlns="http://www.w3.org/2000/svg" 644 > 645 <path 646 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 647 stroke="#9B9B9B" 648 stroke-linecap="round" 649 stroke-linejoin="round" 650 stroke-width="2" 651 /> 652 <path 653 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 654 stroke="#9B9B9B" 655 stroke-linecap="round" 656 stroke-linejoin="round" 657 stroke-width="2" 658 /> 659 </svg> 660 </span> 661 </a> 662 </h3> 663 <p 664 class="mb-4 css-1kfqm4n-TextComponent" 665 data-text="true" 666 > 667 <span 668 class="css-1lk0cux" 669 > 670 Type: 671 </span> 672 673 <code 674 class="css-iwb7ur-TextComponent" 675 data-text="true" 676 > 677 ( 678 ) => 679 void 680 </code> 681 </p> 682 <p 683 class="mb-4 css-1kfqm4n-TextComponent" 684 data-text="true" 685 > 686 The method to call when the user presses the button. You should call 687 <a 688 class="css-1na8e0o-A" 689 href="#isavailableasync" 690 > 691 <code 692 class="css-1a6y07t-TextComponent" 693 data-text="true" 694 > 695 AppleAuthentication.signInAsync 696 </code> 697 </a> 698 699in here. 700 </p> 701 </div> 702 <div 703 class="css-11xr3cd" 704 > 705 <h3 706 class=" css-wbzzgj-TextComponent" 707 data-heading="true" 708 > 709 <a 710 class="css-1y48vg3" 711 href="#style" 712 > 713 <span 714 class="css-s3qkfm" 715 id="style" 716 /> 717 <span 718 class="css-6n7j50" 719 > 720 <code 721 class="css-s0csg4-TextComponent" 722 data-text="true" 723 > 724 style 725 </code> 726 </span> 727 <span 728 class="css-15j1jyt-PermalinkCopyIcon" 729 id="docs-anchor-permalink-style" 730 > 731 <svg 732 aria-label="permalink" 733 class="anchor-icon" 734 fill="none" 735 height="24" 736 viewBox="0 0 24 24" 737 width="24" 738 xmlns="http://www.w3.org/2000/svg" 739 > 740 <path 741 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 742 stroke="#9B9B9B" 743 stroke-linecap="round" 744 stroke-linejoin="round" 745 stroke-width="2" 746 /> 747 <path 748 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 749 stroke="#9B9B9B" 750 stroke-linecap="round" 751 stroke-linejoin="round" 752 stroke-width="2" 753 /> 754 </svg> 755 </span> 756 </a> 757 </h3> 758 <p 759 class="mb-4 css-1kfqm4n-TextComponent" 760 data-text="true" 761 > 762 <span 763 class="css-1lk0cux" 764 > 765 Optional • 766 </span> 767 <span 768 class="css-1lk0cux" 769 > 770 Type: 771 </span> 772 773 <code 774 class="css-iwb7ur-TextComponent" 775 data-text="true" 776 > 777 StyleProp 778 < 779 <span> 780 <a 781 class="css-1na8e0o-A" 782 href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" 783 rel="noopener noreferrer" 784 target="_blank" 785 > 786 Omit 787 </a> 788 < 789 <span> 790 <a 791 class="css-1na8e0o-A" 792 href="https://reactnative.dev/docs/view-style-props" 793 rel="noopener noreferrer" 794 target="_blank" 795 > 796 ViewStyle 797 </a> 798 , 799 </span> 800 <span> 801 <span> 802 'backgroundColor' 803 | 804 </span> 805 <span> 806 'borderRadius' 807 </span> 808 </span> 809 > 810 </span> 811 > 812 </code> 813 </p> 814 <p 815 class="mb-4 css-1kfqm4n-TextComponent" 816 data-text="true" 817 > 818 The custom style to apply to the button. Should not include 819 <code 820 class="css-1a6y07t-TextComponent" 821 data-text="true" 822 > 823 backgroundColor 824 </code> 825 or 826 <code 827 class="css-1a6y07t-TextComponent" 828 data-text="true" 829 > 830 borderRadius 831 </code> 832 833properties. 834 </p> 835 </div> 836 <h3 837 class=" css-wbzzgj-TextComponent" 838 data-heading="true" 839 > 840 <a 841 class="css-1y48vg3" 842 href="#inherited-props" 843 > 844 <span 845 class="css-s3qkfm" 846 id="inherited-props" 847 /> 848 <span 849 class="css-6n7j50" 850 > 851 Inherited Props 852 </span> 853 <span 854 class="css-15j1jyt-PermalinkCopyIcon" 855 id="docs-anchor-permalink-inherited-props" 856 > 857 <svg 858 aria-label="permalink" 859 class="anchor-icon" 860 fill="none" 861 height="24" 862 viewBox="0 0 24 24" 863 width="24" 864 xmlns="http://www.w3.org/2000/svg" 865 > 866 <path 867 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 868 stroke="#9B9B9B" 869 stroke-linecap="round" 870 stroke-linejoin="round" 871 stroke-width="2" 872 /> 873 <path 874 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 875 stroke="#9B9B9B" 876 stroke-linecap="round" 877 stroke-linejoin="round" 878 stroke-width="2" 879 /> 880 </svg> 881 </span> 882 </a> 883 </h3> 884 <ul 885 class="css-118jp6n-TextComponent" 886 > 887 <li 888 class="css-1hxzfrf-TextComponent" 889 data-text="true" 890 > 891 <code 892 class="css-iwb7ur-TextComponent" 893 data-text="true" 894 > 895 <a 896 class="css-1na8e0o-A" 897 href="https://reactnative.dev/docs/view#props" 898 rel="noopener noreferrer" 899 target="_blank" 900 > 901 ViewProps 902 </a> 903 </code> 904 </li> 905 </ul> 906 </div> 907 </div> 908 <h2 909 class=" css-1qsxz84-TextComponent" 910 data-heading="true" 911 > 912 <a 913 class="css-1y48vg3" 914 href="#methods" 915 > 916 <span 917 class="css-s3qkfm" 918 id="methods" 919 /> 920 <span 921 class="css-6n7j50" 922 > 923 Methods 924 </span> 925 <span 926 class="css-15j1jyt-PermalinkCopyIcon" 927 id="docs-anchor-permalink-methods" 928 > 929 <svg 930 aria-label="permalink" 931 class="anchor-icon" 932 fill="none" 933 height="24" 934 viewBox="0 0 24 24" 935 width="24" 936 xmlns="http://www.w3.org/2000/svg" 937 > 938 <path 939 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 940 stroke="#9B9B9B" 941 stroke-linecap="round" 942 stroke-linejoin="round" 943 stroke-width="2" 944 /> 945 <path 946 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 947 stroke="#9B9B9B" 948 stroke-linecap="round" 949 stroke-linejoin="round" 950 stroke-width="2" 951 /> 952 </svg> 953 </span> 954 </a> 955 </h2> 956 <div 957 class="css-11xr3cd" 958 > 959 <h3 960 class=" css-wbzzgj-TextComponent" 961 data-heading="true" 962 > 963 <a 964 class="css-1y48vg3" 965 href="#getcredentialstateasyncuser" 966 > 967 <span 968 class="css-s3qkfm" 969 id="getcredentialstateasyncuser" 970 /> 971 <span 972 class="css-6n7j50" 973 > 974 <code 975 class="css-s0csg4-TextComponent" 976 data-text="true" 977 > 978 getCredentialStateAsync(user) 979 </code> 980 </span> 981 <span 982 class="css-15j1jyt-PermalinkCopyIcon" 983 id="docs-anchor-permalink-getcredentialstateasyncuser" 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 </h3> 1012 <div 1013 class="css-1uyflf8-Table" 1014 > 1015 <table 1016 class="css-q84cm9-Table" 1017 > 1018 <thead 1019 class="bg-subtle border-b border-b-default border-solid" 1020 > 1021 <tr 1022 class="css-190f936-Row" 1023 > 1024 <th 1025 class="css-1uwgm7m-HeaderCell" 1026 > 1027 Name 1028 </th> 1029 <th 1030 class="css-1uwgm7m-HeaderCell" 1031 > 1032 Type 1033 </th> 1034 <th 1035 class="css-1uwgm7m-HeaderCell" 1036 > 1037 Description 1038 </th> 1039 </tr> 1040 </thead> 1041 <tbody> 1042 <tr 1043 class="css-190f936-Row" 1044 > 1045 <td 1046 class="css-zstkv9-Cell" 1047 > 1048 <strong 1049 class="css-bvflvn-TextComponent" 1050 > 1051 user 1052 </strong> 1053 </td> 1054 <td 1055 class="css-zstkv9-Cell" 1056 > 1057 <code 1058 class="css-iwb7ur-TextComponent" 1059 data-text="true" 1060 > 1061 string 1062 </code> 1063 </td> 1064 <td 1065 class="css-zstkv9-Cell" 1066 > 1067 <p 1068 class="mb-4 css-1kfqm4n-TextComponent" 1069 data-text="true" 1070 > 1071 The unique identifier for the user whose credential state you'd like to check. 1072This should come from the user field of an 1073 <a 1074 class="css-1na8e0o-A" 1075 href="#appleauthenticationcredentialstate" 1076 > 1077 <code 1078 class="css-1a6y07t-TextComponent" 1079 data-text="true" 1080 > 1081 AppleAuthenticationCredential 1082 </code> 1083 </a> 1084 object. 1085 </p> 1086 </td> 1087 </tr> 1088 </tbody> 1089 </table> 1090 </div> 1091 <br /> 1092 <p 1093 class="mb-4 css-1kfqm4n-TextComponent" 1094 data-text="true" 1095 > 1096 Queries the current state of a user credential, to determine if it is still valid or if it has been revoked. 1097 </p> 1098 1099 1100 <blockquote 1101 class="css-zknray-Callout" 1102 data-testid="callout-container" 1103 > 1104 <div 1105 class="css-7jywx8-Callout" 1106 > 1107 <svg 1108 class="icon-sm text-icon-default" 1109 fill="currentColor" 1110 role="img" 1111 viewBox="0 0 24 24" 1112 xmlns="http://www.w3.org/2000/svg" 1113 > 1114 <g 1115 id="info-circle" 1116 > 1117 <path 1118 clip-rule="evenodd" 1119 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 1120 fill-rule="evenodd" 1121 id="Solid" 1122 /> 1123 </g> 1124 </svg> 1125 </div> 1126 <div 1127 class="css-1m74yfi-Callout" 1128 > 1129 1130 1131 <p 1132 class="mb-4 css-1kfqm4n-TextComponent" 1133 data-text="true" 1134 > 1135 <strong 1136 class="css-bvflvn-TextComponent" 1137 > 1138 Note: 1139 </strong> 1140 This method must be tested on a real device. On the iOS simulator it always throws an error. 1141 </p> 1142 1143 1144 </div> 1145 </blockquote> 1146 <p 1147 class="css-1eksndl-BoxSectionHeader" 1148 data-text="true" 1149 > 1150 Returns 1151 </p> 1152 <ul 1153 class="!list-none !ml-0 css-118jp6n-TextComponent" 1154 > 1155 <li 1156 class="css-1hxzfrf-TextComponent" 1157 data-text="true" 1158 > 1159 <svg 1160 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 1161 fill="none" 1162 role="img" 1163 stroke="currentColor" 1164 viewBox="0 0 24 24" 1165 xmlns="http://www.w3.org/2000/svg" 1166 > 1167 <g 1168 id="corner-down-right" 1169 > 1170 <path 1171 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 1172 id="Icon" 1173 stroke-linecap="round" 1174 stroke-linejoin="round" 1175 stroke-width="2" 1176 /> 1177 </g> 1178 </svg> 1179 <code 1180 class="css-iwb7ur-TextComponent" 1181 data-text="true" 1182 > 1183 <a 1184 class="css-1na8e0o-A" 1185 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1186 rel="noopener noreferrer" 1187 target="_blank" 1188 > 1189 Promise 1190 </a> 1191 < 1192 <span> 1193 <a 1194 class="css-1na8e0o-A" 1195 href="#appleauthenticationcredentialstate" 1196 > 1197 AppleAuthenticationCredentialState 1198 </a> 1199 </span> 1200 > 1201 </code> 1202 </li> 1203 </ul> 1204 <br /> 1205 <p 1206 class="mb-4 css-1kfqm4n-TextComponent" 1207 data-text="true" 1208 > 1209 A promise that fulfills with an 1210 <a 1211 class="css-1na8e0o-A" 1212 href="#appleauthenticationcredentialstate" 1213 > 1214 <code 1215 class="css-1a6y07t-TextComponent" 1216 data-text="true" 1217 > 1218 AppleAuthenticationCredentialState 1219 </code> 1220 </a> 1221 1222value depending on the state of the credential. 1223 </p> 1224 </div> 1225 <div 1226 class="css-11xr3cd" 1227 > 1228 <h3 1229 class=" css-wbzzgj-TextComponent" 1230 data-heading="true" 1231 > 1232 <a 1233 class="css-1y48vg3" 1234 href="#isavailableasync" 1235 > 1236 <span 1237 class="css-s3qkfm" 1238 id="isavailableasync" 1239 /> 1240 <span 1241 class="css-6n7j50" 1242 > 1243 <code 1244 class="css-s0csg4-TextComponent" 1245 data-text="true" 1246 > 1247 isAvailableAsync() 1248 </code> 1249 </span> 1250 <span 1251 class="css-15j1jyt-PermalinkCopyIcon" 1252 id="docs-anchor-permalink-isavailableasync" 1253 > 1254 <svg 1255 aria-label="permalink" 1256 class="anchor-icon" 1257 fill="none" 1258 height="24" 1259 viewBox="0 0 24 24" 1260 width="24" 1261 xmlns="http://www.w3.org/2000/svg" 1262 > 1263 <path 1264 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1265 stroke="#9B9B9B" 1266 stroke-linecap="round" 1267 stroke-linejoin="round" 1268 stroke-width="2" 1269 /> 1270 <path 1271 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1272 stroke="#9B9B9B" 1273 stroke-linecap="round" 1274 stroke-linejoin="round" 1275 stroke-width="2" 1276 /> 1277 </svg> 1278 </span> 1279 </a> 1280 </h3> 1281 <p 1282 class="mb-4 css-1kfqm4n-TextComponent" 1283 data-text="true" 1284 > 1285 Determine if the current device's operating system supports Apple authentication. 1286 </p> 1287 <p 1288 class="css-1eksndl-BoxSectionHeader" 1289 data-text="true" 1290 > 1291 Returns 1292 </p> 1293 <ul 1294 class="!list-none !ml-0 css-118jp6n-TextComponent" 1295 > 1296 <li 1297 class="css-1hxzfrf-TextComponent" 1298 data-text="true" 1299 > 1300 <svg 1301 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 1302 fill="none" 1303 role="img" 1304 stroke="currentColor" 1305 viewBox="0 0 24 24" 1306 xmlns="http://www.w3.org/2000/svg" 1307 > 1308 <g 1309 id="corner-down-right" 1310 > 1311 <path 1312 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 1313 id="Icon" 1314 stroke-linecap="round" 1315 stroke-linejoin="round" 1316 stroke-width="2" 1317 /> 1318 </g> 1319 </svg> 1320 <code 1321 class="css-iwb7ur-TextComponent" 1322 data-text="true" 1323 > 1324 <a 1325 class="css-1na8e0o-A" 1326 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1327 rel="noopener noreferrer" 1328 target="_blank" 1329 > 1330 Promise 1331 </a> 1332 < 1333 <span> 1334 boolean 1335 </span> 1336 > 1337 </code> 1338 </li> 1339 </ul> 1340 <br /> 1341 <p 1342 class="mb-4 css-1kfqm4n-TextComponent" 1343 data-text="true" 1344 > 1345 A promise that fulfills with 1346 <code 1347 class="css-1a6y07t-TextComponent" 1348 data-text="true" 1349 > 1350 true 1351 </code> 1352 if the system supports Apple authentication, and 1353 <code 1354 class="css-1a6y07t-TextComponent" 1355 data-text="true" 1356 > 1357 false 1358 </code> 1359 otherwise. 1360 </p> 1361 </div> 1362 <div 1363 class="css-11xr3cd" 1364 > 1365 <h3 1366 class=" css-wbzzgj-TextComponent" 1367 data-heading="true" 1368 > 1369 <a 1370 class="css-1y48vg3" 1371 href="#refreshasyncoptions" 1372 > 1373 <span 1374 class="css-s3qkfm" 1375 id="refreshasyncoptions" 1376 /> 1377 <span 1378 class="css-6n7j50" 1379 > 1380 <code 1381 class="css-s0csg4-TextComponent" 1382 data-text="true" 1383 > 1384 refreshAsync(options) 1385 </code> 1386 </span> 1387 <span 1388 class="css-15j1jyt-PermalinkCopyIcon" 1389 id="docs-anchor-permalink-refreshasyncoptions" 1390 > 1391 <svg 1392 aria-label="permalink" 1393 class="anchor-icon" 1394 fill="none" 1395 height="24" 1396 viewBox="0 0 24 24" 1397 width="24" 1398 xmlns="http://www.w3.org/2000/svg" 1399 > 1400 <path 1401 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1402 stroke="#9B9B9B" 1403 stroke-linecap="round" 1404 stroke-linejoin="round" 1405 stroke-width="2" 1406 /> 1407 <path 1408 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1409 stroke="#9B9B9B" 1410 stroke-linecap="round" 1411 stroke-linejoin="round" 1412 stroke-width="2" 1413 /> 1414 </svg> 1415 </span> 1416 </a> 1417 </h3> 1418 <div 1419 class="css-1uyflf8-Table" 1420 > 1421 <table 1422 class="css-q84cm9-Table" 1423 > 1424 <thead 1425 class="bg-subtle border-b border-b-default border-solid" 1426 > 1427 <tr 1428 class="css-190f936-Row" 1429 > 1430 <th 1431 class="css-1uwgm7m-HeaderCell" 1432 > 1433 Name 1434 </th> 1435 <th 1436 class="css-1uwgm7m-HeaderCell" 1437 > 1438 Type 1439 </th> 1440 <th 1441 class="css-1uwgm7m-HeaderCell" 1442 > 1443 Description 1444 </th> 1445 </tr> 1446 </thead> 1447 <tbody> 1448 <tr 1449 class="css-190f936-Row" 1450 > 1451 <td 1452 class="css-zstkv9-Cell" 1453 > 1454 <strong 1455 class="css-bvflvn-TextComponent" 1456 > 1457 options 1458 </strong> 1459 </td> 1460 <td 1461 class="css-zstkv9-Cell" 1462 > 1463 <code 1464 class="css-iwb7ur-TextComponent" 1465 data-text="true" 1466 > 1467 <a 1468 class="css-1na8e0o-A" 1469 href="#appleauthenticationrefreshoptions" 1470 > 1471 AppleAuthenticationRefreshOptions 1472 </a> 1473 </code> 1474 </td> 1475 <td 1476 class="css-zstkv9-Cell" 1477 > 1478 <p 1479 class="mb-4 css-1kfqm4n-TextComponent" 1480 data-text="true" 1481 > 1482 An 1483 <a 1484 class="css-1na8e0o-A" 1485 href="#appleauthenticationrefreshoptions" 1486 > 1487 <code 1488 class="css-1a6y07t-TextComponent" 1489 data-text="true" 1490 > 1491 AppleAuthenticationRefreshOptions 1492 </code> 1493 </a> 1494 object 1495 </p> 1496 </td> 1497 </tr> 1498 </tbody> 1499 </table> 1500 </div> 1501 <br /> 1502 <p 1503 class="mb-4 css-1kfqm4n-TextComponent" 1504 data-text="true" 1505 > 1506 An operation that refreshes the logged-in user’s credentials. 1507Calling this method will show the sign in modal before actually refreshing the user credentials. 1508 </p> 1509 <p 1510 class="css-1eksndl-BoxSectionHeader" 1511 data-text="true" 1512 > 1513 Returns 1514 </p> 1515 <ul 1516 class="!list-none !ml-0 css-118jp6n-TextComponent" 1517 > 1518 <li 1519 class="css-1hxzfrf-TextComponent" 1520 data-text="true" 1521 > 1522 <svg 1523 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 1524 fill="none" 1525 role="img" 1526 stroke="currentColor" 1527 viewBox="0 0 24 24" 1528 xmlns="http://www.w3.org/2000/svg" 1529 > 1530 <g 1531 id="corner-down-right" 1532 > 1533 <path 1534 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 1535 id="Icon" 1536 stroke-linecap="round" 1537 stroke-linejoin="round" 1538 stroke-width="2" 1539 /> 1540 </g> 1541 </svg> 1542 <code 1543 class="css-iwb7ur-TextComponent" 1544 data-text="true" 1545 > 1546 <a 1547 class="css-1na8e0o-A" 1548 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1549 rel="noopener noreferrer" 1550 target="_blank" 1551 > 1552 Promise 1553 </a> 1554 < 1555 <span> 1556 <a 1557 class="css-1na8e0o-A" 1558 href="#appleauthenticationcredential" 1559 > 1560 AppleAuthenticationCredential 1561 </a> 1562 </span> 1563 > 1564 </code> 1565 </li> 1566 </ul> 1567 <br /> 1568 <p 1569 class="mb-4 css-1kfqm4n-TextComponent" 1570 data-text="true" 1571 > 1572 A promise that fulfills with an 1573 <a 1574 class="css-1na8e0o-A" 1575 href="#appleauthenticationcredential" 1576 > 1577 <code 1578 class="css-1a6y07t-TextComponent" 1579 data-text="true" 1580 > 1581 AppleAuthenticationCredential 1582 </code> 1583 </a> 1584 1585object after a successful authentication, and rejects with 1586 <code 1587 class="css-1a6y07t-TextComponent" 1588 data-text="true" 1589 > 1590 ERR_REQUEST_CANCELED 1591 </code> 1592 if the user cancels the 1593refresh operation. 1594 </p> 1595 </div> 1596 <div 1597 class="css-11xr3cd" 1598 > 1599 <h3 1600 class=" css-wbzzgj-TextComponent" 1601 data-heading="true" 1602 > 1603 <a 1604 class="css-1y48vg3" 1605 href="#signinasyncoptions" 1606 > 1607 <span 1608 class="css-s3qkfm" 1609 id="signinasyncoptions" 1610 /> 1611 <span 1612 class="css-6n7j50" 1613 > 1614 <code 1615 class="css-s0csg4-TextComponent" 1616 data-text="true" 1617 > 1618 signInAsync(options) 1619 </code> 1620 </span> 1621 <span 1622 class="css-15j1jyt-PermalinkCopyIcon" 1623 id="docs-anchor-permalink-signinasyncoptions" 1624 > 1625 <svg 1626 aria-label="permalink" 1627 class="anchor-icon" 1628 fill="none" 1629 height="24" 1630 viewBox="0 0 24 24" 1631 width="24" 1632 xmlns="http://www.w3.org/2000/svg" 1633 > 1634 <path 1635 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1636 stroke="#9B9B9B" 1637 stroke-linecap="round" 1638 stroke-linejoin="round" 1639 stroke-width="2" 1640 /> 1641 <path 1642 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1643 stroke="#9B9B9B" 1644 stroke-linecap="round" 1645 stroke-linejoin="round" 1646 stroke-width="2" 1647 /> 1648 </svg> 1649 </span> 1650 </a> 1651 </h3> 1652 <div 1653 class="css-1uyflf8-Table" 1654 > 1655 <table 1656 class="css-q84cm9-Table" 1657 > 1658 <thead 1659 class="bg-subtle border-b border-b-default border-solid" 1660 > 1661 <tr 1662 class="css-190f936-Row" 1663 > 1664 <th 1665 class="css-1uwgm7m-HeaderCell" 1666 > 1667 Name 1668 </th> 1669 <th 1670 class="css-1uwgm7m-HeaderCell" 1671 > 1672 Type 1673 </th> 1674 <th 1675 class="css-1uwgm7m-HeaderCell" 1676 > 1677 Description 1678 </th> 1679 </tr> 1680 </thead> 1681 <tbody> 1682 <tr 1683 class="css-190f936-Row" 1684 > 1685 <td 1686 class="css-zstkv9-Cell" 1687 > 1688 <strong 1689 class="css-bvflvn-TextComponent" 1690 > 1691 options 1692 </strong> 1693 <br /> 1694 <span 1695 class="css-1g95u6x" 1696 > 1697 (optional) 1698 </span> 1699 </td> 1700 <td 1701 class="css-zstkv9-Cell" 1702 > 1703 <code 1704 class="css-iwb7ur-TextComponent" 1705 data-text="true" 1706 > 1707 <a 1708 class="css-1na8e0o-A" 1709 href="#appleauthenticationsigninoptions" 1710 > 1711 AppleAuthenticationSignInOptions 1712 </a> 1713 </code> 1714 </td> 1715 <td 1716 class="css-zstkv9-Cell" 1717 > 1718 <p 1719 class="mb-4 css-1kfqm4n-TextComponent" 1720 data-text="true" 1721 > 1722 An optional 1723 <a 1724 class="css-1na8e0o-A" 1725 href="#appleauthenticationsigninoptions" 1726 > 1727 <code 1728 class="css-1a6y07t-TextComponent" 1729 data-text="true" 1730 > 1731 AppleAuthenticationSignInOptions 1732 </code> 1733 </a> 1734 object 1735 </p> 1736 </td> 1737 </tr> 1738 </tbody> 1739 </table> 1740 </div> 1741 <br /> 1742 <p 1743 class="mb-4 css-1kfqm4n-TextComponent" 1744 data-text="true" 1745 > 1746 Sends a request to the operating system to initiate the Apple authentication flow, which will 1747present a modal to the user over your app and allow them to sign in. 1748 </p> 1749 1750 1751 <p 1752 class="mb-4 css-1kfqm4n-TextComponent" 1753 data-text="true" 1754 > 1755 You can request access to the user's full name and email address in this method, which allows you 1756to personalize your UI for signed in users. However, users can deny access to either or both 1757of these options at runtime. 1758 </p> 1759 1760 1761 <p 1762 class="mb-4 css-1kfqm4n-TextComponent" 1763 data-text="true" 1764 > 1765 Additionally, you will only receive Apple Authentication Credentials the first time users sign 1766into your app, so you must store it for later use. It's best to store this information either 1767server-side, or using 1768 <a 1769 class="css-1na8e0o-A" 1770 href="./securestore" 1771 > 1772 SecureStore 1773 </a> 1774 , so that the data persists across app installs. 1775You can use 1776 <a 1777 class="css-1na8e0o-A" 1778 href="#appleauthenticationcredential" 1779 > 1780 <code 1781 class="css-1a6y07t-TextComponent" 1782 data-text="true" 1783 > 1784 AppleAuthenticationCredential.user 1785 </code> 1786 </a> 1787 to identify 1788the user, since this remains the same for apps released by the same developer. 1789 </p> 1790 <p 1791 class="css-1eksndl-BoxSectionHeader" 1792 data-text="true" 1793 > 1794 Returns 1795 </p> 1796 <ul 1797 class="!list-none !ml-0 css-118jp6n-TextComponent" 1798 > 1799 <li 1800 class="css-1hxzfrf-TextComponent" 1801 data-text="true" 1802 > 1803 <svg 1804 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 1805 fill="none" 1806 role="img" 1807 stroke="currentColor" 1808 viewBox="0 0 24 24" 1809 xmlns="http://www.w3.org/2000/svg" 1810 > 1811 <g 1812 id="corner-down-right" 1813 > 1814 <path 1815 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 1816 id="Icon" 1817 stroke-linecap="round" 1818 stroke-linejoin="round" 1819 stroke-width="2" 1820 /> 1821 </g> 1822 </svg> 1823 <code 1824 class="css-iwb7ur-TextComponent" 1825 data-text="true" 1826 > 1827 <a 1828 class="css-1na8e0o-A" 1829 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 1830 rel="noopener noreferrer" 1831 target="_blank" 1832 > 1833 Promise 1834 </a> 1835 < 1836 <span> 1837 <a 1838 class="css-1na8e0o-A" 1839 href="#appleauthenticationcredential" 1840 > 1841 AppleAuthenticationCredential 1842 </a> 1843 </span> 1844 > 1845 </code> 1846 </li> 1847 </ul> 1848 <br /> 1849 <p 1850 class="mb-4 css-1kfqm4n-TextComponent" 1851 data-text="true" 1852 > 1853 A promise that fulfills with an 1854 <a 1855 class="css-1na8e0o-A" 1856 href="#appleauthenticationcredential" 1857 > 1858 <code 1859 class="css-1a6y07t-TextComponent" 1860 data-text="true" 1861 > 1862 AppleAuthenticationCredential 1863 </code> 1864 </a> 1865 1866object after a successful authentication, and rejects with 1867 <code 1868 class="css-1a6y07t-TextComponent" 1869 data-text="true" 1870 > 1871 ERR_REQUEST_CANCELED 1872 </code> 1873 if the user cancels the 1874sign-in operation. 1875 </p> 1876 </div> 1877 <div 1878 class="css-11xr3cd" 1879 > 1880 <h3 1881 class=" css-wbzzgj-TextComponent" 1882 data-heading="true" 1883 > 1884 <a 1885 class="css-1y48vg3" 1886 href="#signoutasyncoptions" 1887 > 1888 <span 1889 class="css-s3qkfm" 1890 id="signoutasyncoptions" 1891 /> 1892 <span 1893 class="css-6n7j50" 1894 > 1895 <code 1896 class="css-s0csg4-TextComponent" 1897 data-text="true" 1898 > 1899 signOutAsync(options) 1900 </code> 1901 </span> 1902 <span 1903 class="css-15j1jyt-PermalinkCopyIcon" 1904 id="docs-anchor-permalink-signoutasyncoptions" 1905 > 1906 <svg 1907 aria-label="permalink" 1908 class="anchor-icon" 1909 fill="none" 1910 height="24" 1911 viewBox="0 0 24 24" 1912 width="24" 1913 xmlns="http://www.w3.org/2000/svg" 1914 > 1915 <path 1916 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 1917 stroke="#9B9B9B" 1918 stroke-linecap="round" 1919 stroke-linejoin="round" 1920 stroke-width="2" 1921 /> 1922 <path 1923 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 1924 stroke="#9B9B9B" 1925 stroke-linecap="round" 1926 stroke-linejoin="round" 1927 stroke-width="2" 1928 /> 1929 </svg> 1930 </span> 1931 </a> 1932 </h3> 1933 <div 1934 class="css-1uyflf8-Table" 1935 > 1936 <table 1937 class="css-q84cm9-Table" 1938 > 1939 <thead 1940 class="bg-subtle border-b border-b-default border-solid" 1941 > 1942 <tr 1943 class="css-190f936-Row" 1944 > 1945 <th 1946 class="css-1uwgm7m-HeaderCell" 1947 > 1948 Name 1949 </th> 1950 <th 1951 class="css-1uwgm7m-HeaderCell" 1952 > 1953 Type 1954 </th> 1955 <th 1956 class="css-1uwgm7m-HeaderCell" 1957 > 1958 Description 1959 </th> 1960 </tr> 1961 </thead> 1962 <tbody> 1963 <tr 1964 class="css-190f936-Row" 1965 > 1966 <td 1967 class="css-zstkv9-Cell" 1968 > 1969 <strong 1970 class="css-bvflvn-TextComponent" 1971 > 1972 options 1973 </strong> 1974 </td> 1975 <td 1976 class="css-zstkv9-Cell" 1977 > 1978 <code 1979 class="css-iwb7ur-TextComponent" 1980 data-text="true" 1981 > 1982 <a 1983 class="css-1na8e0o-A" 1984 href="#appleauthenticationsignoutoptions" 1985 > 1986 AppleAuthenticationSignOutOptions 1987 </a> 1988 </code> 1989 </td> 1990 <td 1991 class="css-zstkv9-Cell" 1992 > 1993 <p 1994 class="mb-4 css-1kfqm4n-TextComponent" 1995 data-text="true" 1996 > 1997 An 1998 <a 1999 class="css-1na8e0o-A" 2000 href="#appleauthenticationsignoutoptions" 2001 > 2002 <code 2003 class="css-1a6y07t-TextComponent" 2004 data-text="true" 2005 > 2006 AppleAuthenticationSignOutOptions 2007 </code> 2008 </a> 2009 object 2010 </p> 2011 </td> 2012 </tr> 2013 </tbody> 2014 </table> 2015 </div> 2016 <br /> 2017 <p 2018 class="mb-4 css-1kfqm4n-TextComponent" 2019 data-text="true" 2020 > 2021 An operation that ends the authenticated session. 2022Calling this method will show the sign in modal before actually signing the user out. 2023 </p> 2024 2025 2026 <p 2027 class="mb-4 css-1kfqm4n-TextComponent" 2028 data-text="true" 2029 > 2030 It is not recommended to use this method to sign out the user as it works counterintuitively. 2031Instead of using this method it is recommended to simply clear all the user's data collected 2032from using 2033 <a 2034 class="css-1na8e0o-A" 2035 href="./#signinasync" 2036 > 2037 <code 2038 class="css-1a6y07t-TextComponent" 2039 data-text="true" 2040 > 2041 signInAsync 2042 </code> 2043 </a> 2044 or 2045 <a 2046 class="css-1na8e0o-A" 2047 href="./#refreshasync" 2048 > 2049 <code 2050 class="css-1a6y07t-TextComponent" 2051 data-text="true" 2052 > 2053 refreshAsync 2054 </code> 2055 </a> 2056 methods. 2057 </p> 2058 <p 2059 class="css-1eksndl-BoxSectionHeader" 2060 data-text="true" 2061 > 2062 Returns 2063 </p> 2064 <ul 2065 class="!list-none !ml-0 css-118jp6n-TextComponent" 2066 > 2067 <li 2068 class="css-1hxzfrf-TextComponent" 2069 data-text="true" 2070 > 2071 <svg 2072 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 2073 fill="none" 2074 role="img" 2075 stroke="currentColor" 2076 viewBox="0 0 24 24" 2077 xmlns="http://www.w3.org/2000/svg" 2078 > 2079 <g 2080 id="corner-down-right" 2081 > 2082 <path 2083 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 2084 id="Icon" 2085 stroke-linecap="round" 2086 stroke-linejoin="round" 2087 stroke-width="2" 2088 /> 2089 </g> 2090 </svg> 2091 <code 2092 class="css-iwb7ur-TextComponent" 2093 data-text="true" 2094 > 2095 <a 2096 class="css-1na8e0o-A" 2097 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 2098 rel="noopener noreferrer" 2099 target="_blank" 2100 > 2101 Promise 2102 </a> 2103 < 2104 <span> 2105 <a 2106 class="css-1na8e0o-A" 2107 href="#appleauthenticationcredential" 2108 > 2109 AppleAuthenticationCredential 2110 </a> 2111 </span> 2112 > 2113 </code> 2114 </li> 2115 </ul> 2116 <br /> 2117 <p 2118 class="mb-4 css-1kfqm4n-TextComponent" 2119 data-text="true" 2120 > 2121 A promise that fulfills with an 2122 <a 2123 class="css-1na8e0o-A" 2124 href="#appleauthenticationcredential" 2125 > 2126 <code 2127 class="css-1a6y07t-TextComponent" 2128 data-text="true" 2129 > 2130 AppleAuthenticationCredential 2131 </code> 2132 </a> 2133 2134object after a successful authentication, and rejects with 2135 <code 2136 class="css-1a6y07t-TextComponent" 2137 data-text="true" 2138 > 2139 ERR_REQUEST_CANCELED 2140 </code> 2141 if the user cancels the 2142sign-out operation. 2143 </p> 2144 </div> 2145 <h2 2146 class=" css-1qsxz84-TextComponent" 2147 data-heading="true" 2148 > 2149 <a 2150 class="css-1y48vg3" 2151 href="#event-subscriptions" 2152 > 2153 <span 2154 class="css-s3qkfm" 2155 id="event-subscriptions" 2156 /> 2157 <span 2158 class="css-6n7j50" 2159 > 2160 Event Subscriptions 2161 </span> 2162 <span 2163 class="css-15j1jyt-PermalinkCopyIcon" 2164 id="docs-anchor-permalink-event-subscriptions" 2165 > 2166 <svg 2167 aria-label="permalink" 2168 class="anchor-icon" 2169 fill="none" 2170 height="24" 2171 viewBox="0 0 24 24" 2172 width="24" 2173 xmlns="http://www.w3.org/2000/svg" 2174 > 2175 <path 2176 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2177 stroke="#9B9B9B" 2178 stroke-linecap="round" 2179 stroke-linejoin="round" 2180 stroke-width="2" 2181 /> 2182 <path 2183 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2184 stroke="#9B9B9B" 2185 stroke-linecap="round" 2186 stroke-linejoin="round" 2187 stroke-width="2" 2188 /> 2189 </svg> 2190 </span> 2191 </a> 2192 </h2> 2193 <div 2194 class="css-11xr3cd" 2195 > 2196 <h3 2197 class=" css-wbzzgj-TextComponent" 2198 data-heading="true" 2199 > 2200 <a 2201 class="css-1y48vg3" 2202 href="#addrevokelistenerlistener" 2203 > 2204 <span 2205 class="css-s3qkfm" 2206 id="addrevokelistenerlistener" 2207 /> 2208 <span 2209 class="css-6n7j50" 2210 > 2211 <code 2212 class="css-s0csg4-TextComponent" 2213 data-text="true" 2214 > 2215 addRevokeListener(listener) 2216 </code> 2217 </span> 2218 <span 2219 class="css-15j1jyt-PermalinkCopyIcon" 2220 id="docs-anchor-permalink-addrevokelistenerlistener" 2221 > 2222 <svg 2223 aria-label="permalink" 2224 class="anchor-icon" 2225 fill="none" 2226 height="24" 2227 viewBox="0 0 24 24" 2228 width="24" 2229 xmlns="http://www.w3.org/2000/svg" 2230 > 2231 <path 2232 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2233 stroke="#9B9B9B" 2234 stroke-linecap="round" 2235 stroke-linejoin="round" 2236 stroke-width="2" 2237 /> 2238 <path 2239 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2240 stroke="#9B9B9B" 2241 stroke-linecap="round" 2242 stroke-linejoin="round" 2243 stroke-width="2" 2244 /> 2245 </svg> 2246 </span> 2247 </a> 2248 </h3> 2249 <div 2250 class="css-1uyflf8-Table" 2251 > 2252 <table 2253 class="css-q84cm9-Table" 2254 > 2255 <thead 2256 class="bg-subtle border-b border-b-default border-solid" 2257 > 2258 <tr 2259 class="css-190f936-Row" 2260 > 2261 <th 2262 class="css-1uwgm7m-HeaderCell" 2263 > 2264 Name 2265 </th> 2266 <th 2267 class="css-1uwgm7m-HeaderCell" 2268 > 2269 Type 2270 </th> 2271 <th 2272 class="css-1uwgm7m-HeaderCell" 2273 > 2274 Description 2275 </th> 2276 </tr> 2277 </thead> 2278 <tbody> 2279 <tr 2280 class="css-190f936-Row" 2281 > 2282 <td 2283 class="css-zstkv9-Cell" 2284 > 2285 <strong 2286 class="css-bvflvn-TextComponent" 2287 > 2288 listener 2289 </strong> 2290 </td> 2291 <td 2292 class="css-zstkv9-Cell" 2293 > 2294 <code 2295 class="css-iwb7ur-TextComponent" 2296 data-text="true" 2297 > 2298 () => 2299 2300 void 2301 </code> 2302 </td> 2303 <td 2304 class="css-zstkv9-Cell" 2305 > 2306 - 2307 </td> 2308 </tr> 2309 </tbody> 2310 </table> 2311 </div> 2312 <br /> 2313 <p 2314 class="css-1eksndl-BoxSectionHeader" 2315 data-text="true" 2316 > 2317 Returns 2318 </p> 2319 <ul 2320 class="!list-none !ml-0 css-118jp6n-TextComponent" 2321 > 2322 <li 2323 class="css-1hxzfrf-TextComponent" 2324 data-text="true" 2325 > 2326 <svg 2327 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 2328 fill="none" 2329 role="img" 2330 stroke="currentColor" 2331 viewBox="0 0 24 24" 2332 xmlns="http://www.w3.org/2000/svg" 2333 > 2334 <g 2335 id="corner-down-right" 2336 > 2337 <path 2338 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 2339 id="Icon" 2340 stroke-linecap="round" 2341 stroke-linejoin="round" 2342 stroke-width="2" 2343 /> 2344 </g> 2345 </svg> 2346 <code 2347 class="css-iwb7ur-TextComponent" 2348 data-text="true" 2349 > 2350 <a 2351 class="css-1na8e0o-A" 2352 href="#subscription" 2353 > 2354 Subscription 2355 </a> 2356 </code> 2357 </li> 2358 </ul> 2359 <br /> 2360 </div> 2361 <h2 2362 class=" css-1qsxz84-TextComponent" 2363 data-heading="true" 2364 > 2365 <a 2366 class="css-1y48vg3" 2367 href="#types" 2368 > 2369 <span 2370 class="css-s3qkfm" 2371 id="types" 2372 /> 2373 <span 2374 class="css-6n7j50" 2375 > 2376 Types 2377 </span> 2378 <span 2379 class="css-15j1jyt-PermalinkCopyIcon" 2380 id="docs-anchor-permalink-types" 2381 > 2382 <svg 2383 aria-label="permalink" 2384 class="anchor-icon" 2385 fill="none" 2386 height="24" 2387 viewBox="0 0 24 24" 2388 width="24" 2389 xmlns="http://www.w3.org/2000/svg" 2390 > 2391 <path 2392 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2393 stroke="#9B9B9B" 2394 stroke-linecap="round" 2395 stroke-linejoin="round" 2396 stroke-width="2" 2397 /> 2398 <path 2399 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2400 stroke="#9B9B9B" 2401 stroke-linecap="round" 2402 stroke-linejoin="round" 2403 stroke-width="2" 2404 /> 2405 </svg> 2406 </span> 2407 </a> 2408 </h2> 2409 <div 2410 class="css-1fultt1" 2411 > 2412 <h3 2413 class=" css-wbzzgj-TextComponent" 2414 data-heading="true" 2415 > 2416 <a 2417 class="css-1y48vg3" 2418 href="#appleauthenticationcredential" 2419 > 2420 <span 2421 class="css-s3qkfm" 2422 id="appleauthenticationcredential" 2423 /> 2424 <span 2425 class="css-6n7j50" 2426 > 2427 <code 2428 class="css-yd3r23-TextComponent" 2429 data-text="true" 2430 > 2431 AppleAuthenticationCredential 2432 </code> 2433 </span> 2434 <span 2435 class="css-15j1jyt-PermalinkCopyIcon" 2436 id="docs-anchor-permalink-appleauthenticationcredential" 2437 > 2438 <svg 2439 aria-label="permalink" 2440 class="anchor-icon" 2441 fill="none" 2442 height="24" 2443 viewBox="0 0 24 24" 2444 width="24" 2445 xmlns="http://www.w3.org/2000/svg" 2446 > 2447 <path 2448 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2449 stroke="#9B9B9B" 2450 stroke-linecap="round" 2451 stroke-linejoin="round" 2452 stroke-width="2" 2453 /> 2454 <path 2455 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2456 stroke="#9B9B9B" 2457 stroke-linecap="round" 2458 stroke-linejoin="round" 2459 stroke-width="2" 2460 /> 2461 </svg> 2462 </span> 2463 </a> 2464 </h3> 2465 <p 2466 class="mb-4 css-1kfqm4n-TextComponent" 2467 data-text="true" 2468 > 2469 The object type returned from a successful call to 2470 <a 2471 class="css-1na8e0o-A" 2472 href="#appleauthenticationsigninasyncoptions" 2473 > 2474 <code 2475 class="css-1a6y07t-TextComponent" 2476 data-text="true" 2477 > 2478 AppleAuthentication.signInAsync() 2479 </code> 2480 </a> 2481 , 2482 2483 <a 2484 class="css-1na8e0o-A" 2485 href="#appleauthenticationrefreshasyncoptions" 2486 > 2487 <code 2488 class="css-1a6y07t-TextComponent" 2489 data-text="true" 2490 > 2491 AppleAuthentication.refreshAsync() 2492 </code> 2493 </a> 2494 , or 2495 <a 2496 class="css-1na8e0o-A" 2497 href="#appleauthenticationsignoutasyncoptions" 2498 > 2499 <code 2500 class="css-1a6y07t-TextComponent" 2501 data-text="true" 2502 > 2503 AppleAuthentication.signOutAsync() 2504 </code> 2505 </a> 2506 2507which contains all of the pertinent user and credential information. 2508 </p> 2509 <blockquote 2510 class="css-zknray-Callout" 2511 data-testid="callout-container" 2512 > 2513 <div 2514 class="css-7jywx8-Callout" 2515 > 2516 <svg 2517 class="icon-sm text-icon-default" 2518 fill="currentColor" 2519 role="img" 2520 viewBox="0 0 24 24" 2521 xmlns="http://www.w3.org/2000/svg" 2522 > 2523 <g 2524 id="info-circle" 2525 > 2526 <path 2527 clip-rule="evenodd" 2528 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 2529 fill-rule="evenodd" 2530 id="Solid" 2531 /> 2532 </g> 2533 </svg> 2534 </div> 2535 <div 2536 class="css-1m74yfi-Callout" 2537 > 2538 <p 2539 class="mb-4 css-1kfqm4n-TextComponent" 2540 data-text="true" 2541 > 2542 <strong 2543 class="css-bvflvn-TextComponent" 2544 > 2545 See: 2546 </strong> 2547 2548 <a 2549 class="css-1na8e0o-A" 2550 href="https://developer.apple.com/documentation/authenticationservices/asauthorizationappleidcredential" 2551 rel="noopener noreferrer" 2552 target="_blank" 2553 > 2554 Apple 2555Documentation 2556 </a> 2557 2558for more details. 2559 </p> 2560 </div> 2561 </blockquote> 2562 <div 2563 class="css-1uyflf8-Table" 2564 > 2565 <table 2566 class="css-q84cm9-Table" 2567 > 2568 <thead 2569 class="bg-subtle border-b border-b-default border-solid" 2570 > 2571 <tr 2572 class="css-190f936-Row" 2573 > 2574 <th 2575 class="css-1uwgm7m-HeaderCell" 2576 > 2577 Name 2578 </th> 2579 <th 2580 class="css-1uwgm7m-HeaderCell" 2581 > 2582 Type 2583 </th> 2584 <th 2585 class="css-1uwgm7m-HeaderCell" 2586 > 2587 Description 2588 </th> 2589 </tr> 2590 </thead> 2591 <tbody> 2592 <tr 2593 class="css-190f936-Row" 2594 > 2595 <td 2596 class="css-18p3734-Cell" 2597 > 2598 <strong 2599 class="css-bvflvn-TextComponent" 2600 > 2601 authorizationCode 2602 </strong> 2603 </td> 2604 <td 2605 class="css-18p3734-Cell" 2606 > 2607 <code 2608 class="css-iwb7ur-TextComponent" 2609 data-text="true" 2610 > 2611 <span> 2612 string 2613 | 2614 </span> 2615 <span> 2616 null 2617 </span> 2618 </code> 2619 </td> 2620 <td 2621 class="css-18p3734-Cell" 2622 > 2623 <p 2624 class="mb-4 css-1kfqm4n-TextComponent" 2625 data-text="true" 2626 > 2627 A short-lived session token used by your app for proof of authorization when interacting with 2628the app's server counterpart. Unlike 2629 <code 2630 class="css-1a6y07t-TextComponent" 2631 data-text="true" 2632 > 2633 user 2634 </code> 2635 , this is ephemeral and will change each session. 2636 </p> 2637 </td> 2638 </tr> 2639 <tr 2640 class="css-190f936-Row" 2641 > 2642 <td 2643 class="css-18p3734-Cell" 2644 > 2645 <strong 2646 class="css-bvflvn-TextComponent" 2647 > 2648 email 2649 </strong> 2650 </td> 2651 <td 2652 class="css-18p3734-Cell" 2653 > 2654 <code 2655 class="css-iwb7ur-TextComponent" 2656 data-text="true" 2657 > 2658 <span> 2659 string 2660 | 2661 </span> 2662 <span> 2663 null 2664 </span> 2665 </code> 2666 </td> 2667 <td 2668 class="css-18p3734-Cell" 2669 > 2670 <p 2671 class="mb-4 css-1kfqm4n-TextComponent" 2672 data-text="true" 2673 > 2674 The user's email address. Might not be present if you didn't request the 2675 <code 2676 class="css-1a6y07t-TextComponent" 2677 data-text="true" 2678 > 2679 EMAIL 2680 </code> 2681 scope. May 2682also be null if this is not the first time the user has signed into your app. If the user chose 2683to withhold their email address, this field will instead contain an obscured email address with 2684an Apple domain. 2685 </p> 2686 </td> 2687 </tr> 2688 <tr 2689 class="css-190f936-Row" 2690 > 2691 <td 2692 class="css-18p3734-Cell" 2693 > 2694 <strong 2695 class="css-bvflvn-TextComponent" 2696 > 2697 fullName 2698 </strong> 2699 </td> 2700 <td 2701 class="css-18p3734-Cell" 2702 > 2703 <code 2704 class="css-iwb7ur-TextComponent" 2705 data-text="true" 2706 > 2707 <span> 2708 <a 2709 class="css-1na8e0o-A" 2710 href="#appleauthenticationfullname" 2711 > 2712 AppleAuthenticationFullName 2713 </a> 2714 | 2715 </span> 2716 <span> 2717 null 2718 </span> 2719 </code> 2720 </td> 2721 <td 2722 class="css-18p3734-Cell" 2723 > 2724 <p 2725 class="mb-4 css-1kfqm4n-TextComponent" 2726 data-text="true" 2727 > 2728 The user's name. May be 2729 <code 2730 class="css-1a6y07t-TextComponent" 2731 data-text="true" 2732 > 2733 null 2734 </code> 2735 or contain 2736 <code 2737 class="css-1a6y07t-TextComponent" 2738 data-text="true" 2739 > 2740 null 2741 </code> 2742 values if you didn't request the 2743 <code 2744 class="css-1a6y07t-TextComponent" 2745 data-text="true" 2746 > 2747 FULL_NAME 2748 </code> 2749 2750scope, if the user denied access, or if this is not the first time the user has signed into 2751your app. 2752 </p> 2753 </td> 2754 </tr> 2755 <tr 2756 class="css-190f936-Row" 2757 > 2758 <td 2759 class="css-18p3734-Cell" 2760 > 2761 <strong 2762 class="css-bvflvn-TextComponent" 2763 > 2764 identityToken 2765 </strong> 2766 </td> 2767 <td 2768 class="css-18p3734-Cell" 2769 > 2770 <code 2771 class="css-iwb7ur-TextComponent" 2772 data-text="true" 2773 > 2774 <span> 2775 string 2776 | 2777 </span> 2778 <span> 2779 null 2780 </span> 2781 </code> 2782 </td> 2783 <td 2784 class="css-18p3734-Cell" 2785 > 2786 <p 2787 class="mb-4 css-1kfqm4n-TextComponent" 2788 data-text="true" 2789 > 2790 A JSON Web Token (JWT) that securely communicates information about the user to your app. 2791 </p> 2792 </td> 2793 </tr> 2794 <tr 2795 class="css-190f936-Row" 2796 > 2797 <td 2798 class="css-18p3734-Cell" 2799 > 2800 <strong 2801 class="css-bvflvn-TextComponent" 2802 > 2803 realUserStatus 2804 </strong> 2805 </td> 2806 <td 2807 class="css-18p3734-Cell" 2808 > 2809 <code 2810 class="css-iwb7ur-TextComponent" 2811 data-text="true" 2812 > 2813 <a 2814 class="css-1na8e0o-A" 2815 href="#appleauthenticationuserdetectionstatus" 2816 > 2817 AppleAuthenticationUserDetectionStatus 2818 </a> 2819 </code> 2820 </td> 2821 <td 2822 class="css-18p3734-Cell" 2823 > 2824 <p 2825 class="mb-4 css-1kfqm4n-TextComponent" 2826 data-text="true" 2827 > 2828 A value that indicates whether the user appears to the system to be a real person. 2829 </p> 2830 </td> 2831 </tr> 2832 <tr 2833 class="css-190f936-Row" 2834 > 2835 <td 2836 class="css-18p3734-Cell" 2837 > 2838 <strong 2839 class="css-bvflvn-TextComponent" 2840 > 2841 state 2842 </strong> 2843 </td> 2844 <td 2845 class="css-18p3734-Cell" 2846 > 2847 <code 2848 class="css-iwb7ur-TextComponent" 2849 data-text="true" 2850 > 2851 <span> 2852 string 2853 | 2854 </span> 2855 <span> 2856 null 2857 </span> 2858 </code> 2859 </td> 2860 <td 2861 class="css-18p3734-Cell" 2862 > 2863 <p 2864 class="mb-4 css-1kfqm4n-TextComponent" 2865 data-text="true" 2866 > 2867 An arbitrary string that your app provided as 2868 <code 2869 class="css-1a6y07t-TextComponent" 2870 data-text="true" 2871 > 2872 state 2873 </code> 2874 in the request that generated the 2875credential. Used to verify that the response was from the request you made. Can be used to 2876avoid replay attacks. If you did not provide 2877 <code 2878 class="css-1a6y07t-TextComponent" 2879 data-text="true" 2880 > 2881 state 2882 </code> 2883 when making the sign-in request, this field 2884will be 2885 <code 2886 class="css-1a6y07t-TextComponent" 2887 data-text="true" 2888 > 2889 null 2890 </code> 2891 . 2892 </p> 2893 </td> 2894 </tr> 2895 <tr 2896 class="css-190f936-Row" 2897 > 2898 <td 2899 class="css-18p3734-Cell" 2900 > 2901 <strong 2902 class="css-bvflvn-TextComponent" 2903 > 2904 user 2905 </strong> 2906 </td> 2907 <td 2908 class="css-18p3734-Cell" 2909 > 2910 <code 2911 class="css-iwb7ur-TextComponent" 2912 data-text="true" 2913 > 2914 string 2915 </code> 2916 </td> 2917 <td 2918 class="css-18p3734-Cell" 2919 > 2920 <p 2921 class="mb-4 css-1kfqm4n-TextComponent" 2922 data-text="true" 2923 > 2924 An identifier associated with the authenticated user. You can use this to check if the user is 2925still authenticated later. This is stable and can be shared across apps released under the same 2926development team. The same user will have a different identifier for apps released by other 2927developers. 2928 </p> 2929 </td> 2930 </tr> 2931 </tbody> 2932 </table> 2933 </div> 2934 </div> 2935 <div 2936 class="css-1fultt1" 2937 > 2938 <h3 2939 class=" css-wbzzgj-TextComponent" 2940 data-heading="true" 2941 > 2942 <a 2943 class="css-1y48vg3" 2944 href="#appleauthenticationfullname" 2945 > 2946 <span 2947 class="css-s3qkfm" 2948 id="appleauthenticationfullname" 2949 /> 2950 <span 2951 class="css-6n7j50" 2952 > 2953 <code 2954 class="css-yd3r23-TextComponent" 2955 data-text="true" 2956 > 2957 AppleAuthenticationFullName 2958 </code> 2959 </span> 2960 <span 2961 class="css-15j1jyt-PermalinkCopyIcon" 2962 id="docs-anchor-permalink-appleauthenticationfullname" 2963 > 2964 <svg 2965 aria-label="permalink" 2966 class="anchor-icon" 2967 fill="none" 2968 height="24" 2969 viewBox="0 0 24 24" 2970 width="24" 2971 xmlns="http://www.w3.org/2000/svg" 2972 > 2973 <path 2974 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 2975 stroke="#9B9B9B" 2976 stroke-linecap="round" 2977 stroke-linejoin="round" 2978 stroke-width="2" 2979 /> 2980 <path 2981 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 2982 stroke="#9B9B9B" 2983 stroke-linecap="round" 2984 stroke-linejoin="round" 2985 stroke-width="2" 2986 /> 2987 </svg> 2988 </span> 2989 </a> 2990 </h3> 2991 <p 2992 class="mb-4 css-1kfqm4n-TextComponent" 2993 data-text="true" 2994 > 2995 An object representing the tokenized portions of the user's full name. Any of all of the fields 2996may be 2997 <code 2998 class="css-1a6y07t-TextComponent" 2999 data-text="true" 3000 > 3001 null 3002 </code> 3003 . Only applicable fields that the user has allowed your app to access will be nonnull. 3004 </p> 3005 <div 3006 class="css-1uyflf8-Table" 3007 > 3008 <table 3009 class="css-q84cm9-Table" 3010 > 3011 <thead 3012 class="bg-subtle border-b border-b-default border-solid" 3013 > 3014 <tr 3015 class="css-190f936-Row" 3016 > 3017 <th 3018 class="css-1uwgm7m-HeaderCell" 3019 > 3020 Name 3021 </th> 3022 <th 3023 class="css-1uwgm7m-HeaderCell" 3024 > 3025 Type 3026 </th> 3027 <th 3028 class="css-1uwgm7m-HeaderCell" 3029 > 3030 Description 3031 </th> 3032 </tr> 3033 </thead> 3034 <tbody> 3035 <tr 3036 class="css-190f936-Row" 3037 > 3038 <td 3039 class="css-18p3734-Cell" 3040 > 3041 <strong 3042 class="css-bvflvn-TextComponent" 3043 > 3044 familyName 3045 </strong> 3046 </td> 3047 <td 3048 class="css-18p3734-Cell" 3049 > 3050 <code 3051 class="css-iwb7ur-TextComponent" 3052 data-text="true" 3053 > 3054 <span> 3055 string 3056 | 3057 </span> 3058 <span> 3059 null 3060 </span> 3061 </code> 3062 </td> 3063 <td 3064 class="css-18p3734-Cell" 3065 > 3066 - 3067 </td> 3068 </tr> 3069 <tr 3070 class="css-190f936-Row" 3071 > 3072 <td 3073 class="css-18p3734-Cell" 3074 > 3075 <strong 3076 class="css-bvflvn-TextComponent" 3077 > 3078 givenName 3079 </strong> 3080 </td> 3081 <td 3082 class="css-18p3734-Cell" 3083 > 3084 <code 3085 class="css-iwb7ur-TextComponent" 3086 data-text="true" 3087 > 3088 <span> 3089 string 3090 | 3091 </span> 3092 <span> 3093 null 3094 </span> 3095 </code> 3096 </td> 3097 <td 3098 class="css-18p3734-Cell" 3099 > 3100 - 3101 </td> 3102 </tr> 3103 <tr 3104 class="css-190f936-Row" 3105 > 3106 <td 3107 class="css-18p3734-Cell" 3108 > 3109 <strong 3110 class="css-bvflvn-TextComponent" 3111 > 3112 middleName 3113 </strong> 3114 </td> 3115 <td 3116 class="css-18p3734-Cell" 3117 > 3118 <code 3119 class="css-iwb7ur-TextComponent" 3120 data-text="true" 3121 > 3122 <span> 3123 string 3124 | 3125 </span> 3126 <span> 3127 null 3128 </span> 3129 </code> 3130 </td> 3131 <td 3132 class="css-18p3734-Cell" 3133 > 3134 - 3135 </td> 3136 </tr> 3137 <tr 3138 class="css-190f936-Row" 3139 > 3140 <td 3141 class="css-18p3734-Cell" 3142 > 3143 <strong 3144 class="css-bvflvn-TextComponent" 3145 > 3146 namePrefix 3147 </strong> 3148 </td> 3149 <td 3150 class="css-18p3734-Cell" 3151 > 3152 <code 3153 class="css-iwb7ur-TextComponent" 3154 data-text="true" 3155 > 3156 <span> 3157 string 3158 | 3159 </span> 3160 <span> 3161 null 3162 </span> 3163 </code> 3164 </td> 3165 <td 3166 class="css-18p3734-Cell" 3167 > 3168 - 3169 </td> 3170 </tr> 3171 <tr 3172 class="css-190f936-Row" 3173 > 3174 <td 3175 class="css-18p3734-Cell" 3176 > 3177 <strong 3178 class="css-bvflvn-TextComponent" 3179 > 3180 nameSuffix 3181 </strong> 3182 </td> 3183 <td 3184 class="css-18p3734-Cell" 3185 > 3186 <code 3187 class="css-iwb7ur-TextComponent" 3188 data-text="true" 3189 > 3190 <span> 3191 string 3192 | 3193 </span> 3194 <span> 3195 null 3196 </span> 3197 </code> 3198 </td> 3199 <td 3200 class="css-18p3734-Cell" 3201 > 3202 - 3203 </td> 3204 </tr> 3205 <tr 3206 class="css-190f936-Row" 3207 > 3208 <td 3209 class="css-18p3734-Cell" 3210 > 3211 <strong 3212 class="css-bvflvn-TextComponent" 3213 > 3214 nickname 3215 </strong> 3216 </td> 3217 <td 3218 class="css-18p3734-Cell" 3219 > 3220 <code 3221 class="css-iwb7ur-TextComponent" 3222 data-text="true" 3223 > 3224 <span> 3225 string 3226 | 3227 </span> 3228 <span> 3229 null 3230 </span> 3231 </code> 3232 </td> 3233 <td 3234 class="css-18p3734-Cell" 3235 > 3236 - 3237 </td> 3238 </tr> 3239 </tbody> 3240 </table> 3241 </div> 3242 </div> 3243 <div 3244 class="css-1fultt1" 3245 > 3246 <h3 3247 class=" css-wbzzgj-TextComponent" 3248 data-heading="true" 3249 > 3250 <a 3251 class="css-1y48vg3" 3252 href="#appleauthenticationrefreshoptions" 3253 > 3254 <span 3255 class="css-s3qkfm" 3256 id="appleauthenticationrefreshoptions" 3257 /> 3258 <span 3259 class="css-6n7j50" 3260 > 3261 <code 3262 class="css-yd3r23-TextComponent" 3263 data-text="true" 3264 > 3265 AppleAuthenticationRefreshOptions 3266 </code> 3267 </span> 3268 <span 3269 class="css-15j1jyt-PermalinkCopyIcon" 3270 id="docs-anchor-permalink-appleauthenticationrefreshoptions" 3271 > 3272 <svg 3273 aria-label="permalink" 3274 class="anchor-icon" 3275 fill="none" 3276 height="24" 3277 viewBox="0 0 24 24" 3278 width="24" 3279 xmlns="http://www.w3.org/2000/svg" 3280 > 3281 <path 3282 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3283 stroke="#9B9B9B" 3284 stroke-linecap="round" 3285 stroke-linejoin="round" 3286 stroke-width="2" 3287 /> 3288 <path 3289 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3290 stroke="#9B9B9B" 3291 stroke-linecap="round" 3292 stroke-linejoin="round" 3293 stroke-width="2" 3294 /> 3295 </svg> 3296 </span> 3297 </a> 3298 </h3> 3299 <p 3300 class="mb-4 css-1kfqm4n-TextComponent" 3301 data-text="true" 3302 > 3303 The options you can supply when making a call to 3304 <a 3305 class="css-1na8e0o-A" 3306 href="#appleauthenticationrefreshasyncoptions" 3307 > 3308 <code 3309 class="css-1a6y07t-TextComponent" 3310 data-text="true" 3311 > 3312 AppleAuthentication.refreshAsync() 3313 </code> 3314 </a> 3315 . 3316You must include the ID string of the user whose credentials you'd like to refresh. 3317 </p> 3318 <blockquote 3319 class="css-zknray-Callout" 3320 data-testid="callout-container" 3321 > 3322 <div 3323 class="css-7jywx8-Callout" 3324 > 3325 <svg 3326 class="icon-sm text-icon-default" 3327 fill="currentColor" 3328 role="img" 3329 viewBox="0 0 24 24" 3330 xmlns="http://www.w3.org/2000/svg" 3331 > 3332 <g 3333 id="info-circle" 3334 > 3335 <path 3336 clip-rule="evenodd" 3337 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 3338 fill-rule="evenodd" 3339 id="Solid" 3340 /> 3341 </g> 3342 </svg> 3343 </div> 3344 <div 3345 class="css-1m74yfi-Callout" 3346 > 3347 <p 3348 class="mb-4 css-1kfqm4n-TextComponent" 3349 data-text="true" 3350 > 3351 <strong 3352 class="css-bvflvn-TextComponent" 3353 > 3354 See: 3355 </strong> 3356 3357 <a 3358 class="css-1na8e0o-A" 3359 href="https://developer.apple.com/documentation/authenticationservices/asauthorizationopenidrequest" 3360 rel="noopener noreferrer" 3361 target="_blank" 3362 > 3363 Apple 3364Documentation 3365 </a> 3366 3367for more details. 3368 </p> 3369 </div> 3370 </blockquote> 3371 <div 3372 class="css-1uyflf8-Table" 3373 > 3374 <table 3375 class="css-q84cm9-Table" 3376 > 3377 <thead 3378 class="bg-subtle border-b border-b-default border-solid" 3379 > 3380 <tr 3381 class="css-190f936-Row" 3382 > 3383 <th 3384 class="css-1uwgm7m-HeaderCell" 3385 > 3386 Name 3387 </th> 3388 <th 3389 class="css-1uwgm7m-HeaderCell" 3390 > 3391 Type 3392 </th> 3393 <th 3394 class="css-1uwgm7m-HeaderCell" 3395 > 3396 Description 3397 </th> 3398 </tr> 3399 </thead> 3400 <tbody> 3401 <tr 3402 class="css-190f936-Row" 3403 > 3404 <td 3405 class="css-18p3734-Cell" 3406 > 3407 <strong 3408 class="css-bvflvn-TextComponent" 3409 > 3410 requestedScopes 3411 </strong> 3412 <br /> 3413 <span 3414 class="css-1g95u6x" 3415 > 3416 (optional) 3417 </span> 3418 </td> 3419 <td 3420 class="css-18p3734-Cell" 3421 > 3422 <code 3423 class="css-iwb7ur-TextComponent" 3424 data-text="true" 3425 > 3426 <a 3427 class="css-1na8e0o-A" 3428 href="#appleauthenticationscope" 3429 > 3430 AppleAuthenticationScope 3431 [] 3432 </a> 3433 </code> 3434 </td> 3435 <td 3436 class="css-18p3734-Cell" 3437 > 3438 <p 3439 class="mb-4 css-1kfqm4n-TextComponent" 3440 data-text="true" 3441 > 3442 Array of user information scopes to which your app is requesting access. Note that the user can 3443choose to deny your app access to any scope at the time of logging in. You will still need to 3444handle 3445 <code 3446 class="css-1a6y07t-TextComponent" 3447 data-text="true" 3448 > 3449 null 3450 </code> 3451 values for any scopes you request. Additionally, note that the requested scopes 3452will only be provided to you the first time each user signs into your app; in subsequent 3453requests they will be 3454 <code 3455 class="css-1a6y07t-TextComponent" 3456 data-text="true" 3457 > 3458 null 3459 </code> 3460 . Defaults to 3461 <code 3462 class="css-1a6y07t-TextComponent" 3463 data-text="true" 3464 > 3465 [] 3466 </code> 3467 (no scopes). 3468 </p> 3469 </td> 3470 </tr> 3471 <tr 3472 class="css-190f936-Row" 3473 > 3474 <td 3475 class="css-18p3734-Cell" 3476 > 3477 <strong 3478 class="css-bvflvn-TextComponent" 3479 > 3480 state 3481 </strong> 3482 <br /> 3483 <span 3484 class="css-1g95u6x" 3485 > 3486 (optional) 3487 </span> 3488 </td> 3489 <td 3490 class="css-18p3734-Cell" 3491 > 3492 <code 3493 class="css-iwb7ur-TextComponent" 3494 data-text="true" 3495 > 3496 string 3497 </code> 3498 </td> 3499 <td 3500 class="css-18p3734-Cell" 3501 > 3502 <p 3503 class="mb-4 css-1kfqm4n-TextComponent" 3504 data-text="true" 3505 > 3506 An arbitrary string that is returned unmodified in the corresponding credential after a 3507successful authentication. This can be used to verify that the response was from the request 3508you made and avoid replay attacks. More information on this property is available in the 3509OAuth 2.0 protocol 3510 <a 3511 class="css-1na8e0o-A" 3512 href="https://tools.ietf.org/html/rfc6749#section-10.12" 3513 rel="noopener noreferrer" 3514 target="_blank" 3515 > 3516 RFC6749 3517 </a> 3518 . 3519 </p> 3520 </td> 3521 </tr> 3522 <tr 3523 class="css-190f936-Row" 3524 > 3525 <td 3526 class="css-18p3734-Cell" 3527 > 3528 <strong 3529 class="css-bvflvn-TextComponent" 3530 > 3531 user 3532 </strong> 3533 </td> 3534 <td 3535 class="css-18p3734-Cell" 3536 > 3537 <code 3538 class="css-iwb7ur-TextComponent" 3539 data-text="true" 3540 > 3541 string 3542 </code> 3543 </td> 3544 <td 3545 class="css-18p3734-Cell" 3546 > 3547 - 3548 </td> 3549 </tr> 3550 </tbody> 3551 </table> 3552 </div> 3553 </div> 3554 <div 3555 class="css-1fultt1" 3556 > 3557 <h3 3558 class=" css-wbzzgj-TextComponent" 3559 data-heading="true" 3560 > 3561 <a 3562 class="css-1y48vg3" 3563 href="#appleauthenticationsigninoptions" 3564 > 3565 <span 3566 class="css-s3qkfm" 3567 id="appleauthenticationsigninoptions" 3568 /> 3569 <span 3570 class="css-6n7j50" 3571 > 3572 <code 3573 class="css-yd3r23-TextComponent" 3574 data-text="true" 3575 > 3576 AppleAuthenticationSignInOptions 3577 </code> 3578 </span> 3579 <span 3580 class="css-15j1jyt-PermalinkCopyIcon" 3581 id="docs-anchor-permalink-appleauthenticationsigninoptions" 3582 > 3583 <svg 3584 aria-label="permalink" 3585 class="anchor-icon" 3586 fill="none" 3587 height="24" 3588 viewBox="0 0 24 24" 3589 width="24" 3590 xmlns="http://www.w3.org/2000/svg" 3591 > 3592 <path 3593 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3594 stroke="#9B9B9B" 3595 stroke-linecap="round" 3596 stroke-linejoin="round" 3597 stroke-width="2" 3598 /> 3599 <path 3600 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3601 stroke="#9B9B9B" 3602 stroke-linecap="round" 3603 stroke-linejoin="round" 3604 stroke-width="2" 3605 /> 3606 </svg> 3607 </span> 3608 </a> 3609 </h3> 3610 <p 3611 class="mb-4 css-1kfqm4n-TextComponent" 3612 data-text="true" 3613 > 3614 The options you can supply when making a call to 3615 <a 3616 class="css-1na8e0o-A" 3617 href="#appleauthenticationsigninasyncoptions" 3618 > 3619 <code 3620 class="css-1a6y07t-TextComponent" 3621 data-text="true" 3622 > 3623 AppleAuthentication.signInAsync() 3624 </code> 3625 </a> 3626 . 3627None of these options are required. 3628 </p> 3629 <blockquote 3630 class="css-zknray-Callout" 3631 data-testid="callout-container" 3632 > 3633 <div 3634 class="css-7jywx8-Callout" 3635 > 3636 <svg 3637 class="icon-sm text-icon-default" 3638 fill="currentColor" 3639 role="img" 3640 viewBox="0 0 24 24" 3641 xmlns="http://www.w3.org/2000/svg" 3642 > 3643 <g 3644 id="info-circle" 3645 > 3646 <path 3647 clip-rule="evenodd" 3648 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 3649 fill-rule="evenodd" 3650 id="Solid" 3651 /> 3652 </g> 3653 </svg> 3654 </div> 3655 <div 3656 class="css-1m74yfi-Callout" 3657 > 3658 <p 3659 class="mb-4 css-1kfqm4n-TextComponent" 3660 data-text="true" 3661 > 3662 <strong 3663 class="css-bvflvn-TextComponent" 3664 > 3665 See: 3666 </strong> 3667 3668 <a 3669 class="css-1na8e0o-A" 3670 href="https://developer.apple.com/documentation/authenticationservices/asauthorizationopenidrequest" 3671 rel="noopener noreferrer" 3672 target="_blank" 3673 > 3674 Apple 3675Documentation 3676 </a> 3677 3678for more details. 3679 </p> 3680 </div> 3681 </blockquote> 3682 <div 3683 class="css-1uyflf8-Table" 3684 > 3685 <table 3686 class="css-q84cm9-Table" 3687 > 3688 <thead 3689 class="bg-subtle border-b border-b-default border-solid" 3690 > 3691 <tr 3692 class="css-190f936-Row" 3693 > 3694 <th 3695 class="css-1uwgm7m-HeaderCell" 3696 > 3697 Name 3698 </th> 3699 <th 3700 class="css-1uwgm7m-HeaderCell" 3701 > 3702 Type 3703 </th> 3704 <th 3705 class="css-1uwgm7m-HeaderCell" 3706 > 3707 Description 3708 </th> 3709 </tr> 3710 </thead> 3711 <tbody> 3712 <tr 3713 class="css-190f936-Row" 3714 > 3715 <td 3716 class="css-18p3734-Cell" 3717 > 3718 <strong 3719 class="css-bvflvn-TextComponent" 3720 > 3721 nonce 3722 </strong> 3723 <br /> 3724 <span 3725 class="css-1g95u6x" 3726 > 3727 (optional) 3728 </span> 3729 </td> 3730 <td 3731 class="css-18p3734-Cell" 3732 > 3733 <code 3734 class="css-iwb7ur-TextComponent" 3735 data-text="true" 3736 > 3737 string 3738 </code> 3739 </td> 3740 <td 3741 class="css-18p3734-Cell" 3742 > 3743 <p 3744 class="mb-4 css-1kfqm4n-TextComponent" 3745 data-text="true" 3746 > 3747 An arbitrary string that is used to prevent replay attacks. See more information on this in the 3748 3749 <a 3750 class="css-1na8e0o-A" 3751 href="https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowSteps" 3752 rel="noopener noreferrer" 3753 target="_blank" 3754 > 3755 OpenID Connect specification 3756 </a> 3757 . 3758 </p> 3759 </td> 3760 </tr> 3761 <tr 3762 class="css-190f936-Row" 3763 > 3764 <td 3765 class="css-18p3734-Cell" 3766 > 3767 <strong 3768 class="css-bvflvn-TextComponent" 3769 > 3770 requestedScopes 3771 </strong> 3772 <br /> 3773 <span 3774 class="css-1g95u6x" 3775 > 3776 (optional) 3777 </span> 3778 </td> 3779 <td 3780 class="css-18p3734-Cell" 3781 > 3782 <code 3783 class="css-iwb7ur-TextComponent" 3784 data-text="true" 3785 > 3786 <a 3787 class="css-1na8e0o-A" 3788 href="#appleauthenticationscope" 3789 > 3790 AppleAuthenticationScope 3791 [] 3792 </a> 3793 </code> 3794 </td> 3795 <td 3796 class="css-18p3734-Cell" 3797 > 3798 <p 3799 class="mb-4 css-1kfqm4n-TextComponent" 3800 data-text="true" 3801 > 3802 Array of user information scopes to which your app is requesting access. Note that the user can 3803choose to deny your app access to any scope at the time of logging in. You will still need to 3804handle 3805 <code 3806 class="css-1a6y07t-TextComponent" 3807 data-text="true" 3808 > 3809 null 3810 </code> 3811 values for any scopes you request. Additionally, note that the requested scopes 3812will only be provided to you the first time each user signs into your app; in subsequent 3813requests they will be 3814 <code 3815 class="css-1a6y07t-TextComponent" 3816 data-text="true" 3817 > 3818 null 3819 </code> 3820 . Defaults to 3821 <code 3822 class="css-1a6y07t-TextComponent" 3823 data-text="true" 3824 > 3825 [] 3826 </code> 3827 (no scopes). 3828 </p> 3829 </td> 3830 </tr> 3831 <tr 3832 class="css-190f936-Row" 3833 > 3834 <td 3835 class="css-18p3734-Cell" 3836 > 3837 <strong 3838 class="css-bvflvn-TextComponent" 3839 > 3840 state 3841 </strong> 3842 <br /> 3843 <span 3844 class="css-1g95u6x" 3845 > 3846 (optional) 3847 </span> 3848 </td> 3849 <td 3850 class="css-18p3734-Cell" 3851 > 3852 <code 3853 class="css-iwb7ur-TextComponent" 3854 data-text="true" 3855 > 3856 string 3857 </code> 3858 </td> 3859 <td 3860 class="css-18p3734-Cell" 3861 > 3862 <p 3863 class="mb-4 css-1kfqm4n-TextComponent" 3864 data-text="true" 3865 > 3866 An arbitrary string that is returned unmodified in the corresponding credential after a 3867successful authentication. This can be used to verify that the response was from the request 3868you made and avoid replay attacks. More information on this property is available in the 3869OAuth 2.0 protocol 3870 <a 3871 class="css-1na8e0o-A" 3872 href="https://tools.ietf.org/html/rfc6749#section-10.12" 3873 rel="noopener noreferrer" 3874 target="_blank" 3875 > 3876 RFC6749 3877 </a> 3878 . 3879 </p> 3880 </td> 3881 </tr> 3882 </tbody> 3883 </table> 3884 </div> 3885 </div> 3886 <div 3887 class="css-1fultt1" 3888 > 3889 <h3 3890 class=" css-wbzzgj-TextComponent" 3891 data-heading="true" 3892 > 3893 <a 3894 class="css-1y48vg3" 3895 href="#appleauthenticationsignoutoptions" 3896 > 3897 <span 3898 class="css-s3qkfm" 3899 id="appleauthenticationsignoutoptions" 3900 /> 3901 <span 3902 class="css-6n7j50" 3903 > 3904 <code 3905 class="css-yd3r23-TextComponent" 3906 data-text="true" 3907 > 3908 AppleAuthenticationSignOutOptions 3909 </code> 3910 </span> 3911 <span 3912 class="css-15j1jyt-PermalinkCopyIcon" 3913 id="docs-anchor-permalink-appleauthenticationsignoutoptions" 3914 > 3915 <svg 3916 aria-label="permalink" 3917 class="anchor-icon" 3918 fill="none" 3919 height="24" 3920 viewBox="0 0 24 24" 3921 width="24" 3922 xmlns="http://www.w3.org/2000/svg" 3923 > 3924 <path 3925 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 3926 stroke="#9B9B9B" 3927 stroke-linecap="round" 3928 stroke-linejoin="round" 3929 stroke-width="2" 3930 /> 3931 <path 3932 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 3933 stroke="#9B9B9B" 3934 stroke-linecap="round" 3935 stroke-linejoin="round" 3936 stroke-width="2" 3937 /> 3938 </svg> 3939 </span> 3940 </a> 3941 </h3> 3942 <p 3943 class="mb-4 css-1kfqm4n-TextComponent" 3944 data-text="true" 3945 > 3946 The options you can supply when making a call to 3947 <a 3948 class="css-1na8e0o-A" 3949 href="#appleauthenticationsignoutasyncoptions" 3950 > 3951 <code 3952 class="css-1a6y07t-TextComponent" 3953 data-text="true" 3954 > 3955 AppleAuthentication.signOutAsync() 3956 </code> 3957 </a> 3958 . 3959You must include the ID string of the user to sign out. 3960 </p> 3961 <blockquote 3962 class="css-zknray-Callout" 3963 data-testid="callout-container" 3964 > 3965 <div 3966 class="css-7jywx8-Callout" 3967 > 3968 <svg 3969 class="icon-sm text-icon-default" 3970 fill="currentColor" 3971 role="img" 3972 viewBox="0 0 24 24" 3973 xmlns="http://www.w3.org/2000/svg" 3974 > 3975 <g 3976 id="info-circle" 3977 > 3978 <path 3979 clip-rule="evenodd" 3980 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 3981 fill-rule="evenodd" 3982 id="Solid" 3983 /> 3984 </g> 3985 </svg> 3986 </div> 3987 <div 3988 class="css-1m74yfi-Callout" 3989 > 3990 <p 3991 class="mb-4 css-1kfqm4n-TextComponent" 3992 data-text="true" 3993 > 3994 <strong 3995 class="css-bvflvn-TextComponent" 3996 > 3997 See: 3998 </strong> 3999 4000 <a 4001 class="css-1na8e0o-A" 4002 href="https://developer.apple.com/documentation/authenticationservices/asauthorizationopenidrequest" 4003 rel="noopener noreferrer" 4004 target="_blank" 4005 > 4006 Apple 4007Documentation 4008 </a> 4009 4010for more details. 4011 </p> 4012 </div> 4013 </blockquote> 4014 <div 4015 class="css-1uyflf8-Table" 4016 > 4017 <table 4018 class="css-q84cm9-Table" 4019 > 4020 <thead 4021 class="bg-subtle border-b border-b-default border-solid" 4022 > 4023 <tr 4024 class="css-190f936-Row" 4025 > 4026 <th 4027 class="css-1uwgm7m-HeaderCell" 4028 > 4029 Name 4030 </th> 4031 <th 4032 class="css-1uwgm7m-HeaderCell" 4033 > 4034 Type 4035 </th> 4036 <th 4037 class="css-1uwgm7m-HeaderCell" 4038 > 4039 Description 4040 </th> 4041 </tr> 4042 </thead> 4043 <tbody> 4044 <tr 4045 class="css-190f936-Row" 4046 > 4047 <td 4048 class="css-18p3734-Cell" 4049 > 4050 <strong 4051 class="css-bvflvn-TextComponent" 4052 > 4053 state 4054 </strong> 4055 <br /> 4056 <span 4057 class="css-1g95u6x" 4058 > 4059 (optional) 4060 </span> 4061 </td> 4062 <td 4063 class="css-18p3734-Cell" 4064 > 4065 <code 4066 class="css-iwb7ur-TextComponent" 4067 data-text="true" 4068 > 4069 string 4070 </code> 4071 </td> 4072 <td 4073 class="css-18p3734-Cell" 4074 > 4075 <p 4076 class="mb-4 css-1kfqm4n-TextComponent" 4077 data-text="true" 4078 > 4079 An arbitrary string that is returned unmodified in the corresponding credential after a 4080successful authentication. This can be used to verify that the response was from the request 4081you made and avoid replay attacks. More information on this property is available in the 4082OAuth 2.0 protocol 4083 <a 4084 class="css-1na8e0o-A" 4085 href="https://tools.ietf.org/html/rfc6749#section-10.12" 4086 rel="noopener noreferrer" 4087 target="_blank" 4088 > 4089 RFC6749 4090 </a> 4091 . 4092 </p> 4093 </td> 4094 </tr> 4095 <tr 4096 class="css-190f936-Row" 4097 > 4098 <td 4099 class="css-18p3734-Cell" 4100 > 4101 <strong 4102 class="css-bvflvn-TextComponent" 4103 > 4104 user 4105 </strong> 4106 </td> 4107 <td 4108 class="css-18p3734-Cell" 4109 > 4110 <code 4111 class="css-iwb7ur-TextComponent" 4112 data-text="true" 4113 > 4114 string 4115 </code> 4116 </td> 4117 <td 4118 class="css-18p3734-Cell" 4119 > 4120 - 4121 </td> 4122 </tr> 4123 </tbody> 4124 </table> 4125 </div> 4126 </div> 4127 <div 4128 class="css-1fultt1" 4129 > 4130 <h3 4131 class=" css-wbzzgj-TextComponent" 4132 data-heading="true" 4133 > 4134 <a 4135 class="css-1y48vg3" 4136 href="#subscription" 4137 > 4138 <span 4139 class="css-s3qkfm" 4140 id="subscription" 4141 /> 4142 <span 4143 class="css-6n7j50" 4144 > 4145 <code 4146 class="css-yd3r23-TextComponent" 4147 data-text="true" 4148 > 4149 Subscription 4150 </code> 4151 </span> 4152 <span 4153 class="css-15j1jyt-PermalinkCopyIcon" 4154 id="docs-anchor-permalink-subscription" 4155 > 4156 <svg 4157 aria-label="permalink" 4158 class="anchor-icon" 4159 fill="none" 4160 height="24" 4161 viewBox="0 0 24 24" 4162 width="24" 4163 xmlns="http://www.w3.org/2000/svg" 4164 > 4165 <path 4166 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4167 stroke="#9B9B9B" 4168 stroke-linecap="round" 4169 stroke-linejoin="round" 4170 stroke-width="2" 4171 /> 4172 <path 4173 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4174 stroke="#9B9B9B" 4175 stroke-linecap="round" 4176 stroke-linejoin="round" 4177 stroke-width="2" 4178 /> 4179 </svg> 4180 </span> 4181 </a> 4182 </h3> 4183 <div 4184 class="css-1uyflf8-Table" 4185 > 4186 <table 4187 class="css-q84cm9-Table" 4188 > 4189 <thead 4190 class="bg-subtle border-b border-b-default border-solid" 4191 > 4192 <tr 4193 class="css-190f936-Row" 4194 > 4195 <th 4196 class="css-1uwgm7m-HeaderCell" 4197 > 4198 Name 4199 </th> 4200 <th 4201 class="css-1uwgm7m-HeaderCell" 4202 > 4203 Type 4204 </th> 4205 <th 4206 class="css-1uwgm7m-HeaderCell" 4207 > 4208 Description 4209 </th> 4210 </tr> 4211 </thead> 4212 <tbody> 4213 <tr 4214 class="css-190f936-Row" 4215 > 4216 <td 4217 class="css-18p3734-Cell" 4218 > 4219 <strong 4220 class="css-bvflvn-TextComponent" 4221 > 4222 remove 4223 </strong> 4224 </td> 4225 <td 4226 class="css-18p3734-Cell" 4227 > 4228 <code 4229 class="css-iwb7ur-TextComponent" 4230 data-text="true" 4231 > 4232 () => 4233 4234 void 4235 </code> 4236 </td> 4237 <td 4238 class="css-18p3734-Cell" 4239 > 4240 - 4241 </td> 4242 </tr> 4243 </tbody> 4244 </table> 4245 </div> 4246 </div> 4247 <h2 4248 class=" css-1qsxz84-TextComponent" 4249 data-heading="true" 4250 > 4251 <a 4252 class="css-1y48vg3" 4253 href="#enums" 4254 > 4255 <span 4256 class="css-s3qkfm" 4257 id="enums" 4258 /> 4259 <span 4260 class="css-6n7j50" 4261 > 4262 Enums 4263 </span> 4264 <span 4265 class="css-15j1jyt-PermalinkCopyIcon" 4266 id="docs-anchor-permalink-enums" 4267 > 4268 <svg 4269 aria-label="permalink" 4270 class="anchor-icon" 4271 fill="none" 4272 height="24" 4273 viewBox="0 0 24 24" 4274 width="24" 4275 xmlns="http://www.w3.org/2000/svg" 4276 > 4277 <path 4278 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4279 stroke="#9B9B9B" 4280 stroke-linecap="round" 4281 stroke-linejoin="round" 4282 stroke-width="2" 4283 /> 4284 <path 4285 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4286 stroke="#9B9B9B" 4287 stroke-linecap="round" 4288 stroke-linejoin="round" 4289 stroke-width="2" 4290 /> 4291 </svg> 4292 </span> 4293 </a> 4294 </h2> 4295 <div 4296 class="css-1gsbrid" 4297 > 4298 <h3 4299 class=" css-wbzzgj-TextComponent" 4300 data-heading="true" 4301 > 4302 <a 4303 class="css-1y48vg3" 4304 href="#appleauthenticationbuttonstyle" 4305 > 4306 <span 4307 class="css-s3qkfm" 4308 id="appleauthenticationbuttonstyle" 4309 /> 4310 <span 4311 class="css-6n7j50" 4312 > 4313 <code 4314 class="css-yd3r23-TextComponent" 4315 data-text="true" 4316 > 4317 AppleAuthenticationButtonStyle 4318 </code> 4319 </span> 4320 <span 4321 class="css-15j1jyt-PermalinkCopyIcon" 4322 id="docs-anchor-permalink-appleauthenticationbuttonstyle" 4323 > 4324 <svg 4325 aria-label="permalink" 4326 class="anchor-icon" 4327 fill="none" 4328 height="24" 4329 viewBox="0 0 24 24" 4330 width="24" 4331 xmlns="http://www.w3.org/2000/svg" 4332 > 4333 <path 4334 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4335 stroke="#9B9B9B" 4336 stroke-linecap="round" 4337 stroke-linejoin="round" 4338 stroke-width="2" 4339 /> 4340 <path 4341 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4342 stroke="#9B9B9B" 4343 stroke-linecap="round" 4344 stroke-linejoin="round" 4345 stroke-width="2" 4346 /> 4347 </svg> 4348 </span> 4349 </a> 4350 </h3> 4351 <p 4352 class="mb-4 css-1kfqm4n-TextComponent" 4353 data-text="true" 4354 > 4355 An enum whose values control which pre-defined color scheme to use when rendering an 4356 <a 4357 class="css-1na8e0o-A" 4358 href="#appleauthenticationappleauthenticationbutton" 4359 > 4360 <code 4361 class="css-1a6y07t-TextComponent" 4362 data-text="true" 4363 > 4364 AppleAuthenticationButton 4365 </code> 4366 </a> 4367 . 4368 </p> 4369 <div 4370 class="css-11xr3cd" 4371 > 4372 <h4 4373 class=" css-1y1xevk-TextComponent" 4374 data-heading="true" 4375 > 4376 <a 4377 class="css-1y48vg3" 4378 href="#white" 4379 > 4380 <span 4381 class="css-s3qkfm" 4382 id="white" 4383 /> 4384 <span 4385 class="css-6n7j50" 4386 > 4387 <code 4388 class="css-iwb7ur-TextComponent" 4389 data-text="true" 4390 > 4391 WHITE 4392 </code> 4393 </span> 4394 <span 4395 class="css-15j1jyt-PermalinkCopyIcon" 4396 id="docs-anchor-permalink-white" 4397 > 4398 <svg 4399 aria-label="permalink" 4400 class="anchor-icon" 4401 fill="none" 4402 height="24" 4403 viewBox="0 0 24 24" 4404 width="24" 4405 xmlns="http://www.w3.org/2000/svg" 4406 > 4407 <path 4408 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4409 stroke="#9B9B9B" 4410 stroke-linecap="round" 4411 stroke-linejoin="round" 4412 stroke-width="2" 4413 /> 4414 <path 4415 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4416 stroke="#9B9B9B" 4417 stroke-linecap="round" 4418 stroke-linejoin="round" 4419 stroke-width="2" 4420 /> 4421 </svg> 4422 </span> 4423 </a> 4424 </h4> 4425 <code 4426 class="mb-4 css-1h2013i-TextComponent" 4427 data-text="true" 4428 > 4429 AppleAuthenticationButtonStyle.WHITE = 0 4430 </code> 4431 <p 4432 class="mb-4 css-1kfqm4n-TextComponent" 4433 data-text="true" 4434 > 4435 White button with black text. 4436 </p> 4437 </div> 4438 <div 4439 class="css-11xr3cd" 4440 > 4441 <h4 4442 class=" css-1y1xevk-TextComponent" 4443 data-heading="true" 4444 > 4445 <a 4446 class="css-1y48vg3" 4447 href="#white_outline" 4448 > 4449 <span 4450 class="css-s3qkfm" 4451 id="white_outline" 4452 /> 4453 <span 4454 class="css-6n7j50" 4455 > 4456 <code 4457 class="css-iwb7ur-TextComponent" 4458 data-text="true" 4459 > 4460 WHITE_OUTLINE 4461 </code> 4462 </span> 4463 <span 4464 class="css-15j1jyt-PermalinkCopyIcon" 4465 id="docs-anchor-permalink-white_outline" 4466 > 4467 <svg 4468 aria-label="permalink" 4469 class="anchor-icon" 4470 fill="none" 4471 height="24" 4472 viewBox="0 0 24 24" 4473 width="24" 4474 xmlns="http://www.w3.org/2000/svg" 4475 > 4476 <path 4477 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4478 stroke="#9B9B9B" 4479 stroke-linecap="round" 4480 stroke-linejoin="round" 4481 stroke-width="2" 4482 /> 4483 <path 4484 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4485 stroke="#9B9B9B" 4486 stroke-linecap="round" 4487 stroke-linejoin="round" 4488 stroke-width="2" 4489 /> 4490 </svg> 4491 </span> 4492 </a> 4493 </h4> 4494 <code 4495 class="mb-4 css-1h2013i-TextComponent" 4496 data-text="true" 4497 > 4498 AppleAuthenticationButtonStyle.WHITE_OUTLINE = 1 4499 </code> 4500 <p 4501 class="mb-4 css-1kfqm4n-TextComponent" 4502 data-text="true" 4503 > 4504 White button with a black outline and black text. 4505 </p> 4506 </div> 4507 <div 4508 class="css-11xr3cd" 4509 > 4510 <h4 4511 class=" css-1y1xevk-TextComponent" 4512 data-heading="true" 4513 > 4514 <a 4515 class="css-1y48vg3" 4516 href="#black" 4517 > 4518 <span 4519 class="css-s3qkfm" 4520 id="black" 4521 /> 4522 <span 4523 class="css-6n7j50" 4524 > 4525 <code 4526 class="css-iwb7ur-TextComponent" 4527 data-text="true" 4528 > 4529 BLACK 4530 </code> 4531 </span> 4532 <span 4533 class="css-15j1jyt-PermalinkCopyIcon" 4534 id="docs-anchor-permalink-black" 4535 > 4536 <svg 4537 aria-label="permalink" 4538 class="anchor-icon" 4539 fill="none" 4540 height="24" 4541 viewBox="0 0 24 24" 4542 width="24" 4543 xmlns="http://www.w3.org/2000/svg" 4544 > 4545 <path 4546 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4547 stroke="#9B9B9B" 4548 stroke-linecap="round" 4549 stroke-linejoin="round" 4550 stroke-width="2" 4551 /> 4552 <path 4553 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4554 stroke="#9B9B9B" 4555 stroke-linecap="round" 4556 stroke-linejoin="round" 4557 stroke-width="2" 4558 /> 4559 </svg> 4560 </span> 4561 </a> 4562 </h4> 4563 <code 4564 class="mb-4 css-1h2013i-TextComponent" 4565 data-text="true" 4566 > 4567 AppleAuthenticationButtonStyle.BLACK = 2 4568 </code> 4569 <p 4570 class="mb-4 css-1kfqm4n-TextComponent" 4571 data-text="true" 4572 > 4573 Black button with white text. 4574 </p> 4575 </div> 4576 </div> 4577 <div 4578 class="css-1gsbrid" 4579 > 4580 <h3 4581 class=" css-wbzzgj-TextComponent" 4582 data-heading="true" 4583 > 4584 <a 4585 class="css-1y48vg3" 4586 href="#appleauthenticationbuttontype" 4587 > 4588 <span 4589 class="css-s3qkfm" 4590 id="appleauthenticationbuttontype" 4591 /> 4592 <span 4593 class="css-6n7j50" 4594 > 4595 <code 4596 class="css-yd3r23-TextComponent" 4597 data-text="true" 4598 > 4599 AppleAuthenticationButtonType 4600 </code> 4601 </span> 4602 <span 4603 class="css-15j1jyt-PermalinkCopyIcon" 4604 id="docs-anchor-permalink-appleauthenticationbuttontype" 4605 > 4606 <svg 4607 aria-label="permalink" 4608 class="anchor-icon" 4609 fill="none" 4610 height="24" 4611 viewBox="0 0 24 24" 4612 width="24" 4613 xmlns="http://www.w3.org/2000/svg" 4614 > 4615 <path 4616 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4617 stroke="#9B9B9B" 4618 stroke-linecap="round" 4619 stroke-linejoin="round" 4620 stroke-width="2" 4621 /> 4622 <path 4623 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4624 stroke="#9B9B9B" 4625 stroke-linecap="round" 4626 stroke-linejoin="round" 4627 stroke-width="2" 4628 /> 4629 </svg> 4630 </span> 4631 </a> 4632 </h3> 4633 <p 4634 class="mb-4 css-1kfqm4n-TextComponent" 4635 data-text="true" 4636 > 4637 An enum whose values control which pre-defined text to use when rendering an 4638 <a 4639 class="css-1na8e0o-A" 4640 href="#appleauthenticationappleauthenticationbutton" 4641 > 4642 <code 4643 class="css-1a6y07t-TextComponent" 4644 data-text="true" 4645 > 4646 AppleAuthenticationButton 4647 </code> 4648 </a> 4649 . 4650 </p> 4651 <div 4652 class="css-11xr3cd" 4653 > 4654 <h4 4655 class=" css-1y1xevk-TextComponent" 4656 data-heading="true" 4657 > 4658 <a 4659 class="css-1y48vg3" 4660 href="#sign_in" 4661 > 4662 <span 4663 class="css-s3qkfm" 4664 id="sign_in" 4665 /> 4666 <span 4667 class="css-6n7j50" 4668 > 4669 <code 4670 class="css-iwb7ur-TextComponent" 4671 data-text="true" 4672 > 4673 SIGN_IN 4674 </code> 4675 </span> 4676 <span 4677 class="css-15j1jyt-PermalinkCopyIcon" 4678 id="docs-anchor-permalink-sign_in" 4679 > 4680 <svg 4681 aria-label="permalink" 4682 class="anchor-icon" 4683 fill="none" 4684 height="24" 4685 viewBox="0 0 24 24" 4686 width="24" 4687 xmlns="http://www.w3.org/2000/svg" 4688 > 4689 <path 4690 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4691 stroke="#9B9B9B" 4692 stroke-linecap="round" 4693 stroke-linejoin="round" 4694 stroke-width="2" 4695 /> 4696 <path 4697 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4698 stroke="#9B9B9B" 4699 stroke-linecap="round" 4700 stroke-linejoin="round" 4701 stroke-width="2" 4702 /> 4703 </svg> 4704 </span> 4705 </a> 4706 </h4> 4707 <code 4708 class="mb-4 css-1h2013i-TextComponent" 4709 data-text="true" 4710 > 4711 AppleAuthenticationButtonType.SIGN_IN = 0 4712 </code> 4713 <p 4714 class="mb-4 css-1kfqm4n-TextComponent" 4715 data-text="true" 4716 > 4717 "Sign in with Apple" 4718 </p> 4719 </div> 4720 <div 4721 class="css-11xr3cd" 4722 > 4723 <h4 4724 class=" css-1y1xevk-TextComponent" 4725 data-heading="true" 4726 > 4727 <a 4728 class="css-1y48vg3" 4729 href="#continue" 4730 > 4731 <span 4732 class="css-s3qkfm" 4733 id="continue" 4734 /> 4735 <span 4736 class="css-6n7j50" 4737 > 4738 <code 4739 class="css-iwb7ur-TextComponent" 4740 data-text="true" 4741 > 4742 CONTINUE 4743 </code> 4744 </span> 4745 <span 4746 class="css-15j1jyt-PermalinkCopyIcon" 4747 id="docs-anchor-permalink-continue" 4748 > 4749 <svg 4750 aria-label="permalink" 4751 class="anchor-icon" 4752 fill="none" 4753 height="24" 4754 viewBox="0 0 24 24" 4755 width="24" 4756 xmlns="http://www.w3.org/2000/svg" 4757 > 4758 <path 4759 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4760 stroke="#9B9B9B" 4761 stroke-linecap="round" 4762 stroke-linejoin="round" 4763 stroke-width="2" 4764 /> 4765 <path 4766 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4767 stroke="#9B9B9B" 4768 stroke-linecap="round" 4769 stroke-linejoin="round" 4770 stroke-width="2" 4771 /> 4772 </svg> 4773 </span> 4774 </a> 4775 </h4> 4776 <code 4777 class="mb-4 css-1h2013i-TextComponent" 4778 data-text="true" 4779 > 4780 AppleAuthenticationButtonType.CONTINUE = 1 4781 </code> 4782 <p 4783 class="mb-4 css-1kfqm4n-TextComponent" 4784 data-text="true" 4785 > 4786 "Continue with Apple" 4787 </p> 4788 </div> 4789 <div 4790 class="css-11xr3cd" 4791 > 4792 <strong 4793 class="css-bvflvn-TextComponent" 4794 > 4795 Only for: 4796 4797 </strong> 4798 <div 4799 class="!bg-palette-blue4 !text-palette-blue12 !border-palette-blue5 css-r2zk2g-PlatformTag" 4800 > 4801 <svg 4802 class="icon-xs text-palette-blue12" 4803 fill="none" 4804 role="img" 4805 viewBox="0 0 24 24" 4806 xmlns="http://www.w3.org/2000/svg" 4807 > 4808 <g 4809 id="apple" 4810 > 4811 <path 4812 d="M20.4478 17.3538C20.1312 18.0852 19.7564 18.7585 19.3222 19.3775C18.7303 20.2214 18.2457 20.8055 17.8722 21.1299C17.2933 21.6623 16.673 21.935 16.0088 21.9505C15.5319 21.9505 14.9568 21.8148 14.2874 21.5395C13.6158 21.2656 12.9986 21.1299 12.4343 21.1299C11.8424 21.1299 11.2076 21.2656 10.5287 21.5395C9.84865 21.8148 9.30085 21.9582 8.88201 21.9724C8.24504 21.9996 7.61014 21.7192 6.9764 21.1299C6.57191 20.7771 6.06598 20.1723 5.45989 19.3155C4.80961 18.4005 4.27499 17.3396 3.85615 16.13C3.4076 14.8235 3.18274 13.5583 3.18274 12.3335C3.18274 10.9304 3.48591 9.72034 4.09316 8.70628C4.5704 7.89174 5.20531 7.24922 5.99994 6.77753C6.79457 6.30584 7.65317 6.06547 8.57781 6.0501C9.08374 6.0501 9.7472 6.20659 10.5717 6.51416C11.3938 6.82276 11.9217 6.97926 12.1532 6.97926C12.3262 6.97926 12.9127 6.79627 13.9068 6.43145C14.847 6.09313 15.6404 5.95304 16.2905 6.00823C18.0519 6.15038 19.3752 6.84473 20.2552 8.09567C18.6799 9.05016 17.9007 10.387 17.9162 12.102C17.9304 13.4379 18.415 14.5495 19.3674 15.4321C19.799 15.8418 20.2811 16.1584 20.8174 16.3833C20.7011 16.7206 20.5783 17.0436 20.4478 17.3538ZM16.4081 1.45728C16.4081 2.50431 16.0256 3.48192 15.2631 4.38678C14.343 5.46249 13.2301 6.08408 12.0232 5.986C12.0078 5.86039 11.9989 5.72819 11.9989 5.58926C11.9989 4.58412 12.4365 3.50841 13.2135 2.62888C13.6015 2.18355 14.0949 1.81327 14.6932 1.51789C15.2902 1.22692 15.855 1.066 16.3861 1.03845C16.4016 1.17842 16.4081 1.3184 16.4081 1.45727V1.45728Z" 4813 fill="currentColor" 4814 id="Vector" 4815 /> 4816 </g> 4817 </svg> 4818 <span 4819 class="css-6g4m4t-PlatformTag" 4820 > 4821 iOS 13.2+ 4822 </span> 4823 </div> 4824 <br /> 4825 <h4 4826 class=" css-1y1xevk-TextComponent" 4827 data-heading="true" 4828 > 4829 <a 4830 class="css-1y48vg3" 4831 href="#sign_up" 4832 > 4833 <span 4834 class="css-s3qkfm" 4835 id="sign_up" 4836 /> 4837 <span 4838 class="css-6n7j50" 4839 > 4840 <code 4841 class="css-iwb7ur-TextComponent" 4842 data-text="true" 4843 > 4844 SIGN_UP 4845 </code> 4846 </span> 4847 <span 4848 class="css-15j1jyt-PermalinkCopyIcon" 4849 id="docs-anchor-permalink-sign_up" 4850 > 4851 <svg 4852 aria-label="permalink" 4853 class="anchor-icon" 4854 fill="none" 4855 height="24" 4856 viewBox="0 0 24 24" 4857 width="24" 4858 xmlns="http://www.w3.org/2000/svg" 4859 > 4860 <path 4861 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4862 stroke="#9B9B9B" 4863 stroke-linecap="round" 4864 stroke-linejoin="round" 4865 stroke-width="2" 4866 /> 4867 <path 4868 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4869 stroke="#9B9B9B" 4870 stroke-linecap="round" 4871 stroke-linejoin="round" 4872 stroke-width="2" 4873 /> 4874 </svg> 4875 </span> 4876 </a> 4877 </h4> 4878 <code 4879 class="mb-4 css-1h2013i-TextComponent" 4880 data-text="true" 4881 > 4882 AppleAuthenticationButtonType.SIGN_UP = 2 4883 </code> 4884 <p 4885 class="mb-4 css-1kfqm4n-TextComponent" 4886 data-text="true" 4887 > 4888 "Sign up with Apple" 4889 </p> 4890 </div> 4891 </div> 4892 <div 4893 class="css-1gsbrid" 4894 > 4895 <h3 4896 class=" css-wbzzgj-TextComponent" 4897 data-heading="true" 4898 > 4899 <a 4900 class="css-1y48vg3" 4901 href="#appleauthenticationcredentialstate" 4902 > 4903 <span 4904 class="css-s3qkfm" 4905 id="appleauthenticationcredentialstate" 4906 /> 4907 <span 4908 class="css-6n7j50" 4909 > 4910 <code 4911 class="css-yd3r23-TextComponent" 4912 data-text="true" 4913 > 4914 AppleAuthenticationCredentialState 4915 </code> 4916 </span> 4917 <span 4918 class="css-15j1jyt-PermalinkCopyIcon" 4919 id="docs-anchor-permalink-appleauthenticationcredentialstate" 4920 > 4921 <svg 4922 aria-label="permalink" 4923 class="anchor-icon" 4924 fill="none" 4925 height="24" 4926 viewBox="0 0 24 24" 4927 width="24" 4928 xmlns="http://www.w3.org/2000/svg" 4929 > 4930 <path 4931 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 4932 stroke="#9B9B9B" 4933 stroke-linecap="round" 4934 stroke-linejoin="round" 4935 stroke-width="2" 4936 /> 4937 <path 4938 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 4939 stroke="#9B9B9B" 4940 stroke-linecap="round" 4941 stroke-linejoin="round" 4942 stroke-width="2" 4943 /> 4944 </svg> 4945 </span> 4946 </a> 4947 </h3> 4948 <p 4949 class="mb-4 css-1kfqm4n-TextComponent" 4950 data-text="true" 4951 > 4952 An enum whose values specify state of the credential when checked with 4953 <a 4954 class="css-1na8e0o-A" 4955 href="#appleauthenticationgetcredentialstateasyncuser" 4956 > 4957 <code 4958 class="css-1a6y07t-TextComponent" 4959 data-text="true" 4960 > 4961 AppleAuthentication.getCredentialStateAsync() 4962 </code> 4963 </a> 4964 . 4965 </p> 4966 <blockquote 4967 class="css-zknray-Callout" 4968 data-testid="callout-container" 4969 > 4970 <div 4971 class="css-7jywx8-Callout" 4972 > 4973 <svg 4974 class="icon-sm text-icon-default" 4975 fill="currentColor" 4976 role="img" 4977 viewBox="0 0 24 24" 4978 xmlns="http://www.w3.org/2000/svg" 4979 > 4980 <g 4981 id="info-circle" 4982 > 4983 <path 4984 clip-rule="evenodd" 4985 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 4986 fill-rule="evenodd" 4987 id="Solid" 4988 /> 4989 </g> 4990 </svg> 4991 </div> 4992 <div 4993 class="css-1m74yfi-Callout" 4994 > 4995 <p 4996 class="mb-4 css-1kfqm4n-TextComponent" 4997 data-text="true" 4998 > 4999 <strong 5000 class="css-bvflvn-TextComponent" 5001 > 5002 See: 5003 </strong> 5004 5005 <a 5006 class="css-1na8e0o-A" 5007 href="https://developer.apple.com/documentation/authenticationservices/asauthorizationappleidprovidercredentialstate" 5008 rel="noopener noreferrer" 5009 target="_blank" 5010 > 5011 Apple 5012Documentation 5013 </a> 5014 5015for more details. 5016 </p> 5017 </div> 5018 </blockquote> 5019 <div 5020 class="css-11xr3cd" 5021 > 5022 <h4 5023 class=" css-1y1xevk-TextComponent" 5024 data-heading="true" 5025 > 5026 <a 5027 class="css-1y48vg3" 5028 href="#revoked" 5029 > 5030 <span 5031 class="css-s3qkfm" 5032 id="revoked" 5033 /> 5034 <span 5035 class="css-6n7j50" 5036 > 5037 <code 5038 class="css-iwb7ur-TextComponent" 5039 data-text="true" 5040 > 5041 REVOKED 5042 </code> 5043 </span> 5044 <span 5045 class="css-15j1jyt-PermalinkCopyIcon" 5046 id="docs-anchor-permalink-revoked" 5047 > 5048 <svg 5049 aria-label="permalink" 5050 class="anchor-icon" 5051 fill="none" 5052 height="24" 5053 viewBox="0 0 24 24" 5054 width="24" 5055 xmlns="http://www.w3.org/2000/svg" 5056 > 5057 <path 5058 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5059 stroke="#9B9B9B" 5060 stroke-linecap="round" 5061 stroke-linejoin="round" 5062 stroke-width="2" 5063 /> 5064 <path 5065 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5066 stroke="#9B9B9B" 5067 stroke-linecap="round" 5068 stroke-linejoin="round" 5069 stroke-width="2" 5070 /> 5071 </svg> 5072 </span> 5073 </a> 5074 </h4> 5075 <code 5076 class="mb-4 css-1h2013i-TextComponent" 5077 data-text="true" 5078 > 5079 AppleAuthenticationCredentialState.REVOKED = 0 5080 </code> 5081 </div> 5082 <div 5083 class="css-11xr3cd" 5084 > 5085 <h4 5086 class=" css-1y1xevk-TextComponent" 5087 data-heading="true" 5088 > 5089 <a 5090 class="css-1y48vg3" 5091 href="#authorized" 5092 > 5093 <span 5094 class="css-s3qkfm" 5095 id="authorized" 5096 /> 5097 <span 5098 class="css-6n7j50" 5099 > 5100 <code 5101 class="css-iwb7ur-TextComponent" 5102 data-text="true" 5103 > 5104 AUTHORIZED 5105 </code> 5106 </span> 5107 <span 5108 class="css-15j1jyt-PermalinkCopyIcon" 5109 id="docs-anchor-permalink-authorized" 5110 > 5111 <svg 5112 aria-label="permalink" 5113 class="anchor-icon" 5114 fill="none" 5115 height="24" 5116 viewBox="0 0 24 24" 5117 width="24" 5118 xmlns="http://www.w3.org/2000/svg" 5119 > 5120 <path 5121 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5122 stroke="#9B9B9B" 5123 stroke-linecap="round" 5124 stroke-linejoin="round" 5125 stroke-width="2" 5126 /> 5127 <path 5128 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5129 stroke="#9B9B9B" 5130 stroke-linecap="round" 5131 stroke-linejoin="round" 5132 stroke-width="2" 5133 /> 5134 </svg> 5135 </span> 5136 </a> 5137 </h4> 5138 <code 5139 class="mb-4 css-1h2013i-TextComponent" 5140 data-text="true" 5141 > 5142 AppleAuthenticationCredentialState.AUTHORIZED = 1 5143 </code> 5144 </div> 5145 <div 5146 class="css-11xr3cd" 5147 > 5148 <h4 5149 class=" css-1y1xevk-TextComponent" 5150 data-heading="true" 5151 > 5152 <a 5153 class="css-1y48vg3" 5154 href="#not_found" 5155 > 5156 <span 5157 class="css-s3qkfm" 5158 id="not_found" 5159 /> 5160 <span 5161 class="css-6n7j50" 5162 > 5163 <code 5164 class="css-iwb7ur-TextComponent" 5165 data-text="true" 5166 > 5167 NOT_FOUND 5168 </code> 5169 </span> 5170 <span 5171 class="css-15j1jyt-PermalinkCopyIcon" 5172 id="docs-anchor-permalink-not_found" 5173 > 5174 <svg 5175 aria-label="permalink" 5176 class="anchor-icon" 5177 fill="none" 5178 height="24" 5179 viewBox="0 0 24 24" 5180 width="24" 5181 xmlns="http://www.w3.org/2000/svg" 5182 > 5183 <path 5184 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5185 stroke="#9B9B9B" 5186 stroke-linecap="round" 5187 stroke-linejoin="round" 5188 stroke-width="2" 5189 /> 5190 <path 5191 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5192 stroke="#9B9B9B" 5193 stroke-linecap="round" 5194 stroke-linejoin="round" 5195 stroke-width="2" 5196 /> 5197 </svg> 5198 </span> 5199 </a> 5200 </h4> 5201 <code 5202 class="mb-4 css-1h2013i-TextComponent" 5203 data-text="true" 5204 > 5205 AppleAuthenticationCredentialState.NOT_FOUND = 2 5206 </code> 5207 </div> 5208 <div 5209 class="css-11xr3cd" 5210 > 5211 <h4 5212 class=" css-1y1xevk-TextComponent" 5213 data-heading="true" 5214 > 5215 <a 5216 class="css-1y48vg3" 5217 href="#transferred" 5218 > 5219 <span 5220 class="css-s3qkfm" 5221 id="transferred" 5222 /> 5223 <span 5224 class="css-6n7j50" 5225 > 5226 <code 5227 class="css-iwb7ur-TextComponent" 5228 data-text="true" 5229 > 5230 TRANSFERRED 5231 </code> 5232 </span> 5233 <span 5234 class="css-15j1jyt-PermalinkCopyIcon" 5235 id="docs-anchor-permalink-transferred" 5236 > 5237 <svg 5238 aria-label="permalink" 5239 class="anchor-icon" 5240 fill="none" 5241 height="24" 5242 viewBox="0 0 24 24" 5243 width="24" 5244 xmlns="http://www.w3.org/2000/svg" 5245 > 5246 <path 5247 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5248 stroke="#9B9B9B" 5249 stroke-linecap="round" 5250 stroke-linejoin="round" 5251 stroke-width="2" 5252 /> 5253 <path 5254 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5255 stroke="#9B9B9B" 5256 stroke-linecap="round" 5257 stroke-linejoin="round" 5258 stroke-width="2" 5259 /> 5260 </svg> 5261 </span> 5262 </a> 5263 </h4> 5264 <code 5265 class="mb-4 css-1h2013i-TextComponent" 5266 data-text="true" 5267 > 5268 AppleAuthenticationCredentialState.TRANSFERRED = 3 5269 </code> 5270 </div> 5271 </div> 5272 <div 5273 class="css-1gsbrid" 5274 > 5275 <h3 5276 class=" css-wbzzgj-TextComponent" 5277 data-heading="true" 5278 > 5279 <a 5280 class="css-1y48vg3" 5281 href="#appleauthenticationoperation" 5282 > 5283 <span 5284 class="css-s3qkfm" 5285 id="appleauthenticationoperation" 5286 /> 5287 <span 5288 class="css-6n7j50" 5289 > 5290 <code 5291 class="css-yd3r23-TextComponent" 5292 data-text="true" 5293 > 5294 AppleAuthenticationOperation 5295 </code> 5296 </span> 5297 <span 5298 class="css-15j1jyt-PermalinkCopyIcon" 5299 id="docs-anchor-permalink-appleauthenticationoperation" 5300 > 5301 <svg 5302 aria-label="permalink" 5303 class="anchor-icon" 5304 fill="none" 5305 height="24" 5306 viewBox="0 0 24 24" 5307 width="24" 5308 xmlns="http://www.w3.org/2000/svg" 5309 > 5310 <path 5311 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5312 stroke="#9B9B9B" 5313 stroke-linecap="round" 5314 stroke-linejoin="round" 5315 stroke-width="2" 5316 /> 5317 <path 5318 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5319 stroke="#9B9B9B" 5320 stroke-linecap="round" 5321 stroke-linejoin="round" 5322 stroke-width="2" 5323 /> 5324 </svg> 5325 </span> 5326 </a> 5327 </h3> 5328 <div 5329 class="css-11xr3cd" 5330 > 5331 <h4 5332 class=" css-1y1xevk-TextComponent" 5333 data-heading="true" 5334 > 5335 <a 5336 class="css-1y48vg3" 5337 href="#implicit" 5338 > 5339 <span 5340 class="css-s3qkfm" 5341 id="implicit" 5342 /> 5343 <span 5344 class="css-6n7j50" 5345 > 5346 <code 5347 class="css-iwb7ur-TextComponent" 5348 data-text="true" 5349 > 5350 IMPLICIT 5351 </code> 5352 </span> 5353 <span 5354 class="css-15j1jyt-PermalinkCopyIcon" 5355 id="docs-anchor-permalink-implicit" 5356 > 5357 <svg 5358 aria-label="permalink" 5359 class="anchor-icon" 5360 fill="none" 5361 height="24" 5362 viewBox="0 0 24 24" 5363 width="24" 5364 xmlns="http://www.w3.org/2000/svg" 5365 > 5366 <path 5367 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5368 stroke="#9B9B9B" 5369 stroke-linecap="round" 5370 stroke-linejoin="round" 5371 stroke-width="2" 5372 /> 5373 <path 5374 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5375 stroke="#9B9B9B" 5376 stroke-linecap="round" 5377 stroke-linejoin="round" 5378 stroke-width="2" 5379 /> 5380 </svg> 5381 </span> 5382 </a> 5383 </h4> 5384 <code 5385 class="mb-4 css-1h2013i-TextComponent" 5386 data-text="true" 5387 > 5388 AppleAuthenticationOperation.IMPLICIT = 0 5389 </code> 5390 <p 5391 class="mb-4 css-1kfqm4n-TextComponent" 5392 data-text="true" 5393 > 5394 An operation that depends on the particular kind of credential provider. 5395 </p> 5396 </div> 5397 <div 5398 class="css-11xr3cd" 5399 > 5400 <h4 5401 class=" css-1y1xevk-TextComponent" 5402 data-heading="true" 5403 > 5404 <a 5405 class="css-1y48vg3" 5406 href="#login" 5407 > 5408 <span 5409 class="css-s3qkfm" 5410 id="login" 5411 /> 5412 <span 5413 class="css-6n7j50" 5414 > 5415 <code 5416 class="css-iwb7ur-TextComponent" 5417 data-text="true" 5418 > 5419 LOGIN 5420 </code> 5421 </span> 5422 <span 5423 class="css-15j1jyt-PermalinkCopyIcon" 5424 id="docs-anchor-permalink-login" 5425 > 5426 <svg 5427 aria-label="permalink" 5428 class="anchor-icon" 5429 fill="none" 5430 height="24" 5431 viewBox="0 0 24 24" 5432 width="24" 5433 xmlns="http://www.w3.org/2000/svg" 5434 > 5435 <path 5436 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5437 stroke="#9B9B9B" 5438 stroke-linecap="round" 5439 stroke-linejoin="round" 5440 stroke-width="2" 5441 /> 5442 <path 5443 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5444 stroke="#9B9B9B" 5445 stroke-linecap="round" 5446 stroke-linejoin="round" 5447 stroke-width="2" 5448 /> 5449 </svg> 5450 </span> 5451 </a> 5452 </h4> 5453 <code 5454 class="mb-4 css-1h2013i-TextComponent" 5455 data-text="true" 5456 > 5457 AppleAuthenticationOperation.LOGIN = 1 5458 </code> 5459 </div> 5460 <div 5461 class="css-11xr3cd" 5462 > 5463 <h4 5464 class=" css-1y1xevk-TextComponent" 5465 data-heading="true" 5466 > 5467 <a 5468 class="css-1y48vg3" 5469 href="#refresh" 5470 > 5471 <span 5472 class="css-s3qkfm" 5473 id="refresh" 5474 /> 5475 <span 5476 class="css-6n7j50" 5477 > 5478 <code 5479 class="css-iwb7ur-TextComponent" 5480 data-text="true" 5481 > 5482 REFRESH 5483 </code> 5484 </span> 5485 <span 5486 class="css-15j1jyt-PermalinkCopyIcon" 5487 id="docs-anchor-permalink-refresh" 5488 > 5489 <svg 5490 aria-label="permalink" 5491 class="anchor-icon" 5492 fill="none" 5493 height="24" 5494 viewBox="0 0 24 24" 5495 width="24" 5496 xmlns="http://www.w3.org/2000/svg" 5497 > 5498 <path 5499 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5500 stroke="#9B9B9B" 5501 stroke-linecap="round" 5502 stroke-linejoin="round" 5503 stroke-width="2" 5504 /> 5505 <path 5506 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5507 stroke="#9B9B9B" 5508 stroke-linecap="round" 5509 stroke-linejoin="round" 5510 stroke-width="2" 5511 /> 5512 </svg> 5513 </span> 5514 </a> 5515 </h4> 5516 <code 5517 class="mb-4 css-1h2013i-TextComponent" 5518 data-text="true" 5519 > 5520 AppleAuthenticationOperation.REFRESH = 2 5521 </code> 5522 </div> 5523 <div 5524 class="css-11xr3cd" 5525 > 5526 <h4 5527 class=" css-1y1xevk-TextComponent" 5528 data-heading="true" 5529 > 5530 <a 5531 class="css-1y48vg3" 5532 href="#logout" 5533 > 5534 <span 5535 class="css-s3qkfm" 5536 id="logout" 5537 /> 5538 <span 5539 class="css-6n7j50" 5540 > 5541 <code 5542 class="css-iwb7ur-TextComponent" 5543 data-text="true" 5544 > 5545 LOGOUT 5546 </code> 5547 </span> 5548 <span 5549 class="css-15j1jyt-PermalinkCopyIcon" 5550 id="docs-anchor-permalink-logout" 5551 > 5552 <svg 5553 aria-label="permalink" 5554 class="anchor-icon" 5555 fill="none" 5556 height="24" 5557 viewBox="0 0 24 24" 5558 width="24" 5559 xmlns="http://www.w3.org/2000/svg" 5560 > 5561 <path 5562 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5563 stroke="#9B9B9B" 5564 stroke-linecap="round" 5565 stroke-linejoin="round" 5566 stroke-width="2" 5567 /> 5568 <path 5569 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5570 stroke="#9B9B9B" 5571 stroke-linecap="round" 5572 stroke-linejoin="round" 5573 stroke-width="2" 5574 /> 5575 </svg> 5576 </span> 5577 </a> 5578 </h4> 5579 <code 5580 class="mb-4 css-1h2013i-TextComponent" 5581 data-text="true" 5582 > 5583 AppleAuthenticationOperation.LOGOUT = 3 5584 </code> 5585 </div> 5586 </div> 5587 <div 5588 class="css-1gsbrid" 5589 > 5590 <h3 5591 class=" css-wbzzgj-TextComponent" 5592 data-heading="true" 5593 > 5594 <a 5595 class="css-1y48vg3" 5596 href="#appleauthenticationscope" 5597 > 5598 <span 5599 class="css-s3qkfm" 5600 id="appleauthenticationscope" 5601 /> 5602 <span 5603 class="css-6n7j50" 5604 > 5605 <code 5606 class="css-yd3r23-TextComponent" 5607 data-text="true" 5608 > 5609 AppleAuthenticationScope 5610 </code> 5611 </span> 5612 <span 5613 class="css-15j1jyt-PermalinkCopyIcon" 5614 id="docs-anchor-permalink-appleauthenticationscope" 5615 > 5616 <svg 5617 aria-label="permalink" 5618 class="anchor-icon" 5619 fill="none" 5620 height="24" 5621 viewBox="0 0 24 24" 5622 width="24" 5623 xmlns="http://www.w3.org/2000/svg" 5624 > 5625 <path 5626 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5627 stroke="#9B9B9B" 5628 stroke-linecap="round" 5629 stroke-linejoin="round" 5630 stroke-width="2" 5631 /> 5632 <path 5633 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5634 stroke="#9B9B9B" 5635 stroke-linecap="round" 5636 stroke-linejoin="round" 5637 stroke-width="2" 5638 /> 5639 </svg> 5640 </span> 5641 </a> 5642 </h3> 5643 <p 5644 class="mb-4 css-1kfqm4n-TextComponent" 5645 data-text="true" 5646 > 5647 An enum whose values specify scopes you can request when calling 5648 <a 5649 class="css-1na8e0o-A" 5650 href="#appleauthenticationsigninasyncoptions" 5651 > 5652 <code 5653 class="css-1a6y07t-TextComponent" 5654 data-text="true" 5655 > 5656 AppleAuthentication.signInAsync() 5657 </code> 5658 </a> 5659 . 5660 </p> 5661 5662 5663 <blockquote 5664 class="css-zknray-Callout" 5665 data-testid="callout-container" 5666 > 5667 <div 5668 class="css-7jywx8-Callout" 5669 > 5670 <svg 5671 class="icon-sm text-icon-default" 5672 fill="currentColor" 5673 role="img" 5674 viewBox="0 0 24 24" 5675 xmlns="http://www.w3.org/2000/svg" 5676 > 5677 <g 5678 id="info-circle" 5679 > 5680 <path 5681 clip-rule="evenodd" 5682 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 5683 fill-rule="evenodd" 5684 id="Solid" 5685 /> 5686 </g> 5687 </svg> 5688 </div> 5689 <div 5690 class="css-1m74yfi-Callout" 5691 > 5692 5693 5694 <p 5695 class="mb-4 css-1kfqm4n-TextComponent" 5696 data-text="true" 5697 > 5698 Note that it is possible that you will not be granted all of the scopes which you request. 5699You will still need to handle null values for any fields you request. 5700 </p> 5701 5702 5703 </div> 5704 </blockquote> 5705 <blockquote 5706 class="css-zknray-Callout" 5707 data-testid="callout-container" 5708 > 5709 <div 5710 class="css-7jywx8-Callout" 5711 > 5712 <svg 5713 class="icon-sm text-icon-default" 5714 fill="currentColor" 5715 role="img" 5716 viewBox="0 0 24 24" 5717 xmlns="http://www.w3.org/2000/svg" 5718 > 5719 <g 5720 id="info-circle" 5721 > 5722 <path 5723 clip-rule="evenodd" 5724 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 5725 fill-rule="evenodd" 5726 id="Solid" 5727 /> 5728 </g> 5729 </svg> 5730 </div> 5731 <div 5732 class="css-1m74yfi-Callout" 5733 > 5734 <p 5735 class="mb-4 css-1kfqm4n-TextComponent" 5736 data-text="true" 5737 > 5738 <strong 5739 class="css-bvflvn-TextComponent" 5740 > 5741 See: 5742 </strong> 5743 5744 <a 5745 class="css-1na8e0o-A" 5746 href="https://developer.apple.com/documentation/authenticationservices/asauthorizationscope" 5747 rel="noopener noreferrer" 5748 target="_blank" 5749 > 5750 Apple 5751Documentation 5752 </a> 5753 5754for more details. 5755 </p> 5756 </div> 5757 </blockquote> 5758 <div 5759 class="css-11xr3cd" 5760 > 5761 <h4 5762 class=" css-1y1xevk-TextComponent" 5763 data-heading="true" 5764 > 5765 <a 5766 class="css-1y48vg3" 5767 href="#full_name" 5768 > 5769 <span 5770 class="css-s3qkfm" 5771 id="full_name" 5772 /> 5773 <span 5774 class="css-6n7j50" 5775 > 5776 <code 5777 class="css-iwb7ur-TextComponent" 5778 data-text="true" 5779 > 5780 FULL_NAME 5781 </code> 5782 </span> 5783 <span 5784 class="css-15j1jyt-PermalinkCopyIcon" 5785 id="docs-anchor-permalink-full_name" 5786 > 5787 <svg 5788 aria-label="permalink" 5789 class="anchor-icon" 5790 fill="none" 5791 height="24" 5792 viewBox="0 0 24 24" 5793 width="24" 5794 xmlns="http://www.w3.org/2000/svg" 5795 > 5796 <path 5797 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5798 stroke="#9B9B9B" 5799 stroke-linecap="round" 5800 stroke-linejoin="round" 5801 stroke-width="2" 5802 /> 5803 <path 5804 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5805 stroke="#9B9B9B" 5806 stroke-linecap="round" 5807 stroke-linejoin="round" 5808 stroke-width="2" 5809 /> 5810 </svg> 5811 </span> 5812 </a> 5813 </h4> 5814 <code 5815 class="mb-4 css-1h2013i-TextComponent" 5816 data-text="true" 5817 > 5818 AppleAuthenticationScope.FULL_NAME = 0 5819 </code> 5820 </div> 5821 <div 5822 class="css-11xr3cd" 5823 > 5824 <h4 5825 class=" css-1y1xevk-TextComponent" 5826 data-heading="true" 5827 > 5828 <a 5829 class="css-1y48vg3" 5830 href="#email" 5831 > 5832 <span 5833 class="css-s3qkfm" 5834 id="email" 5835 /> 5836 <span 5837 class="css-6n7j50" 5838 > 5839 <code 5840 class="css-iwb7ur-TextComponent" 5841 data-text="true" 5842 > 5843 EMAIL 5844 </code> 5845 </span> 5846 <span 5847 class="css-15j1jyt-PermalinkCopyIcon" 5848 id="docs-anchor-permalink-email" 5849 > 5850 <svg 5851 aria-label="permalink" 5852 class="anchor-icon" 5853 fill="none" 5854 height="24" 5855 viewBox="0 0 24 24" 5856 width="24" 5857 xmlns="http://www.w3.org/2000/svg" 5858 > 5859 <path 5860 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5861 stroke="#9B9B9B" 5862 stroke-linecap="round" 5863 stroke-linejoin="round" 5864 stroke-width="2" 5865 /> 5866 <path 5867 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5868 stroke="#9B9B9B" 5869 stroke-linecap="round" 5870 stroke-linejoin="round" 5871 stroke-width="2" 5872 /> 5873 </svg> 5874 </span> 5875 </a> 5876 </h4> 5877 <code 5878 class="mb-4 css-1h2013i-TextComponent" 5879 data-text="true" 5880 > 5881 AppleAuthenticationScope.EMAIL = 1 5882 </code> 5883 </div> 5884 </div> 5885 <div 5886 class="css-1gsbrid" 5887 > 5888 <h3 5889 class=" css-wbzzgj-TextComponent" 5890 data-heading="true" 5891 > 5892 <a 5893 class="css-1y48vg3" 5894 href="#appleauthenticationuserdetectionstatus" 5895 > 5896 <span 5897 class="css-s3qkfm" 5898 id="appleauthenticationuserdetectionstatus" 5899 /> 5900 <span 5901 class="css-6n7j50" 5902 > 5903 <code 5904 class="css-yd3r23-TextComponent" 5905 data-text="true" 5906 > 5907 AppleAuthenticationUserDetectionStatus 5908 </code> 5909 </span> 5910 <span 5911 class="css-15j1jyt-PermalinkCopyIcon" 5912 id="docs-anchor-permalink-appleauthenticationuserdetectionstatus" 5913 > 5914 <svg 5915 aria-label="permalink" 5916 class="anchor-icon" 5917 fill="none" 5918 height="24" 5919 viewBox="0 0 24 24" 5920 width="24" 5921 xmlns="http://www.w3.org/2000/svg" 5922 > 5923 <path 5924 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 5925 stroke="#9B9B9B" 5926 stroke-linecap="round" 5927 stroke-linejoin="round" 5928 stroke-width="2" 5929 /> 5930 <path 5931 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 5932 stroke="#9B9B9B" 5933 stroke-linecap="round" 5934 stroke-linejoin="round" 5935 stroke-width="2" 5936 /> 5937 </svg> 5938 </span> 5939 </a> 5940 </h3> 5941 <p 5942 class="mb-4 css-1kfqm4n-TextComponent" 5943 data-text="true" 5944 > 5945 An enum whose values specify the system's best guess for how likely the current user is a real person. 5946 </p> 5947 <blockquote 5948 class="css-zknray-Callout" 5949 data-testid="callout-container" 5950 > 5951 <div 5952 class="css-7jywx8-Callout" 5953 > 5954 <svg 5955 class="icon-sm text-icon-default" 5956 fill="currentColor" 5957 role="img" 5958 viewBox="0 0 24 24" 5959 xmlns="http://www.w3.org/2000/svg" 5960 > 5961 <g 5962 id="info-circle" 5963 > 5964 <path 5965 clip-rule="evenodd" 5966 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 5967 fill-rule="evenodd" 5968 id="Solid" 5969 /> 5970 </g> 5971 </svg> 5972 </div> 5973 <div 5974 class="css-1m74yfi-Callout" 5975 > 5976 <p 5977 class="mb-4 css-1kfqm4n-TextComponent" 5978 data-text="true" 5979 > 5980 <strong 5981 class="css-bvflvn-TextComponent" 5982 > 5983 See: 5984 </strong> 5985 5986 <a 5987 class="css-1na8e0o-A" 5988 href="https://developer.apple.com/documentation/authenticationservices/asuserdetectionstatus" 5989 rel="noopener noreferrer" 5990 target="_blank" 5991 > 5992 Apple 5993Documentation 5994 </a> 5995 5996for more details. 5997 </p> 5998 </div> 5999 </blockquote> 6000 <div 6001 class="css-11xr3cd" 6002 > 6003 <h4 6004 class=" css-1y1xevk-TextComponent" 6005 data-heading="true" 6006 > 6007 <a 6008 class="css-1y48vg3" 6009 href="#unsupported" 6010 > 6011 <span 6012 class="css-s3qkfm" 6013 id="unsupported" 6014 /> 6015 <span 6016 class="css-6n7j50" 6017 > 6018 <code 6019 class="css-iwb7ur-TextComponent" 6020 data-text="true" 6021 > 6022 UNSUPPORTED 6023 </code> 6024 </span> 6025 <span 6026 class="css-15j1jyt-PermalinkCopyIcon" 6027 id="docs-anchor-permalink-unsupported" 6028 > 6029 <svg 6030 aria-label="permalink" 6031 class="anchor-icon" 6032 fill="none" 6033 height="24" 6034 viewBox="0 0 24 24" 6035 width="24" 6036 xmlns="http://www.w3.org/2000/svg" 6037 > 6038 <path 6039 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6040 stroke="#9B9B9B" 6041 stroke-linecap="round" 6042 stroke-linejoin="round" 6043 stroke-width="2" 6044 /> 6045 <path 6046 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6047 stroke="#9B9B9B" 6048 stroke-linecap="round" 6049 stroke-linejoin="round" 6050 stroke-width="2" 6051 /> 6052 </svg> 6053 </span> 6054 </a> 6055 </h4> 6056 <code 6057 class="mb-4 css-1h2013i-TextComponent" 6058 data-text="true" 6059 > 6060 AppleAuthenticationUserDetectionStatus.UNSUPPORTED = 0 6061 </code> 6062 <p 6063 class="mb-4 css-1kfqm4n-TextComponent" 6064 data-text="true" 6065 > 6066 The system does not support this determination and there is no data. 6067 </p> 6068 </div> 6069 <div 6070 class="css-11xr3cd" 6071 > 6072 <h4 6073 class=" css-1y1xevk-TextComponent" 6074 data-heading="true" 6075 > 6076 <a 6077 class="css-1y48vg3" 6078 href="#unknown" 6079 > 6080 <span 6081 class="css-s3qkfm" 6082 id="unknown" 6083 /> 6084 <span 6085 class="css-6n7j50" 6086 > 6087 <code 6088 class="css-iwb7ur-TextComponent" 6089 data-text="true" 6090 > 6091 UNKNOWN 6092 </code> 6093 </span> 6094 <span 6095 class="css-15j1jyt-PermalinkCopyIcon" 6096 id="docs-anchor-permalink-unknown" 6097 > 6098 <svg 6099 aria-label="permalink" 6100 class="anchor-icon" 6101 fill="none" 6102 height="24" 6103 viewBox="0 0 24 24" 6104 width="24" 6105 xmlns="http://www.w3.org/2000/svg" 6106 > 6107 <path 6108 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6109 stroke="#9B9B9B" 6110 stroke-linecap="round" 6111 stroke-linejoin="round" 6112 stroke-width="2" 6113 /> 6114 <path 6115 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6116 stroke="#9B9B9B" 6117 stroke-linecap="round" 6118 stroke-linejoin="round" 6119 stroke-width="2" 6120 /> 6121 </svg> 6122 </span> 6123 </a> 6124 </h4> 6125 <code 6126 class="mb-4 css-1h2013i-TextComponent" 6127 data-text="true" 6128 > 6129 AppleAuthenticationUserDetectionStatus.UNKNOWN = 1 6130 </code> 6131 <p 6132 class="mb-4 css-1kfqm4n-TextComponent" 6133 data-text="true" 6134 > 6135 The system has not determined whether the user might be a real person. 6136 </p> 6137 </div> 6138 <div 6139 class="css-11xr3cd" 6140 > 6141 <h4 6142 class=" css-1y1xevk-TextComponent" 6143 data-heading="true" 6144 > 6145 <a 6146 class="css-1y48vg3" 6147 href="#likely_real" 6148 > 6149 <span 6150 class="css-s3qkfm" 6151 id="likely_real" 6152 /> 6153 <span 6154 class="css-6n7j50" 6155 > 6156 <code 6157 class="css-iwb7ur-TextComponent" 6158 data-text="true" 6159 > 6160 LIKELY_REAL 6161 </code> 6162 </span> 6163 <span 6164 class="css-15j1jyt-PermalinkCopyIcon" 6165 id="docs-anchor-permalink-likely_real" 6166 > 6167 <svg 6168 aria-label="permalink" 6169 class="anchor-icon" 6170 fill="none" 6171 height="24" 6172 viewBox="0 0 24 24" 6173 width="24" 6174 xmlns="http://www.w3.org/2000/svg" 6175 > 6176 <path 6177 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6178 stroke="#9B9B9B" 6179 stroke-linecap="round" 6180 stroke-linejoin="round" 6181 stroke-width="2" 6182 /> 6183 <path 6184 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6185 stroke="#9B9B9B" 6186 stroke-linecap="round" 6187 stroke-linejoin="round" 6188 stroke-width="2" 6189 /> 6190 </svg> 6191 </span> 6192 </a> 6193 </h4> 6194 <code 6195 class="mb-4 css-1h2013i-TextComponent" 6196 data-text="true" 6197 > 6198 AppleAuthenticationUserDetectionStatus.LIKELY_REAL = 2 6199 </code> 6200 <p 6201 class="mb-4 css-1kfqm4n-TextComponent" 6202 data-text="true" 6203 > 6204 The user appears to be a real person. 6205 </p> 6206 </div> 6207 </div> 6208</div> 6209`; 6210 6211exports[`APISection expo-barcode-scanner 1`] = ` 6212<div> 6213 <h2 6214 class=" css-1qsxz84-TextComponent" 6215 data-heading="true" 6216 > 6217 <a 6218 class="css-1y48vg3" 6219 href="#component" 6220 > 6221 <span 6222 class="css-s3qkfm" 6223 id="component" 6224 /> 6225 <span 6226 class="css-6n7j50" 6227 > 6228 Component 6229 </span> 6230 <span 6231 class="css-15j1jyt-PermalinkCopyIcon" 6232 id="docs-anchor-permalink-component" 6233 > 6234 <svg 6235 aria-label="permalink" 6236 class="anchor-icon" 6237 fill="none" 6238 height="24" 6239 viewBox="0 0 24 24" 6240 width="24" 6241 xmlns="http://www.w3.org/2000/svg" 6242 > 6243 <path 6244 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6245 stroke="#9B9B9B" 6246 stroke-linecap="round" 6247 stroke-linejoin="round" 6248 stroke-width="2" 6249 /> 6250 <path 6251 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6252 stroke="#9B9B9B" 6253 stroke-linecap="round" 6254 stroke-linejoin="round" 6255 stroke-width="2" 6256 /> 6257 </svg> 6258 </span> 6259 </a> 6260 </h2> 6261 <div 6262 class="css-1fultt1" 6263 > 6264 <h3 6265 class=" css-wbzzgj-TextComponent" 6266 data-heading="true" 6267 > 6268 <a 6269 class="css-1y48vg3" 6270 href="#barcodescanner" 6271 > 6272 <span 6273 class="css-s3qkfm" 6274 id="barcodescanner" 6275 /> 6276 <span 6277 class="css-6n7j50" 6278 > 6279 <code 6280 class="css-yd3r23-TextComponent" 6281 data-text="true" 6282 > 6283 BarCodeScanner 6284 </code> 6285 </span> 6286 <span 6287 class="css-15j1jyt-PermalinkCopyIcon" 6288 id="docs-anchor-permalink-barcodescanner" 6289 > 6290 <svg 6291 aria-label="permalink" 6292 class="anchor-icon" 6293 fill="none" 6294 height="24" 6295 viewBox="0 0 24 24" 6296 width="24" 6297 xmlns="http://www.w3.org/2000/svg" 6298 > 6299 <path 6300 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6301 stroke="#9B9B9B" 6302 stroke-linecap="round" 6303 stroke-linejoin="round" 6304 stroke-width="2" 6305 /> 6306 <path 6307 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6308 stroke="#9B9B9B" 6309 stroke-linecap="round" 6310 stroke-linejoin="round" 6311 stroke-width="2" 6312 /> 6313 </svg> 6314 </span> 6315 </a> 6316 </h3> 6317 <p 6318 class="mb-4 css-1kfqm4n-TextComponent" 6319 data-text="true" 6320 > 6321 <strong 6322 class="css-bvflvn-TextComponent" 6323 > 6324 Type: 6325 </strong> 6326 6327 <code 6328 class="css-iwb7ur-TextComponent" 6329 data-text="true" 6330 > 6331 React. 6332 Component 6333 < 6334 <span> 6335 <a 6336 class="css-1na8e0o-A" 6337 href="#barcodescannerprops" 6338 > 6339 BarCodeScannerProps 6340 </a> 6341 </span> 6342 > 6343 </code> 6344 </p> 6345 <h2 6346 class=" css-1qsxz84-TextComponent" 6347 data-heading="true" 6348 > 6349 <a 6350 class="css-1y48vg3" 6351 href="#props" 6352 > 6353 <span 6354 class="css-s3qkfm" 6355 id="props" 6356 /> 6357 <span 6358 class="css-6n7j50" 6359 > 6360 Props 6361 </span> 6362 <span 6363 class="css-15j1jyt-PermalinkCopyIcon" 6364 id="docs-anchor-permalink-props" 6365 > 6366 <svg 6367 aria-label="permalink" 6368 class="anchor-icon" 6369 fill="none" 6370 height="24" 6371 viewBox="0 0 24 24" 6372 width="24" 6373 xmlns="http://www.w3.org/2000/svg" 6374 > 6375 <path 6376 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6377 stroke="#9B9B9B" 6378 stroke-linecap="round" 6379 stroke-linejoin="round" 6380 stroke-width="2" 6381 /> 6382 <path 6383 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6384 stroke="#9B9B9B" 6385 stroke-linecap="round" 6386 stroke-linejoin="round" 6387 stroke-width="2" 6388 /> 6389 </svg> 6390 </span> 6391 </a> 6392 </h2> 6393 <div> 6394 <div 6395 class="css-11xr3cd" 6396 > 6397 <h3 6398 class=" css-wbzzgj-TextComponent" 6399 data-heading="true" 6400 > 6401 <a 6402 class="css-1y48vg3" 6403 href="#barcodetypes" 6404 > 6405 <span 6406 class="css-s3qkfm" 6407 id="barcodetypes" 6408 /> 6409 <span 6410 class="css-6n7j50" 6411 > 6412 <code 6413 class="css-s0csg4-TextComponent" 6414 data-text="true" 6415 > 6416 barCodeTypes 6417 </code> 6418 </span> 6419 <span 6420 class="css-15j1jyt-PermalinkCopyIcon" 6421 id="docs-anchor-permalink-barcodetypes" 6422 > 6423 <svg 6424 aria-label="permalink" 6425 class="anchor-icon" 6426 fill="none" 6427 height="24" 6428 viewBox="0 0 24 24" 6429 width="24" 6430 xmlns="http://www.w3.org/2000/svg" 6431 > 6432 <path 6433 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6434 stroke="#9B9B9B" 6435 stroke-linecap="round" 6436 stroke-linejoin="round" 6437 stroke-width="2" 6438 /> 6439 <path 6440 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6441 stroke="#9B9B9B" 6442 stroke-linecap="round" 6443 stroke-linejoin="round" 6444 stroke-width="2" 6445 /> 6446 </svg> 6447 </span> 6448 </a> 6449 </h3> 6450 <p 6451 class="mb-4 css-1kfqm4n-TextComponent" 6452 data-text="true" 6453 > 6454 <span 6455 class="css-1lk0cux" 6456 > 6457 Optional • 6458 </span> 6459 <span 6460 class="css-1lk0cux" 6461 > 6462 Type: 6463 </span> 6464 6465 <code 6466 class="css-iwb7ur-TextComponent" 6467 data-text="true" 6468 > 6469 string[] 6470 </code> 6471 </p> 6472 <p 6473 class="mb-4 css-1kfqm4n-TextComponent" 6474 data-text="true" 6475 > 6476 An array of bar code types. Usage: 6477 <code 6478 class="css-1a6y07t-TextComponent" 6479 data-text="true" 6480 > 6481 BarCodeScanner.Constants.BarCodeType.<codeType> 6482 </code> 6483 where 6484 6485 <code 6486 class="css-1a6y07t-TextComponent" 6487 data-text="true" 6488 > 6489 codeType 6490 </code> 6491 is one of these 6492 <a 6493 class="css-1na8e0o-A" 6494 href="#supported-formats" 6495 > 6496 listed above 6497 </a> 6498 . Defaults to all supported bar 6499code types. It is recommended to provide only the bar code formats you expect to scan to 6500minimize battery usage. 6501 </p> 6502 6503 6504 <p 6505 class="mb-4 css-1kfqm4n-TextComponent" 6506 data-text="true" 6507 > 6508 For example: 6509 <code 6510 class="css-1a6y07t-TextComponent" 6511 data-text="true" 6512 > 6513 barCodeTypes={[BarCodeScanner.Constants.BarCodeType.qr]} 6514 </code> 6515 . 6516 </p> 6517 </div> 6518 <div 6519 class="css-11xr3cd" 6520 > 6521 <h3 6522 class=" css-wbzzgj-TextComponent" 6523 data-heading="true" 6524 > 6525 <a 6526 class="css-1y48vg3" 6527 href="#onbarcodescanned" 6528 > 6529 <span 6530 class="css-s3qkfm" 6531 id="onbarcodescanned" 6532 /> 6533 <span 6534 class="css-6n7j50" 6535 > 6536 <code 6537 class="css-s0csg4-TextComponent" 6538 data-text="true" 6539 > 6540 onBarCodeScanned 6541 </code> 6542 </span> 6543 <span 6544 class="css-15j1jyt-PermalinkCopyIcon" 6545 id="docs-anchor-permalink-onbarcodescanned" 6546 > 6547 <svg 6548 aria-label="permalink" 6549 class="anchor-icon" 6550 fill="none" 6551 height="24" 6552 viewBox="0 0 24 24" 6553 width="24" 6554 xmlns="http://www.w3.org/2000/svg" 6555 > 6556 <path 6557 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6558 stroke="#9B9B9B" 6559 stroke-linecap="round" 6560 stroke-linejoin="round" 6561 stroke-width="2" 6562 /> 6563 <path 6564 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6565 stroke="#9B9B9B" 6566 stroke-linecap="round" 6567 stroke-linejoin="round" 6568 stroke-width="2" 6569 /> 6570 </svg> 6571 </span> 6572 </a> 6573 </h3> 6574 <p 6575 class="mb-4 css-1kfqm4n-TextComponent" 6576 data-text="true" 6577 > 6578 <span 6579 class="css-1lk0cux" 6580 > 6581 Optional • 6582 </span> 6583 <span 6584 class="css-1lk0cux" 6585 > 6586 Type: 6587 </span> 6588 6589 <code 6590 class="css-iwb7ur-TextComponent" 6591 data-text="true" 6592 > 6593 <a 6594 class="css-1na8e0o-A" 6595 href="#barcodescannedcallback" 6596 > 6597 BarCodeScannedCallback 6598 </a> 6599 </code> 6600 </p> 6601 <p 6602 class="mb-4 css-1kfqm4n-TextComponent" 6603 data-text="true" 6604 > 6605 A callback that is invoked when a bar code has been successfully scanned. The callback is 6606provided with an 6607 <a 6608 class="css-1na8e0o-A" 6609 href="#barcodescannerresult" 6610 > 6611 BarCodeScannerResult 6612 </a> 6613 . 6614 </p> 6615 6616 6617 <blockquote 6618 class="css-zknray-Callout" 6619 data-testid="callout-container" 6620 > 6621 <div 6622 class="css-7jywx8-Callout" 6623 > 6624 <svg 6625 class="icon-sm text-icon-default" 6626 fill="currentColor" 6627 role="img" 6628 viewBox="0 0 24 24" 6629 xmlns="http://www.w3.org/2000/svg" 6630 > 6631 <g 6632 id="info-circle" 6633 > 6634 <path 6635 clip-rule="evenodd" 6636 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 6637 fill-rule="evenodd" 6638 id="Solid" 6639 /> 6640 </g> 6641 </svg> 6642 </div> 6643 <div 6644 class="css-1m74yfi-Callout" 6645 > 6646 6647 6648 <p 6649 class="mb-4 css-1kfqm4n-TextComponent" 6650 data-text="true" 6651 > 6652 <strong 6653 class="css-bvflvn-TextComponent" 6654 > 6655 Note: 6656 </strong> 6657 Passing 6658 <code 6659 class="css-1a6y07t-TextComponent" 6660 data-text="true" 6661 > 6662 undefined 6663 </code> 6664 to the 6665 <code 6666 class="css-1a6y07t-TextComponent" 6667 data-text="true" 6668 > 6669 onBarCodeScanned 6670 </code> 6671 prop will result in no scanning. This 6672can be used to effectively "pause" the scanner so that it doesn't continually scan even after 6673data has been retrieved. 6674 </p> 6675 6676 6677 </div> 6678 </blockquote> 6679 </div> 6680 <div 6681 class="css-11xr3cd" 6682 > 6683 <h3 6684 class=" css-wbzzgj-TextComponent" 6685 data-heading="true" 6686 > 6687 <a 6688 class="css-1y48vg3" 6689 href="#type" 6690 > 6691 <span 6692 class="css-s3qkfm" 6693 id="type" 6694 /> 6695 <span 6696 class="css-6n7j50" 6697 > 6698 <code 6699 class="css-s0csg4-TextComponent" 6700 data-text="true" 6701 > 6702 type 6703 </code> 6704 </span> 6705 <span 6706 class="css-15j1jyt-PermalinkCopyIcon" 6707 id="docs-anchor-permalink-type" 6708 > 6709 <svg 6710 aria-label="permalink" 6711 class="anchor-icon" 6712 fill="none" 6713 height="24" 6714 viewBox="0 0 24 24" 6715 width="24" 6716 xmlns="http://www.w3.org/2000/svg" 6717 > 6718 <path 6719 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6720 stroke="#9B9B9B" 6721 stroke-linecap="round" 6722 stroke-linejoin="round" 6723 stroke-width="2" 6724 /> 6725 <path 6726 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6727 stroke="#9B9B9B" 6728 stroke-linecap="round" 6729 stroke-linejoin="round" 6730 stroke-width="2" 6731 /> 6732 </svg> 6733 </span> 6734 </a> 6735 </h3> 6736 <p 6737 class="mb-4 css-1kfqm4n-TextComponent" 6738 data-text="true" 6739 > 6740 <span 6741 class="css-1lk0cux" 6742 > 6743 Optional • 6744 </span> 6745 <span 6746 class="css-1lk0cux" 6747 > 6748 Type: 6749 </span> 6750 6751 <code 6752 class="css-iwb7ur-TextComponent" 6753 data-text="true" 6754 > 6755 <span> 6756 'front' 6757 | 6758 </span> 6759 <span> 6760 'back' 6761 | 6762 </span> 6763 <span> 6764 number 6765 </span> 6766 </code> 6767 <span> 6768 <span 6769 class="css-1lk0cux" 6770 > 6771 • Default: 6772 </span> 6773 6774 <code 6775 class="css-iwb7ur-TextComponent" 6776 data-text="true" 6777 > 6778 Type.back 6779 </code> 6780 </span> 6781 </p> 6782 <p 6783 class="mb-4 css-1kfqm4n-TextComponent" 6784 data-text="true" 6785 > 6786 Camera facing. Use one of 6787 <code 6788 class="css-1a6y07t-TextComponent" 6789 data-text="true" 6790 > 6791 BarCodeScanner.Constants.Type 6792 </code> 6793 . Use either 6794 <code 6795 class="css-1a6y07t-TextComponent" 6796 data-text="true" 6797 > 6798 Type.front 6799 </code> 6800 or 6801 <code 6802 class="css-1a6y07t-TextComponent" 6803 data-text="true" 6804 > 6805 Type.back 6806 </code> 6807 . 6808Same as 6809 <code 6810 class="css-1a6y07t-TextComponent" 6811 data-text="true" 6812 > 6813 Camera.Constants.Type 6814 </code> 6815 . 6816 </p> 6817 </div> 6818 <h3 6819 class=" css-wbzzgj-TextComponent" 6820 data-heading="true" 6821 > 6822 <a 6823 class="css-1y48vg3" 6824 href="#inherited-props" 6825 > 6826 <span 6827 class="css-s3qkfm" 6828 id="inherited-props" 6829 /> 6830 <span 6831 class="css-6n7j50" 6832 > 6833 Inherited Props 6834 </span> 6835 <span 6836 class="css-15j1jyt-PermalinkCopyIcon" 6837 id="docs-anchor-permalink-inherited-props" 6838 > 6839 <svg 6840 aria-label="permalink" 6841 class="anchor-icon" 6842 fill="none" 6843 height="24" 6844 viewBox="0 0 24 24" 6845 width="24" 6846 xmlns="http://www.w3.org/2000/svg" 6847 > 6848 <path 6849 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6850 stroke="#9B9B9B" 6851 stroke-linecap="round" 6852 stroke-linejoin="round" 6853 stroke-width="2" 6854 /> 6855 <path 6856 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6857 stroke="#9B9B9B" 6858 stroke-linecap="round" 6859 stroke-linejoin="round" 6860 stroke-width="2" 6861 /> 6862 </svg> 6863 </span> 6864 </a> 6865 </h3> 6866 <ul 6867 class="css-118jp6n-TextComponent" 6868 > 6869 <li 6870 class="css-1hxzfrf-TextComponent" 6871 data-text="true" 6872 > 6873 <code 6874 class="css-iwb7ur-TextComponent" 6875 data-text="true" 6876 > 6877 <a 6878 class="css-1na8e0o-A" 6879 href="https://reactnative.dev/docs/view#props" 6880 rel="noopener noreferrer" 6881 target="_blank" 6882 > 6883 ViewProps 6884 </a> 6885 </code> 6886 </li> 6887 </ul> 6888 </div> 6889 </div> 6890 <h2 6891 class=" css-1qsxz84-TextComponent" 6892 data-heading="true" 6893 > 6894 <a 6895 class="css-1y48vg3" 6896 href="#hooks" 6897 > 6898 <span 6899 class="css-s3qkfm" 6900 id="hooks" 6901 /> 6902 <span 6903 class="css-6n7j50" 6904 > 6905 Hooks 6906 </span> 6907 <span 6908 class="css-15j1jyt-PermalinkCopyIcon" 6909 id="docs-anchor-permalink-hooks" 6910 > 6911 <svg 6912 aria-label="permalink" 6913 class="anchor-icon" 6914 fill="none" 6915 height="24" 6916 viewBox="0 0 24 24" 6917 width="24" 6918 xmlns="http://www.w3.org/2000/svg" 6919 > 6920 <path 6921 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6922 stroke="#9B9B9B" 6923 stroke-linecap="round" 6924 stroke-linejoin="round" 6925 stroke-width="2" 6926 /> 6927 <path 6928 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6929 stroke="#9B9B9B" 6930 stroke-linecap="round" 6931 stroke-linejoin="round" 6932 stroke-width="2" 6933 /> 6934 </svg> 6935 </span> 6936 </a> 6937 </h2> 6938 <div 6939 class="css-11xr3cd" 6940 > 6941 <h3 6942 class=" css-wbzzgj-TextComponent" 6943 data-heading="true" 6944 > 6945 <a 6946 class="css-1y48vg3" 6947 href="#usepermissionsoptions" 6948 > 6949 <span 6950 class="css-s3qkfm" 6951 id="usepermissionsoptions" 6952 /> 6953 <span 6954 class="css-6n7j50" 6955 > 6956 <code 6957 class="css-s0csg4-TextComponent" 6958 data-text="true" 6959 > 6960 usePermissions(options) 6961 </code> 6962 </span> 6963 <span 6964 class="css-15j1jyt-PermalinkCopyIcon" 6965 id="docs-anchor-permalink-usepermissionsoptions" 6966 > 6967 <svg 6968 aria-label="permalink" 6969 class="anchor-icon" 6970 fill="none" 6971 height="24" 6972 viewBox="0 0 24 24" 6973 width="24" 6974 xmlns="http://www.w3.org/2000/svg" 6975 > 6976 <path 6977 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 6978 stroke="#9B9B9B" 6979 stroke-linecap="round" 6980 stroke-linejoin="round" 6981 stroke-width="2" 6982 /> 6983 <path 6984 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 6985 stroke="#9B9B9B" 6986 stroke-linecap="round" 6987 stroke-linejoin="round" 6988 stroke-width="2" 6989 /> 6990 </svg> 6991 </span> 6992 </a> 6993 </h3> 6994 <div 6995 class="css-1uyflf8-Table" 6996 > 6997 <table 6998 class="css-q84cm9-Table" 6999 > 7000 <thead 7001 class="bg-subtle border-b border-b-default border-solid" 7002 > 7003 <tr 7004 class="css-190f936-Row" 7005 > 7006 <th 7007 class="css-1uwgm7m-HeaderCell" 7008 > 7009 Name 7010 </th> 7011 <th 7012 class="css-1uwgm7m-HeaderCell" 7013 > 7014 Type 7015 </th> 7016 <th 7017 class="css-1uwgm7m-HeaderCell" 7018 > 7019 Description 7020 </th> 7021 </tr> 7022 </thead> 7023 <tbody> 7024 <tr 7025 class="css-190f936-Row" 7026 > 7027 <td 7028 class="css-zstkv9-Cell" 7029 > 7030 <strong 7031 class="css-bvflvn-TextComponent" 7032 > 7033 options 7034 </strong> 7035 <br /> 7036 <span 7037 class="css-1g95u6x" 7038 > 7039 (optional) 7040 </span> 7041 </td> 7042 <td 7043 class="css-zstkv9-Cell" 7044 > 7045 <code 7046 class="css-iwb7ur-TextComponent" 7047 data-text="true" 7048 > 7049 <a 7050 class="css-1na8e0o-A" 7051 href="#permissionhookoptions" 7052 > 7053 PermissionHookOptions 7054 </a> 7055 < 7056 <span> 7057 object 7058 </span> 7059 > 7060 </code> 7061 </td> 7062 <td 7063 class="css-zstkv9-Cell" 7064 > 7065 - 7066 </td> 7067 </tr> 7068 </tbody> 7069 </table> 7070 </div> 7071 <br /> 7072 <p 7073 class="mb-4 css-1kfqm4n-TextComponent" 7074 data-text="true" 7075 > 7076 Check or request permissions for the barcode scanner. 7077This uses both 7078 <code 7079 class="css-1a6y07t-TextComponent" 7080 data-text="true" 7081 > 7082 requestPermissionAsync 7083 </code> 7084 and 7085 <code 7086 class="css-1a6y07t-TextComponent" 7087 data-text="true" 7088 > 7089 getPermissionsAsync 7090 </code> 7091 to interact with the permissions. 7092 </p> 7093 <p 7094 class="css-1eksndl-BoxSectionHeader" 7095 data-text="true" 7096 > 7097 Example 7098 </p> 7099 <pre> 7100 <pre 7101 class="css-1tmj8fm" 7102 data-text="true" 7103 > 7104 <code 7105 class="css-1r5zesl" 7106 > 7107 <span 7108 class="token keyword" 7109 > 7110 const 7111 </span> 7112 7113 <span 7114 class="token punctuation" 7115 > 7116 [ 7117 </span> 7118 permissionResponse 7119 <span 7120 class="token punctuation" 7121 > 7122 , 7123 </span> 7124 requestPermission 7125 <span 7126 class="token punctuation" 7127 > 7128 ] 7129 </span> 7130 7131 <span 7132 class="token operator" 7133 > 7134 = 7135 </span> 7136 7137 <span 7138 class="token maybe-class-name" 7139 > 7140 BarCodeScanner 7141 </span> 7142 <span 7143 class="token punctuation" 7144 > 7145 . 7146 </span> 7147 <span 7148 class="token method function property-access" 7149 > 7150 usePermissions 7151 </span> 7152 <span 7153 class="token punctuation" 7154 > 7155 ( 7156 </span> 7157 <span 7158 class="token punctuation" 7159 > 7160 ) 7161 </span> 7162 <span 7163 class="token punctuation" 7164 > 7165 ; 7166 </span> 7167 7168 7169 </code> 7170 </pre> 7171 </pre> 7172 <p 7173 class="css-1eksndl-BoxSectionHeader" 7174 data-text="true" 7175 > 7176 Returns 7177 </p> 7178 <ul 7179 class="!list-none !ml-0 css-118jp6n-TextComponent" 7180 > 7181 <li 7182 class="css-1hxzfrf-TextComponent" 7183 data-text="true" 7184 > 7185 <svg 7186 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 7187 fill="none" 7188 role="img" 7189 stroke="currentColor" 7190 viewBox="0 0 24 24" 7191 xmlns="http://www.w3.org/2000/svg" 7192 > 7193 <g 7194 id="corner-down-right" 7195 > 7196 <path 7197 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 7198 id="Icon" 7199 stroke-linecap="round" 7200 stroke-linejoin="round" 7201 stroke-width="2" 7202 /> 7203 </g> 7204 </svg> 7205 <code 7206 class="css-iwb7ur-TextComponent" 7207 data-text="true" 7208 > 7209 [ 7210 <span> 7211 <span> 7212 null 7213 | 7214 </span> 7215 <span> 7216 <a 7217 class="css-1na8e0o-A" 7218 href="#permissionresponse" 7219 > 7220 PermissionResponse 7221 </a> 7222 </span> 7223 , 7224 </span> 7225 <span> 7226 RequestPermissionMethod 7227 < 7228 <span> 7229 <a 7230 class="css-1na8e0o-A" 7231 href="#permissionresponse" 7232 > 7233 PermissionResponse 7234 </a> 7235 </span> 7236 > 7237 , 7238 </span> 7239 <span> 7240 GetPermissionMethod 7241 < 7242 <span> 7243 <a 7244 class="css-1na8e0o-A" 7245 href="#permissionresponse" 7246 > 7247 PermissionResponse 7248 </a> 7249 </span> 7250 > 7251 </span> 7252 ] 7253 </code> 7254 </li> 7255 </ul> 7256 <br /> 7257 </div> 7258 <h2 7259 class=" css-1qsxz84-TextComponent" 7260 data-heading="true" 7261 > 7262 <a 7263 class="css-1y48vg3" 7264 href="#methods" 7265 > 7266 <span 7267 class="css-s3qkfm" 7268 id="methods" 7269 /> 7270 <span 7271 class="css-6n7j50" 7272 > 7273 Methods 7274 </span> 7275 <span 7276 class="css-15j1jyt-PermalinkCopyIcon" 7277 id="docs-anchor-permalink-methods" 7278 > 7279 <svg 7280 aria-label="permalink" 7281 class="anchor-icon" 7282 fill="none" 7283 height="24" 7284 viewBox="0 0 24 24" 7285 width="24" 7286 xmlns="http://www.w3.org/2000/svg" 7287 > 7288 <path 7289 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 7290 stroke="#9B9B9B" 7291 stroke-linecap="round" 7292 stroke-linejoin="round" 7293 stroke-width="2" 7294 /> 7295 <path 7296 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 7297 stroke="#9B9B9B" 7298 stroke-linecap="round" 7299 stroke-linejoin="round" 7300 stroke-width="2" 7301 /> 7302 </svg> 7303 </span> 7304 </a> 7305 </h2> 7306 <div 7307 class="css-11xr3cd" 7308 > 7309 <h3 7310 class=" css-wbzzgj-TextComponent" 7311 data-heading="true" 7312 > 7313 <a 7314 class="css-1y48vg3" 7315 href="#barcodescannergetpermissionsasync" 7316 > 7317 <span 7318 class="css-s3qkfm" 7319 id="barcodescannergetpermissionsasync" 7320 /> 7321 <span 7322 class="css-6n7j50" 7323 > 7324 <code 7325 class="css-s0csg4-TextComponent" 7326 data-text="true" 7327 > 7328 BarCodeScanner.getPermissionsAsync() 7329 </code> 7330 </span> 7331 <span 7332 class="css-15j1jyt-PermalinkCopyIcon" 7333 id="docs-anchor-permalink-barcodescannergetpermissionsasync" 7334 > 7335 <svg 7336 aria-label="permalink" 7337 class="anchor-icon" 7338 fill="none" 7339 height="24" 7340 viewBox="0 0 24 24" 7341 width="24" 7342 xmlns="http://www.w3.org/2000/svg" 7343 > 7344 <path 7345 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 7346 stroke="#9B9B9B" 7347 stroke-linecap="round" 7348 stroke-linejoin="round" 7349 stroke-width="2" 7350 /> 7351 <path 7352 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 7353 stroke="#9B9B9B" 7354 stroke-linecap="round" 7355 stroke-linejoin="round" 7356 stroke-width="2" 7357 /> 7358 </svg> 7359 </span> 7360 </a> 7361 </h3> 7362 <p 7363 class="mb-4 css-1kfqm4n-TextComponent" 7364 data-text="true" 7365 > 7366 Checks user's permissions for accessing the camera. 7367 </p> 7368 <p 7369 class="css-1eksndl-BoxSectionHeader" 7370 data-text="true" 7371 > 7372 Returns 7373 </p> 7374 <ul 7375 class="!list-none !ml-0 css-118jp6n-TextComponent" 7376 > 7377 <li 7378 class="css-1hxzfrf-TextComponent" 7379 data-text="true" 7380 > 7381 <svg 7382 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 7383 fill="none" 7384 role="img" 7385 stroke="currentColor" 7386 viewBox="0 0 24 24" 7387 xmlns="http://www.w3.org/2000/svg" 7388 > 7389 <g 7390 id="corner-down-right" 7391 > 7392 <path 7393 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 7394 id="Icon" 7395 stroke-linecap="round" 7396 stroke-linejoin="round" 7397 stroke-width="2" 7398 /> 7399 </g> 7400 </svg> 7401 <code 7402 class="css-iwb7ur-TextComponent" 7403 data-text="true" 7404 > 7405 <a 7406 class="css-1na8e0o-A" 7407 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 7408 rel="noopener noreferrer" 7409 target="_blank" 7410 > 7411 Promise 7412 </a> 7413 < 7414 <span> 7415 <a 7416 class="css-1na8e0o-A" 7417 href="#permissionresponse" 7418 > 7419 PermissionResponse 7420 </a> 7421 </span> 7422 > 7423 </code> 7424 </li> 7425 </ul> 7426 <br /> 7427 <p 7428 class="mb-4 css-1kfqm4n-TextComponent" 7429 data-text="true" 7430 > 7431 Return a promise that fulfills to an object of type 7432 <a 7433 class="css-1na8e0o-A" 7434 href="#permissionresponse" 7435 > 7436 <code 7437 class="css-1a6y07t-TextComponent" 7438 data-text="true" 7439 > 7440 PermissionResponse 7441 </code> 7442 </a> 7443 . 7444 </p> 7445 </div> 7446 <div 7447 class="css-11xr3cd" 7448 > 7449 <h3 7450 class=" css-wbzzgj-TextComponent" 7451 data-heading="true" 7452 > 7453 <a 7454 class="css-1y48vg3" 7455 href="#barcodescannerrequestpermissionsasync" 7456 > 7457 <span 7458 class="css-s3qkfm" 7459 id="barcodescannerrequestpermissionsasync" 7460 /> 7461 <span 7462 class="css-6n7j50" 7463 > 7464 <code 7465 class="css-s0csg4-TextComponent" 7466 data-text="true" 7467 > 7468 BarCodeScanner.requestPermissionsAsync() 7469 </code> 7470 </span> 7471 <span 7472 class="css-15j1jyt-PermalinkCopyIcon" 7473 id="docs-anchor-permalink-barcodescannerrequestpermissionsasync" 7474 > 7475 <svg 7476 aria-label="permalink" 7477 class="anchor-icon" 7478 fill="none" 7479 height="24" 7480 viewBox="0 0 24 24" 7481 width="24" 7482 xmlns="http://www.w3.org/2000/svg" 7483 > 7484 <path 7485 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 7486 stroke="#9B9B9B" 7487 stroke-linecap="round" 7488 stroke-linejoin="round" 7489 stroke-width="2" 7490 /> 7491 <path 7492 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 7493 stroke="#9B9B9B" 7494 stroke-linecap="round" 7495 stroke-linejoin="round" 7496 stroke-width="2" 7497 /> 7498 </svg> 7499 </span> 7500 </a> 7501 </h3> 7502 <p 7503 class="mb-4 css-1kfqm4n-TextComponent" 7504 data-text="true" 7505 > 7506 Asks the user to grant permissions for accessing the camera. 7507 </p> 7508 7509 7510 <p 7511 class="mb-4 css-1kfqm4n-TextComponent" 7512 data-text="true" 7513 > 7514 On iOS this will require apps to specify the 7515 <code 7516 class="css-1a6y07t-TextComponent" 7517 data-text="true" 7518 > 7519 NSCameraUsageDescription 7520 </code> 7521 entry in the 7522 <code 7523 class="css-1a6y07t-TextComponent" 7524 data-text="true" 7525 > 7526 Info.plist 7527 </code> 7528 . 7529 </p> 7530 <p 7531 class="css-1eksndl-BoxSectionHeader" 7532 data-text="true" 7533 > 7534 Returns 7535 </p> 7536 <ul 7537 class="!list-none !ml-0 css-118jp6n-TextComponent" 7538 > 7539 <li 7540 class="css-1hxzfrf-TextComponent" 7541 data-text="true" 7542 > 7543 <svg 7544 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 7545 fill="none" 7546 role="img" 7547 stroke="currentColor" 7548 viewBox="0 0 24 24" 7549 xmlns="http://www.w3.org/2000/svg" 7550 > 7551 <g 7552 id="corner-down-right" 7553 > 7554 <path 7555 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 7556 id="Icon" 7557 stroke-linecap="round" 7558 stroke-linejoin="round" 7559 stroke-width="2" 7560 /> 7561 </g> 7562 </svg> 7563 <code 7564 class="css-iwb7ur-TextComponent" 7565 data-text="true" 7566 > 7567 <a 7568 class="css-1na8e0o-A" 7569 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 7570 rel="noopener noreferrer" 7571 target="_blank" 7572 > 7573 Promise 7574 </a> 7575 < 7576 <span> 7577 <a 7578 class="css-1na8e0o-A" 7579 href="#permissionresponse" 7580 > 7581 PermissionResponse 7582 </a> 7583 </span> 7584 > 7585 </code> 7586 </li> 7587 </ul> 7588 <br /> 7589 <p 7590 class="mb-4 css-1kfqm4n-TextComponent" 7591 data-text="true" 7592 > 7593 Return a promise that fulfills to an object of type 7594 <a 7595 class="css-1na8e0o-A" 7596 href="#permissionresponse" 7597 > 7598 <code 7599 class="css-1a6y07t-TextComponent" 7600 data-text="true" 7601 > 7602 PermissionResponse 7603 </code> 7604 </a> 7605 . 7606 </p> 7607 </div> 7608 <div 7609 class="css-11xr3cd" 7610 > 7611 <h3 7612 class=" css-wbzzgj-TextComponent" 7613 data-heading="true" 7614 > 7615 <a 7616 class="css-1y48vg3" 7617 href="#barcodescannerscanfromurlasyncurl-barcodetypes" 7618 > 7619 <span 7620 class="css-s3qkfm" 7621 id="barcodescannerscanfromurlasyncurl-barcodetypes" 7622 /> 7623 <span 7624 class="css-6n7j50" 7625 > 7626 <code 7627 class="css-s0csg4-TextComponent" 7628 data-text="true" 7629 > 7630 BarCodeScanner.scanFromURLAsync(url, barCodeTypes) 7631 </code> 7632 </span> 7633 <span 7634 class="css-15j1jyt-PermalinkCopyIcon" 7635 id="docs-anchor-permalink-barcodescannerscanfromurlasyncurl-barcodetypes" 7636 > 7637 <svg 7638 aria-label="permalink" 7639 class="anchor-icon" 7640 fill="none" 7641 height="24" 7642 viewBox="0 0 24 24" 7643 width="24" 7644 xmlns="http://www.w3.org/2000/svg" 7645 > 7646 <path 7647 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 7648 stroke="#9B9B9B" 7649 stroke-linecap="round" 7650 stroke-linejoin="round" 7651 stroke-width="2" 7652 /> 7653 <path 7654 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 7655 stroke="#9B9B9B" 7656 stroke-linecap="round" 7657 stroke-linejoin="round" 7658 stroke-width="2" 7659 /> 7660 </svg> 7661 </span> 7662 </a> 7663 </h3> 7664 <div 7665 class="css-1uyflf8-Table" 7666 > 7667 <table 7668 class="css-q84cm9-Table" 7669 > 7670 <thead 7671 class="bg-subtle border-b border-b-default border-solid" 7672 > 7673 <tr 7674 class="css-190f936-Row" 7675 > 7676 <th 7677 class="css-1uwgm7m-HeaderCell" 7678 > 7679 Name 7680 </th> 7681 <th 7682 class="css-1uwgm7m-HeaderCell" 7683 > 7684 Type 7685 </th> 7686 <th 7687 class="css-1uwgm7m-HeaderCell" 7688 > 7689 Description 7690 </th> 7691 </tr> 7692 </thead> 7693 <tbody> 7694 <tr 7695 class="css-190f936-Row" 7696 > 7697 <td 7698 class="css-zstkv9-Cell" 7699 > 7700 <strong 7701 class="css-bvflvn-TextComponent" 7702 > 7703 url 7704 </strong> 7705 </td> 7706 <td 7707 class="css-zstkv9-Cell" 7708 > 7709 <code 7710 class="css-iwb7ur-TextComponent" 7711 data-text="true" 7712 > 7713 string 7714 </code> 7715 </td> 7716 <td 7717 class="css-zstkv9-Cell" 7718 > 7719 <p 7720 class="mb-4 css-1kfqm4n-TextComponent" 7721 data-text="true" 7722 > 7723 URL to get the image from. 7724 </p> 7725 </td> 7726 </tr> 7727 <tr 7728 class="css-190f936-Row" 7729 > 7730 <td 7731 class="css-zstkv9-Cell" 7732 > 7733 <strong 7734 class="css-bvflvn-TextComponent" 7735 > 7736 barCodeTypes 7737 </strong> 7738 <br /> 7739 <span 7740 class="css-1g95u6x" 7741 > 7742 (optional) 7743 </span> 7744 </td> 7745 <td 7746 class="css-zstkv9-Cell" 7747 > 7748 <code 7749 class="css-iwb7ur-TextComponent" 7750 data-text="true" 7751 > 7752 string[] 7753 </code> 7754 </td> 7755 <td 7756 class="css-zstkv9-Cell" 7757 > 7758 <p 7759 class="mb-4 css-1kfqm4n-TextComponent" 7760 data-text="true" 7761 > 7762 An array of bar code types. Defaults to all supported bar code types on 7763the platform. 7764 </p> 7765 7766 7767 <blockquote 7768 class="css-zknray-Callout" 7769 data-testid="callout-container" 7770 > 7771 <div 7772 class="css-7jywx8-Callout" 7773 > 7774 <svg 7775 class="icon-sm text-icon-default" 7776 fill="currentColor" 7777 role="img" 7778 viewBox="0 0 24 24" 7779 xmlns="http://www.w3.org/2000/svg" 7780 > 7781 <g 7782 id="info-circle" 7783 > 7784 <path 7785 clip-rule="evenodd" 7786 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 7787 fill-rule="evenodd" 7788 id="Solid" 7789 /> 7790 </g> 7791 </svg> 7792 </div> 7793 <div 7794 class="css-1m74yfi-Callout" 7795 > 7796 7797 7798 <p 7799 class="mb-4 css-1kfqm4n-TextComponent" 7800 data-text="true" 7801 > 7802 <strong 7803 class="css-bvflvn-TextComponent" 7804 > 7805 Note: 7806 </strong> 7807 Only QR codes are supported on iOS. 7808 </p> 7809 7810 7811 </div> 7812 </blockquote> 7813 </td> 7814 </tr> 7815 </tbody> 7816 </table> 7817 </div> 7818 <br /> 7819 <p 7820 class="mb-4 css-1kfqm4n-TextComponent" 7821 data-text="true" 7822 > 7823 Scan bar codes from the image given by the URL. 7824 </p> 7825 <p 7826 class="css-1eksndl-BoxSectionHeader" 7827 data-text="true" 7828 > 7829 Returns 7830 </p> 7831 <ul 7832 class="!list-none !ml-0 css-118jp6n-TextComponent" 7833 > 7834 <li 7835 class="css-1hxzfrf-TextComponent" 7836 data-text="true" 7837 > 7838 <svg 7839 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 7840 fill="none" 7841 role="img" 7842 stroke="currentColor" 7843 viewBox="0 0 24 24" 7844 xmlns="http://www.w3.org/2000/svg" 7845 > 7846 <g 7847 id="corner-down-right" 7848 > 7849 <path 7850 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 7851 id="Icon" 7852 stroke-linecap="round" 7853 stroke-linejoin="round" 7854 stroke-width="2" 7855 /> 7856 </g> 7857 </svg> 7858 <code 7859 class="css-iwb7ur-TextComponent" 7860 data-text="true" 7861 > 7862 <a 7863 class="css-1na8e0o-A" 7864 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 7865 rel="noopener noreferrer" 7866 target="_blank" 7867 > 7868 Promise 7869 </a> 7870 < 7871 <span> 7872 <a 7873 class="css-1na8e0o-A" 7874 href="#barcodescannerresult" 7875 > 7876 BarCodeScannerResult 7877 [] 7878 </a> 7879 </span> 7880 > 7881 </code> 7882 </li> 7883 </ul> 7884 <br /> 7885 <p 7886 class="mb-4 css-1kfqm4n-TextComponent" 7887 data-text="true" 7888 > 7889 A possibly empty array of objects of the 7890 <code 7891 class="css-1a6y07t-TextComponent" 7892 data-text="true" 7893 > 7894 BarCodeScannerResult 7895 </code> 7896 shape, where the type 7897refers to the bar code type that was scanned and the data is the information encoded in the bar 7898code. 7899 </p> 7900 </div> 7901 <h2 7902 class=" css-1qsxz84-TextComponent" 7903 data-heading="true" 7904 > 7905 <a 7906 class="css-1y48vg3" 7907 href="#interfaces" 7908 > 7909 <span 7910 class="css-s3qkfm" 7911 id="interfaces" 7912 /> 7913 <span 7914 class="css-6n7j50" 7915 > 7916 Interfaces 7917 </span> 7918 <span 7919 class="css-15j1jyt-PermalinkCopyIcon" 7920 id="docs-anchor-permalink-interfaces" 7921 > 7922 <svg 7923 aria-label="permalink" 7924 class="anchor-icon" 7925 fill="none" 7926 height="24" 7927 viewBox="0 0 24 24" 7928 width="24" 7929 xmlns="http://www.w3.org/2000/svg" 7930 > 7931 <path 7932 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 7933 stroke="#9B9B9B" 7934 stroke-linecap="round" 7935 stroke-linejoin="round" 7936 stroke-width="2" 7937 /> 7938 <path 7939 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 7940 stroke="#9B9B9B" 7941 stroke-linecap="round" 7942 stroke-linejoin="round" 7943 stroke-width="2" 7944 /> 7945 </svg> 7946 </span> 7947 </a> 7948 </h2> 7949 <div 7950 class="css-11xr3cd" 7951 > 7952 <h3 7953 class=" css-wbzzgj-TextComponent" 7954 data-heading="true" 7955 > 7956 <a 7957 class="css-1y48vg3" 7958 href="#permissionresponse" 7959 > 7960 <span 7961 class="css-s3qkfm" 7962 id="permissionresponse" 7963 /> 7964 <span 7965 class="css-6n7j50" 7966 > 7967 <code 7968 class="css-yd3r23-TextComponent" 7969 data-text="true" 7970 > 7971 PermissionResponse 7972 </code> 7973 </span> 7974 <span 7975 class="css-15j1jyt-PermalinkCopyIcon" 7976 id="docs-anchor-permalink-permissionresponse" 7977 > 7978 <svg 7979 aria-label="permalink" 7980 class="anchor-icon" 7981 fill="none" 7982 height="24" 7983 viewBox="0 0 24 24" 7984 width="24" 7985 xmlns="http://www.w3.org/2000/svg" 7986 > 7987 <path 7988 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 7989 stroke="#9B9B9B" 7990 stroke-linecap="round" 7991 stroke-linejoin="round" 7992 stroke-width="2" 7993 /> 7994 <path 7995 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 7996 stroke="#9B9B9B" 7997 stroke-linecap="round" 7998 stroke-linejoin="round" 7999 stroke-width="2" 8000 /> 8001 </svg> 8002 </span> 8003 </a> 8004 </h3> 8005 <p 8006 class="mb-4 css-1kfqm4n-TextComponent" 8007 data-text="true" 8008 > 8009 An object obtained by permissions get and request functions. 8010 </p> 8011 <p 8012 class="css-1eksndl-BoxSectionHeader" 8013 data-text="true" 8014 > 8015 PermissionResponse Properties 8016 </p> 8017 <div 8018 class="css-1uyflf8-Table" 8019 > 8020 <table 8021 class="css-q84cm9-Table" 8022 > 8023 <thead 8024 class="bg-subtle border-b border-b-default border-solid" 8025 > 8026 <tr 8027 class="css-190f936-Row" 8028 > 8029 <th 8030 class="css-1uwgm7m-HeaderCell" 8031 > 8032 Name 8033 </th> 8034 <th 8035 class="css-1uwgm7m-HeaderCell" 8036 > 8037 Type 8038 </th> 8039 <th 8040 class="css-1uwgm7m-HeaderCell" 8041 > 8042 Description 8043 </th> 8044 </tr> 8045 </thead> 8046 <tbody> 8047 <tr 8048 class="css-190f936-Row" 8049 > 8050 <td 8051 class="css-18p3734-Cell" 8052 > 8053 <strong 8054 class="css-bvflvn-TextComponent" 8055 > 8056 canAskAgain 8057 </strong> 8058 </td> 8059 <td 8060 class="css-18p3734-Cell" 8061 > 8062 <code 8063 class="css-iwb7ur-TextComponent" 8064 data-text="true" 8065 > 8066 boolean 8067 </code> 8068 </td> 8069 <td 8070 class="css-18p3734-Cell" 8071 > 8072 <p 8073 class="mb-4 css-1kfqm4n-TextComponent" 8074 data-text="true" 8075 > 8076 Indicates if user can be asked again for specific permission. 8077If not, one should be directed to the Settings app 8078in order to enable/disable the permission. 8079 </p> 8080 </td> 8081 </tr> 8082 <tr 8083 class="css-190f936-Row" 8084 > 8085 <td 8086 class="css-18p3734-Cell" 8087 > 8088 <strong 8089 class="css-bvflvn-TextComponent" 8090 > 8091 expires 8092 </strong> 8093 </td> 8094 <td 8095 class="css-18p3734-Cell" 8096 > 8097 <code 8098 class="css-iwb7ur-TextComponent" 8099 data-text="true" 8100 > 8101 <a 8102 class="css-1na8e0o-A" 8103 href="#permissionexpiration" 8104 > 8105 PermissionExpiration 8106 </a> 8107 </code> 8108 </td> 8109 <td 8110 class="css-18p3734-Cell" 8111 > 8112 <p 8113 class="mb-4 css-1kfqm4n-TextComponent" 8114 data-text="true" 8115 > 8116 Determines time when the permission expires. 8117 </p> 8118 </td> 8119 </tr> 8120 <tr 8121 class="css-190f936-Row" 8122 > 8123 <td 8124 class="css-18p3734-Cell" 8125 > 8126 <strong 8127 class="css-bvflvn-TextComponent" 8128 > 8129 granted 8130 </strong> 8131 </td> 8132 <td 8133 class="css-18p3734-Cell" 8134 > 8135 <code 8136 class="css-iwb7ur-TextComponent" 8137 data-text="true" 8138 > 8139 boolean 8140 </code> 8141 </td> 8142 <td 8143 class="css-18p3734-Cell" 8144 > 8145 <p 8146 class="mb-4 css-1kfqm4n-TextComponent" 8147 data-text="true" 8148 > 8149 A convenience boolean that indicates if the permission is granted. 8150 </p> 8151 </td> 8152 </tr> 8153 <tr 8154 class="css-190f936-Row" 8155 > 8156 <td 8157 class="css-18p3734-Cell" 8158 > 8159 <strong 8160 class="css-bvflvn-TextComponent" 8161 > 8162 status 8163 </strong> 8164 </td> 8165 <td 8166 class="css-18p3734-Cell" 8167 > 8168 <code 8169 class="css-iwb7ur-TextComponent" 8170 data-text="true" 8171 > 8172 <a 8173 class="css-1na8e0o-A" 8174 href="#permissionstatus" 8175 > 8176 PermissionStatus 8177 </a> 8178 </code> 8179 </td> 8180 <td 8181 class="css-18p3734-Cell" 8182 > 8183 <p 8184 class="mb-4 css-1kfqm4n-TextComponent" 8185 data-text="true" 8186 > 8187 Determines the status of the permission. 8188 </p> 8189 </td> 8190 </tr> 8191 </tbody> 8192 </table> 8193 </div> 8194 <br /> 8195 </div> 8196 <h2 8197 class=" css-1qsxz84-TextComponent" 8198 data-heading="true" 8199 > 8200 <a 8201 class="css-1y48vg3" 8202 href="#types" 8203 > 8204 <span 8205 class="css-s3qkfm" 8206 id="types" 8207 /> 8208 <span 8209 class="css-6n7j50" 8210 > 8211 Types 8212 </span> 8213 <span 8214 class="css-15j1jyt-PermalinkCopyIcon" 8215 id="docs-anchor-permalink-types" 8216 > 8217 <svg 8218 aria-label="permalink" 8219 class="anchor-icon" 8220 fill="none" 8221 height="24" 8222 viewBox="0 0 24 24" 8223 width="24" 8224 xmlns="http://www.w3.org/2000/svg" 8225 > 8226 <path 8227 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 8228 stroke="#9B9B9B" 8229 stroke-linecap="round" 8230 stroke-linejoin="round" 8231 stroke-width="2" 8232 /> 8233 <path 8234 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 8235 stroke="#9B9B9B" 8236 stroke-linecap="round" 8237 stroke-linejoin="round" 8238 stroke-width="2" 8239 /> 8240 </svg> 8241 </span> 8242 </a> 8243 </h2> 8244 <div 8245 class="css-1fultt1" 8246 > 8247 <h3 8248 class=" css-wbzzgj-TextComponent" 8249 data-heading="true" 8250 > 8251 <a 8252 class="css-1y48vg3" 8253 href="#barcodebounds" 8254 > 8255 <span 8256 class="css-s3qkfm" 8257 id="barcodebounds" 8258 /> 8259 <span 8260 class="css-6n7j50" 8261 > 8262 <code 8263 class="css-yd3r23-TextComponent" 8264 data-text="true" 8265 > 8266 BarCodeBounds 8267 </code> 8268 </span> 8269 <span 8270 class="css-15j1jyt-PermalinkCopyIcon" 8271 id="docs-anchor-permalink-barcodebounds" 8272 > 8273 <svg 8274 aria-label="permalink" 8275 class="anchor-icon" 8276 fill="none" 8277 height="24" 8278 viewBox="0 0 24 24" 8279 width="24" 8280 xmlns="http://www.w3.org/2000/svg" 8281 > 8282 <path 8283 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 8284 stroke="#9B9B9B" 8285 stroke-linecap="round" 8286 stroke-linejoin="round" 8287 stroke-width="2" 8288 /> 8289 <path 8290 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 8291 stroke="#9B9B9B" 8292 stroke-linecap="round" 8293 stroke-linejoin="round" 8294 stroke-width="2" 8295 /> 8296 </svg> 8297 </span> 8298 </a> 8299 </h3> 8300 <div 8301 class="css-1uyflf8-Table" 8302 > 8303 <table 8304 class="css-q84cm9-Table" 8305 > 8306 <thead 8307 class="bg-subtle border-b border-b-default border-solid" 8308 > 8309 <tr 8310 class="css-190f936-Row" 8311 > 8312 <th 8313 class="css-1uwgm7m-HeaderCell" 8314 > 8315 Name 8316 </th> 8317 <th 8318 class="css-1uwgm7m-HeaderCell" 8319 > 8320 Type 8321 </th> 8322 <th 8323 class="css-1uwgm7m-HeaderCell" 8324 > 8325 Description 8326 </th> 8327 </tr> 8328 </thead> 8329 <tbody> 8330 <tr 8331 class="css-190f936-Row" 8332 > 8333 <td 8334 class="css-18p3734-Cell" 8335 > 8336 <strong 8337 class="css-bvflvn-TextComponent" 8338 > 8339 origin 8340 </strong> 8341 </td> 8342 <td 8343 class="css-18p3734-Cell" 8344 > 8345 <code 8346 class="css-iwb7ur-TextComponent" 8347 data-text="true" 8348 > 8349 <a 8350 class="css-1na8e0o-A" 8351 href="#barcodepoint" 8352 > 8353 BarCodePoint 8354 </a> 8355 </code> 8356 </td> 8357 <td 8358 class="css-18p3734-Cell" 8359 > 8360 <p 8361 class="mb-4 css-1kfqm4n-TextComponent" 8362 data-text="true" 8363 > 8364 The origin point of the bounding box. 8365 </p> 8366 </td> 8367 </tr> 8368 <tr 8369 class="css-190f936-Row" 8370 > 8371 <td 8372 class="css-18p3734-Cell" 8373 > 8374 <strong 8375 class="css-bvflvn-TextComponent" 8376 > 8377 size 8378 </strong> 8379 </td> 8380 <td 8381 class="css-18p3734-Cell" 8382 > 8383 <code 8384 class="css-iwb7ur-TextComponent" 8385 data-text="true" 8386 > 8387 <a 8388 class="css-1na8e0o-A" 8389 href="#barcodesize" 8390 > 8391 BarCodeSize 8392 </a> 8393 </code> 8394 </td> 8395 <td 8396 class="css-18p3734-Cell" 8397 > 8398 <p 8399 class="mb-4 css-1kfqm4n-TextComponent" 8400 data-text="true" 8401 > 8402 The size of the bounding box. 8403 </p> 8404 </td> 8405 </tr> 8406 </tbody> 8407 </table> 8408 </div> 8409 </div> 8410 <div 8411 class="css-1fultt1" 8412 > 8413 <h3 8414 class=" css-wbzzgj-TextComponent" 8415 data-heading="true" 8416 > 8417 <a 8418 class="css-1y48vg3" 8419 href="#barcodeevent" 8420 > 8421 <span 8422 class="css-s3qkfm" 8423 id="barcodeevent" 8424 /> 8425 <span 8426 class="css-6n7j50" 8427 > 8428 <code 8429 class="css-yd3r23-TextComponent" 8430 data-text="true" 8431 > 8432 BarCodeEvent 8433 </code> 8434 </span> 8435 <span 8436 class="css-15j1jyt-PermalinkCopyIcon" 8437 id="docs-anchor-permalink-barcodeevent" 8438 > 8439 <svg 8440 aria-label="permalink" 8441 class="anchor-icon" 8442 fill="none" 8443 height="24" 8444 viewBox="0 0 24 24" 8445 width="24" 8446 xmlns="http://www.w3.org/2000/svg" 8447 > 8448 <path 8449 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 8450 stroke="#9B9B9B" 8451 stroke-linecap="round" 8452 stroke-linejoin="round" 8453 stroke-width="2" 8454 /> 8455 <path 8456 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 8457 stroke="#9B9B9B" 8458 stroke-linecap="round" 8459 stroke-linejoin="round" 8460 stroke-width="2" 8461 /> 8462 </svg> 8463 </span> 8464 </a> 8465 </h3> 8466 <p 8467 class="css-1kfqm4n-TextComponent" 8468 data-text="true" 8469 > 8470 <code 8471 class="css-iwb7ur-TextComponent" 8472 data-text="true" 8473 > 8474 <a 8475 class="css-1na8e0o-A" 8476 href="#barcodescannerresult" 8477 > 8478 BarCodeScannerResult 8479 </a> 8480 </code> 8481 8482 extended by: 8483 </p> 8484 <br /> 8485 <div 8486 class="css-1uyflf8-Table" 8487 > 8488 <table 8489 class="css-q84cm9-Table" 8490 > 8491 <thead 8492 class="bg-subtle border-b border-b-default border-solid" 8493 > 8494 <tr 8495 class="css-190f936-Row" 8496 > 8497 <th 8498 class="css-1uwgm7m-HeaderCell" 8499 > 8500 Name 8501 </th> 8502 <th 8503 class="css-1uwgm7m-HeaderCell" 8504 > 8505 Type 8506 </th> 8507 <th 8508 class="css-1uwgm7m-HeaderCell" 8509 > 8510 Description 8511 </th> 8512 </tr> 8513 </thead> 8514 <tbody> 8515 <tr 8516 class="css-190f936-Row" 8517 > 8518 <td 8519 class="css-18p3734-Cell" 8520 > 8521 <strong 8522 class="css-bvflvn-TextComponent" 8523 > 8524 target 8525 </strong> 8526 <br /> 8527 <span 8528 class="css-1g95u6x" 8529 > 8530 (optional) 8531 </span> 8532 </td> 8533 <td 8534 class="css-18p3734-Cell" 8535 > 8536 <code 8537 class="css-iwb7ur-TextComponent" 8538 data-text="true" 8539 > 8540 number 8541 </code> 8542 </td> 8543 <td 8544 class="css-18p3734-Cell" 8545 > 8546 - 8547 </td> 8548 </tr> 8549 </tbody> 8550 </table> 8551 </div> 8552 </div> 8553 <div 8554 class="css-1fultt1" 8555 > 8556 <h3 8557 class=" css-wbzzgj-TextComponent" 8558 data-heading="true" 8559 > 8560 <a 8561 class="css-1y48vg3" 8562 href="#barcodeeventcallbackarguments" 8563 > 8564 <span 8565 class="css-s3qkfm" 8566 id="barcodeeventcallbackarguments" 8567 /> 8568 <span 8569 class="css-6n7j50" 8570 > 8571 <code 8572 class="css-yd3r23-TextComponent" 8573 data-text="true" 8574 > 8575 BarCodeEventCallbackArguments 8576 </code> 8577 </span> 8578 <span 8579 class="css-15j1jyt-PermalinkCopyIcon" 8580 id="docs-anchor-permalink-barcodeeventcallbackarguments" 8581 > 8582 <svg 8583 aria-label="permalink" 8584 class="anchor-icon" 8585 fill="none" 8586 height="24" 8587 viewBox="0 0 24 24" 8588 width="24" 8589 xmlns="http://www.w3.org/2000/svg" 8590 > 8591 <path 8592 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 8593 stroke="#9B9B9B" 8594 stroke-linecap="round" 8595 stroke-linejoin="round" 8596 stroke-width="2" 8597 /> 8598 <path 8599 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 8600 stroke="#9B9B9B" 8601 stroke-linecap="round" 8602 stroke-linejoin="round" 8603 stroke-width="2" 8604 /> 8605 </svg> 8606 </span> 8607 </a> 8608 </h3> 8609 <div 8610 class="css-1uyflf8-Table" 8611 > 8612 <table 8613 class="css-q84cm9-Table" 8614 > 8615 <thead 8616 class="bg-subtle border-b border-b-default border-solid" 8617 > 8618 <tr 8619 class="css-190f936-Row" 8620 > 8621 <th 8622 class="css-1uwgm7m-HeaderCell" 8623 > 8624 Name 8625 </th> 8626 <th 8627 class="css-1uwgm7m-HeaderCell" 8628 > 8629 Type 8630 </th> 8631 <th 8632 class="css-1uwgm7m-HeaderCell" 8633 > 8634 Description 8635 </th> 8636 </tr> 8637 </thead> 8638 <tbody> 8639 <tr 8640 class="css-190f936-Row" 8641 > 8642 <td 8643 class="css-18p3734-Cell" 8644 > 8645 <strong 8646 class="css-bvflvn-TextComponent" 8647 > 8648 nativeEvent 8649 </strong> 8650 </td> 8651 <td 8652 class="css-18p3734-Cell" 8653 > 8654 <code 8655 class="css-iwb7ur-TextComponent" 8656 data-text="true" 8657 > 8658 <a 8659 class="css-1na8e0o-A" 8660 href="#barcodeevent" 8661 > 8662 BarCodeEvent 8663 </a> 8664 </code> 8665 </td> 8666 <td 8667 class="css-18p3734-Cell" 8668 > 8669 - 8670 </td> 8671 </tr> 8672 </tbody> 8673 </table> 8674 </div> 8675 </div> 8676 <div 8677 class="css-1fultt1" 8678 > 8679 <h3 8680 class=" css-wbzzgj-TextComponent" 8681 data-heading="true" 8682 > 8683 <a 8684 class="css-1y48vg3" 8685 href="#barcodepoint" 8686 > 8687 <span 8688 class="css-s3qkfm" 8689 id="barcodepoint" 8690 /> 8691 <span 8692 class="css-6n7j50" 8693 > 8694 <code 8695 class="css-yd3r23-TextComponent" 8696 data-text="true" 8697 > 8698 BarCodePoint 8699 </code> 8700 </span> 8701 <span 8702 class="css-15j1jyt-PermalinkCopyIcon" 8703 id="docs-anchor-permalink-barcodepoint" 8704 > 8705 <svg 8706 aria-label="permalink" 8707 class="anchor-icon" 8708 fill="none" 8709 height="24" 8710 viewBox="0 0 24 24" 8711 width="24" 8712 xmlns="http://www.w3.org/2000/svg" 8713 > 8714 <path 8715 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 8716 stroke="#9B9B9B" 8717 stroke-linecap="round" 8718 stroke-linejoin="round" 8719 stroke-width="2" 8720 /> 8721 <path 8722 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 8723 stroke="#9B9B9B" 8724 stroke-linecap="round" 8725 stroke-linejoin="round" 8726 stroke-width="2" 8727 /> 8728 </svg> 8729 </span> 8730 </a> 8731 </h3> 8732 <p 8733 class="mb-4 css-1kfqm4n-TextComponent" 8734 data-text="true" 8735 > 8736 Those coordinates are represented in the coordinate space of the barcode source (e.g. when you 8737are using the barcode scanner view, these values are adjusted to the dimensions of the view). 8738 </p> 8739 <div 8740 class="css-1uyflf8-Table" 8741 > 8742 <table 8743 class="css-q84cm9-Table" 8744 > 8745 <thead 8746 class="bg-subtle border-b border-b-default border-solid" 8747 > 8748 <tr 8749 class="css-190f936-Row" 8750 > 8751 <th 8752 class="css-1uwgm7m-HeaderCell" 8753 > 8754 Name 8755 </th> 8756 <th 8757 class="css-1uwgm7m-HeaderCell" 8758 > 8759 Type 8760 </th> 8761 <th 8762 class="css-1uwgm7m-HeaderCell" 8763 > 8764 Description 8765 </th> 8766 </tr> 8767 </thead> 8768 <tbody> 8769 <tr 8770 class="css-190f936-Row" 8771 > 8772 <td 8773 class="css-18p3734-Cell" 8774 > 8775 <strong 8776 class="css-bvflvn-TextComponent" 8777 > 8778 x 8779 </strong> 8780 </td> 8781 <td 8782 class="css-18p3734-Cell" 8783 > 8784 <code 8785 class="css-iwb7ur-TextComponent" 8786 data-text="true" 8787 > 8788 number 8789 </code> 8790 </td> 8791 <td 8792 class="css-18p3734-Cell" 8793 > 8794 <p 8795 class="mb-4 css-1kfqm4n-TextComponent" 8796 data-text="true" 8797 > 8798 The 8799 <code 8800 class="css-1a6y07t-TextComponent" 8801 data-text="true" 8802 > 8803 x 8804 </code> 8805 coordinate value. 8806 </p> 8807 </td> 8808 </tr> 8809 <tr 8810 class="css-190f936-Row" 8811 > 8812 <td 8813 class="css-18p3734-Cell" 8814 > 8815 <strong 8816 class="css-bvflvn-TextComponent" 8817 > 8818 y 8819 </strong> 8820 </td> 8821 <td 8822 class="css-18p3734-Cell" 8823 > 8824 <code 8825 class="css-iwb7ur-TextComponent" 8826 data-text="true" 8827 > 8828 number 8829 </code> 8830 </td> 8831 <td 8832 class="css-18p3734-Cell" 8833 > 8834 <p 8835 class="mb-4 css-1kfqm4n-TextComponent" 8836 data-text="true" 8837 > 8838 The 8839 <code 8840 class="css-1a6y07t-TextComponent" 8841 data-text="true" 8842 > 8843 y 8844 </code> 8845 coordinate value. 8846 </p> 8847 </td> 8848 </tr> 8849 </tbody> 8850 </table> 8851 </div> 8852 </div> 8853 <div 8854 class="css-1fultt1" 8855 > 8856 <h3 8857 class=" css-wbzzgj-TextComponent" 8858 data-heading="true" 8859 > 8860 <a 8861 class="css-1y48vg3" 8862 href="#barcodescannedcallback" 8863 > 8864 <span 8865 class="css-s3qkfm" 8866 id="barcodescannedcallback" 8867 /> 8868 <span 8869 class="css-6n7j50" 8870 > 8871 <code 8872 class="css-yd3r23-TextComponent" 8873 data-text="true" 8874 > 8875 BarCodeScannedCallback 8876 () 8877 </code> 8878 </span> 8879 <span 8880 class="css-15j1jyt-PermalinkCopyIcon" 8881 id="docs-anchor-permalink-barcodescannedcallback" 8882 > 8883 <svg 8884 aria-label="permalink" 8885 class="anchor-icon" 8886 fill="none" 8887 height="24" 8888 viewBox="0 0 24 24" 8889 width="24" 8890 xmlns="http://www.w3.org/2000/svg" 8891 > 8892 <path 8893 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 8894 stroke="#9B9B9B" 8895 stroke-linecap="round" 8896 stroke-linejoin="round" 8897 stroke-width="2" 8898 /> 8899 <path 8900 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 8901 stroke="#9B9B9B" 8902 stroke-linecap="round" 8903 stroke-linejoin="round" 8904 stroke-width="2" 8905 /> 8906 </svg> 8907 </span> 8908 </a> 8909 </h3> 8910 <div> 8911 <div 8912 class="css-1uyflf8-Table" 8913 > 8914 <table 8915 class="css-q84cm9-Table" 8916 > 8917 <thead 8918 class="bg-subtle border-b border-b-default border-solid" 8919 > 8920 <tr 8921 class="css-190f936-Row" 8922 > 8923 <th 8924 class="css-1uwgm7m-HeaderCell" 8925 > 8926 Name 8927 </th> 8928 <th 8929 class="css-1uwgm7m-HeaderCell" 8930 > 8931 Type 8932 </th> 8933 <th 8934 class="css-1uwgm7m-HeaderCell" 8935 > 8936 Description 8937 </th> 8938 </tr> 8939 </thead> 8940 <tbody> 8941 <tr 8942 class="css-190f936-Row" 8943 > 8944 <td 8945 class="css-zstkv9-Cell" 8946 > 8947 <strong 8948 class="css-bvflvn-TextComponent" 8949 > 8950 params 8951 </strong> 8952 </td> 8953 <td 8954 class="css-zstkv9-Cell" 8955 > 8956 <code 8957 class="css-iwb7ur-TextComponent" 8958 data-text="true" 8959 > 8960 <a 8961 class="css-1na8e0o-A" 8962 href="#barcodeevent" 8963 > 8964 BarCodeEvent 8965 </a> 8966 </code> 8967 </td> 8968 <td 8969 class="css-zstkv9-Cell" 8970 > 8971 - 8972 </td> 8973 </tr> 8974 </tbody> 8975 </table> 8976 </div> 8977 </div> 8978 </div> 8979 <div 8980 class="css-1fultt1" 8981 > 8982 <h3 8983 class=" css-wbzzgj-TextComponent" 8984 data-heading="true" 8985 > 8986 <a 8987 class="css-1y48vg3" 8988 href="#barcodescannerresult" 8989 > 8990 <span 8991 class="css-s3qkfm" 8992 id="barcodescannerresult" 8993 /> 8994 <span 8995 class="css-6n7j50" 8996 > 8997 <code 8998 class="css-yd3r23-TextComponent" 8999 data-text="true" 9000 > 9001 BarCodeScannerResult 9002 </code> 9003 </span> 9004 <span 9005 class="css-15j1jyt-PermalinkCopyIcon" 9006 id="docs-anchor-permalink-barcodescannerresult" 9007 > 9008 <svg 9009 aria-label="permalink" 9010 class="anchor-icon" 9011 fill="none" 9012 height="24" 9013 viewBox="0 0 24 24" 9014 width="24" 9015 xmlns="http://www.w3.org/2000/svg" 9016 > 9017 <path 9018 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9019 stroke="#9B9B9B" 9020 stroke-linecap="round" 9021 stroke-linejoin="round" 9022 stroke-width="2" 9023 /> 9024 <path 9025 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9026 stroke="#9B9B9B" 9027 stroke-linecap="round" 9028 stroke-linejoin="round" 9029 stroke-width="2" 9030 /> 9031 </svg> 9032 </span> 9033 </a> 9034 </h3> 9035 <div 9036 class="css-1uyflf8-Table" 9037 > 9038 <table 9039 class="css-q84cm9-Table" 9040 > 9041 <thead 9042 class="bg-subtle border-b border-b-default border-solid" 9043 > 9044 <tr 9045 class="css-190f936-Row" 9046 > 9047 <th 9048 class="css-1uwgm7m-HeaderCell" 9049 > 9050 Name 9051 </th> 9052 <th 9053 class="css-1uwgm7m-HeaderCell" 9054 > 9055 Type 9056 </th> 9057 <th 9058 class="css-1uwgm7m-HeaderCell" 9059 > 9060 Description 9061 </th> 9062 </tr> 9063 </thead> 9064 <tbody> 9065 <tr 9066 class="css-190f936-Row" 9067 > 9068 <td 9069 class="css-18p3734-Cell" 9070 > 9071 <strong 9072 class="css-bvflvn-TextComponent" 9073 > 9074 bounds 9075 </strong> 9076 </td> 9077 <td 9078 class="css-18p3734-Cell" 9079 > 9080 <code 9081 class="css-iwb7ur-TextComponent" 9082 data-text="true" 9083 > 9084 <a 9085 class="css-1na8e0o-A" 9086 href="#barcodebounds" 9087 > 9088 BarCodeBounds 9089 </a> 9090 </code> 9091 </td> 9092 <td 9093 class="css-18p3734-Cell" 9094 > 9095 <p 9096 class="mb-4 css-1kfqm4n-TextComponent" 9097 data-text="true" 9098 > 9099 The 9100 <a 9101 class="css-1na8e0o-A" 9102 href="#barcodebounds" 9103 > 9104 BarCodeBounds 9105 </a> 9106 object. 9107 9108 <code 9109 class="css-1a6y07t-TextComponent" 9110 data-text="true" 9111 > 9112 bounds 9113 </code> 9114 in some case will be representing an empty rectangle. 9115Moreover, 9116 <code 9117 class="css-1a6y07t-TextComponent" 9118 data-text="true" 9119 > 9120 bounds 9121 </code> 9122 doesn't have to bound the whole barcode. 9123For some types, they will represent the area used by the scanner. 9124 </p> 9125 </td> 9126 </tr> 9127 <tr 9128 class="css-190f936-Row" 9129 > 9130 <td 9131 class="css-18p3734-Cell" 9132 > 9133 <strong 9134 class="css-bvflvn-TextComponent" 9135 > 9136 cornerPoints 9137 </strong> 9138 </td> 9139 <td 9140 class="css-18p3734-Cell" 9141 > 9142 <code 9143 class="css-iwb7ur-TextComponent" 9144 data-text="true" 9145 > 9146 <a 9147 class="css-1na8e0o-A" 9148 href="#barcodepoint" 9149 > 9150 BarCodePoint 9151 [] 9152 </a> 9153 </code> 9154 </td> 9155 <td 9156 class="css-18p3734-Cell" 9157 > 9158 <p 9159 class="mb-4 css-1kfqm4n-TextComponent" 9160 data-text="true" 9161 > 9162 Corner points of the bounding box. 9163 9164 <code 9165 class="css-1a6y07t-TextComponent" 9166 data-text="true" 9167 > 9168 cornerPoints 9169 </code> 9170 is not always available and may be empty. On iOS, for 9171 <code 9172 class="css-1a6y07t-TextComponent" 9173 data-text="true" 9174 > 9175 code39 9176 </code> 9177 and 9178 <code 9179 class="css-1a6y07t-TextComponent" 9180 data-text="true" 9181 > 9182 pdf417 9183 </code> 9184 9185you don't get this value. 9186 </p> 9187 </td> 9188 </tr> 9189 <tr 9190 class="css-190f936-Row" 9191 > 9192 <td 9193 class="css-18p3734-Cell" 9194 > 9195 <strong 9196 class="css-bvflvn-TextComponent" 9197 > 9198 data 9199 </strong> 9200 </td> 9201 <td 9202 class="css-18p3734-Cell" 9203 > 9204 <code 9205 class="css-iwb7ur-TextComponent" 9206 data-text="true" 9207 > 9208 string 9209 </code> 9210 </td> 9211 <td 9212 class="css-18p3734-Cell" 9213 > 9214 <p 9215 class="mb-4 css-1kfqm4n-TextComponent" 9216 data-text="true" 9217 > 9218 The information encoded in the bar code. 9219 </p> 9220 </td> 9221 </tr> 9222 <tr 9223 class="css-190f936-Row" 9224 > 9225 <td 9226 class="css-18p3734-Cell" 9227 > 9228 <strong 9229 class="css-bvflvn-TextComponent" 9230 > 9231 type 9232 </strong> 9233 </td> 9234 <td 9235 class="css-18p3734-Cell" 9236 > 9237 <code 9238 class="css-iwb7ur-TextComponent" 9239 data-text="true" 9240 > 9241 string 9242 </code> 9243 </td> 9244 <td 9245 class="css-18p3734-Cell" 9246 > 9247 <p 9248 class="mb-4 css-1kfqm4n-TextComponent" 9249 data-text="true" 9250 > 9251 The barcode type. 9252 </p> 9253 </td> 9254 </tr> 9255 </tbody> 9256 </table> 9257 </div> 9258 </div> 9259 <div 9260 class="css-1fultt1" 9261 > 9262 <h3 9263 class=" css-wbzzgj-TextComponent" 9264 data-heading="true" 9265 > 9266 <a 9267 class="css-1y48vg3" 9268 href="#barcodesize" 9269 > 9270 <span 9271 class="css-s3qkfm" 9272 id="barcodesize" 9273 /> 9274 <span 9275 class="css-6n7j50" 9276 > 9277 <code 9278 class="css-yd3r23-TextComponent" 9279 data-text="true" 9280 > 9281 BarCodeSize 9282 </code> 9283 </span> 9284 <span 9285 class="css-15j1jyt-PermalinkCopyIcon" 9286 id="docs-anchor-permalink-barcodesize" 9287 > 9288 <svg 9289 aria-label="permalink" 9290 class="anchor-icon" 9291 fill="none" 9292 height="24" 9293 viewBox="0 0 24 24" 9294 width="24" 9295 xmlns="http://www.w3.org/2000/svg" 9296 > 9297 <path 9298 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9299 stroke="#9B9B9B" 9300 stroke-linecap="round" 9301 stroke-linejoin="round" 9302 stroke-width="2" 9303 /> 9304 <path 9305 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9306 stroke="#9B9B9B" 9307 stroke-linecap="round" 9308 stroke-linejoin="round" 9309 stroke-width="2" 9310 /> 9311 </svg> 9312 </span> 9313 </a> 9314 </h3> 9315 <div 9316 class="css-1uyflf8-Table" 9317 > 9318 <table 9319 class="css-q84cm9-Table" 9320 > 9321 <thead 9322 class="bg-subtle border-b border-b-default border-solid" 9323 > 9324 <tr 9325 class="css-190f936-Row" 9326 > 9327 <th 9328 class="css-1uwgm7m-HeaderCell" 9329 > 9330 Name 9331 </th> 9332 <th 9333 class="css-1uwgm7m-HeaderCell" 9334 > 9335 Type 9336 </th> 9337 <th 9338 class="css-1uwgm7m-HeaderCell" 9339 > 9340 Description 9341 </th> 9342 </tr> 9343 </thead> 9344 <tbody> 9345 <tr 9346 class="css-190f936-Row" 9347 > 9348 <td 9349 class="css-18p3734-Cell" 9350 > 9351 <strong 9352 class="css-bvflvn-TextComponent" 9353 > 9354 height 9355 </strong> 9356 </td> 9357 <td 9358 class="css-18p3734-Cell" 9359 > 9360 <code 9361 class="css-iwb7ur-TextComponent" 9362 data-text="true" 9363 > 9364 number 9365 </code> 9366 </td> 9367 <td 9368 class="css-18p3734-Cell" 9369 > 9370 <p 9371 class="mb-4 css-1kfqm4n-TextComponent" 9372 data-text="true" 9373 > 9374 The height value. 9375 </p> 9376 </td> 9377 </tr> 9378 <tr 9379 class="css-190f936-Row" 9380 > 9381 <td 9382 class="css-18p3734-Cell" 9383 > 9384 <strong 9385 class="css-bvflvn-TextComponent" 9386 > 9387 width 9388 </strong> 9389 </td> 9390 <td 9391 class="css-18p3734-Cell" 9392 > 9393 <code 9394 class="css-iwb7ur-TextComponent" 9395 data-text="true" 9396 > 9397 number 9398 </code> 9399 </td> 9400 <td 9401 class="css-18p3734-Cell" 9402 > 9403 <p 9404 class="mb-4 css-1kfqm4n-TextComponent" 9405 data-text="true" 9406 > 9407 The width value. 9408 </p> 9409 </td> 9410 </tr> 9411 </tbody> 9412 </table> 9413 </div> 9414 </div> 9415 <div 9416 class="css-1fultt1" 9417 > 9418 <h3 9419 class=" css-wbzzgj-TextComponent" 9420 data-heading="true" 9421 > 9422 <a 9423 class="css-1y48vg3" 9424 href="#permissionhookoptions" 9425 > 9426 <span 9427 class="css-s3qkfm" 9428 id="permissionhookoptions" 9429 /> 9430 <span 9431 class="css-6n7j50" 9432 > 9433 <code 9434 class="css-yd3r23-TextComponent" 9435 data-text="true" 9436 > 9437 PermissionHookOptions 9438 </code> 9439 </span> 9440 <span 9441 class="css-15j1jyt-PermalinkCopyIcon" 9442 id="docs-anchor-permalink-permissionhookoptions" 9443 > 9444 <svg 9445 aria-label="permalink" 9446 class="anchor-icon" 9447 fill="none" 9448 height="24" 9449 viewBox="0 0 24 24" 9450 width="24" 9451 xmlns="http://www.w3.org/2000/svg" 9452 > 9453 <path 9454 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9455 stroke="#9B9B9B" 9456 stroke-linecap="round" 9457 stroke-linejoin="round" 9458 stroke-width="2" 9459 /> 9460 <path 9461 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9462 stroke="#9B9B9B" 9463 stroke-linecap="round" 9464 stroke-linejoin="round" 9465 stroke-width="2" 9466 /> 9467 </svg> 9468 </span> 9469 </a> 9470 </h3> 9471 <p 9472 class="css-1kfqm4n-TextComponent" 9473 data-text="true" 9474 > 9475 Acceptable values are: 9476 9477 <span> 9478 <code 9479 class="css-iwb7ur-TextComponent" 9480 data-text="true" 9481 > 9482 PermissionHookBehavior 9483 </code> 9484 , 9485 </span> 9486 <span> 9487 <code 9488 class="css-iwb7ur-TextComponent" 9489 data-text="true" 9490 > 9491 Options 9492 </code> 9493 . 9494 </span> 9495 </p> 9496 </div> 9497 <h2 9498 class=" css-1qsxz84-TextComponent" 9499 data-heading="true" 9500 > 9501 <a 9502 class="css-1y48vg3" 9503 href="#enums" 9504 > 9505 <span 9506 class="css-s3qkfm" 9507 id="enums" 9508 /> 9509 <span 9510 class="css-6n7j50" 9511 > 9512 Enums 9513 </span> 9514 <span 9515 class="css-15j1jyt-PermalinkCopyIcon" 9516 id="docs-anchor-permalink-enums" 9517 > 9518 <svg 9519 aria-label="permalink" 9520 class="anchor-icon" 9521 fill="none" 9522 height="24" 9523 viewBox="0 0 24 24" 9524 width="24" 9525 xmlns="http://www.w3.org/2000/svg" 9526 > 9527 <path 9528 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9529 stroke="#9B9B9B" 9530 stroke-linecap="round" 9531 stroke-linejoin="round" 9532 stroke-width="2" 9533 /> 9534 <path 9535 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9536 stroke="#9B9B9B" 9537 stroke-linecap="round" 9538 stroke-linejoin="round" 9539 stroke-width="2" 9540 /> 9541 </svg> 9542 </span> 9543 </a> 9544 </h2> 9545 <div 9546 class="css-1gsbrid" 9547 > 9548 <h3 9549 class=" css-wbzzgj-TextComponent" 9550 data-heading="true" 9551 > 9552 <a 9553 class="css-1y48vg3" 9554 href="#permissionstatus" 9555 > 9556 <span 9557 class="css-s3qkfm" 9558 id="permissionstatus" 9559 /> 9560 <span 9561 class="css-6n7j50" 9562 > 9563 <code 9564 class="css-yd3r23-TextComponent" 9565 data-text="true" 9566 > 9567 PermissionStatus 9568 </code> 9569 </span> 9570 <span 9571 class="css-15j1jyt-PermalinkCopyIcon" 9572 id="docs-anchor-permalink-permissionstatus" 9573 > 9574 <svg 9575 aria-label="permalink" 9576 class="anchor-icon" 9577 fill="none" 9578 height="24" 9579 viewBox="0 0 24 24" 9580 width="24" 9581 xmlns="http://www.w3.org/2000/svg" 9582 > 9583 <path 9584 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9585 stroke="#9B9B9B" 9586 stroke-linecap="round" 9587 stroke-linejoin="round" 9588 stroke-width="2" 9589 /> 9590 <path 9591 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9592 stroke="#9B9B9B" 9593 stroke-linecap="round" 9594 stroke-linejoin="round" 9595 stroke-width="2" 9596 /> 9597 </svg> 9598 </span> 9599 </a> 9600 </h3> 9601 <div 9602 class="css-11xr3cd" 9603 > 9604 <h4 9605 class=" css-1y1xevk-TextComponent" 9606 data-heading="true" 9607 > 9608 <a 9609 class="css-1y48vg3" 9610 href="#denied" 9611 > 9612 <span 9613 class="css-s3qkfm" 9614 id="denied" 9615 /> 9616 <span 9617 class="css-6n7j50" 9618 > 9619 <code 9620 class="css-iwb7ur-TextComponent" 9621 data-text="true" 9622 > 9623 DENIED 9624 </code> 9625 </span> 9626 <span 9627 class="css-15j1jyt-PermalinkCopyIcon" 9628 id="docs-anchor-permalink-denied" 9629 > 9630 <svg 9631 aria-label="permalink" 9632 class="anchor-icon" 9633 fill="none" 9634 height="24" 9635 viewBox="0 0 24 24" 9636 width="24" 9637 xmlns="http://www.w3.org/2000/svg" 9638 > 9639 <path 9640 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9641 stroke="#9B9B9B" 9642 stroke-linecap="round" 9643 stroke-linejoin="round" 9644 stroke-width="2" 9645 /> 9646 <path 9647 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9648 stroke="#9B9B9B" 9649 stroke-linecap="round" 9650 stroke-linejoin="round" 9651 stroke-width="2" 9652 /> 9653 </svg> 9654 </span> 9655 </a> 9656 </h4> 9657 <code 9658 class="mb-4 css-1h2013i-TextComponent" 9659 data-text="true" 9660 > 9661 PermissionStatus.DENIED = "denied" 9662 </code> 9663 <p 9664 class="mb-4 css-1kfqm4n-TextComponent" 9665 data-text="true" 9666 > 9667 User has denied the permission. 9668 </p> 9669 </div> 9670 <div 9671 class="css-11xr3cd" 9672 > 9673 <h4 9674 class=" css-1y1xevk-TextComponent" 9675 data-heading="true" 9676 > 9677 <a 9678 class="css-1y48vg3" 9679 href="#granted" 9680 > 9681 <span 9682 class="css-s3qkfm" 9683 id="granted" 9684 /> 9685 <span 9686 class="css-6n7j50" 9687 > 9688 <code 9689 class="css-iwb7ur-TextComponent" 9690 data-text="true" 9691 > 9692 GRANTED 9693 </code> 9694 </span> 9695 <span 9696 class="css-15j1jyt-PermalinkCopyIcon" 9697 id="docs-anchor-permalink-granted" 9698 > 9699 <svg 9700 aria-label="permalink" 9701 class="anchor-icon" 9702 fill="none" 9703 height="24" 9704 viewBox="0 0 24 24" 9705 width="24" 9706 xmlns="http://www.w3.org/2000/svg" 9707 > 9708 <path 9709 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9710 stroke="#9B9B9B" 9711 stroke-linecap="round" 9712 stroke-linejoin="round" 9713 stroke-width="2" 9714 /> 9715 <path 9716 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9717 stroke="#9B9B9B" 9718 stroke-linecap="round" 9719 stroke-linejoin="round" 9720 stroke-width="2" 9721 /> 9722 </svg> 9723 </span> 9724 </a> 9725 </h4> 9726 <code 9727 class="mb-4 css-1h2013i-TextComponent" 9728 data-text="true" 9729 > 9730 PermissionStatus.GRANTED = "granted" 9731 </code> 9732 <p 9733 class="mb-4 css-1kfqm4n-TextComponent" 9734 data-text="true" 9735 > 9736 User has granted the permission. 9737 </p> 9738 </div> 9739 <div 9740 class="css-11xr3cd" 9741 > 9742 <h4 9743 class=" css-1y1xevk-TextComponent" 9744 data-heading="true" 9745 > 9746 <a 9747 class="css-1y48vg3" 9748 href="#undetermined" 9749 > 9750 <span 9751 class="css-s3qkfm" 9752 id="undetermined" 9753 /> 9754 <span 9755 class="css-6n7j50" 9756 > 9757 <code 9758 class="css-iwb7ur-TextComponent" 9759 data-text="true" 9760 > 9761 UNDETERMINED 9762 </code> 9763 </span> 9764 <span 9765 class="css-15j1jyt-PermalinkCopyIcon" 9766 id="docs-anchor-permalink-undetermined" 9767 > 9768 <svg 9769 aria-label="permalink" 9770 class="anchor-icon" 9771 fill="none" 9772 height="24" 9773 viewBox="0 0 24 24" 9774 width="24" 9775 xmlns="http://www.w3.org/2000/svg" 9776 > 9777 <path 9778 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9779 stroke="#9B9B9B" 9780 stroke-linecap="round" 9781 stroke-linejoin="round" 9782 stroke-width="2" 9783 /> 9784 <path 9785 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9786 stroke="#9B9B9B" 9787 stroke-linecap="round" 9788 stroke-linejoin="round" 9789 stroke-width="2" 9790 /> 9791 </svg> 9792 </span> 9793 </a> 9794 </h4> 9795 <code 9796 class="mb-4 css-1h2013i-TextComponent" 9797 data-text="true" 9798 > 9799 PermissionStatus.UNDETERMINED = "undetermined" 9800 </code> 9801 <p 9802 class="mb-4 css-1kfqm4n-TextComponent" 9803 data-text="true" 9804 > 9805 User hasn't granted or denied the permission yet. 9806 </p> 9807 </div> 9808 </div> 9809</div> 9810`; 9811 9812exports[`APISection expo-pedometer 1`] = ` 9813<div> 9814 <h2 9815 class=" css-1qsxz84-TextComponent" 9816 data-heading="true" 9817 > 9818 <a 9819 class="css-1y48vg3" 9820 href="#methods" 9821 > 9822 <span 9823 class="css-s3qkfm" 9824 id="methods" 9825 /> 9826 <span 9827 class="css-6n7j50" 9828 > 9829 Methods 9830 </span> 9831 <span 9832 class="css-15j1jyt-PermalinkCopyIcon" 9833 id="docs-anchor-permalink-methods" 9834 > 9835 <svg 9836 aria-label="permalink" 9837 class="anchor-icon" 9838 fill="none" 9839 height="24" 9840 viewBox="0 0 24 24" 9841 width="24" 9842 xmlns="http://www.w3.org/2000/svg" 9843 > 9844 <path 9845 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9846 stroke="#9B9B9B" 9847 stroke-linecap="round" 9848 stroke-linejoin="round" 9849 stroke-width="2" 9850 /> 9851 <path 9852 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9853 stroke="#9B9B9B" 9854 stroke-linecap="round" 9855 stroke-linejoin="round" 9856 stroke-width="2" 9857 /> 9858 </svg> 9859 </span> 9860 </a> 9861 </h2> 9862 <div 9863 class="css-11xr3cd" 9864 > 9865 <h3 9866 class=" css-wbzzgj-TextComponent" 9867 data-heading="true" 9868 > 9869 <a 9870 class="css-1y48vg3" 9871 href="#getpermissionsasync" 9872 > 9873 <span 9874 class="css-s3qkfm" 9875 id="getpermissionsasync" 9876 /> 9877 <span 9878 class="css-6n7j50" 9879 > 9880 <code 9881 class="css-s0csg4-TextComponent" 9882 data-text="true" 9883 > 9884 getPermissionsAsync() 9885 </code> 9886 </span> 9887 <span 9888 class="css-15j1jyt-PermalinkCopyIcon" 9889 id="docs-anchor-permalink-getpermissionsasync" 9890 > 9891 <svg 9892 aria-label="permalink" 9893 class="anchor-icon" 9894 fill="none" 9895 height="24" 9896 viewBox="0 0 24 24" 9897 width="24" 9898 xmlns="http://www.w3.org/2000/svg" 9899 > 9900 <path 9901 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 9902 stroke="#9B9B9B" 9903 stroke-linecap="round" 9904 stroke-linejoin="round" 9905 stroke-width="2" 9906 /> 9907 <path 9908 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 9909 stroke="#9B9B9B" 9910 stroke-linecap="round" 9911 stroke-linejoin="round" 9912 stroke-width="2" 9913 /> 9914 </svg> 9915 </span> 9916 </a> 9917 </h3> 9918 <p 9919 class="mb-4 css-1kfqm4n-TextComponent" 9920 data-text="true" 9921 > 9922 Checks user's permissions for accessing pedometer. 9923 </p> 9924 <p 9925 class="css-1eksndl-BoxSectionHeader" 9926 data-text="true" 9927 > 9928 Returns 9929 </p> 9930 <ul 9931 class="!list-none !ml-0 css-118jp6n-TextComponent" 9932 > 9933 <li 9934 class="css-1hxzfrf-TextComponent" 9935 data-text="true" 9936 > 9937 <svg 9938 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 9939 fill="none" 9940 role="img" 9941 stroke="currentColor" 9942 viewBox="0 0 24 24" 9943 xmlns="http://www.w3.org/2000/svg" 9944 > 9945 <g 9946 id="corner-down-right" 9947 > 9948 <path 9949 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 9950 id="Icon" 9951 stroke-linecap="round" 9952 stroke-linejoin="round" 9953 stroke-width="2" 9954 /> 9955 </g> 9956 </svg> 9957 <code 9958 class="css-iwb7ur-TextComponent" 9959 data-text="true" 9960 > 9961 <a 9962 class="css-1na8e0o-A" 9963 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 9964 rel="noopener noreferrer" 9965 target="_blank" 9966 > 9967 Promise 9968 </a> 9969 < 9970 <span> 9971 <a 9972 class="css-1na8e0o-A" 9973 href="#permissionresponse" 9974 > 9975 PermissionResponse 9976 </a> 9977 </span> 9978 > 9979 </code> 9980 </li> 9981 </ul> 9982 <br /> 9983 </div> 9984 <div 9985 class="css-11xr3cd" 9986 > 9987 <strong 9988 class="css-bvflvn-TextComponent" 9989 > 9990 Only for: 9991 9992 </strong> 9993 <div 9994 class="!bg-palette-blue4 !text-palette-blue12 !border-palette-blue5 css-r2zk2g-PlatformTag" 9995 > 9996 <svg 9997 class="icon-xs text-palette-blue12" 9998 fill="none" 9999 role="img" 10000 viewBox="0 0 24 24" 10001 xmlns="http://www.w3.org/2000/svg" 10002 > 10003 <g 10004 id="apple" 10005 > 10006 <path 10007 d="M20.4478 17.3538C20.1312 18.0852 19.7564 18.7585 19.3222 19.3775C18.7303 20.2214 18.2457 20.8055 17.8722 21.1299C17.2933 21.6623 16.673 21.935 16.0088 21.9505C15.5319 21.9505 14.9568 21.8148 14.2874 21.5395C13.6158 21.2656 12.9986 21.1299 12.4343 21.1299C11.8424 21.1299 11.2076 21.2656 10.5287 21.5395C9.84865 21.8148 9.30085 21.9582 8.88201 21.9724C8.24504 21.9996 7.61014 21.7192 6.9764 21.1299C6.57191 20.7771 6.06598 20.1723 5.45989 19.3155C4.80961 18.4005 4.27499 17.3396 3.85615 16.13C3.4076 14.8235 3.18274 13.5583 3.18274 12.3335C3.18274 10.9304 3.48591 9.72034 4.09316 8.70628C4.5704 7.89174 5.20531 7.24922 5.99994 6.77753C6.79457 6.30584 7.65317 6.06547 8.57781 6.0501C9.08374 6.0501 9.7472 6.20659 10.5717 6.51416C11.3938 6.82276 11.9217 6.97926 12.1532 6.97926C12.3262 6.97926 12.9127 6.79627 13.9068 6.43145C14.847 6.09313 15.6404 5.95304 16.2905 6.00823C18.0519 6.15038 19.3752 6.84473 20.2552 8.09567C18.6799 9.05016 17.9007 10.387 17.9162 12.102C17.9304 13.4379 18.415 14.5495 19.3674 15.4321C19.799 15.8418 20.2811 16.1584 20.8174 16.3833C20.7011 16.7206 20.5783 17.0436 20.4478 17.3538ZM16.4081 1.45728C16.4081 2.50431 16.0256 3.48192 15.2631 4.38678C14.343 5.46249 13.2301 6.08408 12.0232 5.986C12.0078 5.86039 11.9989 5.72819 11.9989 5.58926C11.9989 4.58412 12.4365 3.50841 13.2135 2.62888C13.6015 2.18355 14.0949 1.81327 14.6932 1.51789C15.2902 1.22692 15.855 1.066 16.3861 1.03845C16.4016 1.17842 16.4081 1.3184 16.4081 1.45727V1.45728Z" 10008 fill="currentColor" 10009 id="Vector" 10010 /> 10011 </g> 10012 </svg> 10013 <span 10014 class="css-6g4m4t-PlatformTag" 10015 > 10016 iOS 10017 </span> 10018 </div> 10019 <br /> 10020 <h3 10021 class=" css-wbzzgj-TextComponent" 10022 data-heading="true" 10023 > 10024 <a 10025 class="css-1y48vg3" 10026 href="#getstepcountasyncstart-end" 10027 > 10028 <span 10029 class="css-s3qkfm" 10030 id="getstepcountasyncstart-end" 10031 /> 10032 <span 10033 class="css-6n7j50" 10034 > 10035 <code 10036 class="css-s0csg4-TextComponent" 10037 data-text="true" 10038 > 10039 getStepCountAsync(start, end) 10040 </code> 10041 </span> 10042 <span 10043 class="css-15j1jyt-PermalinkCopyIcon" 10044 id="docs-anchor-permalink-getstepcountasyncstart-end" 10045 > 10046 <svg 10047 aria-label="permalink" 10048 class="anchor-icon" 10049 fill="none" 10050 height="24" 10051 viewBox="0 0 24 24" 10052 width="24" 10053 xmlns="http://www.w3.org/2000/svg" 10054 > 10055 <path 10056 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 10057 stroke="#9B9B9B" 10058 stroke-linecap="round" 10059 stroke-linejoin="round" 10060 stroke-width="2" 10061 /> 10062 <path 10063 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 10064 stroke="#9B9B9B" 10065 stroke-linecap="round" 10066 stroke-linejoin="round" 10067 stroke-width="2" 10068 /> 10069 </svg> 10070 </span> 10071 </a> 10072 </h3> 10073 <div 10074 class="css-1uyflf8-Table" 10075 > 10076 <table 10077 class="css-q84cm9-Table" 10078 > 10079 <thead 10080 class="bg-subtle border-b border-b-default border-solid" 10081 > 10082 <tr 10083 class="css-190f936-Row" 10084 > 10085 <th 10086 class="css-1uwgm7m-HeaderCell" 10087 > 10088 Name 10089 </th> 10090 <th 10091 class="css-1uwgm7m-HeaderCell" 10092 > 10093 Type 10094 </th> 10095 <th 10096 class="css-1uwgm7m-HeaderCell" 10097 > 10098 Description 10099 </th> 10100 </tr> 10101 </thead> 10102 <tbody> 10103 <tr 10104 class="css-190f936-Row" 10105 > 10106 <td 10107 class="css-zstkv9-Cell" 10108 > 10109 <strong 10110 class="css-bvflvn-TextComponent" 10111 > 10112 start 10113 </strong> 10114 </td> 10115 <td 10116 class="css-zstkv9-Cell" 10117 > 10118 <code 10119 class="css-iwb7ur-TextComponent" 10120 data-text="true" 10121 > 10122 <a 10123 class="css-1na8e0o-A" 10124 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" 10125 rel="noopener noreferrer" 10126 target="_blank" 10127 > 10128 Date 10129 </a> 10130 </code> 10131 </td> 10132 <td 10133 class="css-zstkv9-Cell" 10134 > 10135 <p 10136 class="mb-4 css-1kfqm4n-TextComponent" 10137 data-text="true" 10138 > 10139 A date indicating the start of the range over which to measure steps. 10140 </p> 10141 </td> 10142 </tr> 10143 <tr 10144 class="css-190f936-Row" 10145 > 10146 <td 10147 class="css-zstkv9-Cell" 10148 > 10149 <strong 10150 class="css-bvflvn-TextComponent" 10151 > 10152 end 10153 </strong> 10154 </td> 10155 <td 10156 class="css-zstkv9-Cell" 10157 > 10158 <code 10159 class="css-iwb7ur-TextComponent" 10160 data-text="true" 10161 > 10162 <a 10163 class="css-1na8e0o-A" 10164 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" 10165 rel="noopener noreferrer" 10166 target="_blank" 10167 > 10168 Date 10169 </a> 10170 </code> 10171 </td> 10172 <td 10173 class="css-zstkv9-Cell" 10174 > 10175 <p 10176 class="mb-4 css-1kfqm4n-TextComponent" 10177 data-text="true" 10178 > 10179 A date indicating the end of the range over which to measure steps. 10180 </p> 10181 </td> 10182 </tr> 10183 </tbody> 10184 </table> 10185 </div> 10186 <br /> 10187 <p 10188 class="mb-4 css-1kfqm4n-TextComponent" 10189 data-text="true" 10190 > 10191 Get the step count between two dates. 10192 </p> 10193 <p 10194 class="css-1eksndl-BoxSectionHeader" 10195 data-text="true" 10196 > 10197 Returns 10198 </p> 10199 <ul 10200 class="!list-none !ml-0 css-118jp6n-TextComponent" 10201 > 10202 <li 10203 class="css-1hxzfrf-TextComponent" 10204 data-text="true" 10205 > 10206 <svg 10207 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 10208 fill="none" 10209 role="img" 10210 stroke="currentColor" 10211 viewBox="0 0 24 24" 10212 xmlns="http://www.w3.org/2000/svg" 10213 > 10214 <g 10215 id="corner-down-right" 10216 > 10217 <path 10218 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 10219 id="Icon" 10220 stroke-linecap="round" 10221 stroke-linejoin="round" 10222 stroke-width="2" 10223 /> 10224 </g> 10225 </svg> 10226 <code 10227 class="css-iwb7ur-TextComponent" 10228 data-text="true" 10229 > 10230 <a 10231 class="css-1na8e0o-A" 10232 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 10233 rel="noopener noreferrer" 10234 target="_blank" 10235 > 10236 Promise 10237 </a> 10238 < 10239 <span> 10240 <a 10241 class="css-1na8e0o-A" 10242 href="#pedometerresult" 10243 > 10244 PedometerResult 10245 </a> 10246 </span> 10247 > 10248 </code> 10249 </li> 10250 </ul> 10251 <br /> 10252 <p 10253 class="mb-4 css-1kfqm4n-TextComponent" 10254 data-text="true" 10255 > 10256 Returns a promise that fulfills with a 10257 <a 10258 class="css-1na8e0o-A" 10259 href="#pedometerresult" 10260 > 10261 <code 10262 class="css-1a6y07t-TextComponent" 10263 data-text="true" 10264 > 10265 PedometerResult 10266 </code> 10267 </a> 10268 . 10269 </p> 10270 10271 10272 <p 10273 class="mb-4 css-1kfqm4n-TextComponent" 10274 data-text="true" 10275 > 10276 As 10277 <a 10278 class="css-1na8e0o-A" 10279 href="https://developer.apple.com/documentation/coremotion/cmpedometer/1613946-querypedometerdatafromdate?language=objc" 10280 rel="noopener noreferrer" 10281 target="_blank" 10282 > 10283 Apple documentation states 10284 </a> 10285 : 10286 </p> 10287 10288 10289 <blockquote 10290 class="css-zknray-Callout" 10291 data-testid="callout-container" 10292 > 10293 <div 10294 class="css-7jywx8-Callout" 10295 > 10296 <svg 10297 class="icon-sm text-icon-default" 10298 fill="currentColor" 10299 role="img" 10300 viewBox="0 0 24 24" 10301 xmlns="http://www.w3.org/2000/svg" 10302 > 10303 <g 10304 id="info-circle" 10305 > 10306 <path 10307 clip-rule="evenodd" 10308 d="M12 1C5.92487 1 1 5.92487 1 12C1 18.0751 5.92487 23 12 23C18.0751 23 23 18.0751 23 12C23 5.92487 18.0751 1 12 1ZM12 7C11.4477 7 11 7.44772 11 8C11 8.55228 11.4477 9 12 9H12.01C12.5623 9 13.01 8.55228 13.01 8C13.01 7.44772 12.5623 7 12.01 7H12ZM13 12C13 11.4477 12.5523 11 12 11C11.4477 11 11 11.4477 11 12V16C11 16.5523 11.4477 17 12 17C12.5523 17 13 16.5523 13 16V12Z" 10309 fill-rule="evenodd" 10310 id="Solid" 10311 /> 10312 </g> 10313 </svg> 10314 </div> 10315 <div 10316 class="css-1m74yfi-Callout" 10317 > 10318 10319 10320 <p 10321 class="mb-4 css-1kfqm4n-TextComponent" 10322 data-text="true" 10323 > 10324 Only the past seven days worth of data is stored and available for you to retrieve. Specifying 10325a start date that is more than seven days in the past returns only the available data. 10326 </p> 10327 10328 10329 </div> 10330 </blockquote> 10331 </div> 10332 <div 10333 class="css-11xr3cd" 10334 > 10335 <h3 10336 class=" css-wbzzgj-TextComponent" 10337 data-heading="true" 10338 > 10339 <a 10340 class="css-1y48vg3" 10341 href="#isavailableasync" 10342 > 10343 <span 10344 class="css-s3qkfm" 10345 id="isavailableasync" 10346 /> 10347 <span 10348 class="css-6n7j50" 10349 > 10350 <code 10351 class="css-s0csg4-TextComponent" 10352 data-text="true" 10353 > 10354 isAvailableAsync() 10355 </code> 10356 </span> 10357 <span 10358 class="css-15j1jyt-PermalinkCopyIcon" 10359 id="docs-anchor-permalink-isavailableasync" 10360 > 10361 <svg 10362 aria-label="permalink" 10363 class="anchor-icon" 10364 fill="none" 10365 height="24" 10366 viewBox="0 0 24 24" 10367 width="24" 10368 xmlns="http://www.w3.org/2000/svg" 10369 > 10370 <path 10371 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 10372 stroke="#9B9B9B" 10373 stroke-linecap="round" 10374 stroke-linejoin="round" 10375 stroke-width="2" 10376 /> 10377 <path 10378 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 10379 stroke="#9B9B9B" 10380 stroke-linecap="round" 10381 stroke-linejoin="round" 10382 stroke-width="2" 10383 /> 10384 </svg> 10385 </span> 10386 </a> 10387 </h3> 10388 <p 10389 class="mb-4 css-1kfqm4n-TextComponent" 10390 data-text="true" 10391 > 10392 Returns whether the pedometer is enabled on the device. 10393 </p> 10394 <p 10395 class="css-1eksndl-BoxSectionHeader" 10396 data-text="true" 10397 > 10398 Returns 10399 </p> 10400 <ul 10401 class="!list-none !ml-0 css-118jp6n-TextComponent" 10402 > 10403 <li 10404 class="css-1hxzfrf-TextComponent" 10405 data-text="true" 10406 > 10407 <svg 10408 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 10409 fill="none" 10410 role="img" 10411 stroke="currentColor" 10412 viewBox="0 0 24 24" 10413 xmlns="http://www.w3.org/2000/svg" 10414 > 10415 <g 10416 id="corner-down-right" 10417 > 10418 <path 10419 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 10420 id="Icon" 10421 stroke-linecap="round" 10422 stroke-linejoin="round" 10423 stroke-width="2" 10424 /> 10425 </g> 10426 </svg> 10427 <code 10428 class="css-iwb7ur-TextComponent" 10429 data-text="true" 10430 > 10431 <a 10432 class="css-1na8e0o-A" 10433 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 10434 rel="noopener noreferrer" 10435 target="_blank" 10436 > 10437 Promise 10438 </a> 10439 < 10440 <span> 10441 boolean 10442 </span> 10443 > 10444 </code> 10445 </li> 10446 </ul> 10447 <br /> 10448 <p 10449 class="mb-4 css-1kfqm4n-TextComponent" 10450 data-text="true" 10451 > 10452 Returns a promise that fulfills with a 10453 <code 10454 class="css-1a6y07t-TextComponent" 10455 data-text="true" 10456 > 10457 boolean 10458 </code> 10459 , indicating whether the pedometer is 10460available on this device. 10461 </p> 10462 </div> 10463 <div 10464 class="css-11xr3cd" 10465 > 10466 <h3 10467 class=" css-wbzzgj-TextComponent" 10468 data-heading="true" 10469 > 10470 <a 10471 class="css-1y48vg3" 10472 href="#requestpermissionsasync" 10473 > 10474 <span 10475 class="css-s3qkfm" 10476 id="requestpermissionsasync" 10477 /> 10478 <span 10479 class="css-6n7j50" 10480 > 10481 <code 10482 class="css-s0csg4-TextComponent" 10483 data-text="true" 10484 > 10485 requestPermissionsAsync() 10486 </code> 10487 </span> 10488 <span 10489 class="css-15j1jyt-PermalinkCopyIcon" 10490 id="docs-anchor-permalink-requestpermissionsasync" 10491 > 10492 <svg 10493 aria-label="permalink" 10494 class="anchor-icon" 10495 fill="none" 10496 height="24" 10497 viewBox="0 0 24 24" 10498 width="24" 10499 xmlns="http://www.w3.org/2000/svg" 10500 > 10501 <path 10502 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 10503 stroke="#9B9B9B" 10504 stroke-linecap="round" 10505 stroke-linejoin="round" 10506 stroke-width="2" 10507 /> 10508 <path 10509 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 10510 stroke="#9B9B9B" 10511 stroke-linecap="round" 10512 stroke-linejoin="round" 10513 stroke-width="2" 10514 /> 10515 </svg> 10516 </span> 10517 </a> 10518 </h3> 10519 <p 10520 class="mb-4 css-1kfqm4n-TextComponent" 10521 data-text="true" 10522 > 10523 Asks the user to grant permissions for accessing pedometer. 10524 </p> 10525 <p 10526 class="css-1eksndl-BoxSectionHeader" 10527 data-text="true" 10528 > 10529 Returns 10530 </p> 10531 <ul 10532 class="!list-none !ml-0 css-118jp6n-TextComponent" 10533 > 10534 <li 10535 class="css-1hxzfrf-TextComponent" 10536 data-text="true" 10537 > 10538 <svg 10539 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 10540 fill="none" 10541 role="img" 10542 stroke="currentColor" 10543 viewBox="0 0 24 24" 10544 xmlns="http://www.w3.org/2000/svg" 10545 > 10546 <g 10547 id="corner-down-right" 10548 > 10549 <path 10550 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 10551 id="Icon" 10552 stroke-linecap="round" 10553 stroke-linejoin="round" 10554 stroke-width="2" 10555 /> 10556 </g> 10557 </svg> 10558 <code 10559 class="css-iwb7ur-TextComponent" 10560 data-text="true" 10561 > 10562 <a 10563 class="css-1na8e0o-A" 10564 href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" 10565 rel="noopener noreferrer" 10566 target="_blank" 10567 > 10568 Promise 10569 </a> 10570 < 10571 <span> 10572 <a 10573 class="css-1na8e0o-A" 10574 href="#permissionresponse" 10575 > 10576 PermissionResponse 10577 </a> 10578 </span> 10579 > 10580 </code> 10581 </li> 10582 </ul> 10583 <br /> 10584 </div> 10585 <div 10586 class="css-11xr3cd" 10587 > 10588 <h3 10589 class=" css-wbzzgj-TextComponent" 10590 data-heading="true" 10591 > 10592 <a 10593 class="css-1y48vg3" 10594 href="#watchstepcountcallback" 10595 > 10596 <span 10597 class="css-s3qkfm" 10598 id="watchstepcountcallback" 10599 /> 10600 <span 10601 class="css-6n7j50" 10602 > 10603 <code 10604 class="css-s0csg4-TextComponent" 10605 data-text="true" 10606 > 10607 watchStepCount(callback) 10608 </code> 10609 </span> 10610 <span 10611 class="css-15j1jyt-PermalinkCopyIcon" 10612 id="docs-anchor-permalink-watchstepcountcallback" 10613 > 10614 <svg 10615 aria-label="permalink" 10616 class="anchor-icon" 10617 fill="none" 10618 height="24" 10619 viewBox="0 0 24 24" 10620 width="24" 10621 xmlns="http://www.w3.org/2000/svg" 10622 > 10623 <path 10624 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 10625 stroke="#9B9B9B" 10626 stroke-linecap="round" 10627 stroke-linejoin="round" 10628 stroke-width="2" 10629 /> 10630 <path 10631 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 10632 stroke="#9B9B9B" 10633 stroke-linecap="round" 10634 stroke-linejoin="round" 10635 stroke-width="2" 10636 /> 10637 </svg> 10638 </span> 10639 </a> 10640 </h3> 10641 <div 10642 class="css-1uyflf8-Table" 10643 > 10644 <table 10645 class="css-q84cm9-Table" 10646 > 10647 <thead 10648 class="bg-subtle border-b border-b-default border-solid" 10649 > 10650 <tr 10651 class="css-190f936-Row" 10652 > 10653 <th 10654 class="css-1uwgm7m-HeaderCell" 10655 > 10656 Name 10657 </th> 10658 <th 10659 class="css-1uwgm7m-HeaderCell" 10660 > 10661 Type 10662 </th> 10663 <th 10664 class="css-1uwgm7m-HeaderCell" 10665 > 10666 Description 10667 </th> 10668 </tr> 10669 </thead> 10670 <tbody> 10671 <tr 10672 class="css-190f936-Row" 10673 > 10674 <td 10675 class="css-zstkv9-Cell" 10676 > 10677 <strong 10678 class="css-bvflvn-TextComponent" 10679 > 10680 callback 10681 </strong> 10682 </td> 10683 <td 10684 class="css-zstkv9-Cell" 10685 > 10686 <code 10687 class="css-iwb7ur-TextComponent" 10688 data-text="true" 10689 > 10690 <a 10691 class="css-1na8e0o-A" 10692 href="#pedometerupdatecallback" 10693 > 10694 PedometerUpdateCallback 10695 </a> 10696 </code> 10697 </td> 10698 <td 10699 class="css-zstkv9-Cell" 10700 > 10701 <p 10702 class="mb-4 css-1kfqm4n-TextComponent" 10703 data-text="true" 10704 > 10705 A callback that is invoked when new step count data is available. The callback is 10706provided with a single argument that is 10707 <a 10708 class="css-1na8e0o-A" 10709 href="#pedometerresult" 10710 > 10711 <code 10712 class="css-1a6y07t-TextComponent" 10713 data-text="true" 10714 > 10715 PedometerResult 10716 </code> 10717 </a> 10718 . 10719 </p> 10720 </td> 10721 </tr> 10722 </tbody> 10723 </table> 10724 </div> 10725 <br /> 10726 <p 10727 class="mb-4 css-1kfqm4n-TextComponent" 10728 data-text="true" 10729 > 10730 Subscribe to pedometer updates. 10731 </p> 10732 <p 10733 class="css-1eksndl-BoxSectionHeader" 10734 data-text="true" 10735 > 10736 Returns 10737 </p> 10738 <ul 10739 class="!list-none !ml-0 css-118jp6n-TextComponent" 10740 > 10741 <li 10742 class="css-1hxzfrf-TextComponent" 10743 data-text="true" 10744 > 10745 <svg 10746 class="inline-block icon-sm text-icon-secondary align-middle mr-2" 10747 fill="none" 10748 role="img" 10749 stroke="currentColor" 10750 viewBox="0 0 24 24" 10751 xmlns="http://www.w3.org/2000/svg" 10752 > 10753 <g 10754 id="corner-down-right" 10755 > 10756 <path 10757 d="M4 4V5.4C4 8.76031 4 10.4405 4.65396 11.7239C5.2292 12.8529 6.14708 13.7708 7.27606 14.346C8.55953 15 10.2397 15 13.6 15H20M20 15L15 10M20 15L15 20" 10758 id="Icon" 10759 stroke-linecap="round" 10760 stroke-linejoin="round" 10761 stroke-width="2" 10762 /> 10763 </g> 10764 </svg> 10765 <code 10766 class="css-iwb7ur-TextComponent" 10767 data-text="true" 10768 > 10769 <a 10770 class="css-1na8e0o-A" 10771 href="#subscription" 10772 > 10773 Subscription 10774 </a> 10775 </code> 10776 </li> 10777 </ul> 10778 <br /> 10779 <p 10780 class="mb-4 css-1kfqm4n-TextComponent" 10781 data-text="true" 10782 > 10783 Returns a 10784 <a 10785 class="css-1na8e0o-A" 10786 href="#subscription" 10787 > 10788 <code 10789 class="css-1a6y07t-TextComponent" 10790 data-text="true" 10791 > 10792 Subscription 10793 </code> 10794 </a> 10795 that enables you to call 10796 10797 <code 10798 class="css-1a6y07t-TextComponent" 10799 data-text="true" 10800 > 10801 remove() 10802 </code> 10803 when you would like to unsubscribe the listener. 10804 </p> 10805 </div> 10806 <h2 10807 class=" css-1qsxz84-TextComponent" 10808 data-heading="true" 10809 > 10810 <a 10811 class="css-1y48vg3" 10812 href="#interfaces" 10813 > 10814 <span 10815 class="css-s3qkfm" 10816 id="interfaces" 10817 /> 10818 <span 10819 class="css-6n7j50" 10820 > 10821 Interfaces 10822 </span> 10823 <span 10824 class="css-15j1jyt-PermalinkCopyIcon" 10825 id="docs-anchor-permalink-interfaces" 10826 > 10827 <svg 10828 aria-label="permalink" 10829 class="anchor-icon" 10830 fill="none" 10831 height="24" 10832 viewBox="0 0 24 24" 10833 width="24" 10834 xmlns="http://www.w3.org/2000/svg" 10835 > 10836 <path 10837 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 10838 stroke="#9B9B9B" 10839 stroke-linecap="round" 10840 stroke-linejoin="round" 10841 stroke-width="2" 10842 /> 10843 <path 10844 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 10845 stroke="#9B9B9B" 10846 stroke-linecap="round" 10847 stroke-linejoin="round" 10848 stroke-width="2" 10849 /> 10850 </svg> 10851 </span> 10852 </a> 10853 </h2> 10854 <div 10855 class="css-11xr3cd" 10856 > 10857 <h3 10858 class=" css-wbzzgj-TextComponent" 10859 data-heading="true" 10860 > 10861 <a 10862 class="css-1y48vg3" 10863 href="#permissionresponse" 10864 > 10865 <span 10866 class="css-s3qkfm" 10867 id="permissionresponse" 10868 /> 10869 <span 10870 class="css-6n7j50" 10871 > 10872 <code 10873 class="css-yd3r23-TextComponent" 10874 data-text="true" 10875 > 10876 PermissionResponse 10877 </code> 10878 </span> 10879 <span 10880 class="css-15j1jyt-PermalinkCopyIcon" 10881 id="docs-anchor-permalink-permissionresponse" 10882 > 10883 <svg 10884 aria-label="permalink" 10885 class="anchor-icon" 10886 fill="none" 10887 height="24" 10888 viewBox="0 0 24 24" 10889 width="24" 10890 xmlns="http://www.w3.org/2000/svg" 10891 > 10892 <path 10893 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 10894 stroke="#9B9B9B" 10895 stroke-linecap="round" 10896 stroke-linejoin="round" 10897 stroke-width="2" 10898 /> 10899 <path 10900 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 10901 stroke="#9B9B9B" 10902 stroke-linecap="round" 10903 stroke-linejoin="round" 10904 stroke-width="2" 10905 /> 10906 </svg> 10907 </span> 10908 </a> 10909 </h3> 10910 <p 10911 class="mb-4 css-1kfqm4n-TextComponent" 10912 data-text="true" 10913 > 10914 An object obtained by permissions get and request functions. 10915 </p> 10916 <p 10917 class="css-1eksndl-BoxSectionHeader" 10918 data-text="true" 10919 > 10920 PermissionResponse Properties 10921 </p> 10922 <div 10923 class="css-1uyflf8-Table" 10924 > 10925 <table 10926 class="css-q84cm9-Table" 10927 > 10928 <thead 10929 class="bg-subtle border-b border-b-default border-solid" 10930 > 10931 <tr 10932 class="css-190f936-Row" 10933 > 10934 <th 10935 class="css-1uwgm7m-HeaderCell" 10936 > 10937 Name 10938 </th> 10939 <th 10940 class="css-1uwgm7m-HeaderCell" 10941 > 10942 Type 10943 </th> 10944 <th 10945 class="css-1uwgm7m-HeaderCell" 10946 > 10947 Description 10948 </th> 10949 </tr> 10950 </thead> 10951 <tbody> 10952 <tr 10953 class="css-190f936-Row" 10954 > 10955 <td 10956 class="css-18p3734-Cell" 10957 > 10958 <strong 10959 class="css-bvflvn-TextComponent" 10960 > 10961 canAskAgain 10962 </strong> 10963 </td> 10964 <td 10965 class="css-18p3734-Cell" 10966 > 10967 <code 10968 class="css-iwb7ur-TextComponent" 10969 data-text="true" 10970 > 10971 boolean 10972 </code> 10973 </td> 10974 <td 10975 class="css-18p3734-Cell" 10976 > 10977 <p 10978 class="mb-4 css-1kfqm4n-TextComponent" 10979 data-text="true" 10980 > 10981 Indicates if user can be asked again for specific permission. 10982If not, one should be directed to the Settings app 10983in order to enable/disable the permission. 10984 </p> 10985 </td> 10986 </tr> 10987 <tr 10988 class="css-190f936-Row" 10989 > 10990 <td 10991 class="css-18p3734-Cell" 10992 > 10993 <strong 10994 class="css-bvflvn-TextComponent" 10995 > 10996 expires 10997 </strong> 10998 </td> 10999 <td 11000 class="css-18p3734-Cell" 11001 > 11002 <code 11003 class="css-iwb7ur-TextComponent" 11004 data-text="true" 11005 > 11006 <a 11007 class="css-1na8e0o-A" 11008 href="#permissionexpiration" 11009 > 11010 PermissionExpiration 11011 </a> 11012 </code> 11013 </td> 11014 <td 11015 class="css-18p3734-Cell" 11016 > 11017 <p 11018 class="mb-4 css-1kfqm4n-TextComponent" 11019 data-text="true" 11020 > 11021 Determines time when the permission expires. 11022 </p> 11023 </td> 11024 </tr> 11025 <tr 11026 class="css-190f936-Row" 11027 > 11028 <td 11029 class="css-18p3734-Cell" 11030 > 11031 <strong 11032 class="css-bvflvn-TextComponent" 11033 > 11034 granted 11035 </strong> 11036 </td> 11037 <td 11038 class="css-18p3734-Cell" 11039 > 11040 <code 11041 class="css-iwb7ur-TextComponent" 11042 data-text="true" 11043 > 11044 boolean 11045 </code> 11046 </td> 11047 <td 11048 class="css-18p3734-Cell" 11049 > 11050 <p 11051 class="mb-4 css-1kfqm4n-TextComponent" 11052 data-text="true" 11053 > 11054 A convenience boolean that indicates if the permission is granted. 11055 </p> 11056 </td> 11057 </tr> 11058 <tr 11059 class="css-190f936-Row" 11060 > 11061 <td 11062 class="css-18p3734-Cell" 11063 > 11064 <strong 11065 class="css-bvflvn-TextComponent" 11066 > 11067 status 11068 </strong> 11069 </td> 11070 <td 11071 class="css-18p3734-Cell" 11072 > 11073 <code 11074 class="css-iwb7ur-TextComponent" 11075 data-text="true" 11076 > 11077 <a 11078 class="css-1na8e0o-A" 11079 href="#permissionstatus" 11080 > 11081 PermissionStatus 11082 </a> 11083 </code> 11084 </td> 11085 <td 11086 class="css-18p3734-Cell" 11087 > 11088 <p 11089 class="mb-4 css-1kfqm4n-TextComponent" 11090 data-text="true" 11091 > 11092 Determines the status of the permission. 11093 </p> 11094 </td> 11095 </tr> 11096 </tbody> 11097 </table> 11098 </div> 11099 <br /> 11100 </div> 11101 <h2 11102 class=" css-1qsxz84-TextComponent" 11103 data-heading="true" 11104 > 11105 <a 11106 class="css-1y48vg3" 11107 href="#types" 11108 > 11109 <span 11110 class="css-s3qkfm" 11111 id="types" 11112 /> 11113 <span 11114 class="css-6n7j50" 11115 > 11116 Types 11117 </span> 11118 <span 11119 class="css-15j1jyt-PermalinkCopyIcon" 11120 id="docs-anchor-permalink-types" 11121 > 11122 <svg 11123 aria-label="permalink" 11124 class="anchor-icon" 11125 fill="none" 11126 height="24" 11127 viewBox="0 0 24 24" 11128 width="24" 11129 xmlns="http://www.w3.org/2000/svg" 11130 > 11131 <path 11132 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11133 stroke="#9B9B9B" 11134 stroke-linecap="round" 11135 stroke-linejoin="round" 11136 stroke-width="2" 11137 /> 11138 <path 11139 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11140 stroke="#9B9B9B" 11141 stroke-linecap="round" 11142 stroke-linejoin="round" 11143 stroke-width="2" 11144 /> 11145 </svg> 11146 </span> 11147 </a> 11148 </h2> 11149 <div 11150 class="css-1fultt1" 11151 > 11152 <h3 11153 class=" css-wbzzgj-TextComponent" 11154 data-heading="true" 11155 > 11156 <a 11157 class="css-1y48vg3" 11158 href="#pedometerresult" 11159 > 11160 <span 11161 class="css-s3qkfm" 11162 id="pedometerresult" 11163 /> 11164 <span 11165 class="css-6n7j50" 11166 > 11167 <code 11168 class="css-yd3r23-TextComponent" 11169 data-text="true" 11170 > 11171 PedometerResult 11172 </code> 11173 </span> 11174 <span 11175 class="css-15j1jyt-PermalinkCopyIcon" 11176 id="docs-anchor-permalink-pedometerresult" 11177 > 11178 <svg 11179 aria-label="permalink" 11180 class="anchor-icon" 11181 fill="none" 11182 height="24" 11183 viewBox="0 0 24 24" 11184 width="24" 11185 xmlns="http://www.w3.org/2000/svg" 11186 > 11187 <path 11188 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11189 stroke="#9B9B9B" 11190 stroke-linecap="round" 11191 stroke-linejoin="round" 11192 stroke-width="2" 11193 /> 11194 <path 11195 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11196 stroke="#9B9B9B" 11197 stroke-linecap="round" 11198 stroke-linejoin="round" 11199 stroke-width="2" 11200 /> 11201 </svg> 11202 </span> 11203 </a> 11204 </h3> 11205 <div 11206 class="css-1uyflf8-Table" 11207 > 11208 <table 11209 class="css-q84cm9-Table" 11210 > 11211 <thead 11212 class="bg-subtle border-b border-b-default border-solid" 11213 > 11214 <tr 11215 class="css-190f936-Row" 11216 > 11217 <th 11218 class="css-1uwgm7m-HeaderCell" 11219 > 11220 Name 11221 </th> 11222 <th 11223 class="css-1uwgm7m-HeaderCell" 11224 > 11225 Type 11226 </th> 11227 <th 11228 class="css-1uwgm7m-HeaderCell" 11229 > 11230 Description 11231 </th> 11232 </tr> 11233 </thead> 11234 <tbody> 11235 <tr 11236 class="css-190f936-Row" 11237 > 11238 <td 11239 class="css-18p3734-Cell" 11240 > 11241 <strong 11242 class="css-bvflvn-TextComponent" 11243 > 11244 steps 11245 </strong> 11246 </td> 11247 <td 11248 class="css-18p3734-Cell" 11249 > 11250 <code 11251 class="css-iwb7ur-TextComponent" 11252 data-text="true" 11253 > 11254 number 11255 </code> 11256 </td> 11257 <td 11258 class="css-18p3734-Cell" 11259 > 11260 <p 11261 class="mb-4 css-1kfqm4n-TextComponent" 11262 data-text="true" 11263 > 11264 Number of steps taken between the given dates. 11265 </p> 11266 </td> 11267 </tr> 11268 </tbody> 11269 </table> 11270 </div> 11271 </div> 11272 <div 11273 class="css-1fultt1" 11274 > 11275 <h3 11276 class=" css-wbzzgj-TextComponent" 11277 data-heading="true" 11278 > 11279 <a 11280 class="css-1y48vg3" 11281 href="#pedometerupdatecallback" 11282 > 11283 <span 11284 class="css-s3qkfm" 11285 id="pedometerupdatecallback" 11286 /> 11287 <span 11288 class="css-6n7j50" 11289 > 11290 <code 11291 class="css-yd3r23-TextComponent" 11292 data-text="true" 11293 > 11294 PedometerUpdateCallback 11295 () 11296 </code> 11297 </span> 11298 <span 11299 class="css-15j1jyt-PermalinkCopyIcon" 11300 id="docs-anchor-permalink-pedometerupdatecallback" 11301 > 11302 <svg 11303 aria-label="permalink" 11304 class="anchor-icon" 11305 fill="none" 11306 height="24" 11307 viewBox="0 0 24 24" 11308 width="24" 11309 xmlns="http://www.w3.org/2000/svg" 11310 > 11311 <path 11312 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11313 stroke="#9B9B9B" 11314 stroke-linecap="round" 11315 stroke-linejoin="round" 11316 stroke-width="2" 11317 /> 11318 <path 11319 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11320 stroke="#9B9B9B" 11321 stroke-linecap="round" 11322 stroke-linejoin="round" 11323 stroke-width="2" 11324 /> 11325 </svg> 11326 </span> 11327 </a> 11328 </h3> 11329 <div> 11330 <p 11331 class="mb-4 css-1kfqm4n-TextComponent" 11332 data-text="true" 11333 > 11334 Callback function providing event result as an argument. 11335 </p> 11336 <div 11337 class="css-1uyflf8-Table" 11338 > 11339 <table 11340 class="css-q84cm9-Table" 11341 > 11342 <thead 11343 class="bg-subtle border-b border-b-default border-solid" 11344 > 11345 <tr 11346 class="css-190f936-Row" 11347 > 11348 <th 11349 class="css-1uwgm7m-HeaderCell" 11350 > 11351 Name 11352 </th> 11353 <th 11354 class="css-1uwgm7m-HeaderCell" 11355 > 11356 Type 11357 </th> 11358 <th 11359 class="css-1uwgm7m-HeaderCell" 11360 > 11361 Description 11362 </th> 11363 </tr> 11364 </thead> 11365 <tbody> 11366 <tr 11367 class="css-190f936-Row" 11368 > 11369 <td 11370 class="css-zstkv9-Cell" 11371 > 11372 <strong 11373 class="css-bvflvn-TextComponent" 11374 > 11375 result 11376 </strong> 11377 </td> 11378 <td 11379 class="css-zstkv9-Cell" 11380 > 11381 <code 11382 class="css-iwb7ur-TextComponent" 11383 data-text="true" 11384 > 11385 <a 11386 class="css-1na8e0o-A" 11387 href="#pedometerresult" 11388 > 11389 PedometerResult 11390 </a> 11391 </code> 11392 </td> 11393 <td 11394 class="css-zstkv9-Cell" 11395 > 11396 - 11397 </td> 11398 </tr> 11399 </tbody> 11400 </table> 11401 </div> 11402 </div> 11403 </div> 11404 <div 11405 class="css-1fultt1" 11406 > 11407 <h3 11408 class=" css-wbzzgj-TextComponent" 11409 data-heading="true" 11410 > 11411 <a 11412 class="css-1y48vg3" 11413 href="#permissionexpiration" 11414 > 11415 <span 11416 class="css-s3qkfm" 11417 id="permissionexpiration" 11418 /> 11419 <span 11420 class="css-6n7j50" 11421 > 11422 <code 11423 class="css-yd3r23-TextComponent" 11424 data-text="true" 11425 > 11426 PermissionExpiration 11427 </code> 11428 </span> 11429 <span 11430 class="css-15j1jyt-PermalinkCopyIcon" 11431 id="docs-anchor-permalink-permissionexpiration" 11432 > 11433 <svg 11434 aria-label="permalink" 11435 class="anchor-icon" 11436 fill="none" 11437 height="24" 11438 viewBox="0 0 24 24" 11439 width="24" 11440 xmlns="http://www.w3.org/2000/svg" 11441 > 11442 <path 11443 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11444 stroke="#9B9B9B" 11445 stroke-linecap="round" 11446 stroke-linejoin="round" 11447 stroke-width="2" 11448 /> 11449 <path 11450 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11451 stroke="#9B9B9B" 11452 stroke-linecap="round" 11453 stroke-linejoin="round" 11454 stroke-width="2" 11455 /> 11456 </svg> 11457 </span> 11458 </a> 11459 </h3> 11460 <p 11461 class="mb-4 css-1kfqm4n-TextComponent" 11462 data-text="true" 11463 > 11464 Permission expiration time. Currently, all permissions are granted permanently. 11465 </p> 11466 <p 11467 class="css-1kfqm4n-TextComponent" 11468 data-text="true" 11469 > 11470 Acceptable values are: 11471 11472 <span> 11473 <code 11474 class="css-iwb7ur-TextComponent" 11475 data-text="true" 11476 > 11477 'never' 11478 </code> 11479 , 11480 </span> 11481 <span> 11482 <code 11483 class="css-iwb7ur-TextComponent" 11484 data-text="true" 11485 > 11486 number 11487 </code> 11488 . 11489 </span> 11490 </p> 11491 </div> 11492 <div 11493 class="css-1fultt1" 11494 > 11495 <h3 11496 class=" css-wbzzgj-TextComponent" 11497 data-heading="true" 11498 > 11499 <a 11500 class="css-1y48vg3" 11501 href="#subscription" 11502 > 11503 <span 11504 class="css-s3qkfm" 11505 id="subscription" 11506 /> 11507 <span 11508 class="css-6n7j50" 11509 > 11510 <code 11511 class="css-yd3r23-TextComponent" 11512 data-text="true" 11513 > 11514 Subscription 11515 </code> 11516 </span> 11517 <span 11518 class="css-15j1jyt-PermalinkCopyIcon" 11519 id="docs-anchor-permalink-subscription" 11520 > 11521 <svg 11522 aria-label="permalink" 11523 class="anchor-icon" 11524 fill="none" 11525 height="24" 11526 viewBox="0 0 24 24" 11527 width="24" 11528 xmlns="http://www.w3.org/2000/svg" 11529 > 11530 <path 11531 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11532 stroke="#9B9B9B" 11533 stroke-linecap="round" 11534 stroke-linejoin="round" 11535 stroke-width="2" 11536 /> 11537 <path 11538 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11539 stroke="#9B9B9B" 11540 stroke-linecap="round" 11541 stroke-linejoin="round" 11542 stroke-width="2" 11543 /> 11544 </svg> 11545 </span> 11546 </a> 11547 </h3> 11548 <div 11549 class="css-1uyflf8-Table" 11550 > 11551 <table 11552 class="css-q84cm9-Table" 11553 > 11554 <thead 11555 class="bg-subtle border-b border-b-default border-solid" 11556 > 11557 <tr 11558 class="css-190f936-Row" 11559 > 11560 <th 11561 class="css-1uwgm7m-HeaderCell" 11562 > 11563 Name 11564 </th> 11565 <th 11566 class="css-1uwgm7m-HeaderCell" 11567 > 11568 Type 11569 </th> 11570 <th 11571 class="css-1uwgm7m-HeaderCell" 11572 > 11573 Description 11574 </th> 11575 </tr> 11576 </thead> 11577 <tbody> 11578 <tr 11579 class="css-190f936-Row" 11580 > 11581 <td 11582 class="css-18p3734-Cell" 11583 > 11584 <strong 11585 class="css-bvflvn-TextComponent" 11586 > 11587 remove 11588 </strong> 11589 </td> 11590 <td 11591 class="css-18p3734-Cell" 11592 > 11593 <code 11594 class="css-iwb7ur-TextComponent" 11595 data-text="true" 11596 > 11597 () => 11598 11599 void 11600 </code> 11601 </td> 11602 <td 11603 class="css-18p3734-Cell" 11604 > 11605 - 11606 </td> 11607 </tr> 11608 </tbody> 11609 </table> 11610 </div> 11611 </div> 11612 <h2 11613 class=" css-1qsxz84-TextComponent" 11614 data-heading="true" 11615 > 11616 <a 11617 class="css-1y48vg3" 11618 href="#enums" 11619 > 11620 <span 11621 class="css-s3qkfm" 11622 id="enums" 11623 /> 11624 <span 11625 class="css-6n7j50" 11626 > 11627 Enums 11628 </span> 11629 <span 11630 class="css-15j1jyt-PermalinkCopyIcon" 11631 id="docs-anchor-permalink-enums" 11632 > 11633 <svg 11634 aria-label="permalink" 11635 class="anchor-icon" 11636 fill="none" 11637 height="24" 11638 viewBox="0 0 24 24" 11639 width="24" 11640 xmlns="http://www.w3.org/2000/svg" 11641 > 11642 <path 11643 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11644 stroke="#9B9B9B" 11645 stroke-linecap="round" 11646 stroke-linejoin="round" 11647 stroke-width="2" 11648 /> 11649 <path 11650 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11651 stroke="#9B9B9B" 11652 stroke-linecap="round" 11653 stroke-linejoin="round" 11654 stroke-width="2" 11655 /> 11656 </svg> 11657 </span> 11658 </a> 11659 </h2> 11660 <div 11661 class="css-1gsbrid" 11662 > 11663 <h3 11664 class=" css-wbzzgj-TextComponent" 11665 data-heading="true" 11666 > 11667 <a 11668 class="css-1y48vg3" 11669 href="#permissionstatus" 11670 > 11671 <span 11672 class="css-s3qkfm" 11673 id="permissionstatus" 11674 /> 11675 <span 11676 class="css-6n7j50" 11677 > 11678 <code 11679 class="css-yd3r23-TextComponent" 11680 data-text="true" 11681 > 11682 PermissionStatus 11683 </code> 11684 </span> 11685 <span 11686 class="css-15j1jyt-PermalinkCopyIcon" 11687 id="docs-anchor-permalink-permissionstatus" 11688 > 11689 <svg 11690 aria-label="permalink" 11691 class="anchor-icon" 11692 fill="none" 11693 height="24" 11694 viewBox="0 0 24 24" 11695 width="24" 11696 xmlns="http://www.w3.org/2000/svg" 11697 > 11698 <path 11699 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11700 stroke="#9B9B9B" 11701 stroke-linecap="round" 11702 stroke-linejoin="round" 11703 stroke-width="2" 11704 /> 11705 <path 11706 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11707 stroke="#9B9B9B" 11708 stroke-linecap="round" 11709 stroke-linejoin="round" 11710 stroke-width="2" 11711 /> 11712 </svg> 11713 </span> 11714 </a> 11715 </h3> 11716 <div 11717 class="css-11xr3cd" 11718 > 11719 <h4 11720 class=" css-1y1xevk-TextComponent" 11721 data-heading="true" 11722 > 11723 <a 11724 class="css-1y48vg3" 11725 href="#denied" 11726 > 11727 <span 11728 class="css-s3qkfm" 11729 id="denied" 11730 /> 11731 <span 11732 class="css-6n7j50" 11733 > 11734 <code 11735 class="css-iwb7ur-TextComponent" 11736 data-text="true" 11737 > 11738 DENIED 11739 </code> 11740 </span> 11741 <span 11742 class="css-15j1jyt-PermalinkCopyIcon" 11743 id="docs-anchor-permalink-denied" 11744 > 11745 <svg 11746 aria-label="permalink" 11747 class="anchor-icon" 11748 fill="none" 11749 height="24" 11750 viewBox="0 0 24 24" 11751 width="24" 11752 xmlns="http://www.w3.org/2000/svg" 11753 > 11754 <path 11755 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11756 stroke="#9B9B9B" 11757 stroke-linecap="round" 11758 stroke-linejoin="round" 11759 stroke-width="2" 11760 /> 11761 <path 11762 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11763 stroke="#9B9B9B" 11764 stroke-linecap="round" 11765 stroke-linejoin="round" 11766 stroke-width="2" 11767 /> 11768 </svg> 11769 </span> 11770 </a> 11771 </h4> 11772 <code 11773 class="mb-4 css-1h2013i-TextComponent" 11774 data-text="true" 11775 > 11776 PermissionStatus.DENIED = "denied" 11777 </code> 11778 <p 11779 class="mb-4 css-1kfqm4n-TextComponent" 11780 data-text="true" 11781 > 11782 User has denied the permission. 11783 </p> 11784 </div> 11785 <div 11786 class="css-11xr3cd" 11787 > 11788 <h4 11789 class=" css-1y1xevk-TextComponent" 11790 data-heading="true" 11791 > 11792 <a 11793 class="css-1y48vg3" 11794 href="#granted" 11795 > 11796 <span 11797 class="css-s3qkfm" 11798 id="granted" 11799 /> 11800 <span 11801 class="css-6n7j50" 11802 > 11803 <code 11804 class="css-iwb7ur-TextComponent" 11805 data-text="true" 11806 > 11807 GRANTED 11808 </code> 11809 </span> 11810 <span 11811 class="css-15j1jyt-PermalinkCopyIcon" 11812 id="docs-anchor-permalink-granted" 11813 > 11814 <svg 11815 aria-label="permalink" 11816 class="anchor-icon" 11817 fill="none" 11818 height="24" 11819 viewBox="0 0 24 24" 11820 width="24" 11821 xmlns="http://www.w3.org/2000/svg" 11822 > 11823 <path 11824 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11825 stroke="#9B9B9B" 11826 stroke-linecap="round" 11827 stroke-linejoin="round" 11828 stroke-width="2" 11829 /> 11830 <path 11831 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11832 stroke="#9B9B9B" 11833 stroke-linecap="round" 11834 stroke-linejoin="round" 11835 stroke-width="2" 11836 /> 11837 </svg> 11838 </span> 11839 </a> 11840 </h4> 11841 <code 11842 class="mb-4 css-1h2013i-TextComponent" 11843 data-text="true" 11844 > 11845 PermissionStatus.GRANTED = "granted" 11846 </code> 11847 <p 11848 class="mb-4 css-1kfqm4n-TextComponent" 11849 data-text="true" 11850 > 11851 User has granted the permission. 11852 </p> 11853 </div> 11854 <div 11855 class="css-11xr3cd" 11856 > 11857 <h4 11858 class=" css-1y1xevk-TextComponent" 11859 data-heading="true" 11860 > 11861 <a 11862 class="css-1y48vg3" 11863 href="#undetermined" 11864 > 11865 <span 11866 class="css-s3qkfm" 11867 id="undetermined" 11868 /> 11869 <span 11870 class="css-6n7j50" 11871 > 11872 <code 11873 class="css-iwb7ur-TextComponent" 11874 data-text="true" 11875 > 11876 UNDETERMINED 11877 </code> 11878 </span> 11879 <span 11880 class="css-15j1jyt-PermalinkCopyIcon" 11881 id="docs-anchor-permalink-undetermined" 11882 > 11883 <svg 11884 aria-label="permalink" 11885 class="anchor-icon" 11886 fill="none" 11887 height="24" 11888 viewBox="0 0 24 24" 11889 width="24" 11890 xmlns="http://www.w3.org/2000/svg" 11891 > 11892 <path 11893 d="M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71" 11894 stroke="#9B9B9B" 11895 stroke-linecap="round" 11896 stroke-linejoin="round" 11897 stroke-width="2" 11898 /> 11899 <path 11900 d="M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71" 11901 stroke="#9B9B9B" 11902 stroke-linecap="round" 11903 stroke-linejoin="round" 11904 stroke-width="2" 11905 /> 11906 </svg> 11907 </span> 11908 </a> 11909 </h4> 11910 <code 11911 class="mb-4 css-1h2013i-TextComponent" 11912 data-text="true" 11913 > 11914 PermissionStatus.UNDETERMINED = "undetermined" 11915 </code> 11916 <p 11917 class="mb-4 css-1kfqm4n-TextComponent" 11918 data-text="true" 11919 > 11920 User hasn't granted or denied the permission yet. 11921 </p> 11922 </div> 11923 </div> 11924</div> 11925`; 11926 11927exports[`APISection no data 1`] = ` 11928<div> 11929 <p 11930 class="css-1kfqm4n-TextComponent" 11931 data-text="true" 11932 > 11933 No API data file found, sorry! 11934 </p> 11935</div> 11936`; 11937