Struct ASCredentialProviderViewController

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

Available on crate feature ASCredentialProviderViewController only.

Implementations

impl ASCredentialProviderViewController

pub unsafe fn extensionContext( &self, ) -> Retained<ASCredentialProviderExtensionContext>

Available on macOS and crate feature ASCredentialProviderExtensionContext only.

pub unsafe fn prepareCredentialListForServiceIdentifiers( &self, service_identifiers: &NSArray<ASCredentialServiceIdentifier>, )

Available on macOS and crate feature ASCredentialServiceIdentifier only.

Prepare the view controller to show a list of credentials.

Parameter serviceIdentifiers: the array of service identifiers.

This method is called by the system to prepare the extension’s view controller to present the list of credentials. A service identifier array is passed which can be used to filter or prioritize the credentials that closely match each service. The service identifier array could have zero or more items. If there are more than one item in the array, items with lower indexes represent more specific identifiers for which a credential is being requested. For example, the array could contain identifiers [m.example.com, example.com] with the first item representing the more specifc service that requires a credential. If the array of service identifiers is empty, it is expected that the credential list should still show credentials that the user can pick from.

pub unsafe fn prepareCredentialListForServiceIdentifiers_requestParameters( &self, service_identifiers: &NSArray<ASCredentialServiceIdentifier>, request_parameters: &ASPasskeyCredentialRequestParameters, )

Available on macOS and crate feature ASCredentialServiceIdentifier and crate feature ASPasskeyCredentialRequestParameters only.

Prepare the view controller to show a list of passkey and password credentials.

Parameter serviceIdentifiers: the array of service identifiers.

Parameter requestParameters: the parameters of the active passkey request.

This method is called by the system to prepare the extension’s view controller to present the list of credentials. A service identifier array is passed which can be used to filter or prioritize the credentials that closely match each service. The service identifier array could have zero or more items. If there is more than one item in the array, items with lower indexes represent more specific identifiers for which a credential is being requested. For example, the array could contain identifiers [m.example.com, example.com] with the first item representing the more specifc service that requires a credential. If the array of service identifiers is empty, it is expected that the credential list should still show credentials that the user can pick from. If a passkey credential is selected, the extension should use the requestParameters object to complete the request using the selected passkey credential.

pub unsafe fn prepareOneTimeCodeCredentialListForServiceIdentifiers( &self, service_identifiers: &NSArray<ASCredentialServiceIdentifier>, )

Available on macOS and crate feature ASCredentialServiceIdentifier only.

Prepare the view controller to show a list of one time code credentials.

Parameter serviceIdentifiers: the array of service identifiers.

This method is called by the system to prepare the extension’s view controller to present the list of credentials. A service identifier array is passed which can be used to filter or prioritize the credentials that closely match each service. The service identifier array could have zero or more items. If there is more than one item in the array, items with lower indexes represent more specific identifiers for which a credential is being requested. For example, the array could contain identifiers [m.example.com, example.com] with the first item representing the more specifc service that requires a credential. If the array of service identifiers is empty, it is expected that the credential list should still show credentials that the user can pick from.

pub unsafe fn provideCredentialWithoutUserInteractionForIdentity( &self, credential_identity: &ASPasswordCredentialIdentity, )

👎Deprecated

Available on macOS and crate feature ASPasswordCredentialIdentity only.

Attempt to provide the user-requested credential without any user interaction.

Parameter credentialIdentity: the credential identity for which a credential should be provided.

After the user selects a credential identity, the system may ask your extension to provide the credential without showing any user interface if possible to enhance the user experience. If your extension can accomplish this (for example, the user’s passwords database is still unlocked from a recent interaction), call -[ASCredentialProviderExtensionContext completeRequestWithSelectedCredential:completionHandler:] to provide the credential. If an error occurs, call -[ASCredentialProviderExtensionContext cancelRequestWithError:] and pass an error with domain ASExtensionErrorDomain and an appropriate error code from ASExtensionErrorCode. For example, if your extension requires user interaction because the passwords database needs to be unlocked, pass an error with code ASExtensionErrorCodeUserInteractionRequired.

Note: When this method is called, your extension’s view controller is not present on the screen. Do not attempt or expect to show any user interface in this method.

pub unsafe fn provideCredentialWithoutUserInteractionForRequest( &self, credential_request: &ProtocolObject<dyn ASCredentialRequest>, )

Available on macOS and crate feature ASCredentialRequest only.

Attempt to provide the user-requested credential without any user interaction.

After the user selects a credential identity, the system will create a credential request, the contents of which will depend on whether the credential to use is a password or passkey. The request type will match the type of credential that was requested. Refer to ASPasswordCredentialRequest, ASPasskeyCredentialRequest, and ASOneTimeCodeCredentialRequest for details.

