co.poynt.os.services.v1

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-beta2

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	captureCashback(long amount, long tipAmount, long cashbackAmountLimit, java.lang.String currency, boolean autoSubmit, long autoSubmitTimeout, IPoyntSecondScreenCashbackEntryListener listener) Displays the cashback collection screen to the customer.
void	captureCode(SecondScreenLabels negativeButtonLabel, IPoyntSecondScreenCodeScanListener listener) Displays the scan code (barcode, qrcode, etc.) screen to the customer.
void	captureDccChoice(co.poynt.api.model.ExchangeRate exchangeRate, java.lang.String stayID, IPoyntSecondScreenDynamicCurrConversionListener listener) Displays Dynamic Currency Conversion option
void	captureEmailAddress(java.lang.String currentReceiptEmail, SecondScreenLabels negativeButtonLabel, SecondScreenLabels positiveButtonLabel, IPoyntSecondScreenEmailEntryListener listener) Displays the email address collection screen to the customer.
void	capturePhone(java.lang.String currentPhone, SecondScreenLabels negativeButtonLabel, SecondScreenLabels positiveButtonLabel, IPoyntSecondScreenPhoneEntryListener listener) Deprecated. in favor of capturePhoneWithOptions
void	capturePhoneNumber(SecondScreenLabels negativeButtonLabel, SecondScreenLabels positiveButtonLabel, IPoyntSecondScreenPhoneEntryListener listener) Displays the phone numer collection screen to the customer.
void	capturePhoneWithOptions(java.lang.String currentPhone, SecondScreenLabels negativeButtonLabel, SecondScreenLabels positiveButtonLabel, android.os.Bundle options, IPoyntSecondScreenPhoneEntryListener listener) Displays the phone numer collection screen to the customer.
void	captureTip(co.poynt.api.model.Transaction transaction, IPoyntSecondScreenTipCaptureListener listener) Displays the tip collection screen to the customer.
void	collectEmailAddress(java.lang.String currentReceiptEmail, IPoyntSecondScreenEmailEntryListener listener) Deprecated. in favor of captureEmailAddress
void	collectPhoneNumber(IPoyntSecondScreenPhoneEntryListener listener) Deprecated. in favor of capturePhoneNumber
void	collectRating(int minValue, int maxValue, int increment, java.lang.String message, android.graphics.Bitmap logo, android.graphics.Bitmap scaleImage, IPoyntSecondScreenRatingEntryListener listener) Collect rating from the user based on the given scale.
void	collectTextEntry(java.lang.String initialText, IPoyntSecondScreenTextEntryListener listener) Displays the text collection screen to the customer.
void	collectTip(co.poynt.api.model.Transaction transaction, IPoyntSecondScreenTipEntryListener listener) Deprecated. in favor of captureTip
void	displayMessage(java.lang.String messageLabel, android.graphics.Bitmap backgroundImage) Displays a message with a custom background
void	displayWelcome(java.lang.String buttonLabel, android.graphics.Bitmap topLogo, IPoyntSecondScreenCheckInListener listener) Displays the welcome screen to the customer with an optional Check-in button.
void	scanCode(IPoyntSecondScreenCodeScanListener listener) Deprecated. in favor of captureCode Displays the scan code (barcode, qrcode, etc.) screen to the customer.
void	showCheckIn(java.lang.String buttonLabel, android.graphics.Bitmap buttonBackground, android.graphics.Bitmap backgroundImage, IPoyntSecondScreenCheckInListener listener) Displays a screen with an action button with the default text "CHECK-IN"
void	showItem(java.util.List<co.poynt.api.model.OrderItem> items, long totalAmount, java.lang.String currency) Displays the given list of items on the second screen.
void	showOrder(co.poynt.api.model.Order order, long totalAmount, java.lang.String currency) Displays the given order on the second screen.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

showItem

void showItem(java.util.List<co.poynt.api.model.OrderItem> items,
              long totalAmount,
              java.lang.String currency)
       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

totalAmount - Total amount of items in cents.

currency - Currency of the total amount.

Throws:

android.os.RemoteException

collectTip

void collectTip(co.poynt.api.model.Transaction transaction,
                IPoyntSecondScreenTipEntryListener listener)
         throws android.os.RemoteException

Deprecated. in favor of captureTip

Displays the tip collection screen to the customer.

Parameters:

transaction - Transaction

callback - IPoyntSecondScreenTipAndReceiptListener

