Struct PKPaymentRequest 

pub struct PKPaymentRequest { /* private fields */ }

Available on crate feature PKPaymentRequest only.

Apple’s documentation

Implementations

impl PKPaymentRequest

pub unsafe fn availableNetworks() -> Retained<NSArray<PKPaymentNetwork>>

Available on crate feature PKConstants only.

pub unsafe fn paymentContactInvalidErrorWithContactField_localizedDescription( field: &PKContactField, localized_description: Option<&NSString>, ) -> Retained<NSError>

Available on crate feature PKConstants only.

pub unsafe fn paymentShippingAddressInvalidErrorWithKey_localizedDescription( postal_address_key: &NSString, localized_description: Option<&NSString>, ) -> Retained<NSError>

pub unsafe fn paymentBillingAddressInvalidErrorWithKey_localizedDescription( postal_address_key: &NSString, localized_description: Option<&NSString>, ) -> Retained<NSError>

pub unsafe fn paymentShippingAddressUnserviceableErrorWithLocalizedDescription( localized_description: Option<&NSString>, ) -> Retained<NSError>

pub unsafe fn paymentCouponCodeInvalidErrorWithLocalizedDescription( localized_description: Option<&NSString>, ) -> Retained<NSError>

pub unsafe fn paymentCouponCodeExpiredErrorWithLocalizedDescription( localized_description: Option<&NSString>, ) -> Retained<NSError>

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

pub unsafe fn setMerchantIdentifier(&self, merchant_identifier: &NSString)

Setter for merchantIdentifier.

This is copied when set.

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

pub unsafe fn setAttributionIdentifier( &self, attribution_identifier: Option<&NSString>, )

Setter for attributionIdentifier.

This is copied when set.

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

pub unsafe fn setCountryCode(&self, country_code: &NSString)

Setter for countryCode.

This is copied when set.

pub unsafe fn supportedNetworks(&self) -> Retained<NSArray<PKPaymentNetwork>>

Available on crate feature PKConstants only.

pub unsafe fn setSupportedNetworks( &self, supported_networks: &NSArray<PKPaymentNetwork>, )

Available on crate feature PKConstants only.

Setter for supportedNetworks.

This is copied when set.

pub unsafe fn merchantCapabilities(&self) -> PKMerchantCapability

pub unsafe fn setMerchantCapabilities( &self, merchant_capabilities: PKMerchantCapability, )

Setter for merchantCapabilities.

pub unsafe fn supportsCouponCode(&self) -> bool

pub unsafe fn setSupportsCouponCode(&self, supports_coupon_code: bool)

Setter for supportsCouponCode.

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

pub unsafe fn setCouponCode(&self, coupon_code: Option<&NSString>)

Setter for couponCode.

This is copied when set.

pub unsafe fn merchantCategoryCode(&self) -> PKMerchantCategoryCode

pub unsafe fn setMerchantCategoryCode( &self, merchant_category_code: PKMerchantCategoryCode, )

Setter for merchantCategoryCode.

pub unsafe fn paymentSummaryItems( &self, ) -> Retained<NSArray<PKPaymentSummaryItem>>

Available on crate feature PKPaymentSummaryItem only.

pub unsafe fn setPaymentSummaryItems( &self, payment_summary_items: &NSArray<PKPaymentSummaryItem>, )

Available on crate feature PKPaymentSummaryItem only.

Setter for paymentSummaryItems.

This is copied when set.

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

pub unsafe fn setCurrencyCode(&self, currency_code: &NSString)

Setter for currencyCode.

This is copied when set.

pub unsafe fn requiredBillingContactFields( &self, ) -> Retained<NSSet<PKContactField>>

Available on crate feature PKConstants only.

pub unsafe fn setRequiredBillingContactFields( &self, required_billing_contact_fields: &NSSet<PKContactField>, )

Available on crate feature PKConstants only.

Setter for requiredBillingContactFields.

pub unsafe fn requiredBillingAddressFields(&self) -> PKAddressField

👎Deprecated

pub unsafe fn setRequiredBillingAddressFields( &self, required_billing_address_fields: PKAddressField, )

👎Deprecated

Setter for requiredBillingAddressFields.

pub unsafe fn billingContact(&self) -> Option<Retained<PKContact>>

Available on crate feature PKContact only.

pub unsafe fn setBillingContact(&self, billing_contact: Option<&PKContact>)

Available on crate feature PKContact only.

Setter for billingContact.

pub unsafe fn requiredShippingContactFields( &self, ) -> Retained<NSSet<PKContactField>>

Available on crate feature PKConstants only.

pub unsafe fn setRequiredShippingContactFields( &self, required_shipping_contact_fields: &NSSet<PKContactField>, )

