co.poynt.os.services.v1

Interface IPoyntRatingAndReviewService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntRatingAndReviewService.Stub

public interface IPoyntRatingAndReviewService
extends android.os.IInterface

Provides necessary interfaces to support rating and review 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=".CustomRatingAndReviewService"
             android:enabled="true"
             android:exported="true">

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

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

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

  Sample Loyalty 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,
                    please see CapabilityType defined in PoyntSDK for list of types supported.
            -->
            <type>RATING_AND_REVIEW</type>

            <!-- descriptive name of this capability -->
            <provider>Awesome Ratings</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	IPoyntRatingAndReviewService.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
void	cancel(java.lang.String requestId) Cancel previously initiated rating/review request identified by requestId.
void	collect(Payment payment, java.lang.String requestId, IPoyntRatingAndReviewServiceListener callback) Collect rating/review from the customer.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

collect

void collect(Payment payment,
             java.lang.String requestId,
             IPoyntRatingAndReviewServiceListener callback)
      throws android.os.RemoteException

Collect rating/review from the customer. NOTE: When this interface is invoked by Payment Fragment, it will only wait for 30 secs for a response, if no response is received it will move forward to payment collection.

Parameters:

payment - Payment

requestId - RequestId

callback - IPoyntRatingAndReviewServiceListener

Throws:

android.os.RemoteException

cancel

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

Cancel previously initiated rating/review request identified by requestId.

Parameters:

requestId - RequestId sent in previous collect() call

Throws:

android.os.RemoteException