co.poynt.os.services.v2

Interface IPoyntSecondScreenService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntSecondScreenService.Stub

public interface IPoyntSecondScreenService
extends android.os.IInterface

Provides the interfaces to request display of various predefined second screen consumer UI templates. When the templates allow the consumers to enter information, the callbacks are used to return the customer entered information to the caller applications. All calls require the necessary permissions declared in the caller's Android Manifest file. Please refer to Poynt OS Permissions for more details.

Since:

1.0.26

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPoyntSecondScreenService.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
void	captureAgreement(java.lang.String agreementUrl, android.os.Bundle options, IPoyntActionButtonListener listener) Displays web view for agreement w/ accept/decline buttons
void	captureDccChoice(android.os.Bundle options, co.poynt.api.model.ExchangeRate exchangeRate, IPoyntSecondScreenDynamicCurrConversionListener listener) Displays Dynamic Currency Conversion option
void	captureEmail(android.os.Bundle options, IPoyntEmailEntryListener listener) Displays the email address collection screen to the customer.
void	captureInstallmentOption(android.os.Bundle options, java.util.List<InstallmentsOption> installmentsOptions, IPoyntInstallmentPlanListener listener) Presents installment options
void	capturePhone(android.os.Bundle options, IPoyntPhoneEntryListener listener) Displays the phone numer collection screen to the customer.
void	captureReceiptChoice(co.poynt.api.model.TransactionAmounts amounts, java.util.List<ReceiptOption> receiptOptions, android.os.Bundle options, IPoyntReceiptChoiceListener callback) Displays the receipt choices to the customer on the second screen.
void	captureSignature(co.poynt.api.model.TransactionAmounts amounts, android.os.Bundle options, IPoyntSignatureListener callback) Capture Signature screen.
void	captureTip(long amount, java.lang.String currency, android.os.Bundle options, IPoyntTipListener callback) Displays the tip collection screen to the customer.
void	displayMessage(java.lang.String content, android.os.Bundle options) Displays a message with a custom background
void	scanCode(android.os.Bundle options, IPoyntScanCodeListener listener) Displays the scan code (barcode, qrcode, etc.) screen to the customer.
void	showCartConfirmation(java.util.List<co.poynt.api.model.OrderItem> items, java.util.List<co.poynt.api.model.Discount> discounts, java.util.List<co.poynt.api.model.Fee> fees, co.poynt.api.model.TransactionAmounts amounts, boolean enableActionButtons, android.os.Bundle options, IPoyntActionButtonListener callback) Displays the given list of items on the second screen.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

captureTip

void captureTip(long amount,
                java.lang.String currency,
                android.os.Bundle options,
                IPoyntTipListener callback)
         throws android.os.RemoteException

Displays the tip collection screen to the customer.

Parameters:

amount - transaction amount for which tip is being captured

currency - amount currency

options - Bundle with optional parameters, MODE: AMOUNTS or PERCENTS or CUSTOM TIP_AMOUNT1,TIP_AMOUNT2, TIP_AMOUNT3 when mode is AMOUNT TIP_PERCENT1, TIP_PERCENT2, TIP_PERCENT3 when mode is PERCENTAGE TITLE - to set custom title SECONDARY_TITLE

callback - IPoyntTipListener

Throws:

android.os.RemoteException

showCartConfirmation

void showCartConfirmation(java.util.List<co.poynt.api.model.OrderItem> items,
                          java.util.List<co.poynt.api.model.Discount> discounts,
                          java.util.List<co.poynt.api.model.Fee> fees,
                          co.poynt.api.model.TransactionAmounts amounts,
                          boolean enableActionButtons,
                          android.os.Bundle options,
                          IPoyntActionButtonListener callback)
                   throws android.os.RemoteException

Displays the given list of items on the second screen. Only the last 3 items are displayed at any given time along with the item count and total amount.

Parameters:

items - List of OrderItems to display

discounts - List of Discounts to display

fees - List of Fees to display

amounts - TransactionAmounts containing the payment details

enableActionButtons - to enable/disable action buttons in the footer

options - Bundle with optional parameters: TITLE, LEFT_BUTTON_TITLE, RIGHT_BUTTON_TITLE

callback - IPoyntActionButtonListener

Throws:

android.os.RemoteException

captureReceiptChoice

void captureReceiptChoice(co.poynt.api.model.TransactionAmounts amounts,
                          java.util.List<ReceiptOption> receiptOptions,
                          android.os.Bundle options,
                          IPoyntReceiptChoiceListener callback)
                   throws android.os.RemoteException

