objc2_authentication_services/generated/

ASCredentialProviderViewController.rs

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
#[cfg(target_os = "macos")]
use objc2_app_kit::*;
use objc2_foundation::*;

use crate::*;

#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSCoding for ASCredentialProviderViewController {}
);

#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSEditor for ASCredentialProviderViewController {}
);

#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSObjectProtocol for ASCredentialProviderViewController {}
);

#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSSeguePerforming for ASCredentialProviderViewController {}
);

#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSUserInterfaceItemIdentification for ASCredentialProviderViewController {}
);

#[cfg(target_os = "macos")]
impl ASCredentialProviderViewController {
    extern_methods!(
        #[cfg(feature = "ASCredentialProviderExtensionContext")]
        #[unsafe(method(extensionContext))]
        #[unsafe(method_family = none)]
        pub unsafe fn extensionContext(&self) -> Retained<ASCredentialProviderExtensionContext>;

        #[cfg(feature = "ASCredentialServiceIdentifier")]
        /// 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.
        #[unsafe(method(prepareCredentialListForServiceIdentifiers:))]
        #[unsafe(method_family = none)]
        pub unsafe fn prepareCredentialListForServiceIdentifiers(
            &self,
            service_identifiers: &NSArray<ASCredentialServiceIdentifier>,
        );

        #[cfg(all(
            feature = "ASCredentialServiceIdentifier",
            feature = "ASPasskeyCredentialRequestParameters"
        ))]
        /// 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.
        #[unsafe(method(prepareCredentialListForServiceIdentifiers:requestParameters:))]
        #[unsafe(method_family = none)]
        pub unsafe fn prepareCredentialListForServiceIdentifiers_requestParameters(
            &self,
            service_identifiers: &NSArray<ASCredentialServiceIdentifier>,
            request_parameters: &ASPasskeyCredentialRequestParameters,
        );

        #[cfg(feature = "ASCredentialServiceIdentifier")]
        /// 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.
        #[unsafe(method(prepareOneTimeCodeCredentialListForServiceIdentifiers:))]
        #[unsafe(method_family = none)]
        pub unsafe fn prepareOneTimeCodeCredentialListForServiceIdentifiers(
            &self,
            service_identifiers: &NSArray<ASCredentialServiceIdentifier>,
        );

        #[cfg(feature = "ASPasswordCredentialIdentity")]
        /// 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.
        #[deprecated]
        #[unsafe(method(provideCredentialWithoutUserInteractionForIdentity:))]
        #[unsafe(method_family = none)]
        pub unsafe fn provideCredentialWithoutUserInteractionForIdentity(
            &self,
            credential_identity: &ASPasswordCredentialIdentity,
        );

        #[cfg(feature = "ASCredentialRequest")]
        /// 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.
        #[unsafe(method(provideCredentialWithoutUserInteractionForRequest:))]
        #[unsafe(method_family = none)]
        pub unsafe fn provideCredentialWithoutUserInteractionForRequest(
            &self,
            credential_request: &ProtocolObject<dyn ASCredentialRequest>,
        );

        #[cfg(feature = "ASPasswordCredentialIdentity")]
        /// 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.
        #[deprecated]
        #[unsafe(method(prepareInterfaceToProvideCredentialForIdentity:))]
        #[unsafe(method_family = none)]
        pub unsafe fn prepareInterfaceToProvideCredentialForIdentity(
            &self,
            credential_identity: &ASPasswordCredentialIdentity,
        );

        #[cfg(feature = "ASCredentialRequest")]
        /// 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.
        #[unsafe(method(prepareInterfaceToProvideCredentialForRequest:))]
        #[unsafe(method_family = none)]
        pub unsafe fn prepareInterfaceToProvideCredentialForRequest(
            &self,
            credential_request: &ProtocolObject<dyn ASCredentialRequest>,
        );

        /// 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.
        #[unsafe(method(prepareInterfaceForExtensionConfiguration))]
        #[unsafe(method_family = none)]
        pub unsafe fn prepareInterfaceForExtensionConfiguration(&self);

        #[cfg(feature = "ASCredentialRequest")]
        /// 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.
        #[unsafe(method(prepareInterfaceForPasskeyRegistration:))]
        #[unsafe(method_family = none)]
        pub unsafe fn prepareInterfaceForPasskeyRegistration(
            &self,
            registration_request: &ProtocolObject<dyn ASCredentialRequest>,
        );

        #[cfg(feature = "ASPasskeyCredentialRequest")]
        /// 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
        #[unsafe(method(performPasskeyRegistrationWithoutUserInteractionIfPossible:))]
        #[unsafe(method_family = none)]
        pub unsafe fn performPasskeyRegistrationWithoutUserInteractionIfPossible(
            &self,
            registration_request: &ASPasskeyCredentialRequest,
        );

        /// Receive report when a relying party indicates that a passkey's user name was updated.
        ///
        /// This method will be called for handling passkey updates when a relying party reports an update using the `ASCredentialUpdater` API.
        /// This update should be handled in the background, so no blocking UI or error should ever be shown.
        ///
        /// - Parameter relyingParty: Relying party (website) that the crendential is saved for.
        /// - Parameter userHandle: User identifier.
        /// - Parameter newName: The new user name for the credential.
        ///
        /// To indicate support for this feature, add `SupportsCredentialUpdate` under the
        /// `ASCredentialProviderExtensionCapabilities` dictionary.
        ///
        /// Info.plist
        /// ├─ NSExtension
        /// ├─ NSExtensionAttributes
        /// ├─ ASCredentialProviderExtensionCapabilities
        /// ├─ SupportsCredentialUpdate => true
        #[unsafe(method(reportPublicKeyCredentialUpdateForRelyingParty:userHandle:newName:))]
        #[unsafe(method_family = none)]
        pub unsafe fn reportPublicKeyCredentialUpdateForRelyingParty_userHandle_newName(
            &self,
            relying_party: &NSString,
            user_handle: &NSData,
            new_name: &NSString,
        );

        /// Receive report when a relying party indicates an invalid passkey credential.
        ///
        /// This method will be called for handling passkey updates when a relying party reports the credential is no longer valid using the `ASCredentialUpdater` API.
        /// You may hide or remove this credential.
        /// This update should be handled in the background, so no blocking UI or error should ever be shown.
        ///
        /// - Parameter relyingParty: Relying party (website) that the crendential is saved for.
        /// - Parameter credentialID: An identifier that uniquely identifies the passkey.
        ///
        /// To indicate support for this feature, add `SupportsCredentialUpdate` under the
        /// `ASCredentialProviderExtensionCapabilities` dictionary.
        ///
        /// Info.plist
        /// ├─ NSExtension
        /// ├─ NSExtensionAttributes
        /// ├─ ASCredentialProviderExtensionCapabilities
        /// ├─ SupportsCredentialUpdate => true
        #[unsafe(method(reportUnknownPublicKeyCredentialForRelyingParty:credentialID:))]
        #[unsafe(method_family = none)]
        pub unsafe fn reportUnknownPublicKeyCredentialForRelyingParty_credentialID(
            &self,
            relying_party: &NSString,
            credential_id: &NSData,
        );

        /// Receive report when relying party sends a snapshot of all the accepted credentials for an account.
        ///
        /// This method will be called for handling passkey updates when a relying party sends a list of accepted credentials using the `ASCredentialUpdater` API.
        /// You may hide or remove any credential not present in the accepted credentials list.
        /// This update should be handled in the background, so no blocking UI or error should ever be shown.
        ///
        /// - Parameter relyingParty: Relying party (website) that the crendential is saved for.
        /// - Parameter userHandle: User identifier.
        /// - Parameter acceptedCredentialIDs: An array of identifiers that uniquely identifies the accepted credentials.
        ///
        /// To indicate support for this feature, add `SupportsCredentialUpdate` under the
        /// `ASCredentialProviderExtensionCapabilities` dictionary.
        ///
        /// Info.plist
        /// ├─ NSExtension
        /// ├─ NSExtensionAttributes
        /// ├─ ASCredentialProviderExtensionCapabilities
        /// ├─ SupportsCredentialUpdate => true
        #[unsafe(method(reportAllAcceptedPublicKeyCredentialsForRelyingParty:userHandle:acceptedCredentialIDs:))]
        #[unsafe(method_family = none)]
        pub unsafe fn reportAllAcceptedPublicKeyCredentialsForRelyingParty_userHandle_acceptedCredentialIDs(
            &self,
            relying_party: &NSString,
            user_handle: &NSData,
            accepted_credential_i_ds: &NSArray<NSData>,
        );

        /// Receive report when relying party indicates a password credential is no longer needed for a given user name.
        ///
        /// This method will be called for handling password credential updates when a relying party indicates a password is no longer needed using the `ASCredentialUpdater` API.
        /// You may hide or remove the credential.
        /// This update should be handled in the background, so no blocking UI or error should ever be shown.
        ///
        /// - Parameter domain: The website domain that the credential is saved for.
        /// - Parameter userName: The account user name.
        ///
        /// To indicate support for this feature, add `SupportsCredentialUpdate` under the
        /// `ASCredentialProviderExtensionCapabilities` dictionary.
        ///
        /// Info.plist
        /// ├─ NSExtension
        /// ├─ NSExtensionAttributes
        /// ├─ ASCredentialProviderExtensionCapabilities
        /// ├─ SupportsCredentialUpdate => true
        #[unsafe(method(reportUnusedPasswordCredentialForDomain:userName:))]
        #[unsafe(method_family = none)]
        pub unsafe fn reportUnusedPasswordCredentialForDomain_userName(
            &self,
            domain: &NSString,
            user_name: &NSString,
        );
    );
}

/// Methods declared on superclass `NSViewController`.
#[cfg(target_os = "macos")]
impl ASCredentialProviderViewController {
    extern_methods!(
        #[unsafe(method(initWithNibName:bundle:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithNibName_bundle(
            this: Allocated<Self>,
            nib_name_or_nil: Option<&NSNibName>,
            nib_bundle_or_nil: Option<&NSBundle>,
        ) -> Retained<Self>;

        /// # Safety
        ///
        /// `coder` possibly has further requirements.
        #[unsafe(method(initWithCoder:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCoder(
            this: Allocated<Self>,
            coder: &NSCoder,
        ) -> Option<Retained<Self>>;
    );
}

/// Methods declared on superclass `NSResponder`.
#[cfg(target_os = "macos")]
impl ASCredentialProviderViewController {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(target_os = "macos")]
impl ASCredentialProviderViewController {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>;
    );
}