objc2-pass-kit 0.3.2

Bindings to the PassKit framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;

use crate::*;

/// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryaddpassesstatus?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PKPassLibraryAddPassesStatus(pub NSInteger);
impl PKPassLibraryAddPassesStatus {
    #[doc(alias = "PKPassLibraryDidAddPasses")]
    pub const DidAddPasses: Self = Self(0);
    #[doc(alias = "PKPassLibraryShouldReviewPasses")]
    pub const ShouldReviewPasses: Self = Self(1);
    #[doc(alias = "PKPassLibraryDidCancelAddPasses")]
    pub const DidCancelAddPasses: Self = Self(2);
}

unsafe impl Encode for PKPassLibraryAddPassesStatus {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PKPassLibraryAddPassesStatus {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkautomaticpasspresentationsuppressionresult?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PKAutomaticPassPresentationSuppressionResult(pub NSUInteger);
impl PKAutomaticPassPresentationSuppressionResult {
    #[doc(alias = "PKAutomaticPassPresentationSuppressionResultNotSupported")]
    pub const NotSupported: Self = Self(0);
    #[doc(alias = "PKAutomaticPassPresentationSuppressionResultAlreadyPresenting")]
    pub const AlreadyPresenting: Self = Self(1);
    #[doc(alias = "PKAutomaticPassPresentationSuppressionResultDenied")]
    pub const Denied: Self = Self(2);
    #[doc(alias = "PKAutomaticPassPresentationSuppressionResultCancelled")]
    pub const Cancelled: Self = Self(3);
    #[doc(alias = "PKAutomaticPassPresentationSuppressionResultSuccess")]
    pub const Success: Self = Self(4);
}

unsafe impl Encode for PKAutomaticPassPresentationSuppressionResult {
    const ENCODING: Encoding = NSUInteger::ENCODING;
}

unsafe impl RefEncode for PKAutomaticPassPresentationSuppressionResult {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibrarycapability?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PKPassLibraryCapability(pub NSInteger);
impl PKPassLibraryCapability {
    #[doc(alias = "PKPassLibraryCapabilityBackgroundAddPasses")]
    pub const BackgroundAddPasses: Self = Self(0);
}

unsafe impl Encode for PKPassLibraryCapability {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PKPassLibraryCapability {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryauthorizationstatus?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PKPassLibraryAuthorizationStatus(pub NSInteger);
impl PKPassLibraryAuthorizationStatus {
    #[doc(alias = "PKPassLibraryAuthorizationStatusNotDetermined")]
    pub const NotDetermined: Self = Self(-1);
    #[doc(alias = "PKPassLibraryAuthorizationStatusDenied")]
    pub const Denied: Self = Self(0);
    #[doc(alias = "PKPassLibraryAuthorizationStatusAuthorized")]
    pub const Authorized: Self = Self(1);
    #[doc(alias = "PKPassLibraryAuthorizationStatusRestricted")]
    pub const Restricted: Self = Self(2);
}

unsafe impl Encode for PKPassLibraryAuthorizationStatus {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PKPassLibraryAuthorizationStatus {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// [Apple's documentation](https://developer.apple.com/documentation/passkit/pksuppressionrequesttoken?language=objc)
pub type PKSuppressionRequestToken = NSUInteger;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibrary?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct PKPassLibrary;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for PKPassLibrary {}
);

impl PKPassLibrary {
    extern_methods!(
        #[unsafe(method(isPassLibraryAvailable))]
        #[unsafe(method_family = none)]
        pub unsafe fn isPassLibraryAvailable() -> bool;

        #[cfg(feature = "block2")]
        #[unsafe(method(requestAutomaticPassPresentationSuppressionWithResponseHandler:))]
        #[unsafe(method_family = none)]
        pub unsafe fn requestAutomaticPassPresentationSuppressionWithResponseHandler(
            response_handler: &block2::DynBlock<
                dyn Fn(PKAutomaticPassPresentationSuppressionResult),
            >,
        ) -> PKSuppressionRequestToken;

        #[unsafe(method(endAutomaticPassPresentationSuppressionWithRequestToken:))]
        #[unsafe(method_family = none)]
        pub unsafe fn endAutomaticPassPresentationSuppressionWithRequestToken(
            request_token: PKSuppressionRequestToken,
        );

        #[unsafe(method(isSuppressingAutomaticPassPresentation))]
        #[unsafe(method_family = none)]
        pub unsafe fn isSuppressingAutomaticPassPresentation() -> bool;

        #[deprecated = "Use -[PKPassLibrary isPaymentPassActivationAvailable] instead"]
        #[unsafe(method(isPaymentPassActivationAvailable))]
        #[unsafe(method_family = none)]
        pub unsafe fn isPaymentPassActivationAvailable_class() -> bool;

        #[deprecated = "Use -[PKPassLibrary isSecureElementPassActivationAvailable] instead"]
        #[unsafe(method(isPaymentPassActivationAvailable))]
        #[unsafe(method_family = none)]
        pub unsafe fn isPaymentPassActivationAvailable(&self) -> bool;

        #[unsafe(method(isSecureElementPassActivationAvailable))]
        #[unsafe(method_family = none)]
        pub unsafe fn isSecureElementPassActivationAvailable(&self) -> bool;

        #[cfg(all(feature = "PKObject", feature = "PKPass"))]
        #[unsafe(method(passes))]
        #[unsafe(method_family = none)]
        pub unsafe fn passes(&self) -> Retained<NSArray<PKPass>>;

        #[cfg(all(feature = "PKObject", feature = "PKPass"))]
        #[unsafe(method(passWithPassTypeIdentifier:serialNumber:))]
        #[unsafe(method_family = none)]
        pub unsafe fn passWithPassTypeIdentifier_serialNumber(
            &self,
            identifier: &NSString,
            serial_number: &NSString,
        ) -> Option<Retained<PKPass>>;

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKSecureElementPass"
        ))]
        #[unsafe(method(passesWithReaderIdentifier:))]
        #[unsafe(method_family = none)]
        pub unsafe fn passesWithReaderIdentifier(
            &self,
            reader_identifier: &NSString,
        ) -> Retained<NSSet<PKSecureElementPass>>;

