Struct ASAuthorizationController

Source

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

Available on crate feature ASAuthorizationController only.

Expand description

Apple’s documentation

Implementations§

Source §

impl ASAuthorizationController

Source

pub unsafe fn authorizationRequests( &self, ) -> Retained<NSArray<ASAuthorizationRequest>>

Available on crate feature ASAuthorizationRequest only.

Authorization requests that are being serviced by this controller

Source

pub unsafe fn delegate( &self, mtm: MainThreadMarker, ) -> Option<Retained<ProtocolObject<dyn ASAuthorizationControllerDelegate>>>

This delegate will be invoked upon completion of the authorization indicating success or failure. Delegate is required to receive the results of authorization.

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn ASAuthorizationControllerDelegate>>, )

This is a weak property. Setter for delegate.

Source

pub unsafe fn presentationContextProvider( &self, mtm: MainThreadMarker, ) -> Option<Retained<ProtocolObject<dyn ASAuthorizationControllerPresentationContextProviding>>>

This delegate will be invoked upon needing a presentation context to display authorization UI.

Source

pub unsafe fn setPresentationContextProvider( &self, presentation_context_provider: Option<&ProtocolObject<dyn ASAuthorizationControllerPresentationContextProviding>>, )

This is a weak property. Setter for presentationContextProvider.

Source

pub unsafe fn customAuthorizationMethods( &self, ) -> Retained<NSArray<ASAuthorizationCustomMethod>>

Available on crate feature ASAuthorizationCustomMethod only.

A list of custom authorization methods that may be displayed in the authorization UI.

If the user selects one of these methods, instead of attempting to secure an authorization for the requests, the controller will call authorizationController:didCompleteWithCustomMethod: with the selected method, allowing the client to perform the requested authorization.

Source

pub unsafe fn setCustomAuthorizationMethods( &self, custom_authorization_methods: &NSArray<ASAuthorizationCustomMethod>, )

Available on crate feature ASAuthorizationCustomMethod only.

Setter for customAuthorizationMethods.

Source

pub unsafe fn initWithAuthorizationRequests( this: Allocated<Self>, authorization_requests: &NSArray<ASAuthorizationRequest>, ) -> Retained<Self>

Available on crate feature ASAuthorizationRequest only.

Initialize the controller with authorization requests.

Parameter authorizationRequests: At least one request should be provided. Requests of same type maybe honored in first in first out order

Source

pub unsafe fn performRequests(&self)

Initiate the authorization flows. Upon completion, the delegate will be called with either success or failure. Certain authorization flows may require a presentation context. The presentationContextProviderwill be called to provide it.

The instance will remain retained until the flow is either completed or canceled, and the delegate callback is made.

Source

pub unsafe fn performAutoFillAssistedRequests(&self)

Initiate the authorization flows for requests that support AutoFill presentation. UI will be shown when focusing a text field with the appropriate text content type. Upon completion, the delegate will be called with either success or failure.

The instance will remain retained until the flow is either completed or canceled, and the delegate callback is made.

Source

pub unsafe fn performRequestsWithOptions( &self, options: ASAuthorizationControllerRequestOptions, )

Initiate the authorization flows. Upon completion, the delegate will be called with either success or failure. Certain authorization flows may require a presentation context. The presentationContextProviderwill be called to provide it.

Calling this method with no options is the same as calling performRequests.The instance will remain retained until the flow is either completed or canceled, and the delegate callback is made.

Source

pub unsafe fn cancel(&self)

Cancel the running authorization flows, if there are any. If a flow is canceled, the delegate callback will be made indicating the cancel.

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`
    }
}