objc2-intents 0.3.2

//! 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/instartworkoutintent?language=objc)
    #[unsafe(super(INIntent, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(feature = "INIntent")]
    pub struct INStartWorkoutIntent;
);

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

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

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

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

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

#[cfg(feature = "INIntent")]
impl INStartWorkoutIntent {
    extern_methods!(
        #[cfg(all(
            feature = "INSpeakableString",
            feature = "INWorkoutGoalUnitType",
            feature = "INWorkoutLocationType"
        ))]
        #[unsafe(method(initWithWorkoutName:goalValue:workoutGoalUnitType:workoutLocationType:isOpenEnded:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithWorkoutName_goalValue_workoutGoalUnitType_workoutLocationType_isOpenEnded(
            this: Allocated<Self>,
            workout_name: Option<&INSpeakableString>,
            goal_value: Option<&NSNumber>,
            workout_goal_unit_type: INWorkoutGoalUnitType,
            workout_location_type: INWorkoutLocationType,
            is_open_ended: Option<&NSNumber>,
        ) -> Retained<Self>;

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

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

        #[cfg(feature = "INWorkoutGoalUnitType")]
        #[unsafe(method(workoutGoalUnitType))]
        #[unsafe(method_family = none)]
        pub unsafe fn workoutGoalUnitType(&self) -> INWorkoutGoalUnitType;

        #[cfg(feature = "INWorkoutLocationType")]
        #[unsafe(method(workoutLocationType))]
        #[unsafe(method_family = none)]
        pub unsafe fn workoutLocationType(&self) -> INWorkoutLocationType;

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

/// Methods declared on superclass `NSObject`.
#[cfg(feature = "INIntent")]
impl INStartWorkoutIntent {
    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 INStartWorkoutIntent. 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/instartworkoutintenthandling?language=objc)
    pub unsafe trait INStartWorkoutIntentHandling: NSObjectProtocol {
        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResponse",
            feature = "INStartWorkoutIntentResponse",
            feature = "block2"
        ))]
        /// Handling method - Execute the task represented by the INStartWorkoutIntent 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 INStartWorkoutIntentResponse containing the details of the result of having executed the intent
        ///
        ///
        /// See: INStartWorkoutIntentResponse
        #[unsafe(method(handleStartWorkout:completion:))]
        #[unsafe(method_family = none)]
        unsafe fn handleStartWorkout_completion(
            &self,
            intent: &INStartWorkoutIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INStartWorkoutIntentResponse>)>,
        );

        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResponse",
            feature = "INStartWorkoutIntentResponse",
            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 INStartWorkoutIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.
        ///
        ///
        /// See: INStartWorkoutIntentResponse
        #[optional]
        #[unsafe(method(confirmStartWorkout:completion:))]
        #[unsafe(method_family = none)]
        unsafe fn confirmStartWorkout_completion(
            &self,
            intent: &INStartWorkoutIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INStartWorkoutIntentResponse>)>,
        );

        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResolutionResult",
            feature = "INSpeakableStringResolutionResult",
            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
        #[optional]
        #[unsafe(method(resolveWorkoutNameForStartWorkout:withCompletion:))]
        #[unsafe(method_family = none)]
        unsafe fn resolveWorkoutNameForStartWorkout_withCompletion(
            &self,
            intent: &INStartWorkoutIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INSpeakableStringResolutionResult>)>,
        );

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

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

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

        #[cfg(all(
            feature = "INBooleanResolutionResult",
            feature = "INIntent",
            feature = "INIntentResolutionResult",
            feature = "block2"
        ))]
        #[optional]
        #[unsafe(method(resolveIsOpenEndedForStartWorkout:withCompletion:))]
        #[unsafe(method_family = none)]
        unsafe fn resolveIsOpenEndedForStartWorkout_withCompletion(
            &self,
            intent: &INStartWorkoutIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INBooleanResolutionResult>)>,
        );
    }
);