sudovirtualcards/com.sudoplatform.sudovirtualcards

Package-level declarations

The main entry point of the Sudo Platform Virtual Cards SDK for Android. Use the SudoVirtualCardsClient.builder() to construct an instance of the Sudo Platform Virtual Cards SDK.

Types

SudoVirtualCardsClient

interface SudoVirtualCardsClient : AutoCloseable

Interface encapsulating a library for interacting with the Sudo Platform Virtual Cards service.

SudoVirtualCardsNotifiableClient

interface SudoVirtualCardsNotifiableClient : NotifiableClient

Interface encapsulating the NotifiableClient used to handle notifications from the Sudo Platform Virtual Cards Service.

SudoVirtualCardsNotificationHandler

interface SudoVirtualCardsNotificationHandler

SudoVirtualCardsNotificationMetaData

data class SudoVirtualCardsNotificationMetaData(val serviceName: String, val schema: List<SudoVirtualCardsNotificationSchemaEntry>) : NotificationMetaData

SudoVirtualCardsNotificationSchemaEntry

data class SudoVirtualCardsNotificationSchemaEntry(val description: String, val fieldName: String, val type: String) : NotificationSchemaEntry

Functions

initVirtualCardsNotifications

fun NotificationConfiguration.initVirtualCardsNotifications(): NotificationConfiguration

Extension function to ensure a NotificationConfiguration is initialized for receipt of virtual cards service notifications.

isVirtualCardsNotificationForFundingSourceIdEnabled

fun NotificationConfiguration.isVirtualCardsNotificationForFundingSourceIdEnabled(fundingSourceId: String): Boolean

Test whether or not virtual cards service notifications are enabled for a particular funding source

isVirtualCardsNotificationForFundingSourceTypeEnabled

fun NotificationConfiguration.isVirtualCardsNotificationForFundingSourceTypeEnabled(fundingSourceType: FundingSourceType): Boolean

Test whether or not virtual cards service notifications are enabled for a particular funding source type

setVirtualCardsNotificationsForFundingSource

fun NotificationConfiguration.setVirtualCardsNotificationsForFundingSource(fundingSourceId: String, enabled: Boolean): NotificationConfiguration

Extension function to add rules to a NotificationConfiguration for enabling or disabling virtual cards service notifications for a particular funding source id.

setVirtualCardsNotificationsForFundingSourceType

fun NotificationConfiguration.setVirtualCardsNotificationsForFundingSourceType(fundingSourceType: FundingSourceType, enabled: Boolean): NotificationConfiguration

Extension function to add rules to a NotificationConfiguration for enabling or disabling virtual cards service notifications for a particular funding source type.

subscribeToFundingSources

suspend fun SudoVirtualCardsClient.subscribeToFundingSources(id: String, onConnectionChange: (status: Subscriber.ConnectionState) -> Unit = {}, onFundingSourceChanged: (fundingSource: FundingSource) -> Unit)

Subscribes to be notified of modified FundingSources.

subscribeToTransactions

suspend fun SudoVirtualCardsClient.subscribeToTransactions(id: String, onConnectionChange: (status: TransactionSubscriber.ConnectionState) -> Unit = {}, onTransactionChange: (transaction: Transaction) -> Unit)

Subscribes to be notified of new, updated and deleted Transactions.