Struct ASAuthorizationProviderExtensionLoginManager

Source

pub struct ASAuthorizationProviderExtensionLoginManager { /* private fields */ }

Available on crate feature ASAuthorizationProviderExtensionLoginManager only.

Expand description

Apple’s documentation

Implementations§

Source §

pub unsafe fn isDeviceRegistered(&self) -> bool

Returns YES if the current device completed registration.

Source

pub unsafe fn isUserRegistered(&self) -> bool

Returns YES if current user completed registration.

Source

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

Returns the device registration token from the MDM profile.

Source

pub unsafe fn authenticationMethod( &self, ) -> ASAuthorizationProviderExtensionAuthenticationMethod

Available on crate feature ASAuthorizationProviderExtensionRegistrationHandler only.

Returns the authentication method used for the device.

Source

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

Returns the extension data from the MDM profile.

Source

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

👎Deprecated

The user name to use when authenticating with the identity provider.

Source

pub unsafe fn setLoginUserName(&self, login_user_name: Option<&NSString>)

👎Deprecated

Setter for loginUserName.

This is copied when set.

Source

pub unsafe fn userLoginConfiguration( &self, ) -> Option<Retained<ASAuthorizationProviderExtensionUserLoginConfiguration>>

Available on crate feature ASAuthorizationProviderExtensionUserLoginConfiguration only.

Retrieves the current user login configuration for the extension.

Source

pub unsafe fn saveUserLoginConfiguration_error( &self, user_login_configuration: &ASAuthorizationProviderExtensionUserLoginConfiguration, ) -> Result<(), Retained<NSError>>

Available on crate feature ASAuthorizationProviderExtensionUserLoginConfiguration only.

Saves or replaces the user login configration.

Parameter userLoginConfiguration: The user login configration to use.

Parameter error: The error when there are validation errors or nil.

Source

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

Retrieves or sets the current SSO tokens response for the current user and extension.

Source

pub unsafe fn setSsoTokens(&self, sso_tokens: Option<&NSDictionary>)

Setter for ssoTokens.

This is copied when set.

§Safety

sso_tokens generic should be of the correct type.

Source

pub unsafe fn loginConfiguration( &self, ) -> Option<Retained<ASAuthorizationProviderExtensionLoginConfiguration>>

Available on crate feature ASAuthorizationProviderExtensionLoginConfiguration only.

Retrieves or sets the current login configuration for the extension.

Source

pub unsafe fn saveLoginConfiguration_error( &self, login_configuration: &ASAuthorizationProviderExtensionLoginConfiguration, ) -> Result<(), Retained<NSError>>

Available on crate feature ASAuthorizationProviderExtensionLoginConfiguration only.

Saves or replaces the login configration.

Parameter loginConfiguration: The login configration to use.

Parameter error: The error when there are validation errors or nil.

Source

pub unsafe fn saveCertificate_keyType( &self, certificate: &SecCertificate, key_type: ASAuthorizationProviderExtensionKeyType, )

Available on crate feature objc2-security only.

Saves the provided certificate for the key type.

Parameter certificate: The certificate to save.

Parameter keyType: The key type for the certificate.

Source

pub unsafe fn copyKeyForKeyType( &self, key_type: ASAuthorizationProviderExtensionKeyType, ) -> Option<Retained<SecKey>>

Available on crate feature objc2-security only.

Retrieves the key for the specified platform SSO key type.

Parameter keyType: The key type to retrieve.

Source

pub unsafe fn copyIdentityForKeyType( &self, key_type: ASAuthorizationProviderExtensionKeyType, ) -> Option<Retained<SecIdentity>>

Available on crate feature objc2-security only.

Retrieves the identity for the specified platform SSO key type.

Parameter keyType: The key type to retrieve.

Source

pub unsafe fn beginKeyRotationForKeyType( &self, key_type: ASAuthorizationProviderExtensionKeyType, ) -> Option<Retained<SecKey>>

Available on crate feature objc2-security only.

Generates a new key for the specified platform SSO key type using the strongest supported key strength returning the new key. Nil is returned if there is an error generating the new key.

Parameter keyType: The key type to retrieve.

Source

pub unsafe fn completeKeyRotationForKeyType( &self, key_type: ASAuthorizationProviderExtensionKeyType, )

Completes rotation for the key to replace the previous key.

Parameter keyType: The key type to retrieve.

Source

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

Available on crate feature block2 only.

Requests AppSSOAgent reauthenticate the current user for the current extension. This is used when the tokens are revoked, or expired and need to be requested again.

Source

pub unsafe fn deviceRegistrationsNeedsRepair(&self)

Requests that the device registration be run again to repair it.

Source

pub unsafe fn userRegistrationsNeedsRepair(&self)

Requests that user registration be run again for the current user to repair it.

Source

pub unsafe fn decryptionKeysNeedRepair(&self)

Requests that the decryption keys are repaired.

Source

pub unsafe fn resetKeys(&self)

Creates new Encryption, Signing, and Secure Enclave keys for the user. The old keys will be destroyed.

Source

pub unsafe fn resetDeviceKeys(&self)

Creates new Encryption, and Signing keys for the device or user. The old keys will be destroyed.

Source

pub unsafe fn resetUserSecureEnclaveKey(&self)

Creates new Encryption, Signing, and Secure Enclave keys for the user. The old keys will be destroyed.

Source

pub unsafe fn attestKey_clientDataHash_completion( &self, key_type: ASAuthorizationProviderExtensionKeyType, client_data_hash: &NSData, completion: &DynBlock<dyn Fn(mut NSArray, mut NSError)>, )

Available on crate feature block2 only.

Provides a new or cached attestation for the specified key type.

Parameter keyType: The key type for the attestation.

Parameter clientDataHash: A SHA256 hash of a unique, single-use data block that embeds a challenge from your server.

Parameter completion: A closure that the method calls upon completion with the following parameters:

attestationCertificates An array of certificates that verify the validity of the key associated with the keyType. Send this to your server for processing.
error A DCError instance that indicates the reason for failure, or nil on success.

Source

pub unsafe fn attestPendingKey_clientDataHash_completion( &self, key_type: ASAuthorizationProviderExtensionKeyType, client_data_hash: &NSData, completion: &DynBlock<dyn Fn(mut NSArray, mut NSError)>, )

Available on crate feature block2 only.

Provides a new or cached attestation for the specified pending key type.

Parameter keyType: The pending key type for the attestation.

Parameter clientDataHash: A SHA256 hash of a unique, single-use data block that embeds a challenge from your server.

Parameter completion: A closure that the method calls upon completion with the following parameters:

attestationCertificates An array of certificates that verify the validity of the pending key associated with the keyType. Send this to your server for processing.
error A DCError instance that indicates the reason for failure, or nil on success.

Source

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

Available on crate feature block2 only.

Asks authorization service to show extension view controller for registration. If the controller cannot be shown an error is returned. This is only valid during registration.

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