The system may ask your extension to provide the credential without showing any user interface if possible to enhance the user experience. If your extension can accomplish this (for example, the user’s passwords database is still unlocked from a recent interaction), call -[ASCredentialProviderExtensionContext completeRequestWithSelectedCredential:completionHandler:] for password credentials, -[ASCredentialProviderExtensionContext completeAssertionRequestWithSelectedPasskeyCredential:completionHandler:] for passkey credentials, or -[ASCredentialProviderExtensionContext completeOneTimeCodeRequestWithSelectedCredential:completionHandler:] for one time code credentials. If an error occurs, call -[ASCredentialProviderExtensionContext cancelRequestWithError:] and pass an error with domain ASExtensionErrorDomain and an appropriate error code from ASExtensionErrorCode. For example, if your extension requires user interaction because the passwords database needs to be unlocked, pass an error with code ASExtensionErrorCodeUserInteractionRequired.

In order for your extension to be presented in the list of options for passkey assertion requests, your extension needs to specify a true value for the Information Property List key ProvidesPasskeys under the ASCredentialProviderExtensionCapabilities dictionary.

Info.plist ├─ NSExtension ├─ NSExtensionAttributes ├─ ASCredentialProviderExtensionCapabilities ├─ ProvidesPasskeys => true

Similarly, your extension needs to specify a true value for the Information Property List key ProvidesOneTimeCodes under the ASCredentialProviderExtensionCapabilities dictionary in order to be presented in the list of options for one time code requests.

• Note: When this method is called, your extension’s view controller is not present on the screen. Do not attempt or expect to show any user interface in this method.

• Parameter credentialRequest: The credential request for which a credential should be provided.

pub unsafe fn prepareInterfaceToProvideCredentialForIdentity( &self, credential_identity: &ASPasswordCredentialIdentity, )

👎Deprecated

Available on macOS and crate feature ASPasswordCredentialIdentity only.

Prepare the view controller to show user interface for providing the user-requested credential.

Parameter credentialIdentity: the credential identity for which a credential should be provided.

The system calls this method when your extension cannot provide the requested credential without user interaction. Set up the view controller for any user interaction required to provide the requested credential only. The user interaction should be limited in nature to operations required for providing the requested credential. An example is showing an authentication UI to unlock the user’s passwords database. Call -[ASCredentialProviderExtensionContext completeRequestWithSelectedCredential:completionHandler:] to provide the credential. If an error occurs, call -[ASCredentialProviderExtensionContext cancelRequestWithError:] and pass an error with domain ASExtensionErrorDomain and an appropriate error code from ASExtensionErrorCode. For example, if the credential identity cannot be found in the database, pass an error with code ASExtensionErrorCodeCredentialIdentityNotFound.

pub unsafe fn prepareInterfaceToProvideCredentialForRequest( &self, credential_request: &ProtocolObject<dyn ASCredentialRequest>, )

Available on macOS and crate feature ASCredentialRequest only.

Prepare the view controller to show user interface for providing the user-requested credential.

Parameter credentialRequest: the credential request for which a credential should be provided.

The system calls this method when your extension cannot provide the requested credential without user interaction. Set up the view controller for any user interaction required to provide the requested credential only. The user interaction should be limited in nature to operations required for providing the requested credential. An example is showing an authentication UI to unlock the user’s passwords database. Call -[ASCredentialProviderExtensionContext completeRequestWithSelectedCredential:completionHandler:] for password credentials or -[ASCredentialProviderExtensionContext completeAssertionRequestWithSelectedPasskeyCredential:completionHandler:] for passkey credentials. If an error occurs, call -[ASCredentialProviderExtensionContext cancelRequestWithError:] and pass an error with domain ASExtensionErrorDomain and an appropriate error code from ASExtensionErrorCode. For example, if the credential identity cannot be found in the database, pass an error with code ASExtensionErrorCodeCredentialIdentityNotFound.

pub unsafe fn prepareInterfaceForExtensionConfiguration(&self)

Available on macOS only.

Prepare the view controller to show user interface when the user enables your extension.

The system calls this method after your extension is enabled by the user in Settings. You can use this method to give the user a chance to configure the extension or to provide credential identities to the system. After the configuration is done, call -[ASCredentialProviderExtensionContext completeExtensionConfigurationRequest].

Note: This method only gets called if your extension supports this functionality by specifying “ASCredentialProviderExtensionShowsConfigurationUI”: YES in its extension attributes.

pub unsafe fn prepareInterfaceForPasskeyRegistration( &self, registration_request: &ProtocolObject<dyn ASCredentialRequest>, )

Available on macOS and crate feature ASCredentialRequest only.

Prepare UI to register a passkey for the specified relying party.

The system calls this method when the user selects your extension to use for creating a passkey. In order for your extension to be presented in the list of options for passkey registration requests, your extension needs to specify a true value for the Information Property List key ProvidesPasskeys under the ASCredentialProviderExtensionCapabilities dictionary.

