callback/com.teya.unifiedepossdk/PaymentStateSubscription

PaymentStateSubscription

@ObjCName(name = "TeyaPaymentStateSubscription", exact = true)

interface PaymentStateSubscription

PaymentStateSubscription is a handler to a payment which is "in progress". It allows for:

subscribing (and unsubscribing) to state changes
cancelling the payment (unsupported by some implementations and also best effort, can be ignored by the Teya payment app)
get information about the state (see com.teya.unifiedepossdk.PaymentStateDetails)

PosLink specifics:

Pass a TeyaPosLinkPaymentInProgressUi listener to the subscribe call to make Teya UI show up while the payment is in progress. You can also use unsubscribe with that same instance to hide the UI, although usually that shouldn't be needed as the UI hides itself after a final state (with some extra configurable delay).

Types

CancellationResult

typealias ~~CancellationResult~~ = CancellationResult

CancellationResultInfo

typealias ~~CancellationResultInfo~~ = CancellationResultInfo

DeprecatedCancellationResult

@HiddenFromObjC

fun interface ~~DeprecatedCancellationResult~~

InProgressState

typealias ~~InProgressState~~ = InProgressState

PaymentState

typealias ~~PaymentState~~ = PaymentState

PaymentStateChangeListener

@ObjCName(name = "TeyaPaymentStateChangeListener", exact = true)

interface PaymentStateChangeListener

Listener for payment state changes.

PaymentStateDetails

interface ~~PaymentStateDetails~~

PaymentStateReason

typealias ~~PaymentStateReason~~ = PaymentStateReason

Properties

currentState

abstract val currentState: PaymentStateDetails

Returns the current state of the payment. com.teya.unifiedepossdk.PaymentStateDetails

transactionType

abstract val transactionType: TransactionType

Whether this subscription tracks a payment (money charged to the card) or a refund (money returned to the card). See TransactionType.

Functions

cancelPayment

@HiddenFromObjC

abstract fun ~~cancelPayment~~(onResult: PaymentStateSubscription.DeprecatedCancellationResult)

abstract fun cancelPayment(onResult: (CancellationResultInfo) -> Unit)

Cancels the ongoing payment request. This is a best effort call, meaning that the Teya payment app may ignore this request, if, for example, it is too late to cancel it.

abstract fun subscribe(listener: PaymentStateSubscription.PaymentStateChangeListener): PaymentStateSubscription

Subscribes the listener to receive state change updates. Some states may be skipped by some implementations, don't assume that you'll get notified for each individual intermediate state.

unsubscribe

abstract fun unsubscribe(listener: PaymentStateSubscription.PaymentStateChangeListener)

Unsubscribes the listener from receiving state change updates.

unsubscribeAll

abstract fun unsubscribeAll()

Calls unsubscribe for all current listeners.