OfferWalletObject

  • OfferWalletObject is a Parcelable class representing an offer such as a coupon, with a buyerId and a redemptionCode.

  • It includes details like barcode information, issuer name, title, and validity time.

  • The class provides methods to access various data points related to the offer.

  • A builder is available to create instances of OfferWalletObject.

public final classOfferWalletObject extendsObject
implementsParcelable

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

classOfferWalletObject.BuilderBuilder to create aOfferWalletObject. 

Inherited Constant Summary

From interface android.os.Parcelable
intCONTENTS_FILE_DESCRIPTOR
intPARCELABLE_WRITE_RETURN_VALUE

Field Summary

public static finalCreator<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
staticOfferWalletObject.Builder
void
writeToParcel(Parcel dest, int flags)

Inherited Method Summary

From class java.lang.Object
Object
clone()
boolean
equals(Object arg0)
void
finalize()
finalClass<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()
From interface android.os.Parcelable
abstract int
describeContents()
abstract void
writeToParcel(Parcel arg0, int arg1)

Fields

public static finalCreator<OfferWalletObject>CREATOR

Public Methods

publicStringgetBarcodeAlternateText()

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

publicStringgetBarcodeLabel()

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

Returns
  • Barcode label.

publicStringgetBarcodeType()

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

publicStringgetBarcodeValue()

Returns encoded barcode value.

publicStringgetClassId()

Returns offer Class Id.

publicStringgetId()

Returns the unique identifier for this Wallet Object.

publicArrayList<UriData>getImageModuleDataMainImageUris()

Returns image module main image uris.

publicStringgetInfoModuleDataHexBackgroundColor()

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.

publicStringgetInfoModuleDataHexFontColor()

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

Returns
  • Info module hex font color.

publicArrayList<LabelValueRow>getInfoModuleDataLabelValueRows()

Returns info module label value rows.

public booleangetInfoModuleDataShowLastUpdateTime()

Returns info module show last update time flag.

publicStringgetIssuerName()

Returns offer issuer name.

publicArrayList<UriData>getLinksModuleDataUris()

Returns links module uris.

publicArrayList<LatLng>getLocations()

Returns locations where the object is considered valid.

publicArrayList<WalletObjectMessage>getMessages()

Returns offer Object messages.

publicStringgetRedemptionCode()

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 intgetState()

Returns offer Object state.

publicArrayList<TextModuleData>getTextModulesData()

Returns text modules.

publicStringgetTitle()

Returns the title of the offer.

publicTimeIntervalgetValidTimeInterval()

Returns time interval within which the object is considered valid.

public intgetVersionCode()

public staticOfferWalletObject.BuildernewBuilder()

public voidwriteToParcel(Parcel dest, int flags)

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-10-31 UTC.