        #[cfg(all(feature = "PKObject", feature = "PKPass", feature = "PKPass_Types"))]
        #[unsafe(method(passesOfType:))]
        #[unsafe(method_family = none)]
        pub unsafe fn passesOfType(&self, pass_type: PKPassType) -> Retained<NSArray<PKPass>>;

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKPaymentPass",
            feature = "PKSecureElementPass"
        ))]
        #[deprecated = "Use -[PKPassLibrary remoteSecureElementPasses] instead"]
        #[unsafe(method(remotePaymentPasses))]
        #[unsafe(method_family = none)]
        pub unsafe fn remotePaymentPasses(&self) -> Retained<NSArray<PKPaymentPass>>;

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKSecureElementPass"
        ))]
        #[unsafe(method(remoteSecureElementPasses))]
        #[unsafe(method_family = none)]
        pub unsafe fn remoteSecureElementPasses(&self) -> Retained<NSArray<PKSecureElementPass>>;

        #[cfg(all(feature = "PKObject", feature = "PKPass"))]
        #[unsafe(method(removePass:))]
        #[unsafe(method_family = none)]
        pub unsafe fn removePass(&self, pass: &PKPass);

        #[cfg(all(feature = "PKObject", feature = "PKPass"))]
        #[unsafe(method(containsPass:))]
        #[unsafe(method_family = none)]
        pub unsafe fn containsPass(&self, pass: &PKPass) -> bool;

        #[cfg(all(feature = "PKObject", feature = "PKPass"))]
        #[unsafe(method(replacePassWithPass:))]
        #[unsafe(method_family = none)]
        pub unsafe fn replacePassWithPass(&self, pass: &PKPass) -> bool;

        #[cfg(all(feature = "PKObject", feature = "PKPass", feature = "block2"))]
        #[unsafe(method(addPasses:withCompletionHandler:))]
        #[unsafe(method_family = none)]
        pub unsafe fn addPasses_withCompletionHandler(
            &self,
            passes: &NSArray<PKPass>,
            completion: Option<&block2::DynBlock<dyn Fn(PKPassLibraryAddPassesStatus)>>,
        );

        #[unsafe(method(openPaymentSetup))]
        #[unsafe(method_family = none)]
        pub unsafe fn openPaymentSetup(&self);

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKPaymentPass",
            feature = "PKSecureElementPass"
        ))]
        #[deprecated = "Use -[PKPassLibrary presentSecureElementPass:] instead"]
        #[unsafe(method(presentPaymentPass:))]
        #[unsafe(method_family = none)]
        pub unsafe fn presentPaymentPass(&self, pass: &PKPaymentPass);

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKSecureElementPass"
        ))]
        #[unsafe(method(presentSecureElementPass:))]
        #[unsafe(method_family = none)]
        pub unsafe fn presentSecureElementPass(&self, pass: &PKSecureElementPass);

        #[deprecated = "Use -[PKPassLibrary canAddSecureElementPassWithPrimaryAccountIdentifier] instead"]
        #[unsafe(method(canAddPaymentPassWithPrimaryAccountIdentifier:))]
        #[unsafe(method_family = none)]
        pub unsafe fn canAddPaymentPassWithPrimaryAccountIdentifier(
            &self,
            primary_account_identifier: &NSString,
        ) -> bool;

        #[unsafe(method(canAddSecureElementPassWithPrimaryAccountIdentifier:))]
        #[unsafe(method_family = none)]
        pub unsafe fn canAddSecureElementPassWithPrimaryAccountIdentifier(
            &self,
            primary_account_identifier: &NSString,
        ) -> bool;

        #[unsafe(method(canAddFelicaPass))]
        #[unsafe(method_family = none)]
        pub unsafe fn canAddFelicaPass(&self) -> bool;

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKPaymentPass",
            feature = "PKSecureElementPass",
            feature = "block2"
        ))]
        #[deprecated = "Use activateSecureElementPass:withActivationData:completion: instead"]
        #[unsafe(method(activatePaymentPass:withActivationData:completion:))]
        #[unsafe(method_family = none)]
        pub unsafe fn activatePaymentPass_withActivationData_completion(
            &self,
            payment_pass: &PKPaymentPass,
            activation_data: &NSData,
            completion: Option<&block2::DynBlock<dyn Fn(Bool, NonNull<NSError>)>>,
        );

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKPaymentPass",
            feature = "PKSecureElementPass",
            feature = "block2"
        ))]
        #[deprecated = "Use activatePaymentPass:withActivationData:completion: instead"]
        #[unsafe(method(activatePaymentPass:withActivationCode:completion:))]
        #[unsafe(method_family = none)]
        pub unsafe fn activatePaymentPass_withActivationCode_completion(
            &self,
            payment_pass: &PKPaymentPass,
            activation_code: &NSString,
            completion: Option<&block2::DynBlock<dyn Fn(Bool, NonNull<NSError>)>>,
        );

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKSecureElementPass",
            feature = "block2"
        ))]
        #[unsafe(method(activateSecureElementPass:withActivationData:completion:))]
        #[unsafe(method_family = none)]
        pub unsafe fn activateSecureElementPass_withActivationData_completion(
            &self,
            secure_element_pass: &PKSecureElementPass,
            activation_data: &NSData,
            completion: Option<&block2::DynBlock<dyn Fn(Bool, *mut NSError)>>,
        );

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKSecureElementPass",
            feature = "block2"
        ))]
        #[unsafe(method(signData:withSecureElementPass:completion:))]
        #[unsafe(method_family = none)]
        pub unsafe fn signData_withSecureElementPass_completion(
            &self,
            sign_data: &NSData,
            secure_element_pass: &PKSecureElementPass,
            completion: &block2::DynBlock<dyn Fn(*mut NSData, *mut NSData, *mut NSError)>,
        );

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKSecureElementPass",
            feature = "block2"
        ))]
        #[unsafe(method(encryptedServiceProviderDataForSecureElementPass:completion:))]
        #[unsafe(method_family = none)]
        pub unsafe fn encryptedServiceProviderDataForSecureElementPass_completion(
            &self,
            secure_element_pass: &PKSecureElementPass,
            completion: &block2::DynBlock<dyn Fn(*mut NSDictionary, *mut NSError)>,
        );

        #[cfg(all(
            feature = "PKObject",
            feature = "PKPass",
            feature = "PKSecureElementPass",
            feature = "block2"
        ))]
        #[unsafe(method(serviceProviderDataForSecureElementPass:completion:))]
        #[unsafe(method_family = none)]
        pub unsafe fn serviceProviderDataForSecureElementPass_completion(
            &self,
            secure_element_pass: &PKSecureElementPass,
            completion: &block2::DynBlock<dyn Fn(*mut NSData, *mut NSError)>,
        );

        #[unsafe(method(authorizationStatusForCapability:))]
        #[unsafe(method_family = none)]
        pub unsafe fn authorizationStatusForCapability(
            &self,
            capability: PKPassLibraryCapability,
        ) -> PKPassLibraryAuthorizationStatus;

        #[cfg(feature = "block2")]
        #[unsafe(method(requestAuthorizationForCapability:completion:))]
        #[unsafe(method_family = none)]
        pub unsafe fn requestAuthorizationForCapability_completion(
            &self,
            capability: PKPassLibraryCapability,
            completion: &block2::DynBlock<dyn Fn(PKPassLibraryAuthorizationStatus)>,
        );
    );
}

