Enumerações
enum	TipoImpressao { IMPRESSAO_PADRAO =(0, "Padrao") , IMPRESSAO_DIRETA_VIA_CLIENTE_VIA_ESTABELECIMENTO =(1, "Ambas") , IMPRESSAO_DIRETA_VIA_CLIENTE =(2, "Cliente") , IMPRESSAO_DIRETA_VIA_ESTABELECIMENTO =(3, "Estabelecimento") , IMPRESSAO_DESABILITADA =(4, "Nenhum") , IMPRESSAO_INDEFINIDA =(5, "Perguntar") }

Funções
public String	getIdTransacao ()

public void	setIdTransacao (String midTransacao)

public String	getPdv ()

public void	setPdv (String mpdv)

public TipoImpressao	getTipoImpressao ()

public void	setTipoImpressao (TipoImpressao tipoImpressao)

public void	setColetarInfoCupomFiscal (boolean coletarInfoCupomFiscal)

public boolean	isColetarInfoCupomFiscal ()

public void	iniciaVenda (String valorTotal, Context context, Handler handler)

public void	iniciaVendaDebito (String valorTotal, Context context, Handler handler)

public void	iniciaVendaCredito (String valorTotal, int tipoFinanciamento, int numeroParcelas, Context context, Handler handler)

public void	iniciaCancelamentoVenda (String valorTotal, String ref, String data, Context context, Handler handler)

public void	iniciaOperacaoAdministrativa (Context context, Handler handler)

public void	iniciaOperacaoAdministrativa (Operacoes operacoes, Context context, Handler handler)

public void	setPersonalizacao (Personalizacao mPersonalizacao)

public int	configuraCupomPersonalizado (String caminhoImagem)

public int	configuraCupomPersonalizado (@NonNull Bitmap Imagembitmap)

Deprecated public void	iniciarPagamentoDebito (String valorTransacao, Context context, Handler handler)

Deprecated public void	iniciarPagamentoCredito (String valorTransacao, int tipoFinanciamento, Context context, Handler handler)

Deprecated public void	iniciarPagamentoCredito (String valorTransacao, int tipoFinanciamento, int numeroParcelas, Context context, Handler handler)

Deprecated public void	iniciarCancelamentoVenda (String valorTotal, Context context, Handler handler)

Deprecated public void	iniciarCancelamentoVenda (String valorTotal, String ref, String data, Context context, Handler handler)

Deprecated public void	iniciarOperacaoAdministrativa (Context context, Handler handler)

Descrição detalhada

Enumerações

◆ TipoImpressao

enum TipoImpressao

Enum responsavel por configurar os tipos de impressão que podem ser utilizadas pela classe de pagamento.

Enumeradores
IMPRESSAO_PADRAO	IMPRIME DIRETO APENAS VIA DO ESTABELECIMENTO E PERGUNTA SOBRE VIA DO CLIENTE
IMPRESSAO_DIRETA_VIA_CLIENTE_VIA_ESTABELECIMENTO	IMPRIME DIRETO TODAS AS VIAS
IMPRESSAO_DIRETA_VIA_CLIENTE	IMPRIME DIRETO APENAS VIA DO CLIENTE
IMPRESSAO_DIRETA_VIA_ESTABELECIMENTO	IMPRIME DIRETO APENAS VIA DO ESTABELECIMENTO
IMPRESSAO_DESABILITADA	NÃO IMPRIME NENHUMA VIA
IMPRESSAO_INDEFINIDA	PERGUNTA AO USUÁRIOS QUAIS VIAS IMPRIMIR

Funções

◆ getIdTransacao()

public String getIdTransacao ( )

Função para retornar o ID da Transação

Retorna: string com o valor configurado pela função setIdTransacao ou um valor randomico gerado em casos onde o id não foi setado;

◆ setIdTransacao()

public void setIdTransacao ( String midTransacao )

Configura o ID da transação

Parâmetros

midTransacao String a ser usada como Identificador da transação

◆ getPdv()

public String getPdv ( )

Função utilizada para retornar o código do PDV

Retorna: retorno tipo string, podendo ser vazio caso não tenha sido configurado pela função setPdv;

◆ setPdv()

public void setPdv ( String mpdv )

Configura o código do pdv que sera acrescentado no retorno das operações

Parâmetros

mpdv	Tipo String com o valor a ser utilizado;

◆ getTipoImpressao()

public TipoImpressao getTipoImpressao ( )

Retorna o tipo de impressão a ser realizado;

Retorna: Enum TipoImpressao

◆ setTipoImpressao()

public void setTipoImpressao ( TipoImpressao tipoImpressao )

Configura qual o tipo de impressão a ser realizado;

Parâmetros

tipoImpressao - Enum TipoImpressao

◆ setColetarInfoCupomFiscal()

public void setColetarInfoCupomFiscal ( boolean coletarInfoCupomFiscal )

Habilida/Desabilita popup para operador informar se o cupom fiscal deve ser emitido;

