DigitalCard Actor Reference
DigitalCard
public actor DigitalCardDigitalCard Class
Implementation of the DigitalCard retrieved from the DigitalCardManager module.
- This can be used to :
- Determine if this card is the default payment card
- Retrieve card details
- Retrieve the current card state
- Retrieve the
digitalCardIdfor this card - Set this card as the default payment card (if it currently is not)
-
Checks if
DigitalCardhas an auxiliary scheme. A card with an auxiliary scheme is also called a co-badged card.Declaration
Swift
public var hasAuxiliaryScheme: Bool { get }Return Value
Bool. It returns a true value if
DigitalCardhas an auxiliary scheme. -
setDefault()AsynchronousSets the
DigitalCardas the default payment card.Throws:
deviceEnvironmentUnsafe(_:)if device environment is unsafe.clientError(_:)if any error encountered during card operations.
Declaration
Swift
public func setDefault() async throws -> BoolReturn Value
Bool. It returns
trueif the operation is successful. -
Digital Card ID of the
DigitalCard.Declaration
Swift
nonisolated public var digitalCardID: String { get } -
Retrieves
DigitalCard.Detailsof the card.Throws:
deviceEnvironmentUnsafe(_:)if device environment is unsafe.clientError(_:)if any error encountered during card operations.
Declaration
Swift
public var details: DigitalCard.Details { get throws }Return Value
DigitalCard.Detailscontaining the details of this card. -
Checks if the
DigitalCardis the default payment card.Throws:
deviceEnvironmentUnsafe(_:)if device environment is unsafe.clientError(_:)if any error encountered during card operations.
Declaration
Swift
public var isDefaultCard: Bool { get throws }Return Value
Bool. It returns
trueif the card is the default payment card. -
Retrieves
DigitalCard.PaymentKeyInfoof the card.Throws:
deviceEnvironmentUnsafe(_:)if device environment is unsafe.clientError(_:)if any error encountered during card operations.
Declaration
Swift
public var paymentKeyInfo: DigitalCard.PaymentKeyInfo { get throws }Return Value
DigitalCard.PaymentKeyInfocontaining the payment key information of this card. -
Returns the
DigitalCard.Stateof the cardThrows:
deviceEnvironmentUnsafe(_:)if device environment is unsafe.clientError(_:)if any error encountered during card operations.
Declaration
Swift
public var state: DigitalCard.State { get throws }Return Value
DigitalCard.Statecontaining the state of this card. -
Returns the
DigitalCard.CardArtof the cardThrows:
clientError(_:)if any error encountered during card operations.
Declaration
Swift
public var cardArt: DigitalCard.CardArt { get throws }Return Value
DigitalCard.CardArtcontaining the card art of this card. -
Returns the
DigitalCard.CardMetaDataof the cardThrows:
deviceEnvironmentUnsafe(_:)if device environment is unsafe.clientError(_:)if any error encountered during card operations.
Declaration
Swift
public var cardMetaData: DigitalCard.CardMetaData { get throws }Return Value
DigitalCard.CardMetaDatacontaining the card meta data of this card. -
Returns if DigitalCard supports ODA
Declaration
Swift
public var isODASupported: Bool { get } -
Returns if DigitalCard needs ODA renewal
Declaration
Swift
public var needsODARenewal: Bool { get } -
Retrieves an array containing all the available
AIDInfo.Since
7.1.0Throws:
clientError(_:)if there is any internal failure.
Declaration
Swift
public var aidInfoList: [AIDInfo] { get throws }Return Value
Array of
AIDInfoof this card. -
setAIDInfoList(_:Asynchronous) Update AIDInfo list to this card.
Since
7.1.0Throws:
aidInfoListMismatchnew aid list does not match original aid listclientError(_:)if there is any internal failure.featureNotSupportedif the card does not support update the AIDInfoList
Declaration
Swift
public func setAIDInfoList(_ aidInfoList: [AIDInfo]) async throws -
Check if the card supports multiple
AIDInfo.aidSince
7.1.0Throws:
clientError(_:)if there is any internal failure.
Declaration
Swift
public var isMultiAID: Bool { get throws } -
CardArt provides the card information used by the MPA for display.
See moreDeclaration
Swift
public struct CardArt : Sendable -
CardArt provides the card information used by the MPA for display.
See moreDeclaration
Swift
public struct CardMetaData : Sendable -
Detailed information pertaining to a specific
See moreDigitalCard.Declaration
Swift
public final class Details : Sendable -
Undocumented
See moreDeclaration
Swift
public enum Error : Sendable, Swift.Error -
See moreDigitalCard.Statuscontains information about the current status of the card.Declaration
Swift
public struct PaymentKeyInfo : Sendable -
Payment key type.
See moreDeclaration
Swift
public enum KeyType : Sendable -
The types of payment methods supported by the
See moreDigitalCard.Declaration
Swift
public enum PaymentType : UInt, Sendable -
The payment scheme of the
See moreDigitalCard.Declaration
Swift
public enum Scheme : UInt, Sendable, Codable -
State of a specific
See moreDigitalCard.Declaration
Swift
public enum State : Int, Sendable