Throws:

android.os.RemoteException

collectPhoneNumber

void collectPhoneNumber(IPoyntSecondScreenPhoneEntryListener listener)
                 throws android.os.RemoteException

Deprecated. in favor of capturePhoneNumber

Displays the phone number collection screen to the customer.

Parameters:

callback - IPoyntSecondScreenPhoneEntryListener

Throws:

android.os.RemoteException

collectEmailAddress

void collectEmailAddress(java.lang.String currentReceiptEmail,
                         IPoyntSecondScreenEmailEntryListener listener)
                  throws android.os.RemoteException

Deprecated. in favor of captureEmailAddress

Displays the email address collection screen to the customer.

Parameters:

currentReceiptEmail - customer's email on record (if available)

callback - IPoyntSecondScreenEmailEntryListener

Throws:

android.os.RemoteException

collectTextEntry

void collectTextEntry(java.lang.String initialText,
                      IPoyntSecondScreenTextEntryListener listener)
               throws android.os.RemoteException

Displays the text collection screen to the customer.

Parameters:

initialText - initial text (if available)

callback - IPoyntSecondScreenEmailEntryListener

Throws:

android.os.RemoteException

scanCode

void scanCode(IPoyntSecondScreenCodeScanListener listener)
       throws android.os.RemoteException

Deprecated. in favor of captureCode Displays the scan code (barcode, qrcode, etc.) screen to the customer.

Parameters:

callback - IPoyntSecondScreenCodeScanListener

Throws:

android.os.RemoteException

displayWelcome

void displayWelcome(java.lang.String buttonLabel,
                    android.graphics.Bitmap topLogo,
                    IPoyntSecondScreenCheckInListener listener)
             throws android.os.RemoteException

Displays the welcome screen to the customer with an optional Check-in button. Button width is 80dp and height wraps content

Parameters:

buttonLabel - The label displayed on the button (defaults to "CHECK-IN")

topLogo - logo to display above the button label

callback - (@link IPoyntSecondScreenCheckInListener}

Throws:

android.os.RemoteException

showOrder

void showOrder(co.poynt.api.model.Order order,
               long totalAmount,
               java.lang.String currency)
        throws android.os.RemoteException

Displays the given order on the second screen. Only the last 3 items are displayed at any given time along with the item count and total amount,discount applied,tax exempted.

Parameters:

order - order Orders to display

totalAmount - Total amount of items in cents.

currency - Currency of the total amount.

Throws:

android.os.RemoteException

captureEmailAddress

void captureEmailAddress(java.lang.String currentReceiptEmail,
                         SecondScreenLabels negativeButtonLabel,
                         SecondScreenLabels positiveButtonLabel,
                         IPoyntSecondScreenEmailEntryListener listener)
                  throws android.os.RemoteException

Displays the email address collection screen to the customer.

Parameters:

currentReceiptEmail - customer's email on record (if available)

negativeButtonLabel - optional parameter to select a label for the button which defaults to "CANCEL"

positiveButtonLabel - optional parameter to select a label for the button which defaults to "SEND"

callback - IPoyntSecondScreenEmailEntryListener

Throws:

android.os.RemoteException

capturePhoneNumber

void capturePhoneNumber(SecondScreenLabels negativeButtonLabel,
                        SecondScreenLabels positiveButtonLabel,
                        IPoyntSecondScreenPhoneEntryListener listener)
                 throws android.os.RemoteException

Displays the phone numer collection screen to the customer.

Parameters:

negativeButtonLabel - optional parameter to select a label for the button which defaults to "CANCEL"

positiveButtonLabel - optional parameter to select a label for the button which defaults to "ENTER"

callback - IPoyntSecondScreenPhoneEntryListener

Throws:

android.os.RemoteException

captureCode

void captureCode(SecondScreenLabels negativeButtonLabel,
                 IPoyntSecondScreenCodeScanListener listener)
          throws android.os.RemoteException

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

Parameters:

negativeButtonLabel - label for the button on the screen

callback - IPoyntSecondScreenCodeScanListener

Throws:

android.os.RemoteException

captureTip

void captureTip(co.poynt.api.model.Transaction transaction,
                IPoyntSecondScreenTipCaptureListener listener)
         throws android.os.RemoteException

Displays the tip collection screen to the customer.

Parameters:

transaction - Transaction

listener - IPoyntSecondScreenTipCaptureListener

Throws:

android.os.RemoteException

collectRating

