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::*;
#[cfg(feature = "objc2-core-location")]
use objc2_core_location::*;
use objc2_foundation::*;

use crate::*;

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

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

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

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

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

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

#[cfg(feature = "INIntent")]
impl INRequestRideIntent {
    extern_methods!(
        #[cfg(all(
            feature = "INDateComponentsRange",
            feature = "INPaymentMethod",
            feature = "INSpeakableString",
            feature = "objc2-core-location"
        ))]
        #[unsafe(method(initWithPickupLocation:dropOffLocation:rideOptionName:partySize:paymentMethod:scheduledPickupTime:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithPickupLocation_dropOffLocation_rideOptionName_partySize_paymentMethod_scheduledPickupTime(
            this: Allocated<Self>,
            pickup_location: Option<&CLPlacemark>,
            drop_off_location: Option<&CLPlacemark>,
            ride_option_name: Option<&INSpeakableString>,
            party_size: Option<&NSNumber>,
            payment_method: Option<&INPaymentMethod>,
            scheduled_pickup_time: Option<&INDateComponentsRange>,
        ) -> Retained<Self>;

        #[cfg(feature = "objc2-core-location")]
        #[unsafe(method(pickupLocation))]
        #[unsafe(method_family = none)]
        pub unsafe fn pickupLocation(&self) -> Option<Retained<CLPlacemark>>;

        #[cfg(feature = "objc2-core-location")]
        #[unsafe(method(dropOffLocation))]
        #[unsafe(method_family = none)]
        pub unsafe fn dropOffLocation(&self) -> Option<Retained<CLPlacemark>>;

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

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

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

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

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

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

        #[cfg(all(
            feature = "INIntent",
            feature = "INIntentResolutionResult",
            feature = "INPlacemarkResolutionResult",
            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(resolvePickupLocationForRequestRide:withCompletion:))]
        #[unsafe(method_family = none)]
        unsafe fn resolvePickupLocationForRequestRide_withCompletion(
            &self,
            intent: &INRequestRideIntent,
            completion: &block2::DynBlock<dyn Fn(NonNull<INPlacemarkResolutionResult>)>,
        );

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

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

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

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