DigitalCardManager

public actor DigitalCardManager

Gives access to the list of available digitalCards, obtaining a specified digitalCard, retrieving the default payment card and unsetting the default status of a card. Also allows card operations such as suspend, resume or deletion of a specified digitalCard.

init()
Initializes the Digital Card Manager
Declaration
Swift

public init()
eventStream Asynchronous
Token Sync process state as an AsyncStream Await the result from invokeDigitalCardSync()
Declaration
Swift

public var eventStream: AsyncStream<SyncEvent> { get async }
Return Value

The current state of the synchronization process as DigitalCardManager.SyncState
unsetDefaultCard() Asynchronous
Removes the current default payment card.
Declaration
Swift

@discardableResult public func unsetDefaultCard() async throws -> Bool
Return Value

Boolean. True if operation was successful. > Throws: > - deviceEnvironmentUnsafe(_:) if device environment is unsafe. > - clientError(_:) if there is any internal failure. > - Else, unknown(_:) - if an unexpected error encountered.


                    
                    
                    digitalCard(forID:)

Asynchronous

Retrieves a DigitalCard.

Declaration

Swift

public func digitalCard(forID digitalCardID: String) async -> DigitalCard?

Parameters


                                digitalCardID

digitalCard ID

Return Value

digitalCard: DigitalCard object with the specified digitalCardID.

invokeDigitalCardSync() Asynchronous
Begins the synchronization process returning its state in an asyncStream. Result returned in eventStream
Throws:

clientError(_:) if there is any internal failure.

serverError(_:) if server error encountered.

networkError if there is a network connectivity error or connection timeout.
Declaration
Swift

public func invokeDigitalCardSync() async throws
isDigitalCardSyncAllowed Asynchronous
Whether or not digital card synchronization is allowed.
Throws:

clientError(_:) if there is any internal failure.

Else, unknown(_:) - if an unexpected error encountered.
Declaration
Swift

public var isDigitalCardSyncAllowed: Bool { get async throws }
digitalCardSyncSchedule Asynchronous
TimeInterval: The number of seconds until the next digital card synchronization.
Throws:

clientError(_:) if there is any internal failure.

Else, unknown(_:) - if an unexpected error encountered.
Declaration
Swift

public var digitalCardSyncSchedule: TimeInterval { get async throws }
cardList Asynchronous
Retrieves an array containing all the available DigitalCard.
Declaration
Swift

public var cardList: [DigitalCard] { get async throws }
Return Value

[DigitalCard] array of digital cards. > Throws: > - deviceEnvironmentUnsafe(_:) if device environment is unsafe. > - clientError(_:) if there is any internal failure. > - Else, unknown(_:) - if an unexpected error encountered.
defaultCard Asynchronous
Retrieves the current default payment card.
Declaration
Swift

public var defaultCard: DigitalCard? { get async throws }
Return Value

String: DigitalCardID of the default card. > Throws: > - deviceEnvironmentUnsafe(_:) if device environment is unsafe. > - clientError(_:) if there is any internal failure. > - Else, unknown(_:) - if an unexpected error encountered.
CardManagementAction
Actions available to the manage(digitalCardID:action:) operation.
See more
Declaration
Swift

public enum CardManagementAction : Sendable


                    
                    
                    manage(digitalCardID:action:)

Asynchronous

Perform a management action on a specific DigitalCard.

The actions available are :
- Suspend
- Resume
- Delete

Throws:

incorrectAuthenticationToken if authentication token is incorrect.

unknownWalletProviderID if wallet provider ID is unknown.

unknownWalletID if wallet ID is unknown.

unknownDigitalCardID if digital card ID is unknown.

cardStateDoesNotAllowRequestedOperation if the card state does not allow the requested operations.

operationAlreadyOngoing if there is an ongoing operation.

unexpectedInternalError if an unexpected internal error is encountered.

externalSystemUnavailable if external system is unavailable.

unknownIssuerID if issuer ID is unknown.

unknownCardID if card ID is unknown.

clientError(_:) if any internal errors are encountered.

networkError if there is a network connectivity error or connection timeout.

serverError(_:) if error encountered during card operations.

Else, unknown(_:) if an unexpected error encountered.

Declaration

Swift

public func manage(digitalCardID: String, action: DigitalCardManager.CardManagementAction) async throws -> String?

Parameters

`digitalCardID`	ID of the `DigitalCard` to perfrom the action on.
`action`	`DigitalCardManager.CardManagementAction`

Return Value

DigitalCardID of the operation if successful.

Internal Implementation

ManageCardError
Errors encountered for
- manage(digitalCardID:action:)
See more
Declaration
Swift

public enum ManageCardError : Sendable, Swift.Error
Error
DigitalCardManager error Possible APIS which uses Error
- unsetDefaultCard()
- manage(digitalCardID:action:)
- invokeDigitalCardSync()
- cardList
- defaultCard
See more
Declaration
Swift

public enum Error : Sendable, Swift.Error
SyncEvent
The states that occur during digital card sync stream..
See more
Declaration
Swift

public enum SyncEvent : Sendable
SyncStatus
Status of a digital card sync operation
See more
Declaration
Swift

public enum SyncStatus : UInt, Equatable, Sendable