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

objc2_cloud_kit/generated/
CKFetchRecordZonesOperation.rs