Parâmetros

coletarInfoCupomFiscal - True para habilitar e false para desabilitar;

◆ isColetarInfoCupomFiscal()

public boolean isColetarInfoCupomFiscal ( )

Função para retornar se esta Habilitado o popup para operador informar se deve ser emitido cupom fiscal Essa informação será retornada ao PDV para que possa ser emitido o cupom fiscal e em seguida seja impresso o danfe para o Cliente. Para impressão dos documentos podem ser utilizadas as funções de impressão de xml presentes no modulo termica ou no modulo brigde.

Retorna: true caso o popup esteja habilidado.

◆ iniciaVenda()

public void iniciaVenda	(	String	valorTotal,
		Context	context,
		Handler	handler
	)

Inicia uma transação. A modalidade (débito ou crédito) sera escolhido pelo operador

Parâmetros

valorTotal	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON. Consulte Retorno

◆ iniciaVendaDebito()

public void iniciaVendaDebito	(	String	valorTotal,
		Context	context,
		Handler	handler
	)

Inicia uma transação de débito

Parâmetros

valorTotal	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON. Consulte Retorno

◆ iniciaVendaCredito()

public void iniciaVendaCredito	(	String	valorTotal,
		int	tipoFinanciamento,
		int	numeroParcelas,
		Context	context,
		Handler	handler
	)

Inicia uma transação de crédito

Parâmetros

valorTotal	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
tipoFinanciamento	- Tipo do financiamento (A vista(1), parcelado emissor(2) ou parcelado estabelecimento(3))
numeroParcelas	- Quantidade de parcelas para as transações parcelada. Para transação a vista o valor sera desconsiderado.
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON. Consulte Retorno

◆ iniciaCancelamentoVenda()

public void iniciaCancelamentoVenda	(	String	valorTotal,
		String	ref,
		String	data,
		Context	context,
		Handler	handler
	)

Função para transação de cancelamento de uma transação débito ou crédito

Parâmetros

valorTotal	- Valor total da venda em centavos, ex: 100 para venda de R$1,00 (ValorTotal no json retornado da venda)
ref	- Referencia da transação original (NSUTerminal no json retornado da venda)
data	- Data da transação original no formato MMM dd, yyyy HH:mm:ss aaa (dataHoraTransacao no json retornado da venda)
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON. Consulte Retorno

◆ iniciaOperacaoAdministrativa() [1/2]

public void iniciaOperacaoAdministrativa	(	Context	context,
		Handler	handler
	)

Inicia uma operação administrativa

Parâmetros

context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON. Consulte Retorno

◆ iniciaOperacaoAdministrativa() [2/2]

public void iniciaOperacaoAdministrativa	(	Operacoes	operacoes,
		Context	context,
		Handler	handler
	)

Inicia uma operação definida pelo Usuario

Parâmetros

operacoes	- Enum de Operações disponiveis.
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON. Consulte Retorno

◆ setPersonalizacao()

public void setPersonalizacao ( Personalizacao mPersonalizacao )

Função para personalização da interface de pagamento.
Por padrão o ElginPay tem a identidade visual da Elgin, azul com branco, mas isso pode ser alterado de acordo com a necessidade da automação.

Parâmetros

mPersonalizacao

- Objeto com as informações de personalização.

Exemplo de personalização:

// ...
 
Personalizacao.Builder pb = new Personalizacao.Builder();
pb.informaIconeToolbar(new File("/sdcard/ic_launcher_round.png"));  // Altera o ícone
pb.informaFonte(new File("/system/fonts/Clockopia.ttf"));           // Altera a fonte
pb.informaCorFonte("#FC9F00");                                      // Altera a cor da fonte
pb.informaCorFonteTeclado("#FC9F00");                               // Altera a cor da fonte do teclado
pb.informaCorFundoToolbar("#FC9F00");                               // Altera a cor do fundo da barra superior
pb.informaCorFundoTela("#0C0807");                                  // Altera a cor do fundo da tela
pb.informaCorTeclaLiberadaTeclado("#464B4E");                       // Altera a cor da tecla liberada do teclado
pb.informaCorFundoTeclado("#1B1A1C");                               // Altera a cor do fundo do teclado
pb.informaCorTextoCaixaEdicao("#464B4E");                           // Altera a cor do texto da caixa de edição
pb.informaCorSeparadorMenu("#FC9F00");                              // Altera a cor dos separadores do menu
 
Personalizacao personalizacao = pb.build(); // Cria o objeto de personalização
 
// ...
 
ElginPay elginPay = new ElginPay();         // Cria o objeto do ElginPay
elginPay.setPersonalizacao(personalizacao); // Configura a personalização do ElginPay
 
// ...

Notas:

O ícone utilizado no exemplo está localizado no diretório sdcard do dispositivo;
A fonte utilizada no exemplo é uma fonte do sistema Android;
As cores devem ser informadas em rgb.

◆ configuraCupomPersonalizado() [1/2]

