objc2_cloud_kit/generated/
CKModifySubscriptionsOperation.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/ckmodifysubscriptionsoperation?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 CKModifySubscriptionsOperation;
16);
17
18#[cfg(all(feature = "CKDatabaseOperation", feature = "CKOperation"))]
19extern_conformance!(
20    unsafe impl NSObjectProtocol for CKModifySubscriptionsOperation {}
21);
22
23#[cfg(all(feature = "CKDatabaseOperation", feature = "CKOperation"))]
24impl CKModifySubscriptionsOperation {
25    extern_methods!(
26        #[unsafe(method(init))]
27        #[unsafe(method_family = init)]
28        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
29
30        #[cfg(feature = "CKSubscription")]
31        #[unsafe(method(initWithSubscriptionsToSave:subscriptionIDsToDelete:))]
32        #[unsafe(method_family = init)]
33        pub unsafe fn initWithSubscriptionsToSave_subscriptionIDsToDelete(
34            this: Allocated<Self>,
35            subscriptions_to_save: Option<&NSArray<CKSubscription>>,
36            subscription_i_ds_to_delete: Option<&NSArray<CKSubscriptionID>>,
37        ) -> Retained<Self>;
38
39        #[cfg(feature = "CKSubscription")]
40        #[unsafe(method(subscriptionsToSave))]
41        #[unsafe(method_family = none)]
42        pub unsafe fn subscriptionsToSave(&self) -> Option<Retained<NSArray<CKSubscription>>>;
43
44        #[cfg(feature = "CKSubscription")]
45        /// Setter for [`subscriptionsToSave`][Self::subscriptionsToSave].
46        #[unsafe(method(setSubscriptionsToSave:))]
47        #[unsafe(method_family = none)]
48        pub unsafe fn setSubscriptionsToSave(
49            &self,
50            subscriptions_to_save: Option<&NSArray<CKSubscription>>,
51        );
52
53        #[cfg(feature = "CKSubscription")]
54        #[unsafe(method(subscriptionIDsToDelete))]
55        #[unsafe(method_family = none)]
56        pub unsafe fn subscriptionIDsToDelete(&self)
57            -> Option<Retained<NSArray<CKSubscriptionID>>>;
58
59        #[cfg(feature = "CKSubscription")]
60        /// Setter for [`subscriptionIDsToDelete`][Self::subscriptionIDsToDelete].
61        #[unsafe(method(setSubscriptionIDsToDelete:))]
62        #[unsafe(method_family = none)]
63        pub unsafe fn setSubscriptionIDsToDelete(
64            &self,
65            subscription_i_ds_to_delete: Option<&NSArray<CKSubscriptionID>>,
66        );
67
68        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
69        /// Called on success or failure of a subscription save
70        ///
71        ///
72        /// Each
73        /// `CKOperation`instance has a private serial queue. This queue is used for all callback block invocations.
74        /// This block may share mutable state with other blocks assigned to this operation, but any such mutable state
75        /// should not be concurrently used outside of blocks assigned to this operation.
76        #[unsafe(method(perSubscriptionSaveBlock))]
77        #[unsafe(method_family = none)]
78        pub unsafe fn perSubscriptionSaveBlock(
79            &self,
80        ) -> *mut block2::DynBlock<
81            dyn Fn(NonNull<CKSubscriptionID>, *mut CKSubscription, *mut NSError),
82        >;
83
84        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
85        /// Setter for [`perSubscriptionSaveBlock`][Self::perSubscriptionSaveBlock].
86        #[unsafe(method(setPerSubscriptionSaveBlock:))]
87        #[unsafe(method_family = none)]
88        pub unsafe fn setPerSubscriptionSaveBlock(
89            &self,
90            per_subscription_save_block: Option<
91                &block2::DynBlock<
92                    dyn Fn(NonNull<CKSubscriptionID>, *mut CKSubscription, *mut NSError),
93                >,
94            >,
95        );
96
97        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
98        /// Called on success or failure of a subscription deletion
99        ///
100        ///
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(perSubscriptionDeleteBlock))]
106        #[unsafe(method_family = none)]
107        pub unsafe fn perSubscriptionDeleteBlock(
108            &self,
109        ) -> *mut block2::DynBlock<dyn Fn(NonNull<CKSubscriptionID>, *mut NSError)>;
110
111        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
112        /// Setter for [`perSubscriptionDeleteBlock`][Self::perSubscriptionDeleteBlock].
113        #[unsafe(method(setPerSubscriptionDeleteBlock:))]
114        #[unsafe(method_family = none)]
115        pub unsafe fn setPerSubscriptionDeleteBlock(
116            &self,
117            per_subscription_delete_block: Option<
118                &block2::DynBlock<dyn Fn(NonNull<CKSubscriptionID>, *mut NSError)>,
119            >,
120        );
121
122        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
123        /// This block is called when the operation completes.
124        ///
125        ///
126        /// The
127        ///
128        /// ```text
129        ///  -[NSOperation completionBlock]
130        /// ```
131        ///
132        /// will also be called if both are set.
133        /// If the error is
134        /// `CKErrorPartialFailure,`the error's userInfo dictionary contains a dictionary of subscriptionIDs to errors keyed off of
135        /// `CKPartialErrorsByItemIDKey.``savedSubscriptions,``deletedSubscriptionIDs`and any
136        /// `CKPartialErrorsByItemIDKey`errors are repeats of the data sent back in previous
137        /// `perSubscriptionSaveBlock`and
138        /// `perSubscriptionDeleteBlock`invocations
139        /// Each
140        /// `CKOperation`instance has a private serial queue. This queue is used for all callback block invocations.
141        /// This block may share mutable state with other blocks assigned to this operation, but any such mutable state
142        /// should not be concurrently used outside of blocks assigned to this operation.
143        #[unsafe(method(modifySubscriptionsCompletionBlock))]
144        #[unsafe(method_family = none)]
145        pub unsafe fn modifySubscriptionsCompletionBlock(
146            &self,
147        ) -> *mut block2::DynBlock<
148            dyn Fn(*mut NSArray<CKSubscription>, *mut NSArray<CKSubscriptionID>, *mut NSError),
149        >;
150
151        #[cfg(all(feature = "CKSubscription", feature = "block2"))]
152        /// Setter for [`modifySubscriptionsCompletionBlock`][Self::modifySubscriptionsCompletionBlock].
153        #[unsafe(method(setModifySubscriptionsCompletionBlock:))]
154        #[unsafe(method_family = none)]
155        pub unsafe fn setModifySubscriptionsCompletionBlock(
156            &self,
157            modify_subscriptions_completion_block: Option<
158                &block2::DynBlock<
159                    dyn Fn(
160                        *mut NSArray<CKSubscription>,
161                        *mut NSArray<CKSubscriptionID>,
162                        *mut NSError,
163                    ),
164                >,
165            >,
166        );
167    );
168}
169
170/// Methods declared on superclass `NSObject`.
171#[cfg(all(feature = "CKDatabaseOperation", feature = "CKOperation"))]
172impl CKModifySubscriptionsOperation {
173    extern_methods!(
174        #[unsafe(method(new))]
175        #[unsafe(method_family = new)]
176        pub unsafe fn new() -> Retained<Self>;
177    );
178}
objc2_cloud_kit/generated/CKModifySubscriptionsOperation.rs

objc2_cloud_kit/generated/
CKModifySubscriptionsOperation.rs
