public interface PGWebLib

Interface para as chamadas das funÃ§Ãµes da PGWebLib.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

PGWebLib.CardEventListener

Interface listener responsÃ¡vel por indicar a apresentaÃ§Ã£o de um cartÃ£o no estado ocioso da biblioteca.

static interface

PGWebLib.TestKeyListener

Interface listener responsÃ¡vel por reportar o progresso da funÃ§Ã£o testKey(TestKeyListener).
Method Summary

Modifier and Type

Method

Description

int

addParameters(Map<Short,String> parametersMap)

Esta funÃ§Ã£o Ã© utilizada para alimentar a biblioteca com as informaÃ§Ãµes da transaÃ§Ã£o a ser realizada, e retorna imediatamente.

void

configPwCliCapAutoInstall(boolean permiteAutoInstalacao)

Define se a automaÃ§Ã£o irÃ¡ utilizar o processo de auto instalaÃ§Ã£o.

void

confirmation(ConfirmationParams confirmationParams)

Esta funÃ§Ã£o informa ao Pay&Go Web o status final da transaÃ§Ã£o em curso (confirmada ou desfeita).

int

executeAutoInstall()

Esta funÃ§Ã£o Ã© utilizada para executar o processo de auto instalaÃ§Ã£o.

int

executeMenuMainAutoInstall()

Esta funÃ§Ã£o Ã© utilizada para chamar o MenuMain da auto instalaÃ§Ã£o.

int

executePreAutoInstall()

Esta funÃ§Ã£o Ã© utilizada para executar o processo de prÃ© auto instalaÃ§Ã£o.

void

executeTransaction()

Esta funÃ§Ã£o tenta realizar uma transaÃ§Ã£o atravÃ©s do Pay&Go Web, utilizando os parÃ¢metros previamente definidos atravÃ©s de addParameters(Map).
Deve ser chamada uma Ãºnica vez.

boolean

getCurrentAutoInstallOperation()

Esta funÃ§Ã£o pode ser chamada para saber se existe uma operaÃ§Ã£o de auto instalaÃ§Ã£o em andamento

boolean

getCurrentOperation()

Esta funÃ§Ã£o pode ser chamada para saber se existe uma operaÃ§Ã£o em andamento

GraphicReceipts

getGraphicReceipts()

Esta funÃ§Ã£o retorna os comprovantes grÃ¡ficos, caso existam.

MerchantInfo

getMerchantInfo()

Esta funÃ§Ã£o Ã© responsÃ¡vel por obter o CPNJ/CPF e a RazÃ£o Social do estabelecimento comercial.

Operation[]

getOperations(byte operType)

Esta funÃ§Ã£o pode ser chamada para obter quais operaÃ§Ãµes o Pay&Go Web disponibiliza no momento, sejam elas administrativas, de venda ou ambas.

PaymentInfo

getPaymentInfo()

Esta funÃ§Ã£o pode ser chamada para obter qual tipo de cartÃ£o estÃ¡ sendo utilizado na transaÃ§Ã£o.

String

getResult(Short informationId)

Esta funÃ§Ã£o pode ser chamada para obter informaÃ§Ãµes que resultaram da transaÃ§Ã£o efetuada, independentemente de ter sido bem ou mal sucedida, e retorna imediatamente.

int

getStatusAutoInstall()

Esta funÃ§Ã£o Ã© utilizada para obter o estado atual do processo de auto instalaÃ§Ã£o.

TransactionOperation[]

getTransactionOperations()

Esta funÃ§Ã£o pode ser chamada para obter quais operaÃ§Ãµes de venda o Pay&Go Web disponibiliza no momento.

void

init(TransactionListener transactionListener, PinpadListener pinpadListener, PGWebLib.CardEventListener cardEventListener, ConfigListener configListener, TesteHardwareListener testeHardwareListener, boolean isProd, String diretorioRaiz)

Esta funÃ§Ã£o Ã© utilizada para inicializar a biblioteca e retorna imediatamente.

void

initAutoInstall(AutoInstallListener autoInstallListener)

Esta funÃ§Ã£o Ã© utilizada para inicializar o processo de auto instalaÃ§Ã£o e retorna imediatamente.

int

newTransaction(byte operation)

Esta funÃ§Ã£o deve ser chamada para iniciar uma nova transaÃ§Ã£o atravÃ©s do Pay&Go Web, e retorna imediatamente.

int

removeCard()

Esta funÃ§Ã£o pode ser chamada para realizar a remoÃ§Ã£o do cartÃ£o.

void

removeCheckEvents()

FunÃ§Ã£o responsÃ¡vel por remover os eventos de checagem do cartÃ£o.

