objc2_pass_kit/generated/
PKAddIdentityDocumentConfiguration.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/passkit/pkidentitydocumentmetadata?language=objc)
12    #[unsafe(super(NSObject))]
13    #[derive(Debug, PartialEq, Eq, Hash)]
14    pub struct PKIdentityDocumentMetadata;
15);
16
17extern_conformance!(
18    unsafe impl NSObjectProtocol for PKIdentityDocumentMetadata {}
19);
20
21impl PKIdentityDocumentMetadata {
22    extern_methods!(
23        #[unsafe(method(init))]
24        #[unsafe(method_family = init)]
25        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
26
27        #[unsafe(method(new))]
28        #[unsafe(method_family = new)]
29        pub unsafe fn new() -> Retained<Self>;
30
31        /// credentialIdentifier: A unique identifier for provisioning credential data.
32        #[unsafe(method(credentialIdentifier))]
33        #[unsafe(method_family = none)]
34        pub unsafe fn credentialIdentifier(&self) -> Retained<NSString>;
35
36        /// sharingInstanceIdentifier: A unique identifier that refers to an instance of sharing of credentials to a user's device initiated from another user, device, or web.
37        #[unsafe(method(sharingInstanceIdentifier))]
38        #[unsafe(method_family = none)]
39        pub unsafe fn sharingInstanceIdentifier(&self) -> Retained<NSString>;
40
41        /// cardTemplateIdentifier: Identifier referencing a card template registered by developers in web portal - identifies a combination of cardProfileIdentifier, cardConfigurationIdentifier, and cardArtBundleName.
42        /// Returns empty string if no identifier is set.
43        #[unsafe(method(cardTemplateIdentifier))]
44        #[unsafe(method_family = none)]
45        pub unsafe fn cardTemplateIdentifier(&self) -> Retained<NSString>;
46
47        /// cardConfigurationIdentifier: Identifier referencing a card configuration registered by developers.
48        /// Returns empty string if no identifier is set.
49        #[unsafe(method(cardConfigurationIdentifier))]
50        #[unsafe(method_family = none)]
51        pub unsafe fn cardConfigurationIdentifier(&self) -> Retained<NSString>;
52
53        /// serverEnvironmentIdentifier: Identifier referencing the target server environment Apple Pay servers should reach out to to provision this pass.
54        /// If not present, the default Apply Pay server environment will be used and an empty string will be returned.
55        #[unsafe(method(serverEnvironmentIdentifier))]
56        #[unsafe(method_family = none)]
57        pub unsafe fn serverEnvironmentIdentifier(&self) -> Retained<NSString>;
58
59        /// Setter for [`serverEnvironmentIdentifier`][Self::serverEnvironmentIdentifier].
60        #[unsafe(method(setServerEnvironmentIdentifier:))]
61        #[unsafe(method_family = none)]
62        pub unsafe fn setServerEnvironmentIdentifier(
63            &self,
64            server_environment_identifier: &NSString,
65        );
66    );
67}
68
69extern_class!(
70    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkjapanindividualnumbercardmetadata?language=objc)
71    #[unsafe(super(PKIdentityDocumentMetadata, NSObject))]
72    #[derive(Debug, PartialEq, Eq, Hash)]
73    pub struct PKJapanIndividualNumberCardMetadata;
74);
75
76extern_conformance!(
77    unsafe impl NSObjectProtocol for PKJapanIndividualNumberCardMetadata {}
78);
79
80impl PKJapanIndividualNumberCardMetadata {
81    extern_methods!(
82        #[cfg(feature = "PKAddSecureElementPassConfiguration")]
83        /// Initialize with parameters configured by issuer's server to indicate the specific product instance to provision.
84        /// - Properties:
85        /// - provisioningCredentialIdentifier: Identifies this user's instance for provisioning.
86        /// - sharingInstanceIdentifier: A short lived token to prevent replay-ability.
87        /// - cardTemplateIdentifier: An identifier for a legacy product on our Apple Pay servers.
88        /// - preview: Object containing information to represent the pass to provision in our UI.
89        #[unsafe(method(initWithProvisioningCredentialIdentifier:sharingInstanceIdentifier:cardTemplateIdentifier:preview:))]
90        #[unsafe(method_family = init)]
91        pub unsafe fn initWithProvisioningCredentialIdentifier_sharingInstanceIdentifier_cardTemplateIdentifier_preview(
92            this: Allocated<Self>,
93            credential_identifier: &NSString,
94            sharing_instance_identifier: &NSString,
95            template_identifier: &NSString,
96            preview: &PKAddPassMetadataPreview,
97        ) -> Retained<Self>;
98
99        #[cfg(feature = "PKAddSecureElementPassConfiguration")]
100        /// Initialize with parameters configured by issuer's server to indicate the specific product instance to provision.
101        /// - Properties:
102        /// - provisioningCredentialIdentifier: Identifies this user's instance for provisioning.
103        /// - sharingInstanceIdentifier: A short lived token to prevent replay-ability.
104        /// - cardConfigurationIdentifier: An identifier for a product on our Apple Pay servers.
105        /// - preview: Object containing information to represent the pass to provision in our UI.
106        #[unsafe(method(initWithProvisioningCredentialIdentifier:sharingInstanceIdentifier:cardConfigurationIdentifier:preview:))]
107        #[unsafe(method_family = init)]
108        pub unsafe fn initWithProvisioningCredentialIdentifier_sharingInstanceIdentifier_cardConfigurationIdentifier_preview(
109            this: Allocated<Self>,
110            credential_identifier: &NSString,
111            sharing_instance_identifier: &NSString,
112            template_identifier: &NSString,
113            preview: &PKAddPassMetadataPreview,
114        ) -> Retained<Self>;
115
116        /// Raw authentication password used to protect authentication functionality.
117        /// If configured in the pass, this functionality allows users to present their identity credentials to external parties.
118        #[unsafe(method(authenticationPassword))]
119        #[unsafe(method_family = none)]
120        pub unsafe fn authenticationPassword(&self) -> Option<Retained<NSString>>;
121
122        /// Setter for [`authenticationPassword`][Self::authenticationPassword].
123        #[unsafe(method(setAuthenticationPassword:))]
124        #[unsafe(method_family = none)]
125        pub unsafe fn setAuthenticationPassword(&self, authentication_password: Option<&NSString>);
126
127        /// Raw signing password used to protect signing functionality.
128        /// If configured in the pass, this functionality allows users to digitally sign with external parties or print officially signed documents.
129        #[unsafe(method(signingPassword))]
130        #[unsafe(method_family = none)]
131        pub unsafe fn signingPassword(&self) -> Option<Retained<NSString>>;
132
133        /// Setter for [`signingPassword`][Self::signingPassword].
134        #[unsafe(method(setSigningPassword:))]
135        #[unsafe(method_family = none)]
136        pub unsafe fn setSigningPassword(&self, signing_password: Option<&NSString>);
137
138        #[cfg(feature = "PKAddSecureElementPassConfiguration")]
139        /// preview: A preview object containing the necessary information to represent the pass during provisioning.
140        #[unsafe(method(preview))]
141        #[unsafe(method_family = none)]
142        pub unsafe fn preview(&self) -> Retained<PKAddPassMetadataPreview>;
143
144        #[cfg(feature = "PKAddSecureElementPassConfiguration")]
145        /// Setter for [`preview`][Self::preview].
146        #[unsafe(method(setPreview:))]
147        #[unsafe(method_family = none)]
148        pub unsafe fn setPreview(&self, preview: &PKAddPassMetadataPreview);
149    );
150}
151
152/// Methods declared on superclass `PKIdentityDocumentMetadata`.
153impl PKJapanIndividualNumberCardMetadata {
154    extern_methods!(
155        #[unsafe(method(init))]
156        #[unsafe(method_family = init)]
157        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
158
159        #[unsafe(method(new))]
160        #[unsafe(method_family = new)]
161        pub unsafe fn new() -> Retained<Self>;
162    );
163}
164
165extern_class!(
166    /// [Apple's documentation](https://developer.apple.com/documentation/passkit/pkaddidentitydocumentconfiguration?language=objc)
167    #[unsafe(super(PKAddSecureElementPassConfiguration, NSObject))]
168    #[derive(Debug, PartialEq, Eq, Hash)]
169    #[cfg(feature = "PKAddSecureElementPassConfiguration")]
170    pub struct PKAddIdentityDocumentConfiguration;
171);
172
173#[cfg(feature = "PKAddSecureElementPassConfiguration")]
174extern_conformance!(
175    unsafe impl NSObjectProtocol for PKAddIdentityDocumentConfiguration {}
176);
177
178#[cfg(feature = "PKAddSecureElementPassConfiguration")]
179impl PKAddIdentityDocumentConfiguration {
180    extern_methods!(
181        #[cfg(feature = "block2")]
182        /// Initialize identity document configuration with corresponding identity document metadata.
183        /// - Parameters:
184        /// - metadata: Set of configured metadata defining the required information to add the corresponding pass to Wallet.
185        /// - completion: Returns the identity document configuration if successful, otherwise returns an error.
186        #[unsafe(method(configurationForMetadata:completion:))]
187        #[unsafe(method_family = none)]
188        pub unsafe fn configurationForMetadata_completion(
189            metadata: &PKIdentityDocumentMetadata,
190            completion: &block2::DynBlock<
191                dyn Fn(*mut PKAddIdentityDocumentConfiguration, *mut NSError),
192            >,
193        );
194
195        /// metadata: Set of configured metadata defining the required information to add the corresponding pass to Wallet.
196        #[unsafe(method(metadata))]
197        #[unsafe(method_family = none)]
198        pub unsafe fn metadata(&self) -> Retained<PKIdentityDocumentMetadata>;
199    );
200}
201
202/// Methods declared on superclass `PKAddSecureElementPassConfiguration`.
203#[cfg(feature = "PKAddSecureElementPassConfiguration")]
204impl PKAddIdentityDocumentConfiguration {
205    extern_methods!(
206        #[unsafe(method(init))]
207        #[unsafe(method_family = init)]
208        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
209
210        #[unsafe(method(new))]
211        #[unsafe(method_family = new)]
212        pub unsafe fn new() -> Retained<Self>;
213    );
214}
objc2_pass_kit/generated/PKAddIdentityDocumentConfiguration.rs

objc2_pass_kit/generated/
PKAddIdentityDocumentConfiguration.rs