Available on crate feature PKConstants only.

Setter for requiredShippingContactFields.

pub unsafe fn requiredShippingAddressFields(&self) -> PKAddressField

👎Deprecated

pub unsafe fn setRequiredShippingAddressFields( &self, required_shipping_address_fields: PKAddressField, )

👎Deprecated

Setter for requiredShippingAddressFields.

pub unsafe fn shippingContact(&self) -> Option<Retained<PKContact>>

Available on crate feature PKContact only.

pub unsafe fn setShippingContact(&self, shipping_contact: Option<&PKContact>)

Available on crate feature PKContact only.

Setter for shippingContact.

pub unsafe fn shippingMethods( &self, ) -> Option<Retained<NSArray<PKShippingMethod>>>

Available on crate features PKPaymentSummaryItem and PKShippingMethod only.

pub unsafe fn setShippingMethods( &self, shipping_methods: Option<&NSArray<PKShippingMethod>>, )

Available on crate features PKPaymentSummaryItem and PKShippingMethod only.

Setter for shippingMethods.

This is copied when set.

pub unsafe fn shippingType(&self) -> PKShippingType

pub unsafe fn setShippingType(&self, shipping_type: PKShippingType)

Setter for shippingType.

pub unsafe fn shippingContactEditingMode(&self) -> PKShippingContactEditingMode

pub unsafe fn setShippingContactEditingMode( &self, shipping_contact_editing_mode: PKShippingContactEditingMode, )

Setter for shippingContactEditingMode.

pub unsafe fn applicationData(&self) -> Option<Retained<NSData>>

pub unsafe fn setApplicationData(&self, application_data: Option<&NSData>)

Setter for applicationData.

This is copied when set.

pub unsafe fn supportedCountries(&self) -> Option<Retained<NSSet<NSString>>>

pub unsafe fn setSupportedCountries( &self, supported_countries: Option<&NSSet<NSString>>, )

Setter for supportedCountries.

This is copied when set.

pub unsafe fn multiTokenContexts( &self, ) -> Retained<NSArray<PKPaymentTokenContext>>

Available on crate feature PKPaymentTokenContext only.

pub unsafe fn setMultiTokenContexts( &self, multi_token_contexts: &NSArray<PKPaymentTokenContext>, )

Available on crate feature PKPaymentTokenContext only.

Setter for multiTokenContexts.

This is copied when set.

pub unsafe fn recurringPaymentRequest( &self, ) -> Option<Retained<PKRecurringPaymentRequest>>

Available on crate feature PKRecurringPaymentRequest only.

pub unsafe fn setRecurringPaymentRequest( &self, recurring_payment_request: Option<&PKRecurringPaymentRequest>, )

Available on crate feature PKRecurringPaymentRequest only.

Setter for recurringPaymentRequest.

pub unsafe fn automaticReloadPaymentRequest( &self, ) -> Option<Retained<PKAutomaticReloadPaymentRequest>>

Available on crate feature PKAutomaticReloadPaymentRequest only.

pub unsafe fn setAutomaticReloadPaymentRequest( &self, automatic_reload_payment_request: Option<&PKAutomaticReloadPaymentRequest>, )

Available on crate feature PKAutomaticReloadPaymentRequest only.

Setter for automaticReloadPaymentRequest.

pub unsafe fn deferredPaymentRequest( &self, ) -> Option<Retained<PKDeferredPaymentRequest>>

Available on crate feature PKDeferredPaymentRequest only.

pub unsafe fn setDeferredPaymentRequest( &self, deferred_payment_request: Option<&PKDeferredPaymentRequest>, )

Available on crate feature PKDeferredPaymentRequest only.

Setter for deferredPaymentRequest.

pub unsafe fn applePayLaterAvailability(&self) -> PKApplePayLaterAvailability

pub unsafe fn setApplePayLaterAvailability( &self, apple_pay_later_availability: PKApplePayLaterAvailability, )

Setter for applePayLaterAvailability.

impl PKPaymentRequest

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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`
    }
}

Trait Implementations

impl AsRef<AnyObject> for PKPaymentRequest

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for PKPaymentRequest

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PKPaymentRequest> for PKPaymentRequest

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for PKPaymentRequest

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for PKPaymentRequest

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for PKPaymentRequest

const NAME: &'static str = "PKPaymentRequest"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<PKPaymentRequest as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for PKPaymentRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for PKPaymentRequest

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for PKPaymentRequest

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for PKPaymentRequest

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for PKPaymentRequest

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for PKPaymentRequest

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for PKPaymentRequest

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for PKPaymentRequest

impl Eq for PKPaymentRequest