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

objc2_cloud_kit/generated/
CKFetchSubscriptionsOperation.rs
