clover-android-loyalty-kit/com.clover.loyalty.activity.helper/CloverCFPLoyaltyHelper

CloverCFPLoyaltyHelper

Used by an Activity on the customer facing side to allow loyalty and customer information to be passed between the customer and merchant facing sides.

Allows an integrator to use whatever base class they want to use for their Activity.

Since

4.1.0

Constructors

CloverCFPLoyaltyHelper

public void CloverCFPLoyaltyHelper(Activity activity, CloverCFPLoyaltyHelper.LoyaltyListener loyaltyListener, CFPSessionListener externalSessionListener)

Main constructor.

Types

LoyaltyListener

public interface LoyaltyListener

Interface implemented on the customer facing side.

Properties

customerInfo

public CustomerInfo customerInfo

displayOrder

public DisplayOrder displayOrder

isStopping

public boolean isStopping

LOG_TAG

public final static String LOG_TAG

Functions

announceCustomerProvidedData

public void announceCustomerProvidedData(LoyaltyDataConfig loyaltyDataConfig, String data)

Used by custom activities to announce loyalty data, collected by the custom activity and put it in the loyalty platform.

dispose

public void dispose()

Cleans up the sessionConnector, loyalty connector and Consumers of this class will want to call this method in their Activity's onDestroy method:

  public class CloverLoyaltyCustomActivity extends Activity {
      private CloverCFPLoyaltyHelper cloverCFPLoyaltyHelper;
      ...
      protected void onDestroy() {
          // Tell the helper to clean up everything
          cloverCFPLoyaltyHelper.dispose();
          super.onDestroy();
      }
      ...
  }

finishActivity

public final void finishActivity()

Finish the activity setting RESULT_OK with a null payload.

getCustomerInfo

@Nullable()

public CustomerInfo getCustomerInfo()

getDisplayOrder

public DisplayOrder getDisplayOrder()

getLoyaltyDataConfig

@Nullable()

public LoyaltyDataConfig getLoyaltyDataConfig(@Nullable() String type)

Given a config type, returns the corresponding LoyaltyDataConfig.

getOrderTotal

public String getOrderTotal()

hasOrder

public boolean hasOrder()

isStopping

public boolean isStopping()

Use this method to know if dispose() has been called on this class.

onStart

public void onStart()

Mirrors the Activity Lifecycle method (@see Activity#onStart()) Consumers of this class should call this method in their activity's "onStart()" method:

  public class CloverLoyaltyCustomActivity extends Activity {
      private CloverCFPLoyaltyHelper cloverCFPLoyaltyHelper;
      ...
      protected void onStart() {
          super.onStart();
          cloverCFPLoyaltyHelper.onStart();
      }
      ...
  }

onStop

public void onStop()

Mirrors the Activity Lifecycle method (@see Activity#onStop()) Consumers of this class should call this method in their activity's "onStop()" method:

  public class CloverLoyaltyCustomActivity extends Activity {
      private CloverCFPLoyaltyHelper cloverCFPLoyaltyHelper;
      ...
      protected void onStop() {
          super.onStop();
          cloverCFPLoyaltyHelper.onStop();
      }
      ...
  }

sendMessage

public void sendMessage(String payload)

Send a message back to the POS.

setCustomerInfo