objc2_intents/generated/
INCancelRideIntent.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10extern_class!(
11    /// [Apple's documentation](https://developer.apple.com/documentation/intents/incancelrideintent?language=objc)
12    #[unsafe(super(INIntent, NSObject))]
13    #[derive(Debug, PartialEq, Eq, Hash)]
14    #[cfg(feature = "INIntent")]
15    pub struct INCancelRideIntent;
16);
17
18#[cfg(feature = "INIntent")]
19extern_conformance!(
20    unsafe impl NSCoding for INCancelRideIntent {}
21);
22
23#[cfg(feature = "INIntent")]
24extern_conformance!(
25    unsafe impl NSCopying for INCancelRideIntent {}
26);
27
28#[cfg(feature = "INIntent")]
29unsafe impl CopyingHelper for INCancelRideIntent {
30    type Result = Self;
31}
32
33#[cfg(feature = "INIntent")]
34extern_conformance!(
35    unsafe impl NSObjectProtocol for INCancelRideIntent {}
36);
37
38#[cfg(feature = "INIntent")]
39extern_conformance!(
40    unsafe impl NSSecureCoding for INCancelRideIntent {}
41);
42
43#[cfg(feature = "INIntent")]
44impl INCancelRideIntent {
45    extern_methods!(
46        #[unsafe(method(init))]
47        #[unsafe(method_family = init)]
48        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
49
50        #[unsafe(method(initWithRideIdentifier:))]
51        #[unsafe(method_family = init)]
52        pub unsafe fn initWithRideIdentifier(
53            this: Allocated<Self>,
54            ride_identifier: &NSString,
55        ) -> Retained<Self>;
56
57        #[unsafe(method(rideIdentifier))]
58        #[unsafe(method_family = none)]
59        pub unsafe fn rideIdentifier(&self) -> Retained<NSString>;
60    );
61}
62
63/// Methods declared on superclass `NSObject`.
64#[cfg(feature = "INIntent")]
65impl INCancelRideIntent {
66    extern_methods!(
67        #[unsafe(method(new))]
68        #[unsafe(method_family = new)]
69        pub unsafe fn new() -> Retained<Self>;
70    );
71}
72
73extern_protocol!(
74    /// Protocol to declare support for handling an INCancelRideIntent. By implementing this protocol, a class can provide logic for confirming and handling the intent.
75    ///
76    /// The minimum requirement for an implementing class is that it should be able to confirm and handle the intent. The handling method is always called last, after confirming the intent.
77    ///
78    /// See also [Apple's documentation](https://developer.apple.com/documentation/intents/incancelrideintenthandling?language=objc)
79    pub unsafe trait INCancelRideIntentHandling: NSObjectProtocol {
80        #[cfg(all(
81            feature = "INCancelRideIntentResponse",
82            feature = "INIntent",
83            feature = "INIntentResponse",
84            feature = "block2"
85        ))]
86        /// Handling method - Execute the task represented by the INCancelRideIntent that's passed in
87        ///
88        /// Called to actually execute the intent. The app must return a response for this intent.
89        ///
90        ///
91        /// Parameter `intent`: The input intent
92        ///
93        /// Parameter `completion`: The response handling block takes a INCancelRideIntentResponse containing the details of the result of having executed the intent
94        ///
95        ///
96        /// See: INCancelRideIntentResponse
97        #[unsafe(method(handleCancelRide:completion:))]
98        #[unsafe(method_family = none)]
99        unsafe fn handleCancelRide_completion(
100            &self,
101            intent: &INCancelRideIntent,
102            completion: &block2::DynBlock<dyn Fn(NonNull<INCancelRideIntentResponse>)>,
103        );
104
105        #[cfg(all(
106            feature = "INCancelRideIntentResponse",
107            feature = "INIntent",
108            feature = "INIntentResponse",
109            feature = "block2"
110        ))]
111        /// Confirmation method - Validate that this intent is ready for the next step (i.e. handling)
112        ///
113        /// 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 may not use the cancel ride intent.
114        ///
115        ///
116        /// Parameter `intent`: The input intent
117        ///
118        /// Parameter `completion`: The response block contains an INCancelRideIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.
119        ///
120        ///
121        /// See: INCancelRideIntentResponse
122        #[optional]
123        #[unsafe(method(confirmCancelRide:completion:))]
124        #[unsafe(method_family = none)]
125        unsafe fn confirmCancelRide_completion(
126            &self,
127            intent: &INCancelRideIntent,
128            completion: &block2::DynBlock<dyn Fn(NonNull<INCancelRideIntentResponse>)>,
129        );
130    }
131);