objc2-intents 0.3.2

Bindings to the Intents framework
Documentation
//! 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::*;
use objc2_foundation::*;

use crate::*;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/intents/insetprofileincarintent?language=objc)
    #[unsafe(super(INIntent, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(feature = "INIntent")]
    #[deprecated = "INSetProfileInCarIntent is deprecated. There is no replacement."]
    pub struct INSetProfileInCarIntent;
);

#[cfg(feature = "INIntent")]
extern_conformance!(
    unsafe impl NSCoding for INSetProfileInCarIntent {}
);

#[cfg(feature = "INIntent")]
extern_conformance!(
    unsafe impl NSCopying for INSetProfileInCarIntent {}
);

#[cfg(feature = "INIntent")]
unsafe impl CopyingHelper for INSetProfileInCarIntent {
    type Result = Self;
}

#[cfg(feature = "INIntent")]
extern_conformance!(
    unsafe impl NSObjectProtocol for INSetProfileInCarIntent {}
);

#[cfg(feature = "INIntent")]
extern_conformance!(
    unsafe impl NSSecureCoding for INSetProfileInCarIntent {}
);

#[cfg(feature = "INIntent")]
impl INSetProfileInCarIntent {
    extern_methods!(
        #[cfg(feature = "INSpeakableString")]
        #[unsafe(method(initWithProfileNumber:profileName:defaultProfile:carName:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithProfileNumber_profileName_defaultProfile_carName(
            this: Allocated<Self>,
            profile_number: Option<&NSNumber>,
            profile_name: Option<&NSString>,
            default_profile: Option<&NSNumber>,
            car_name: Option<&INSpeakableString>,
        ) -> Retained<Self>;

        #[deprecated = "INSetProfileInCarIntent is deprecated. There is no replacement."]
        #[unsafe(method(profileNumber))]
        #[unsafe(method_family = none)]
        pub unsafe fn profileNumber(&self) -> Option<Retained<NSNumber>>;

        #[unsafe(method(profileName))]
        #[unsafe(method_family = none)]
        pub unsafe fn profileName(&self) -> Option<Retained<NSString>>;

        #[deprecated = "INSetProfileInCarIntent is deprecated. There is no replacement."]
        #[unsafe(method(defaultProfile))]
        #[unsafe(method_family = none)]
        pub unsafe fn defaultProfile(&self) -> Option<Retained<NSNumber>>;

        #[cfg(feature = "INSpeakableString")]
        #[unsafe(method(carName))]
        #[unsafe(method_family = none)]
        pub unsafe fn carName(&self) -> Option<Retained<INSpeakableString>>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(feature = "INIntent")]
