Struct PKAddIdentityDocumentMetadata

Source

pub struct PKAddIdentityDocumentMetadata { /* private fields */ }

Available on crate feature PKAddIdentityDocumentConfiguration only.

Expand description

Apple’s documentation

Implementations§

Source §

impl PKAddIdentityDocumentMetadata

Source

pub unsafe fn initWithProvisioningCredentialIdentifier_sharingInstanceIdentifier_cardTemplateIdentifier_issuingCountryCode_documentType_preview( this: Allocated<Self>, credential_identifier: &NSString, sharing_instance_identifier: &NSString, template_identifier: &NSString, issuing_country_code: &NSString, document_type: PKAddIdentityDocumentType, preview: &PKAddPassMetadataPreview, ) -> Retained<Self>

Available on crate feature PKAddSecureElementPassConfiguration only.

Initialize with parameters configured by issuer’s server to indicate the specific product instance to provision.

Properties:
provisioningCredentialIdentifier: Identifies this user’s instance for provisioning.
sharingInstanceIdentifier: A short lived token to prevent replay-ability.
cardTemplateIdentifier: An identifier for a legacy product on our Apple Pay servers.
preview: Object containing information to represent the pass to provision in our UI.
issuingCountryCode: identifies the issuing country of the identity document
identityDocumentType: identifies the type of the identity document
preview: Object containing information to represent the pass to provision in our UI.

Source

pub unsafe fn preview(&self) -> Retained<PKAddPassMetadataPreview>

Available on crate feature PKAddSecureElementPassConfiguration only.

preview: A preview object containing the necessary information to represent the pass during provisioning.

Source §

impl PKAddIdentityDocumentMetadata

Methods declared on superclass PKIdentityDocumentMetadata.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = PKIdentityDocumentMetadata>§

Source

pub unsafe fn credentialIdentifier(&self) -> Retained<NSString>

credentialIdentifier: A unique identifier for provisioning credential data.

Source

pub unsafe fn sharingInstanceIdentifier(&self) -> Retained<NSString>

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.

Source

pub unsafe fn cardTemplateIdentifier(&self) -> Retained<NSString>

cardTemplateIdentifier: Identifier referencing a card template registered by developers in web portal - identifies a combination of cardProfileIdentifier, cardConfigurationIdentifier, and cardArtBundleName. Returns empty string if no identifier is set.

Source

pub unsafe fn cardConfigurationIdentifier(&self) -> Retained<NSString>

cardConfigurationIdentifier: Identifier referencing a card configuration registered by developers. Returns empty string if no identifier is set.

Source

pub unsafe fn serverEnvironmentIdentifier(&self) -> Retained<NSString>

serverEnvironmentIdentifier: Identifier referencing the target server environment Apple Pay servers should reach out to to provision this pass. If not present, the default Apply Pay server environment will be used and an empty string will be returned.

Source

pub unsafe fn setServerEnvironmentIdentifier( &self, server_environment_identifier: &NSString, )

Setter for serverEnvironmentIdentifier.

Source

pub unsafe fn issuingCountryCode(&self) -> Retained<NSString>

issuingCountryCode: identifies the issuing country of the identity document

Source

pub unsafe fn documentType(&self) -> PKAddIdentityDocumentType

identityDocumentType: identifies the type of the identity document

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}