Struct ASAuthorizationAppleIDCredential

Source

#[repr(C)]
pub struct ASAuthorizationAppleIDCredential { /* private fields */ }

Available on crate feature ASAuthorizationAppleIDCredential only.

Expand description

Apple’s documentation

Implementations§

Source §

impl ASAuthorizationAppleIDCredential

Source

pub unsafe fn user(&self) -> Retained<NSString>

An opaque user ID associated with the AppleID used for the sign in. This identifier will be stable across the ‘developer team’, it can later be used as an input to

See: ASAuthorizationRequest to request user contact information.

The identifier will remain stable as long as the user is connected with the requesting client. The value may change upon user disconnecting from the identity provider.

Source

pub unsafe fn state(&self) -> Option<Retained<NSString>>

A copy of the state value that was passed to ASAuthorizationRequest.

Source

pub unsafe fn authorizedScopes(&self) -> Retained<NSArray<ASAuthorizationScope>>

Available on crate feature ASAuthorization only.

This value will contain a list of scopes for which the user provided authorization. These may contain a subset of the requested scopes on

See: ASAuthorizationAppleIDRequest. The application should query this value to identify which scopes were returned as it maybe different from ones requested.

Source

pub unsafe fn authorizationCode(&self) -> Option<Retained<NSData>>

A short-lived, one-time valid token that provides proof of authorization to the server component of the app. The authorization code is bound to the specific transaction using the state attribute passed in the authorization request. The server component of the app can validate the code using Apple’s identity service endpoint provided for this purpose.

Source

pub unsafe fn identityToken(&self) -> Option<Retained<NSData>>

A JSON Web Token (JWT) used to communicate information about the identity of the user in a secure way to the app. The ID token will contain the following information: Issuer Identifier, Subject Identifier, Audience, Expiry Time and Issuance Time signed by Apple’s identity service.

Source

pub unsafe fn email(&self) -> Option<Retained<NSString>>

An optional email shared by the user. This field is populated with a value that the user authorized.

Source

pub unsafe fn fullName(&self) -> Option<Retained<NSPersonNameComponents>>

An optional full name shared by the user. This field is populated with a value that the user authorized.

Source

pub unsafe fn realUserStatus(&self) -> ASUserDetectionStatus

Check this property for a hint as to whether the current user is a “real user”.

See: ASUserDetectionStatus for guidelines on handling each status

Source

pub unsafe fn userAgeRange(&self) -> ASUserAgeRange

Check this property to determine whether the current user is a child.

See: ASUserAgeRange for guidelines on handling each status.

Source

pub unsafe fn new() -> Retained<Self>

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}