Info.plist ├─ NSExtension ├─ NSExtensionAttributes ├─ ASCredentialProviderExtensionCapabilities ├─ ProvidesPasskeys => true

This method will present your extension’s UI for user authentication before creating the passkey. Once the passkey is created, your extension should call -[ASCredentialProviderExtensionContext completeRegistrationRequestWithSelectedPasskeyCredential:completionHandler:] with the newly created ASPasskeyCredential object. If an error occurs, call -[ASCredentialProviderExtensionContext cancelRequestWithError:] and pass an error with domain ASExtensionErrorDomain and an appropriate error code from ASExtensionErrorCode.

• Parameter registrationRequest: The passkey registration request parameters needed to register a new passkey.

pub unsafe fn performPasskeyRegistrationWithoutUserInteractionIfPossible( &self, registration_request: &ASPasskeyCredentialRequest, )

Available on macOS and crate feature ASPasskeyCredentialRequest only.

Perform a conditional passkey registration, if possible.

This method will be called for handling conditional passkey registration requests. A conditional passkey registration request allows your extension to opportunistically register passkeys in the background, if and only if you believe the user is in a good state to do so. Your extension decides can decide what conditions make sense for whether to fulfill or reject this request. For example, an extension may decide to register a passkey only if all of the following conditions are met:

• The user’s vault is currently unlocked.
• The user name for the registration request matches that for an existing saved password.
• The matching saved password was filled recently.
• The user does not already have a passkey for this account.

Fulfilling this request should not remove a user’s saved password for this account, but it may mean that the passkey will be preferred over the password in future AutoFill invocations, if both are supported.

Your extension should complete this request by calling -[ASCredentialProviderExtensionContext completeRegistrationRequestWithSelectedPasskeyCredential:completionHandler:] or-[ASCredentialProviderExtensionContext cancelRequestWithError:], like for standard registration requests. However, this request is not allowed to show UI and ASExtensionErrorCodeUserInteractionRequired will be treated like any other error. The intent of this API is to provide a method of performing a background registration only where easy and convenient, so no blocking UI or error should ever be shown.

To indicate support for this feature, add SupportsConditionalPasskeyRegistration under the ASCredentialProviderExtensionCapabilities dictionary.

Info.plist ├─ NSExtension ├─ NSExtensionAttributes ├─ ASCredentialProviderExtensionCapabilities ├─ SupportsConditionalPasskeyRegistration => true

impl ASCredentialProviderViewController

Methods declared on superclass NSViewController.

pub unsafe fn initWithNibName_bundle( this: Allocated<Self>, nib_name_or_nil: Option<&NSNibName>, nib_bundle_or_nil: Option<&NSBundle>, ) -> Retained<Self>

Available on macOS only.

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Available on macOS only.

impl ASCredentialProviderViewController

Methods declared on superclass NSResponder.

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

Available on macOS only.

impl ASCredentialProviderViewController

Methods declared on superclass NSObject.

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

Available on macOS only.

Methods from Deref<Target = ASViewController>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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

Trait Implementations

impl AsRef<ASCredentialProviderViewController> for ASCredentialProviderViewController

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<AnyObject> for ASCredentialProviderViewController

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for ASCredentialProviderViewController

fn as_ref(&self) -> &ASViewController

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for ASCredentialProviderViewController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ASCredentialProviderViewController

fn borrow(&self) -> &ASViewController

Immutably borrows from an owned value.

impl ClassType for ASCredentialProviderViewController

const NAME: &'static str = "ASCredentialProviderViewController"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for ASCredentialProviderViewController

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ASCredentialProviderViewController

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for ASCredentialProviderViewController

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for ASCredentialProviderViewController

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for ASCredentialProviderViewController

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

impl NSEditor for ASCredentialProviderViewController

unsafe fn discardEditing(&self)

where Self: Sized + Message,

unsafe fn commitEditing(&self) -> bool

where Self: Sized + Message,

unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

where Self: Sized + Message,

unsafe fn commitEditingAndReturnError(&self) -> Result<(), Retained<NSError>>

where Self: Sized + Message,

impl NSObjectProtocol for ASCredentialProviderViewController

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSeguePerforming for ASCredentialProviderViewController

unsafe fn prepareForSegue_sender( &self, segue: &NSStoryboardSegue, sender: Option<&AnyObject>, )

where Self: Sized + Message,

unsafe fn performSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, )

where Self: Sized + Message,

unsafe fn shouldPerformSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, ) -> bool

where Self: Sized + Message,

impl NSUserInterfaceItemIdentification for ASCredentialProviderViewController

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

where Self: Sized + Message,

unsafe fn setIdentifier(&self, identifier: Option<&NSString>)

where Self: Sized + Message,

Setter for identifier.

impl PartialEq for ASCredentialProviderViewController

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for ASCredentialProviderViewController

const ENCODING_REF: Encoding = <ASViewController as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for ASCredentialProviderViewController

impl Eq for ASCredentialProviderViewController