WrapperPPS/br.com.uol.pagseguro.plugpagservice.wrapper

Package-level declarations

Pacote raiz do WrapperPPS.

Types

AppIdentification

open class AppIdentification(context: Context)

Contém os valores que representam a identidade de uma aplicação.

AsyncPlugPag

abstract class AsyncPlugPag(val context: Context, metricListener: WrapperMetricListener) : BasePlugPag

CardIssuerNationality

enum CardIssuerNationality : Enum<CardIssuerNationality>

IPlugPagWrapper

interface IPlugPagWrapper : IWrapperNFC, IWrapperUserProfile, IWrapperPrinter, IWrapperSystem

Classe principal da biblioteca. Responsável por executar todas as ações referentes a PlugPag, como transação, ativação, desativação, entre outros.

PlugPag

open class PlugPag(val context: Context, metricListener: WrapperMetricListener) : AsyncPlugPag

Classe principal da biblioteca. Responsável por executar todas as ações referentes a PlugPag, como transação, ativação, desativação, entre outros. As documentações dessa funcionalidade se encontram em: IPlugPagWrapper

PlugPagAbortResult

data class PlugPagAbortResult(val result: Int) : Serializable

Contém os valores resultantes de uma solicitação de cancelamento.

PlugPagActivationData

data class PlugPagActivationData(val activationCode: String) : Serializable

Contém os valores necessários para solicitação de ativação.

PlugPagAppIdentification

data class PlugPagAppIdentification(val context: Context) : AppIdentification, Serializable

Representa a identidade de uma aplicação conforme seu contexto.

PlugPagCardInfoResult

data class PlugPagCardInfoResult(var result: String? = null, var message: String? = null, var bin: String? = null, var holder: String? = null, var cardHolder: String? = null)

Contém os dados de um cartão de pagamentos advindos de uma leitura do mesmo.

PlugPagCommand

enum PlugPagCommand : Enum<PlugPagCommand>

PlugPagCustomPrinterLayout

class PlugPagCustomPrinterLayout(var title: String? = null, var titleColor: String? = null, var confirmTextColor: String? = null, var cancelTextColor: String? = null, var windowBackgroundColor: String? = null, var buttonBackgroundColor: String? = null, var buttonBackgroundColorDisabled: String? = null, var sendSMSTextColor: String? = null, var maxTimeShowPopup: Int = 0) : Parcelable

Contém os elementos a serem customizados da tela de impressão da via do cliente.

PlugPagEffectuatePreAutoData

data class PlugPagEffectuatePreAutoData(val amount: Int = 0, val userReference: String? = EMPTY_STRING, val printReceipt: Boolean = false, val transactionId: String? = EMPTY_STRING, val transactionCode: String? = EMPTY_STRING) : Parcelable

Contém os dados necessários para solicitar a efetivação de uma transação pré-autorização já criada.

PlugPagEventData

class PlugPagEventData

Contém dados necessários para criação de um evento.

PlugPagEventListener

interface PlugPagEventListener

Contém métodos chamados quando existem novos eventos de pagamento, estorno, desativação ou ativação.

PlugPagExtras

object PlugPagExtras

PlugPagInitializationResult

data class PlugPagInitializationResult(val result: Int, val errorCode: String, val errorMessage: String) : Serializable

Contém os valores resultantes de uma ativação ou desativação.

PlugPagInstallment

data class PlugPagInstallment(val quantity: Int, val amount: Int, val total: Int) : Serializable

Contém os valores resultantes do cálculo de parcelas de uma transação.

PlugPagNearFieldCardData

open class PlugPagNearFieldCardData : Serializable

Contém os dados de entrada de uma leitura ou escrita em cartão NFC.

PlugPagNearFieldRemoveCardType

enum PlugPagNearFieldRemoveCardType : Enum<PlugPagNearFieldRemoveCardType>

Contém os tipos de identificação de remoção do cartão NFC.

PlugPagNFCDetectRemoveCard

data class PlugPagNFCDetectRemoveCard(val detectRemoveCardType: PlugPagNearFieldRemoveCardType, val cardId: Byte)