impl INSetProfileInCarIntent {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

extern_protocol!(
    /// Protocol to declare support for handling an INSetProfileInCarIntent. By implementing this protocol, a class can provide logic for resolving, confirming and handling the intent.
    ///
    /// The minimum requirement for an implementing class is that it should be able to handle the intent. The resolution and confirmation methods are optional. The handling method is always called last, after resolving and confirming the intent.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/intents/insetprofileincarintenthandling?language=objc)
    #[deprecated = "INSetProfileInCarIntentHandling is deprecated. There is no replacement."]
    pub unsafe trait INSetProfileInCarIntentHandling: NSObjectProtocol {
        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResponse",
            feature = "INSetProfileInCarIntentResponse",
            feature = "block2"
        ))]
        /// Handling method - Execute the task represented by the INSetProfileInCarIntent that's passed in
        ///
        /// Called to actually execute the intent. The app must return a response for this intent.
        ///
        ///
        /// Parameter `intent`: The input intent
        ///
        /// Parameter `completion`: The response handling block takes a INSetProfileInCarIntentResponse containing the details of the result of having executed the intent
        ///
        ///
        /// See: INSetProfileInCarIntentResponse
        #[deprecated = "INSetProfileInCarIntentHandling is deprecated. There is no replacement."]
        #[unsafe(method(handleSetProfileInCar:completion:))]
        #[unsafe(method_family = none)]
        unsafe fn handleSetProfileInCar_completion(
            &self,
            intent: &INSetProfileInCarIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INSetProfileInCarIntentResponse>)>,
        );

        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResponse",
            feature = "INSetProfileInCarIntentResponse",
            feature = "block2"
        ))]
        /// Confirmation method - Validate that this intent is ready for the next step (i.e. handling)
        ///
        /// Called prior to asking the app to handle the intent. The app should return a response object that contains additional information about the intent, which may be relevant for the system to show the user prior to handling. If unimplemented, the system will assume the intent is valid following resolution, and will assume there is no additional information relevant to this intent.
        ///
        ///
        /// Parameter `intent`: The input intent
        ///
        /// Parameter `completion`: The response block contains an INSetProfileInCarIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.
        ///
        ///
        /// See: INSetProfileInCarIntentResponse
        #[deprecated = "INSetProfileInCarIntentHandling is deprecated. There is no replacement."]
        #[optional]
        #[unsafe(method(confirmSetProfileInCar:completion:))]
        #[unsafe(method_family = none)]
        unsafe fn confirmSetProfileInCar_completion(
            &self,
            intent: &INSetProfileInCarIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INSetProfileInCarIntentResponse>)>,
        );

        #[cfg(all(
            feature = "INIntegerResolutionResult",
            feature = "INIntent",
            feature = "INIntentResolutionResult",
            feature = "block2"
        ))]
        /// Resolution methods - Determine if this intent is ready for the next step (confirmation)
        ///
        /// Called to make sure the app extension is capable of handling this intent in its current form. This method is for validating if the intent needs any further fleshing out.
        ///
        ///
        /// Parameter `intent`: The input intent
        ///
        /// Parameter `completion`: The response block contains an INIntentResolutionResult for the parameter being resolved
        ///
        ///
        /// See: INIntentResolutionResult
        #[deprecated = "INSetProfileInCarIntentHandling is deprecated. There is no replacement."]
        #[optional]
        #[unsafe(method(resolveProfileNumberForSetProfileInCar:withCompletion:))]
        #[unsafe(method_family = none)]
        unsafe fn resolveProfileNumberForSetProfileInCar_withCompletion(
            &self,
            intent: &INSetProfileInCarIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INIntegerResolutionResult>)>,
        );

        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResolutionResult",
            feature = "INStringResolutionResult",
            feature = "block2"
        ))]
        #[optional]
        #[unsafe(method(resolveProfileNameForSetProfileInCar:withCompletion:))]
        #[unsafe(method_family = none)]
        unsafe fn resolveProfileNameForSetProfileInCar_withCompletion(
            &self,
            intent: &INSetProfileInCarIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INStringResolutionResult>)>,
        );

        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResolutionResult",
            feature = "INSpeakableStringResolutionResult",
            feature = "block2"
        ))]
        #[optional]
        #[unsafe(method(resolveCarNameForSetProfileInCar:withCompletion:))]
        #[unsafe(method_family = none)]
        unsafe fn resolveCarNameForSetProfileInCar_withCompletion(
            &self,
            intent: &INSetProfileInCarIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INSpeakableStringResolutionResult>)>,
        );

        #[cfg(all(
            feature = "INBooleanResolutionResult",
            feature = "INIntent",
            feature = "INIntentResolutionResult",
            feature = "block2"
        ))]
        #[deprecated = "The property doesn't need to be resolved"]
        #[optional]
        #[unsafe(method(resolveDefaultProfileForSetProfileInCar:withCompletion:))]
        #[unsafe(method_family = none)]
        unsafe fn resolveDefaultProfileForSetProfileInCar_withCompletion(
            &self,
            intent: &INSetProfileInCarIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INBooleanResolutionResult>)>,
        );
    }
);