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