void

restartCheckEvents()

FunÃ§Ã£o responsÃ¡vel por reiniciar os eventos de checagem do cartÃ£o.

void

setConfigListener(ConfigListener configListener, boolean isProd)

Esta funÃ§Ã£o Ã© utilizada para alimentar a biblioteca com as informaÃ§Ãµes do terminal.

int

telemetry()

Esta funÃ§Ã£o Ã© utilizada para realizar o envio de telemetria

void

testKey(PGWebLib.TestKeyListener testKeyListener)

Esta funÃ§Ã£o pode ser chamada fora do fluxo de uma transaÃ§Ã£o para verificar o conjunto de chaves presente no equipamento (PIN-Pad ou POS), de acordo com o mapa ABECS.

Method Details
- init
  
  void init(TransactionListener transactionListener, PinpadListener pinpadListener, PGWebLib.CardEventListener cardEventListener, ConfigListener configListener, TesteHardwareListener testeHardwareListener, boolean isProd, String diretorioRaiz)
  
  Esta funÃ§Ã£o Ã© utilizada para inicializar a biblioteca e retorna imediatamente.
  
  Parameters:
  
  transactionListener - TransactionListener para recebimento de eventos transacionais.
  
  pinpadListener - PinpadListener para recebimento de eventos de PIN-Pad.
  
  cardEventListener - PGWebLib.CardEventListener para recebimento de eventos de cartÃ£o.
  
  configListener - ConfigListener para recebimento de dados do terminal.
  
  testeHardwareListener - TesteHardwareListener para realizaÃ§Ã£o do Teste de Hardware.
  
  isProd - indica se a versÃ£o instalada Ã© produtiva.
  
  diretorioRaiz - nome do diretÃ³rio onde os arquivos da pgweblib serÃ£o salvos.
- configPwCliCapAutoInstall
  
  void configPwCliCapAutoInstall(boolean permiteAutoInstalacao)
  
  Define se a automaÃ§Ã£o irÃ¡ utilizar o processo de auto instalaÃ§Ã£o. Quando habilitado, a biblioteca poderÃ¡ realizar automaticamente a instalaÃ§Ã£o dos componentes necessÃ¡rios durante o fluxo de execuÃ§Ã£o. Deve ser chamada apÃ³s a inicializaÃ§Ã£o atravÃ©s do mÃ©todo init(TransactionListener, PinpadListener, CardEventListener, ConfigListener, TesteHardwareListener, boolean, String).
  
  Parameters:
  
  permiteAutoInstalacao - indica se o processo de auto instalaÃ§Ã£o deve ser habilitado (true) ou desabilitado (false).
- initAutoInstall
  
  void initAutoInstall(AutoInstallListener autoInstallListener)
  
  Esta funÃ§Ã£o Ã© utilizada para inicializar o processo de auto instalaÃ§Ã£o e retorna imediatamente.
  
  Parameters:
  
  autoInstallListener - AutoInstallListener para recebimento de eventos do processo de auto instalaÃ§Ã£o.
- getStatusAutoInstall
  
  int getStatusAutoInstall()
  
  Esta funÃ§Ã£o Ã© utilizada para obter o estado atual do processo de auto instalaÃ§Ã£o. Deve ser chamada apÃ³s a inicializaÃ§Ã£o pelo mÃ©todo initAutoInstall(AutoInstallListener).
  
  Returns:
  
  estado atual da auto instalaÃ§Ã£o
- executeAutoInstall
  
  int executeAutoInstall()
  
  Esta funÃ§Ã£o Ã© utilizada para executar o processo de auto instalaÃ§Ã£o. Deve ser chamada apÃ³s a inicializaÃ§Ã£o pelo mÃ©todo initAutoInstall(AutoInstallListener). E se o mÃ©todo executePreAutoInstall() retornou sucesso (0).
  
  Returns:
  
  Erro de execuÃ§Ã£o (ver SeÃ§Ã£o "CÃ³digos de retorno" - especificaÃ§Ã£o PGWebLib).
- executePreAutoInstall
  
  int executePreAutoInstall()
  
  Esta funÃ§Ã£o Ã© utilizada para executar o processo de prÃ© auto instalaÃ§Ã£o. Deve ser chamada apÃ³s a inicializaÃ§Ã£o pelo mÃ©todo initAutoInstall(AutoInstallListener).
  
  Returns:
  
  Erro de execuÃ§Ã£o (ver SeÃ§Ã£o "CÃ³digos de retorno" - especificaÃ§Ã£o PGWebLib).