void collectRating(int minValue,
                   int maxValue,
                   int increment,
                   java.lang.String message,
                   android.graphics.Bitmap logo,
                   android.graphics.Bitmap scaleImage,
                   IPoyntSecondScreenRatingEntryListener listener)
            throws android.os.RemoteException

Collect rating from the user based on the given scale.

Parameters:

minValue - minimum value of the scale (eg. 1)

maxValue - maximum value of the scale (eg. 5)

increment - by between min and max values (eg. value of 1 will display rating scale as 1 2 3 4 5)

listener - IPoyntSecondScreenRatingEntryListener

Throws:

android.os.RemoteException

capturePhone

void capturePhone(java.lang.String currentPhone,
                  SecondScreenLabels negativeButtonLabel,
                  SecondScreenLabels positiveButtonLabel,
                  IPoyntSecondScreenPhoneEntryListener listener)
           throws android.os.RemoteException

Deprecated. in favor of capturePhoneWithOptions

Displays the phone numer collection screen to the customer.

Parameters:

currentPhone - customer's phone number on record (if available)

negativeButtonLabel - optional parameter to select a label for the button which defaults to "CANCEL"

positiveButtonLabel - optional parameter to select a label for the button which defaults to "ENTER"

callback - IPoyntSecondScreenPhoneEntryListener

Throws:

android.os.RemoteException

displayMessage

void displayMessage(java.lang.String messageLabel,
                    android.graphics.Bitmap backgroundImage)
             throws android.os.RemoteException

Displays a message with a custom background

Parameters:

messageLabel - custom message to dipslay on the second screen

backgroundImage - full screen background image

Throws:

android.os.RemoteException

showCheckIn

void showCheckIn(java.lang.String buttonLabel,
                 android.graphics.Bitmap buttonBackground,
                 android.graphics.Bitmap backgroundImage,
                 IPoyntSecondScreenCheckInListener listener)
          throws android.os.RemoteException

Displays a screen with an action button with the default text "CHECK-IN"

Parameters:

buttonLabel - text of the button. If null is passed, the default "CHECK-IN" is displayed

buttonBackground - background image for the button (800dp x 80dp). If null, the button has a default blue color. If not null, the button background is set to transparent color

backgroundImage - background for the second screen (800dp x 480dp). If null, the default background is used.

Throws:

android.os.RemoteException

capturePhoneWithOptions

void capturePhoneWithOptions(java.lang.String currentPhone,
                             SecondScreenLabels negativeButtonLabel,
                             SecondScreenLabels positiveButtonLabel,
                             android.os.Bundle options,
                             IPoyntSecondScreenPhoneEntryListener listener)
                      throws android.os.RemoteException

Displays the phone numer collection screen to the customer.

Parameters:

currentPhone - customer's phone number on record (if available)

negativeButtonLabel - optional parameter to select a label for the button which defaults to "CANCEL"

positiveButtonLabel - optional parameter to select a label for the button which defaults to "ENTER"

options - bundle to pass additional confirmation arguments. Support keys: PROMPT - text prompt in the phone field. Default "ENTER PHONE NUMBER". Allowed values are defined in SecondScreenStrings

callback - IPoyntSecondScreenPhoneEntryListener

Throws:

android.os.RemoteException

captureCashback

void captureCashback(long amount,
                     long tipAmount,
                     long cashbackAmountLimit,
                     java.lang.String currency,
                     boolean autoSubmit,
                     long autoSubmitTimeout,
                     IPoyntSecondScreenCashbackEntryListener listener)
              throws android.os.RemoteException

Displays the cashback collection screen to the customer.

Parameters:

amount - of the transaction (without cashback)

tip - amount (in addition to the amount)

cashbackAmountLimit - max cashback allowed

currency -

autoSubmit - apply timeout on the cashback collection screen

autoSubmitTimeout - timeout in millisecs

listener - IPoyntSecondScreenCashbackEntryListener

Throws:

android.os.RemoteException

captureDccChoice

void captureDccChoice(co.poynt.api.model.ExchangeRate exchangeRate,
                      java.lang.String stayID,
                      IPoyntSecondScreenDynamicCurrConversionListener listener)
               throws android.os.RemoteException

Displays Dynamic Currency Conversion option

Parameters:

exchangeRate -

stayID - optional parameter used for lodging merchants

listener - IPoyntSecondScreenDynamicCurrConversionListener

Throws:

android.os.RemoteException