:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/../../GodotApplePlugins/doc_classes/ASAuthorizationAppleIDCredential.xml. .. _class_ASAuthorizationAppleIDCredential: ASAuthorizationAppleIDCredential ================================ **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Represents a credential that results from a successful Apple ID authentication. .. rst-class:: classref-introduction-group Description ----------- This class contains information about the user authenticated via Sign in with Apple. It includes the user identifier, full name, email, and authentication tokens. The :ref:`identity_token` and :ref:`authorization_code` properties are provided as :ref:`PackedByteArray`\ s, which can be sent to your backend server for verification. The :ref:`real_user_status` property can help you determine if the user is likely a real person or a bot. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PackedByteArray` | :ref:`authorization_code` | ``PackedByteArray()`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Array` | :ref:`authorized_scopes` | ``[]`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`email` | ``""`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`Dictionary` | :ref:`full_name` | ``{}`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PackedByteArray` | :ref:`identity_token` | ``PackedByteArray()`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`real_user_status` | ``0`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`state` | ``""`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`user` | ``""`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`user_age_range` | ``0`` | +-----------------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ASAuthorizationAppleIDCredential_UserDetectionStatus: .. rst-class:: classref-enumeration enum **UserDetectionStatus**: :ref:`🔗` .. _class_ASAuthorizationAppleIDCredential_constant_unsupported: .. rst-class:: classref-enumeration-constant :ref:`UserDetectionStatus` **unsupported** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_ASAuthorizationAppleIDCredential_constant_unknown: .. rst-class:: classref-enumeration-constant :ref:`UserDetectionStatus` **unknown** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_ASAuthorizationAppleIDCredential_constant_likelyReal: .. rst-class:: classref-enumeration-constant :ref:`UserDetectionStatus` **likelyReal** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _enum_ASAuthorizationAppleIDCredential_UserAgeRange: .. rst-class:: classref-enumeration enum **UserAgeRange**: :ref:`🔗` .. _class_ASAuthorizationAppleIDCredential_constant_notknown: .. rst-class:: classref-enumeration-constant :ref:`UserAgeRange` **notknown** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_ASAuthorizationAppleIDCredential_constant_child: .. rst-class:: classref-enumeration-constant :ref:`UserAgeRange` **child** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_ASAuthorizationAppleIDCredential_constant_notChild: .. rst-class:: classref-enumeration-constant :ref:`UserAgeRange` **notChild** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ASAuthorizationAppleIDCredential_property_authorization_code: .. rst-class:: classref-property :ref:`PackedByteArray` **authorization_code** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`PackedByteArray` **get_authorization_code**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedByteArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_authorized_scopes: .. rst-class:: classref-property :ref:`Array` **authorized_scopes** = ``[]`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Array` **get_authorized_scopes**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_email: .. rst-class:: classref-property :ref:`String` **email** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_email**\ (\ ) The user's email address. may be a proxy address if the user chose to hide their email. .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_full_name: .. rst-class:: classref-property :ref:`Dictionary` **full_name** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`Dictionary` **get_full_name**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_identity_token: .. rst-class:: classref-property :ref:`PackedByteArray` **identity_token** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`PackedByteArray` **get_identity_token**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedByteArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_real_user_status: .. rst-class:: classref-property :ref:`int` **real_user_status** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_real_user_status**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_state: .. rst-class:: classref-property :ref:`String` **state** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_state**\ (\ ) An arbitrary string that your app provided to the request that generated this credential. .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_user: .. rst-class:: classref-property :ref:`String` **user** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`String` **get_user**\ (\ ) An identifier associated with the authenticated user. This identifier is stable and unique to your team. .. rst-class:: classref-item-separator ---- .. _class_ASAuthorizationAppleIDCredential_property_user_age_range: .. rst-class:: classref-property :ref:`int` **user_age_range** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - :ref:`int` **get_user_age_range**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`