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

objc2_cloud_kit/generated/
CKFetchRecordZonesOperation.rs
