objc2_cloud_kit/generated/
CKFetchSubscriptionsOperation.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/cloudkit/ckfetchsubscriptionsoperation?language=objc)
12    #[unsafe(super(CKDatabaseOperation, CKOperation, NSOperation, NSObject))]
13    #[derive(Debug, PartialEq, Eq, Hash)]
14    #[cfg(all(feature = "CKDatabaseOperation", feature = "CKOperation"))]
15    pub struct CKFetchSubscriptionsOperation;
16);
17
18#[cfg(all(feature = "CKDatabaseOperation", feature = "CKOperation"))]
19extern_conformance!(
20    unsafe impl NSObjectProtocol for CKFetchSubscriptionsOperation {}
21);
22
23#[cfg(all(feature = "CKDatabaseOperation", feature = "CKOperation"))]
24impl CKFetchSubscriptionsOperation {
25    extern_methods!(
26        #[unsafe(method(fetchAllSubscriptionsOperation))]
27        #[unsafe(method_family = none)]
28        pub unsafe fn fetchAllSubscriptionsOperation() -> Retained<Self>;
29
30        #[unsafe(method(init))]
31        #[unsafe(method_family = init)]
32        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
33
34        #[cfg(feature = "CKSubscription")]
35        #[unsafe(method(initWithSubscriptionIDs:))]
36        #[unsafe(method_family = init)]
37        pub unsafe fn initWithSubscriptionIDs(
38            this: Allocated<Self>,
39            subscription_i_ds: &NSArray<CKSubscriptionID>,
40        ) -> Retained<Self>;
41
42        #[cfg(feature = "CKSubscription")]
43        #[unsafe(method(subscriptionIDs))]
44        #[unsafe(method_family = none)]
45        pub unsafe fn subscriptionIDs(&self) -> Option<Retained<NSArray<CKSubscriptionID>>>;
46
47        #[cfg(feature = "CKSubscription")]
48        /// Setter for [`subscriptionIDs`][Self::subscriptionIDs].
49        #[unsafe(method(setSubscriptionIDs:))]
50        #[unsafe(method_family = none)]
51        pub unsafe fn setSubscriptionIDs(
52            &self,
53            subscription_i_ds: Option<&NSArray<CKSubscriptionID>>,
54        );
55
56        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
57        /// Called on success or failure for each subscriptionID.
58        ///
59        ///
60        /// Each
61        /// `CKOperation`instance has a private serial queue. This queue is used for all callback block invocations.
62        /// This block may share mutable state with other blocks assigned to this operation, but any such mutable state
63        /// should not be concurrently used outside of blocks assigned to this operation.
64        #[unsafe(method(perSubscriptionCompletionBlock))]
65        #[unsafe(method_family = none)]
66        pub unsafe fn perSubscriptionCompletionBlock(
67            &self,
68        ) -> *mut block2::DynBlock<
69            dyn Fn(NonNull<CKSubscriptionID>, *mut CKSubscription, *mut NSError),
70        >;
71
72        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
73        /// Setter for [`perSubscriptionCompletionBlock`][Self::perSubscriptionCompletionBlock].
74        #[unsafe(method(setPerSubscriptionCompletionBlock:))]
75        #[unsafe(method_family = none)]
76        pub unsafe fn setPerSubscriptionCompletionBlock(
77            &self,
78            per_subscription_completion_block: Option<
79                &block2::DynBlock<
80                    dyn Fn(NonNull<CKSubscriptionID>, *mut CKSubscription, *mut NSError),
81                >,
82            >,
83        );
84
85        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
86        /// This block is called when the operation completes.
87        ///
88        ///
89        /// The
90        ///
91        /// ```text
92        ///  -[NSOperation completionBlock]
93        /// ```
94        ///
95        /// will also be called if both are set.
96        /// If the error is
97        /// `CKErrorPartialFailure,`the error's userInfo dictionary contains a dictionary of subscriptionID to errors keyed off of
98        /// `CKPartialErrorsByItemIDKey.``subscriptionsBySubscriptionID`and any
99        /// `CKPartialErrorsByItemIDKey`errors are repeats of the data sent back in previous
100        /// `perSubscriptionCompletionBlock`invocations
101        /// Each
102        /// `CKOperation`instance has a private serial queue. This queue is used for all callback block invocations.
103        /// This block may share mutable state with other blocks assigned to this operation, but any such mutable state
104        /// should not be concurrently used outside of blocks assigned to this operation.
105        #[unsafe(method(fetchSubscriptionCompletionBlock))]
106        #[unsafe(method_family = none)]
107        pub unsafe fn fetchSubscriptionCompletionBlock(
108            &self,
109        ) -> *mut block2::DynBlock<
110            dyn Fn(*mut NSDictionary<CKSubscriptionID, CKSubscription>, *mut NSError),
111        >;
112
113        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
114        /// Setter for [`fetchSubscriptionCompletionBlock`][Self::fetchSubscriptionCompletionBlock].
115        #[unsafe(method(setFetchSubscriptionCompletionBlock:))]
116        #[unsafe(method_family = none)]
117        pub unsafe fn setFetchSubscriptionCompletionBlock(
118            &self,
119            fetch_subscription_completion_block: Option<
120                &block2::DynBlock<
121                    dyn Fn(*mut NSDictionary<CKSubscriptionID, CKSubscription>, *mut NSError),
122                >,
123            >,
124        );
125    );
126}
127
128/// Methods declared on superclass `NSObject`.
129#[cfg(all(feature = "CKDatabaseOperation", feature = "CKOperation"))]
130impl CKFetchSubscriptionsOperation {
131    extern_methods!(
132        #[unsafe(method(new))]
133        #[unsafe(method_family = new)]
134        pub unsafe fn new() -> Retained<Self>;
135    );
136}
objc2_cloud_kit/generated/CKFetchSubscriptionsOperation.rs

objc2_cloud_kit/generated/
CKFetchSubscriptionsOperation.rs
