Struct ASAuthorizationProviderExtensionAuthorizationRequest

Source

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

Available on crate feature ASAuthorizationProviderExtensionAuthorizationRequest only.

Expand description

Apple’s documentation

Implementations§

Source §

impl ASAuthorizationProviderExtensionAuthorizationRequest

Source

pub unsafe fn doNotHandle(&self)

Call when authorization was not handled.

Source

pub unsafe fn cancel(&self)

Call when authorization needs to be canceled from some reason (for example user pressed Cancel button).

Source

pub unsafe fn complete(&self)

Call when authorization succeeded without any output.

Source

pub unsafe fn completeWithHTTPAuthorizationHeaders( &self, http_authorization_headers: &NSDictionary<NSString, NSString>, )

Call when authorization succeeded with an authorization tokens stored in HTTP headers.

Source

pub unsafe fn completeWithHTTPResponse_httpBody( &self, http_response: &NSHTTPURLResponse, http_body: Option<&NSData>, )

Call when authorization succeeded with a HTTP response.

Source

pub unsafe fn completeWithAuthorizationResult( &self, authorization_result: &ASAuthorizationProviderExtensionAuthorizationResult, )

Available on crate feature ASAuthorizationProviderExtensionAuthorizationResult only.

Call when authorization succeeded with

See: ASAuthorizationProviderExtensionAuthorizationResult.

Source

pub unsafe fn completeWithError(&self, error: &NSError)

Call when authorization failed with an error.

Source

pub unsafe fn presentAuthorizationViewControllerWithCompletion( &self, completion: &DynBlock<dyn Fn(Bool, *mut NSError)>, )

Available on crate feature block2 only.

Asks authorization service to show extension view controller. If the controller cannot be shown an error is returned.

Source

pub unsafe fn url(&self) -> Retained<NSURL>

Request URL with all components.

Source

pub unsafe fn requestedOperation( &self, ) -> Retained<ASAuthorizationProviderAuthorizationOperation>

Operation to be executed by the extension.

Source

pub unsafe fn httpHeaders(&self) -> Retained<NSDictionary<NSString, NSString>>

Request HTTP headers.

Source

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

Request body.

Source

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

Realm.

Source

pub unsafe fn extensionData(&self) -> Retained<NSDictionary>

Extension data from extension configuration provided by MDM stored as a property-list.

Source

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

Identification of the calling application.

Source

pub unsafe fn authorizationOptions(&self) -> Retained<NSDictionary>

Authorization options.

Source

pub unsafe fn isCallerManaged(&self) -> bool

Indicates whether the calling application is managed.

Source

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

Team identifier of the calling application.

Source

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

Localized display name of the calling application.

Source

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

Audit token of the calling application.

Source

pub unsafe fn isUserInterfaceEnabled(&self) -> bool

Indicates whether the authorization user interface is enabled.

If user interface is not enabled, then the authorization will fail with

See: ASAuthorizationErrorNotInteractive if it attempts to display the authorization user interface via

See: presentAuthorizationViewControllerWithCompletion.

Source

pub unsafe fn loginManager( &self, ) -> Option<Retained<ASAuthorizationProviderExtensionLoginManager>>

Available on crate feature ASAuthorizationProviderExtensionLoginManager only.

The login manager to interface with the Platform SSO configuration.

Source §

impl ASAuthorizationProviderExtensionAuthorizationRequest

Methods declared on superclass NSObject.

Source

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

Source

pub unsafe fn new() -> 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`
    }
}