Contém os valores necessários para solicitar uma detecção de remoção de um cartão NFC.

PlugPagNFCResult

class PlugPagNFCResult(val startSlot: Int = 0, val endSlot: Int = 0, val slots: Array<HashMap<String, ByteArray>> = emptyArray(), val result: Int = PlugPag.NFC_RET_OK, var message: String? = EMPTY_STRING, var errorCode: String? = EMPTY_STRING)

Contém valores resultantes de uma operação em cartão NFC.

PlugPagPagBankActivationResult

class PlugPagPagBankActivationResult(var result: Int? = 0, var errorCode: String? = "", var errorMessage: String? = "") : Parcelable

Contém os valores resultantes de uma ativação com QRCode PagBank.

PlugPagPaymentData

data class PlugPagPaymentData(val type: Int, val amount: Int, val installmentType: Int, val installments: Int, val userReference: String?, val printReceipt: Boolean, val partialPay: Boolean, val isCarne: Boolean) : Serializable

Contém os valores necessários para iniciar uma solicitação de pagamento.

PlugPagPreAutoData

data class PlugPagPreAutoData(val amount: Int? = 0, val installmentType: Int = 0, val installments: Int = 0, val userReference: String? = EMPTY_STRING, val printReceipt: Boolean? = false) : Parcelable

Contém os valores necessários para solicitação de transação pré-autorizada.

PlugPagPreAutoKeyingData

data class PlugPagPreAutoKeyingData(val amount: Int? = 0, val installmentType: Int = 0, val installments: Int = 0, val userReference: String? = EMPTY_STRING, val printReceipt: Boolean? = false, val pan: String = EMPTY_STRING, val securityCode: String = EMPTY_STRING, val expirationDate: String = EMPTY_STRING) : Parcelable

Contém os dados para criar uma solicitação de transação pré-autorização digitada.

PlugPagPreAutoQueryData

data class PlugPagPreAutoQueryData(val amount: Int? = 0, val installmentType: Int = 0, val installments: Int = 0, val pan: String = EMPTY_STRING, val securityCode: String = EMPTY_STRING, val expirationDate: String = EMPTY_STRING, val transactionDate: String = EMPTY_STRING, val transactionCode: String = EMPTY_STRING) : Parcelable

Contém os dados necessários para solicitação de consulta de transação pré-autorizada digitada.

PlugPagPreAutoQueryResult

data class PlugPagPreAutoQueryResult(val result: Int? = 0, val message: String? = EMPTY_STRING, val errorCode: String? = EMPTY_STRING, val transactions: List<PlugPagTransactionResult>) : Parcelable

Contém o resultado de uma operação de consulta de pré-autorização.

PlugPagPrintActionResult

data class PlugPagPrintActionResult(val result: Int) : Serializable

Contém o valor resultante de uma solicitação de impressão.

PlugPagPrinterData

data class PlugPagPrinterData(val filePath: String, val printerQuality: Int, var steps: Int)

Contém os valores necessários para realização de uma impressão.

PlugPagPrinterListener

interface PlugPagPrinterListener

Contém os métodos chamados durante uma impressão.

PlugPagPrintResult

class PlugPagPrintResult(val result: Int, val message: String?, val errorCode: String?, val steps: Int)

Contém os valores resultantes de uma solicitação de impressão.

PlugPagReceiptSMSData

data class PlugPagReceiptSMSData(val phoneNumber: String, val transactionCode: String)

Contém os valores necessários para realização do envio de comprovante via SMS.

PlugPagStyleData

data class PlugPagStyleData(val headTextColor: Int? = null, val headBackgroundColor: Int? = null, val contentTextColor: Int? = null, val contentTextValue1Color: Int? = null, val contentTextValue2Color: Int? = null, val positiveButtonTextColor: Int? = null, val positiveButtonBackground: Int? = null, val negativeButtonTextColor: Int? = null, val negativeButtonBackground: Int? = null, val genericButtonBackground: Int? = null, val genericButtonTextColor: Int? = null, val genericSmsEditTextBackground: Int? = null, val genericSmsEditTextTextColor: Int? = null, val lineColor: Int? = null) : Serializable

