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