- executeMenuMainAutoInstall
  
  int executeMenuMainAutoInstall()
  
  Esta funÃ§Ã£o Ã© utilizada para chamar o MenuMain da auto instalaÃ§Ã£o.
  
  Returns:
  
  Erro de execuÃ§Ã£o (ver SeÃ§Ã£o "CÃ³digos de retorno" - especificaÃ§Ã£o PGWebLib).
- telemetry
  
  int telemetry()
  
  Esta funÃ§Ã£o Ã© utilizada para realizar o envio de telemetria
  
  Returns:
  
  Erro de execuÃ§Ã£o (ver SeÃ§Ã£o "CÃ³digos de retorno" - especificaÃ§Ã£o PGWebLib).
- newTransaction
  
  int newTransaction(byte operation)
  
  Esta funÃ§Ã£o deve ser chamada para iniciar uma nova transaÃ§Ã£o atravÃ©s do Pay&Go Web, e retorna imediatamente.
  
  Parameters:
  
  operation - Tipo de transaÃ§Ã£o a ser realizada (PWOPER_xxx, conforme a especificaÃ§Ã£o da PGWebLib)
  
  Returns:
  
  Erro de execuÃ§Ã£o (ver SeÃ§Ã£o "CÃ³digos de retorno" - especificaÃ§Ã£o PGWebLib). Uma mensagem de erro pode ser obtida atravÃ©s da funÃ§Ã£o getResult(Short PWINFO_RESULTMSG).
- addParameters
  
  int addParameters(Map<Short,String> parametersMap)
  
  Esta funÃ§Ã£o Ã© utilizada para alimentar a biblioteca com as informaÃ§Ãµes da transaÃ§Ã£o a ser realizada, e retorna imediatamente. Mais de uma informaÃ§Ã£o pode ser adicionada por vez.
  Parameters:
  
  parametersMap - Map com as informaÃ§Ãµes da transaÃ§Ã£o, no formato (ParÃ¢metro, Valor), sendo:
  
  ParÃ¢metro - Identificador do parÃ¢metro (PWINFO_xxx, conforme a especificaÃ§Ã£o da PGWebLib)
  
  Valor - Valor do parÃ¢metro (string ASCII).
  
  Returns:
  
  Erro de execuÃ§Ã£o (ver SeÃ§Ã£o "CÃ³digos de retorno" - especificaÃ§Ã£o PGWebLib). Uma mensagem de erro pode ser obtida atravÃ©s da funÃ§Ã£o getResult(Short PWINFO_RESULTMSG).
- executeTransaction
  
  void executeTransaction()
  
  Esta funÃ§Ã£o tenta realizar uma transaÃ§Ã£o atravÃ©s do Pay&Go Web, utilizando os parÃ¢metros previamente definidos atravÃ©s de addParameters(Map).
  Deve ser chamada uma Ãºnica vez. A partir de entÃ£o, toda a transaÃ§Ã£o serÃ¡ efetuada pelo TransactionListener passado como parÃ¢metro.
  
  Esta funÃ§Ã£o, por se comunicar com a infraestrutura Pay&Go Web, pode demorar alguns segundos para retornar.
- getResult
  
  String getResult(Short informationId)
  
  Esta funÃ§Ã£o pode ser chamada para obter informaÃ§Ãµes que resultaram da transaÃ§Ã£o efetuada, independentemente de ter sido bem ou mal sucedida, e retorna imediatamente.
  
  Parameters:
  
  informationId - CÃ³digo da informaÃ§Ã£o solicitada sendo requisitada (PWINFO_xxx, conforme a especificaÃ§Ã£o da PGWebLib).
  
  Returns:
  
  InformaÃ§Ã£o solicitada. Se null, a informaÃ§Ã£o solicitada nÃ£o existe/nÃ£o foi possÃvel ser obtida.
- removeCard
  
  int removeCard()
  
  Esta funÃ§Ã£o pode ser chamada para realizar a remoÃ§Ã£o do cartÃ£o.
  
  Returns:
  
  retorna '0' quando o cartÃ£o for removido com sucesso.
- confirmation
  
  void confirmation(ConfirmationParams confirmationParams)
  
  Esta funÃ§Ã£o informa ao Pay&Go Web o status final da transaÃ§Ã£o em curso (confirmada ou desfeita). Consultar a especificaÃ§Ã£o da PGWebLib para informaÃ§Ãµes adicionais.
  
  Parameters:
  
  confirmationParams - ParÃ¢metros de confirmaÃ§Ã£o.