Contém cores hexadecimais a serem usadas no design das telas fornecidas pela PlugPagService.

PlugPagSubAcquirerData

data class PlugPagSubAcquirerData(val name: String, val address: String, val city: String, val uf: String, val country: String, val zipCode: String, val mcc: String, val cnpjCpf: String, val docType: String, val telephone: String, val fullName: String, val merchantId: String) : Serializable

Contém os valores referentes ao titular da conta ativa no terminal.

PlugPagSubAcquirerResult

class PlugPagSubAcquirerResult(val name: String, val address: String, val city: String, val uf: String, val country: String, val zipCode: String, val mcc: String, val cnpjCpf: String, val docType: String, val telephone: String, val fullName: String, val merchantId: String) : Serializable

Contém os valores referentes ao titular da conta ativa no terminal.

PlugPagTransactionResult

data class PlugPagTransactionResult(val message: String? = EMPTY_STRING, val errorCode: String? = EMPTY_STRING, val transactionCode: String? = EMPTY_STRING, val transactionId: String? = EMPTY_STRING, val date: String? = EMPTY_STRING, val time: String? = EMPTY_STRING, val hostNsu: String? = EMPTY_STRING, val cardBrand: String? = EMPTY_STRING, val bin: String? = EMPTY_STRING, val holder: String? = EMPTY_STRING, val userReference: String? = EMPTY_STRING, val terminalSerialNumber: String? = EMPTY_STRING, val amount: String? = EMPTY_STRING, val availableBalance: String? = EMPTY_STRING, val cardApplication: String? = EMPTY_STRING, val label: String? = EMPTY_STRING, val holderName: String? = EMPTY_STRING, val extendedHolderName: String? = EMPTY_STRING, val cardIssuerNationality: CardIssuerNationality? = CardIssuerNationality.UNAVAILABLE, val result: Int? = 0, val readerModel: String? = EMPTY_STRING, val nsu: String? = EMPTY_STRING, val autoCode: String? = EMPTY_STRING, val installments: Char? = null, val originalAmount: Int? = 0, val buyerName: String? = EMPTY_STRING, val paymentType: Int? = 0, val typeTransaction: String? = EMPTY_STRING, val appIdentification: String? = EMPTY_STRING, val cardHash: String? = EMPTY_STRING, val preAutoDueDate: String? = EMPTY_STRING, val preAutoOriginalAmount: String? = EMPTY_STRING, val userRegistered: Int = 0, val accumulatedValue: String? = EMPTY_STRING, val consumerIdentification: String? = EMPTY_STRING, val currentBalance: String? = EMPTY_STRING, val consumerPhoneNumber: String? = EMPTY_STRING, val clubePagScreensIds: String? = EMPTY_STRING, val partialPayPartiallyAuthorizedAmount: String? = EMPTY_STRING, val partialPayRemainingAmount: String? = EMPTY_STRING, val pixTxIdCode: String? = EMPTY_STRING) : Parcelable

Contém os valores resultantes de uma solicitação de transação.

PlugPagUserDataResult

data class PlugPagUserDataResult(var address: String? = null, var city: String? = null, var cnpjCpf: String? = null, var addressComplement: String? = null, var companyName: String? = null, var userNickName: String? = null, var addressState: String? = null, var email: String? = null)

Contém os valores referentes ao titular da conta ativa no terminal.

PlugPagVoidData

data class PlugPagVoidData(val transactionCode: String, val transactionId: String, val printReceipt: Boolean = false, val voidType: Int = VOID_PAYMENT) : Serializable

Contém os valores necessários para solicitação de um estorno.

TerminalCapabilities

object TerminalCapabilities

Contém as constantes que representam as funcionalidades do terminal.

WrapperMetricListener

typealias WrapperMetricListener = (WrapperMetric) -> Unit?

Functions

equal

fun PlugPagCommand.equal(value: Int): Boolean

getPlugPagCommand

fun Int.getPlugPagCommand(): PlugPagCommand

notEqual

fun PlugPagCommand.notEqual(value: Int): Boolean

removePrefix

fun PlugPagCommand.removePrefix(): String

value

fun PlugPagCommand.value(): Int