/// Methods declared on superclass `NSObject`.
impl PKPassLibrary {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

/// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibrarynotificationname?language=objc)
// NS_TYPED_EXTENSIBLE_ENUM
pub type PKPassLibraryNotificationName = NSString;

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibrarydidchangenotification?language=objc)
    pub static PKPassLibraryDidChangeNotification: &'static PKPassLibraryNotificationName;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryremotepaymentpassesdidchangenotification?language=objc)
    pub static PKPassLibraryRemotePaymentPassesDidChangeNotification:
        &'static PKPassLibraryNotificationName;
}

/// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibrarynotificationkey?language=objc)
// NS_TYPED_ENUM
pub type PKPassLibraryNotificationKey = NSString;

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryaddedpassesuserinfokey?language=objc)
    pub static PKPassLibraryAddedPassesUserInfoKey: &'static PKPassLibraryNotificationKey;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryreplacementpassesuserinfokey?language=objc)
    pub static PKPassLibraryReplacementPassesUserInfoKey: &'static PKPassLibraryNotificationKey;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryremovedpassinfosuserinfokey?language=objc)
    pub static PKPassLibraryRemovedPassInfosUserInfoKey: &'static PKPassLibraryNotificationKey;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibrarypasstypeidentifieruserinfokey?language=objc)
    pub static PKPassLibraryPassTypeIdentifierUserInfoKey: &'static PKPassLibraryNotificationKey;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryserialnumberuserinfokey?language=objc)
    pub static PKPassLibrarySerialNumberUserInfoKey: &'static PKPassLibraryNotificationKey;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkpasslibraryrecoveredpassesuserinfokey?language=objc)
    pub static PKPassLibraryRecoveredPassesUserInfoKey: &'static PKPassLibraryNotificationKey;
}