Home Guides Reference Downloads

LoyaltyWalletObject

public final class LoyaltyWalletObject extends Object
implements Parcelable

Parcelable representing a loyalty wallet object. An example loyalty wallet object could be a rewards membership where the membership id is placed in the accountId.

Nested Class Summary

class LoyaltyWalletObject.Builder Builder to create a LoyaltyWalletObject. 

Inherited Constant Summary

Field Summary

public static final Creator<LoyaltyWalletObject> CREATOR

Public Method Summary

String
getAccountId()
String
getAccountName()
String
getBarcodeAlternateText()
String
getBarcodeLabel()
This method is deprecated. This value is unused by the platform and will be removed in the future.
String
getBarcodeType()
String
getBarcodeValue()
String
getClassId()
String
getId()
ArrayList<UriData>
getImageModuleDataMainImageUris()
String
getInfoModuleDataHexBackgroundColor()
This method is deprecated. This value is unused by the platform and will be removed in the future.
String
getInfoModuleDataHexFontColor()
This method is deprecated. This value is unused by the platform and will be removed in the future.
ArrayList<LabelValueRow>
getInfoModuleDataLabelValueRows()
boolean
getInfoModuleDataShowLastUpdateTime()
String
getIssuerName()
ArrayList<UriData>
getLinksModuleDataUris()
ArrayList<LatLng>
getLocations()
LoyaltyPoints
getLoyaltyPoints()
ArrayList<WalletObjectMessage>
getMessages()
String
getProgramName()
int
getState()
ArrayList<TextModuleData>
getTextModulesData()
TimeInterval
getValidTimeInterval()
static LoyaltyWalletObject.Builder
newBuilder()
void
writeToParcel(Parcel dest, int flags)

Inherited Method Summary

Fields

public static final Creator<LoyaltyWalletObject> CREATOR

Public Methods

public String getAccountId ()

Returns
  • Loyalty account identifier to be displayed to the user (ex: "12345678").

public String getAccountName ()

Returns
  • Loyalty account holder name (ex: "John Smith").

public String getBarcodeAlternateText ()

Returns
  • Human-readable text to display to the user in addition to the encoded barcode value (ex: "3492013").

public String getBarcodeLabel ()

This method is deprecated.
This value is unused by the platform and will be removed in the future.

Returns
  • Barcode label.

public String getBarcodeType ()

Returns
  • Barcode type. Possible values include "codabar", "qrCode", "textOnly", etc...

public String getBarcodeValue ()

Returns
  • Encoded barcode value.

public String getClassId ()

Returns
  • Wallet Object Class Id.

public String getId ()

Returns
  • The unique identifier for this Wallet Object.

public ArrayList<UriData> getImageModuleDataMainImageUris ()

Returns
  • Image module main image uris.

public String getInfoModuleDataHexBackgroundColor ()

This method is deprecated.
This value is unused by the platform and will be removed in the future.

Returns
  • Info module hex background color.

public String getInfoModuleDataHexFontColor ()

This method is deprecated.
This value is unused by the platform and will be removed in the future.

Returns
  • Info module hex font color.

public ArrayList<LabelValueRow> getInfoModuleDataLabelValueRows ()

Returns
  • Info module label value rows.

public boolean getInfoModuleDataShowLastUpdateTime ()

Returns
  • Info module show last update time flag.

public String getIssuerName ()

Returns
  • The name of who issued this loyalty object.

public ArrayList<UriData> getLinksModuleDataUris ()

Returns
  • Links module uris.

public ArrayList<LatLng> getLocations ()

Returns
  • Locations where the object is considered valid.

public LoyaltyPoints getLoyaltyPoints ()

Returns
  • Loyalty points.

public ArrayList<WalletObjectMessage> getMessages ()

Returns
  • Wallet Object messages.

public String getProgramName ()

Returns
  • The name of the loyalty program associated to this object.

public int getState ()

Returns
  • Wallet Object state.

public ArrayList<TextModuleData> getTextModulesData ()

Returns
  • Text modules.

public TimeInterval getValidTimeInterval ()

Returns
  • Time interval within which the object is considered valid.

public static LoyaltyWalletObject.Builder newBuilder ()

public void writeToParcel (Parcel dest, int flags)