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

objc2_cloud_kit/generated/
CKModifySubscriptionsOperation.rs