Displays the receipt choices to the customer on the second screen. By default all 4 options are displayed - PAPER, EMAIL, TEXT, NO-RECEIPT

Parameters:

options - Bundle to pass options to enable/disale options TITLE, FOOTER_TEXT

callback - IPoyntActionButtonListener

Throws:

android.os.RemoteException

captureSignature

void captureSignature(co.poynt.api.model.TransactionAmounts amounts,
                      android.os.Bundle options,
                      IPoyntSignatureListener callback)
               throws android.os.RemoteException

Capture Signature screen.

Parameters:

transaction - if the signature is collected for a transaction

options - Bundle with additional options AGREEMENT_TEXT

callback - IPoyntSignatureListener

Throws:

android.os.RemoteException

displayMessage

void displayMessage(java.lang.String content,
                    android.os.Bundle options)
             throws android.os.RemoteException

Displays a message with a custom background

Parameters:

content - custom message to dipslay on the second screen, if it's HTML set options

options - bundle containing additional options: CONTENT-TYPE: HTML or TEXT (when URL touch is disabled for security reasons) BACKGROUD-IMAGE FONT_COLOR

backgroundImage - full screen background image for second screen.

Throws:

android.os.RemoteException

captureEmail

void captureEmail(android.os.Bundle options,
                  IPoyntEmailEntryListener listener)
           throws android.os.RemoteException

Displays the email address collection screen to the customer.

Parameters:

options - Bundle containing TITLE EMAIL- existing data to display LEFT_BUTTON_TITLE, RIGHT_BUTTON_TITLE

callback - IPoyntSecondScreenEmailEntryListener

Throws:

android.os.RemoteException

capturePhone

void capturePhone(android.os.Bundle options,
                  IPoyntPhoneEntryListener listener)
           throws android.os.RemoteException

Displays the phone numer collection screen to the customer.

Parameters:

options - Bundle containing TITLE PHONE- existing data to display LEFT_BUTTON_TITLE, RIGHT_BUTTON_TITLE

callback - IPoyntSecondScreenPhoneEntryListener

Throws:

android.os.RemoteException

captureAgreement

void captureAgreement(java.lang.String agreementUrl,
                      android.os.Bundle options,
                      IPoyntActionButtonListener listener)
               throws android.os.RemoteException

Displays web view for agreement w/ accept/decline buttons

Parameters:

options - Bundle containing TITLE LEFT_BUTTON_TITLE, RIGHT_BUTTON_TITLE

callback - IPoyntSecondScreenPhoneEntryListener

Throws:

android.os.RemoteException

scanCode

void scanCode(android.os.Bundle options,
              IPoyntScanCodeListener listener)
       throws android.os.RemoteException

Displays the scan code (barcode, qrcode, etc.) screen to the customer.

Parameters:

options - Bundle containing TITLE BACKGROUND-IMAGE CANCEL_BUTTON_TITLE

callback - IPoyntScanCodeListener

Throws:

android.os.RemoteException

captureDccChoice

void captureDccChoice(android.os.Bundle options,
                      co.poynt.api.model.ExchangeRate exchangeRate,
                      IPoyntSecondScreenDynamicCurrConversionListener listener)
               throws android.os.RemoteException

Displays Dynamic Currency Conversion option

Parameters:

options - Bundle containing HIDE_CONVERSION_FEE - true | false (default) DCC_DISCLAIMER - overrides disclaimer text DCC_DISCLAIMER_FONT_SIZE - font size in sp (e.g. "22sp") DCC_SKIP_CONFIRMATION - do not show the confirmation screen

exchangeRate -

listener - IPoyntSecondScreenDynamicCurrConversionListener

Throws:

android.os.RemoteException

captureInstallmentOption

void captureInstallmentOption(android.os.Bundle options,
                              java.util.List<InstallmentsOption> installmentsOptions,
                              IPoyntInstallmentPlanListener listener)
                       throws android.os.RemoteException

Presents installment options

Parameters:

options - Bundle containing additional options EXTRA_TITLE - screen title EXTRA_BACKGROUND_COLOR - screen background color EXTRA_FONT_COLOR - title color EXTRA_FONT_SIZE - title font size

installmentsOptions - List of co.poynt.api.model.InstallmentsOptions

listener - IPoyntInstallmentPlanListener

Throws:

android.os.RemoteException