Struct ASAuthorizationSingleSignOnRequest

Source

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

Available on crate features ASAuthorizationOpenIDRequest and ASAuthorizationRequest and ASAuthorizationSingleSignOnRequest only.

Expand description

Apple’s documentation

Implementations§

Source §

impl ASAuthorizationSingleSignOnRequest

Source

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

Parameters required by the specific Authorization Server which should be used by the selected Authorization Services extension for authorization.

Source

pub unsafe fn setAuthorizationOptions( &self, authorization_options: &NSArray<NSURLQueryItem>, )

Setter for authorizationOptions.

Source

pub unsafe fn isUserInterfaceEnabled(&self) -> bool

Enables or disables the authorization user interface.

The default values is YES. If user interface is not enabled, then the authorization will fail with

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

Source

pub unsafe fn setUserInterfaceEnabled(&self, user_interface_enabled: bool)

Setter for isUserInterfaceEnabled.

Source §

impl ASAuthorizationSingleSignOnRequest

Methods declared on superclass ASAuthorizationRequest.

Source

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

Source

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

Methods from Deref<Target = ASAuthorizationOpenIDRequest>§

Source

pub unsafe fn requestedScopes( &self, ) -> Option<Retained<NSArray<ASAuthorizationScope>>>

Available on crate feature ASAuthorization only.

The contact information to be requested from the user. Only scopes for which this app was authorized for will be returned.

Source

pub unsafe fn setRequestedScopes( &self, requested_scopes: Option<&NSArray<ASAuthorizationScope>>, )

Available on crate feature ASAuthorization only.

Setter for requestedScopes.

Source

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

State to be passed to the identity provider. This value will be returned as a part of successful ASAuthorization response.

Note: The state size may depend on the actual technology used and an error might be returned by the request execution.

Source

pub unsafe fn setState(&self, state: Option<&NSString>)

Setter for state.

Source

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

Nonce to be passed to the identity provider. This value can be verified with the identity token provided as a part of successful ASAuthorization response.

Note: The nonce size may depend on the actual technology used and an error might be returned by the request execution.

Source

pub unsafe fn setNonce(&self, nonce: Option<&NSString>)

Setter for nonce.

Source

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

Operation to be executed by the request. The ASAuthorizationOperationImplicit operation interpretation depends on the credential provider implementation.

Source

pub unsafe fn setRequestedOperation( &self, requested_operation: &ASAuthorizationOpenIDOperation, )

Setter for requestedOperation.

Methods from Deref<Target = ASAuthorizationRequest>§

Source

pub unsafe fn provider( &self, ) -> Retained<ProtocolObject<dyn ASAuthorizationProvider>>

Available on crate feature ASAuthorizationProvider only.

The provider object that is being used to service this request

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