public int configuraCupomPersonalizado ( String caminhoImagem )

Função utilizada para personalizar a imagem do cupom, sendo defindo através do caminho onde se encontra a imagem.

Parâmetros

caminhoImagem - Parâmetro do tipo String utilizado para informar o caminho absoluto da imagem.

Retorna: - o Retorno será do tipo inteiro, onde :

‍ 0 = SUCESSO
-1 = O ARQUIVO NÃO EXISTE OU NÃO FOI ENCONTRADO

Exemplo de personalização:

// ...

ElginPay pay = new ElginPay();

pay.configuraCupomPersonalizado( Environment.getExternalStorageDirectory().getPath() + "/Download/novoLogoElgin.png");

// ...

◆ configuraCupomPersonalizado() [2/2]

public int configuraCupomPersonalizado ( @NonNull Bitmap Imagembitmap )

Função utilizada para personalizar a imagem do cupom, sendo defindo através de um objeto bitmap onde se encontra a imagem.

Parâmetros

Imagembitmap - Parâmetro do tipo Bitmap, utilizado para informar a imagem de personalização.

Retorna: - o Retorno será do tipo inteiro, onde :

‍ 0 = SUCESSO
-1 = O OBJETO BITMAP NÃO EXISTENTE

Exemplo de personalização usando um bitmap presente na pasta asserts:

// ...

AssetManager am = this.getAssets();

InputStream inputStream = null;

try {

inputStream = am.open("novoLogoElgin.png");

Bitmap bitmap = BitmapFactory.decodeStream(inputStream);

ElginPay pay = new ElginPay();

pay.configuraCupomPersonalizado(bitmap);

// ...

◆ iniciarPagamentoDebito()

Deprecated public void iniciarPagamentoDebito	(	String	valorTransacao,
		Context	context,
		Handler	handler
	)

Inicia uma transação de débito

Obsoleto(a):: Função descontinuada. Utilize ElginPay#iniciaVendaDebito(String, Context, Handler)

Parâmetros

valorTransacao	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON

◆ iniciarPagamentoCredito() [1/2]

Deprecated public void iniciarPagamentoCredito	(	String	valorTransacao,
		int	tipoFinanciamento,
		Context	context,
		Handler	handler
	)

Inicia uma transação de crédito

Obsoleto(a):: Função descontinuada. Utilize a função ElginPay#iniciaVendaCredito(String, int, int, Context, Handler)

Parâmetros

valorTransacao	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
tipoFinanciamento	- Tipo do financiamento (A vista(0), parcelado emissor(1) ou parcelado estabelecimento(2))
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON

◆ iniciarPagamentoCredito() [2/2]

Deprecated public void iniciarPagamentoCredito	(	String	valorTransacao,
		int	tipoFinanciamento,
		int	numeroParcelas,
		Context	context,
		Handler	handler
	)

Inicia uma transação de crédito

Obsoleto(a):: Função descontinuada. Utilize a função ElginPay#iniciaVendaCredito(String, int, int, Context, Handler)

Parâmetros

valorTransacao	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
tipoFinanciamento	- Tipo do financiamento (A vista(1), parcelado emissor(2) ou parcelado estabelecimento(3))
numeroParcelas	- Quantidade de parcelas para as transações parcelada. Para transação a vista o valor sera desconsiderado.
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON

◆ iniciarCancelamentoVenda() [1/2]

Deprecated public void iniciarCancelamentoVenda	(	String	valorTotal,
		Context	context,
		Handler	handler
	)

Função para transação de cancelamento de uma transação débito ou crédito

Obsoleto(a):: Função descontinuada. Utilize a função ElginPay#iniciaCancelamentoVenda(String, String, String, Context, Handler)

Parâmetros

valorTotal	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON

◆ iniciarCancelamentoVenda() [2/2]

Deprecated public void iniciarCancelamentoVenda	(	String	valorTotal,
		String	ref,
		String	data,
		Context	context,
		Handler	handler
	)

Função para transação de cancelamento de uma transação débito ou crédito

Obsoleto(a):: Função descontinuada. Utilize a função ElginPay#iniciaCancelamentoVenda(String, String, String, Context, Handler)

Parâmetros

valorTotal	- Valor total da venda em centavos, ex: 100 para venda de R$1,00
ref	- Ref (NSU) da transação original
data	- Data da transação original no formato MMM dd, yyyy HH:mm:ss aaa
context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON

◆ iniciarOperacaoAdministrativa()

Deprecated public void iniciarOperacaoAdministrativa	(	Context	context,
		Handler	handler
	)

Inicia uma operação administrativa

Obsoleto(a):: Função descontinuada. Utilize a função ElginPay#iniciaOperacaoAdministrativa(Context, Handler)

Parâmetros

context	- Activity atual utilizada para apresentação de Dialogos com o usuário
handler	- Objeto handler utilizado para receber a resposta do transação atravez do método handleMessage. A resposta será enviada como String no formato JSON