co.poynt.os.services.v1

Interface IPoyntReceiptDecoratorService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntReceiptDecoratorService.Stub

public interface IPoyntReceiptDecoratorService
extends android.os.IInterface

Provides necessary interfaces to support receipt decorator service on Poynt OS. Typical integration includes the following steps:

All implementers of this Service must add meta data to the 'Service' element in their Android Manifest file for Poynt to recognize and invoke your service as needed. Here's the example service declaration in AndroidManifest.xml

 
  Sample Service
         <service
             android:name=".CustomizationReceiptService"
             android:enabled="true"
             android:exported="true">

             <!-- define the intent filter with an action as IPoyntReceiptDecoratorService interface -->
             <intent-filter>
                 <action android:name="co.poynt.os.services.v1.IPoyntReceiptDecoratorService" />
             </intent-filter>

             <meta-data
                 android:name="co.poynt.os.service.capability"
                 android:resource="@xml/receipt_capabilities"/>

             <!-- Optional: Provide a logo that will appear on screen -->
             <meta-data
                 android:name="co.poynt.os.service.logo"
                 android:resource="@drawable/custom_receipt" />
         </service>

  Sample Receipt Decorator XML
        <?xml version="1.0" encoding="utf-8"?>
        <!-- This xml defines what capabilities are supported by the service that uses this xml.
          Capabilities will be used by PoyntOS to produce custom UI on behalf of the service to
          get inputs from merchant/customer. -->
        <capability xmlns:android="http://schemas.android.com/apk/res/android">

            <!-- REQUIRED: package name of your android app-->
            <appid>-your-package-name-</appid>

            <!-- REQUIRED: type of capbility, should be one of
                    CUSTOM_TRANSACTION, DISCOUNT, LOYALTY, RECEIPT_DECORATOR
                    please see CapabilityType defined in PoyntSDK for list of types supported.
            -->
            <type>RECEIPT_DECORATOR</type>

            <!-- descriptive name of this capability -->
            <provider>My Custom Receipt Decorator</provider>>

            <!-- entry method could be one of the following
                MANUAL -> will result in showing a icon to the merchant to manually launch the capability.
                CARDREAD -> card data will be directly passed to this capability provider.
                QRCODE -> qr code entry.
                NFC -> NFC will be directly passed  to this capability provider.
                OTHER -> other entry methods.
                each entry method can be additionally filtered with eval tag.
            -->
            <entry_method type="CUSTOM"></entry_method>

        </capability>
 
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	cancel(java.lang.String requestId) Cancel previously initiated request identified by requestId.
void	decorate(PrintedReceipt receipt, java.lang.String requestId, IPoyntReceiptDecoratorServiceListener callback) Decorate PoyntReceipt with additional info.
void	decorateV2(PrintedReceiptV2 receipt, java.lang.String requestId, IPoyntReceiptDecoratorListener callback) Decorate poynt receipt with additional info.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

decorate

void decorate(PrintedReceipt receipt,
              java.lang.String requestId,
              IPoyntReceiptDecoratorServiceListener callback)
       throws android.os.RemoteException

Decorate PoyntReceipt with additional info. NOTE: When this interface is invoked by the receipt service, it will only wait for 1 sec for a response, if no response is received it will move forward to print the receipt as it is.

Parameters:

receipt - PrintedReceipt

requestId - RequestId

callback - IPoyntReceiptDecoratorServiceListener

Throws:

android.os.RemoteException

cancel

void cancel(java.lang.String requestId)
     throws android.os.RemoteException

Cancel previously initiated request identified by requestId.

Parameters:

requestId - RequestId sent in previous decorate() call

Throws:

android.os.RemoteException

decorateV2

void decorateV2(PrintedReceiptV2 receipt,
                java.lang.String requestId,
                IPoyntReceiptDecoratorListener callback)
         throws android.os.RemoteException

Decorate poynt receipt with additional info. NOTE: When this interface is invoked by the receipt service, it will only wait for 1 sec for a response, if no response is received it will move forward to print the receipt as it is.

Parameters:

receipt - PrintedReceiptV2

requestId - RequestId

callback - IPoyntReceiptDecoratorServiceListener

Throws:

android.os.RemoteException