- getGraphicReceipts
  
  GraphicReceipts getGraphicReceipts()
  
  Esta funÃ§Ã£o retorna os comprovantes grÃ¡ficos, caso existam.
  Returns:
  
  Objeto GraphicReceipts com informaÃ§Ãµes sobre os comprovantes grÃ¡ficos, caso existam.
  
  See Also:
  
  GraphicReceipts.getReceipts()
- getOperations
  
  Operation[] getOperations(byte operType)
  
  Esta funÃ§Ã£o pode ser chamada para obter quais operaÃ§Ãµes o Pay&Go Web disponibiliza no momento, sejam elas administrativas, de venda ou ambas.
  
  Parameters:
  
  operType - Soma dos tipos de operaÃ§Ã£o a serem incluÃdos na estrutura de retorno (PWOPTYPE_xxx, conforme especificaÃ§Ã£o da PGWebLib).
  
  Returns:
  
  Vetor com as operaÃ§Ãµes disponibilizadas. Em caso de erro, retorna null.
- getPaymentInfo
  
  PaymentInfo getPaymentInfo()
  
  Esta funÃ§Ã£o pode ser chamada para obter qual tipo de cartÃ£o estÃ¡ sendo utilizado na transaÃ§Ã£o.
  
  Returns:
  
  Objeto PaymentInfo com as informaÃ§Ãµes do tipo de cartÃ£o e parcelamento
- getTransactionOperations
  
  TransactionOperation[] getTransactionOperations()
  
  Esta funÃ§Ã£o pode ser chamada para obter quais operaÃ§Ãµes de venda o Pay&Go Web disponibiliza no momento.
  
  Returns:
  
  Vetor com as operaÃ§Ãµes de venda disponibilizadas. Em caso de erro, retorna null.
- getMerchantInfo
  
  MerchantInfo getMerchantInfo()
  
  Esta funÃ§Ã£o Ã© responsÃ¡vel por obter o CPNJ/CPF e a RazÃ£o Social do estabelecimento comercial.
  
  Returns:
  
  Objeto MerchantInfo com as informaÃ§Ãµes do estabelecimento comercial
- setConfigListener
  
  void setConfigListener(ConfigListener configListener, boolean isProd)
  
  Esta funÃ§Ã£o Ã© utilizada para alimentar a biblioteca com as informaÃ§Ãµes do terminal.
  
  Parameters:
  
  configListener - Listener para obtenÃ§Ã£o dos dados do terminal.
- testKey
  
  void testKey(PGWebLib.TestKeyListener testKeyListener)
  
  Esta funÃ§Ã£o pode ser chamada fora do fluxo de uma transaÃ§Ã£o para verificar o conjunto de chaves presente no equipamento (PIN-Pad ou POS), de acordo com o mapa ABECS.
  
  Parameters:
  
  testKeyListener - Listener para tratar o resultado da execuÃ§Ã£o do teste.
- getCurrentOperation
  
  boolean getCurrentOperation()
  
  Esta funÃ§Ã£o pode ser chamada para saber se existe uma operaÃ§Ã£o em andamento
  
  Returns:
  
  Se for true, significa que uma operaÃ§Ã£o estÃ¡ em andamento; caso contrÃ¡rio, indica que nÃ£o hÃ¡ nenhuma operaÃ§Ã£o ocorrendo.
- removeCheckEvents
  
  void removeCheckEvents()
  
  FunÃ§Ã£o responsÃ¡vel por remover os eventos de checagem do cartÃ£o.
- restartCheckEvents
  
  void restartCheckEvents()
  
  FunÃ§Ã£o responsÃ¡vel por reiniciar os eventos de checagem do cartÃ£o.
- getCurrentAutoInstallOperation
  
  boolean getCurrentAutoInstallOperation()
  
  Esta funÃ§Ã£o pode ser chamada para saber se existe uma operaÃ§Ã£o de auto instalaÃ§Ã£o em andamento
  
  Returns:
  
  Se for true, significa que uma operaÃ§Ã£o estÃ¡ em andamento; caso contrÃ¡rio, indica que nÃ£o hÃ¡ nenhuma operaÃ§Ã£o ocorrendo.

Interface PGWebLib

Nested Class Summary

Method Summary

Method Details

init

configPwCliCapAutoInstall

initAutoInstall

getStatusAutoInstall

executeAutoInstall

executePreAutoInstall

executeMenuMainAutoInstall

telemetry

newTransaction

addParameters

executeTransaction

getResult

removeCard

confirmation

getGraphicReceipts

getOperations

getPaymentInfo

getTransactionOperations

getMerchantInfo

setConfigListener

testKey

getCurrentOperation

removeCheckEvents

restartCheckEvents

getCurrentAutoInstallOperation