Package br.com.setis.pgweblib

Interface PGWPinpad

public interface PGWPinpad
Interface para as funções de acesso ao PIN-Pad da PGWebLib.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CFG_ENDERECO_PP
    Endereço físico (MAC-Address) do PIN-Pad a ser conectado.
    static final int
    CFG_IPAddress_PP
    Endereço ip do Pin-Pad a ser conectado.
    static final int
    CFG_MODO_PINPAD
    Configuração do modo PIN-Pad, sendo:
    "0" -> Não usa PIN-Pad.
    "1" -> Usa PIN-Pad Bluetooth.
    "2" -> Usa PIN-Pad USB.
    "3" -> Usa PIN-Pad embarcado (terminais POS).
    "4" -> Usa PIN-Pad TCP.
    static final int
    CFG_NOME_PP
    Nome do PIN-Pad a ser conectado.
    static final int
    CFG_TCP_PORT
    Número da porta que o Pin-Pad escutará.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    abort()
    Esta função pode ser utilizada pela Automação para interromper uma captura de dados no PIN-pad em curso (durante um fluxo transacional ou a execução de um comando desta interface).
    void
    cancelTyping()
    Esta função deve ser utilizada pela Automação para informar o cancelamento da entrada digitada, somente se o processo foi previamente iniciado por typeCardNumber().
    void
    configurePinPad(Map<Integer,String> pinpadParams)
    Configura os parâmetros de PIN-Pad.
    void
    display(String message, PinpadListener pinpadListener)
    Esta função é utilizada para apresentar uma mensagem no PIN-pad.
    List<android.bluetooth.BluetoothDevice>
    getBondedBluetoothDevices()
    Obtem uma lista de dispositivos Bluetooth pareados com o dispositivo.
    void
    setCardNumber(String cardNumber)
    Esta função deve ser utilizada pela Automação para informar o número do cartão digitado, somente se o processo foi previamente iniciado por typeCardNumber().
    void
    typeCardNumber()
    Esta função pode ser utilizada pela Automação para indicar que a captura dos dados do cartão será manual (digitada).

  • Field Details

    • CFG_MODO_PINPAD

      static final int CFG_MODO_PINPAD
      Configuração do modo PIN-Pad, sendo:
      "0" -> Não usa PIN-Pad.
      "1" -> Usa PIN-Pad Bluetooth.
      "2" -> Usa PIN-Pad USB.
      "3" -> Usa PIN-Pad embarcado (terminais POS).
      "4" -> Usa PIN-Pad TCP.
      See Also:

    • CFG_NOME_PP

      static final int CFG_NOME_PP
      Nome do PIN-Pad a ser conectado.
      See Also:

    • CFG_ENDERECO_PP

      static final int CFG_ENDERECO_PP
      Endereço físico (MAC-Address) do PIN-Pad a ser conectado.
      See Also:

    • CFG_IPAddress_PP

      static final int CFG_IPAddress_PP
      Endereço ip do Pin-Pad a ser conectado.
      See Also:

    • CFG_TCP_PORT

      static final int CFG_TCP_PORT
      Número da porta que o Pin-Pad escutará.
      See Also:

  • Method Details

    • configurePinPad

      void configurePinPad(Map<Integer,String> pinpadParams)
      Configura os parâmetros de PIN-Pad.
      Parameters:
      pinpadParams - Map com os parâmetros de PIN-Pad, sendo:

      • Identificador - Identificador da configuração (uma das constantes CFG_xxx).
      • Valor - Valor da configuração

    • getBondedBluetoothDevices

      List<android.bluetooth.BluetoothDevice> getBondedBluetoothDevices()
      Obtem uma lista de dispositivos Bluetooth pareados com o dispositivo. A configuração do dispositivo deve ser feita através de configurePinPad(Map).
      Returns:
      Lista com os dispositivos pareados. Se nenhum dispositivo pareado, retornará uma lista vazia.

    • abort

      void abort()
      Esta função pode ser utilizada pela Automação para interromper uma captura de dados no PIN-pad em curso (durante um fluxo transacional ou a execução de um comando desta interface).
      See Also:

    • display

      void display(String message, PinpadListener pinpadListener)
      Esta função é utilizada para apresentar uma mensagem no PIN-pad.
      Parameters:
      message - Mensagem a ser apresentada no PIN-pad. O caractere ‘\r’ (0Dh) indica uma quebra de linha.
      pinpadListener - Listener para notificação do estado da captura para o PIN-Pad.

    • typeCardNumber

      void typeCardNumber()
      Esta função pode ser utilizada pela Automação para indicar que a captura dos dados do cartão será manual (digitada). Quando chamada durante a execução de um comando de captura de cartão (PWDAT_CARDINF), caso este permitir a digitação do cartão, o processo de captura no PIN-Pad será abortado, e o callback PinpadListener.onCommandFinished(int) será invocado com o código PWRET_ABORT (-2423). Caso seja chamado fora do fluxo de captura do cartão, ou a transação não permita a digitação, este comando será ignorado.
      See Also:

    • setCardNumber

      void setCardNumber(String cardNumber)
      Esta função deve ser utilizada pela Automação para informar o número do cartão digitado, somente se o processo foi previamente iniciado por typeCardNumber(). Caso contrário, será ignorado.

      IMPORTANTE: Devido ao fato de o número do cartão ser um dado sensível, a automação deve apagar o dado capturado da memória após a chamada à esta função.
      Parameters:
      cardNumber - Número do cartão, capturado pela automação.

    • cancelTyping

      void cancelTyping()
      Esta função deve ser utilizada pela Automação para informar o cancelamento da entrada digitada, somente se o processo foi previamente iniciado por typeCardNumber(). Caso contrário, será ignorado.