OfferWalletObject

public final class OfferWalletObject extends Object
implements Parcelable

Parcelable representing an offer wallet object. This could represent an offer from the merchant such as a coupon, etc. It has a buyerId that identifies the user to the merchant. If the offer is associated to a loyalty program, then this could be an identifier for that program. The offer also has a redemptionCode that will typically be used in the transaction, like a discount code or similar that the user would otherwise have to enter manually.

Nested Class Summary

class OfferWalletObject.Builder Builder to create a OfferWalletObject

Inherited Constant Summary

Field Summary

public static final Creator<OfferWalletObject> CREATOR

Public Method Summary

String
getBarcodeAlternateText()
Returns human-readable text to display to the user in addition to the encoded barcode value (ex: "3492013").
String
getBarcodeLabel()
This method is deprecated. This value is unused by the platform and will be removed in the future.
String
getBarcodeType()
Returns barcode type.
String
getBarcodeValue()
Returns encoded barcode value.
String
getClassId()
Returns offer Class Id.
String
getId()
Returns the unique identifier for this Wallet Object.
ArrayList<UriData>
getImageModuleDataMainImageUris()
Returns image module main image uris.
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()
Returns info module label value rows.
boolean
getInfoModuleDataShowLastUpdateTime()
Returns info module show last update time flag.
String
getIssuerName()
Returns offer issuer name.
ArrayList<UriData>
getLinksModuleDataUris()
Returns links module uris.
ArrayList<LatLng>
getLocations()
Returns locations where the object is considered valid.
ArrayList<WalletObjectMessage>
getMessages()
Returns offer Object messages.
String
getRedemptionCode()
Returns the redemption code of the offer.
int
getState()
Returns offer Object state.
ArrayList<TextModuleData>
getTextModulesData()
Returns text modules.
String
getTitle()
Returns the title of the offer.
TimeInterval
getValidTimeInterval()
Returns time interval within which the object is considered valid.
int
static OfferWalletObject.Builder
void
writeToParcel(Parcel dest, int flags)

Inherited Method Summary

Fields

public static final Creator<OfferWalletObject> CREATOR

Public Methods

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 offer 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's 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 offer issuer name.

public ArrayList<UriData> getLinksModuleDataUris ()

Returns links module uris.

public ArrayList<LatLng> getLocations ()

Returns locations where the object is considered valid.

public ArrayList<WalletObjectMessage> getMessages ()

Returns offer Object messages.

public String getRedemptionCode ()

Returns the redemption code of the offer. This would be a coupon code or similar that user could enter to gain a discount, reward, etc.

public int getState ()

Returns offer Object state.

public ArrayList<TextModuleData> getTextModulesData ()

Returns text modules.

public String getTitle ()

Returns the title of the offer.

public TimeInterval getValidTimeInterval ()

Returns time interval within which the object is considered valid.

public int getVersionCode ()

public static OfferWalletObject.Builder newBuilder ()

Returns a new OfferWalletObject.Builder.

public void writeToParcel (Parcel dest, int flags)