GiftCardWalletObject

public final class GiftCardWalletObject extends Object
implements Parcelable

Parcelable representing a gift card wallet object.

Nested Class Summary

class GiftCardWalletObject.Builder Builder for GiftCardWalletObject

Inherited Constant Summary

Field Summary

public static final Creator<GiftCardWalletObject> CREATOR

Public Method Summary

String
getBalanceCurrencyCode()
Returns the currency code for the balance.
long
getBalanceMicros()
Returns balance for this card.
long
getBalanceUpdateTime()
Returns timestamp when the card balance was last updated.
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
getCardIdentifier()
This method is deprecated. This value is unused by the platform and will be removed in the future.
String
getCardNumber()
Returns number identifiyng this card.
String
getClassId()
Returns gift card Class Id.
String
getEventNumber()
Returns the card's event number, an optional field used by some gift cards.
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 gift card issuer name.
ArrayList<UriData>
getLinksModuleDataUris()
Returns links module uris.
ArrayList<LatLng>
getLocations()
Returns locations where the object is considered valid.
ArrayList<WalletObjectMessage>
getMessages()
Returns gift card Object messages.
String
getPin()
Returns pIN to access this card.
int
getState()
Returns gift card Object state.
ArrayList<TextModuleData>
getTextModulesData()
Returns text modules.
String
getTitle()
Returns title of the gift card.
TimeInterval
getValidTimeInterval()
Returns time interval within which the object is considered valid.
static GiftCardWalletObject.Builder
newBuilder()
Creates a helper instance whose implementation follows the builder pattern to create new objects of GiftCardWalletObject.
void
writeToParcel(Parcel dest, int flags)

Inherited Method Summary

Fields

public static final Creator<GiftCardWalletObject> CREATOR

Public Methods

public String getBalanceCurrencyCode ()

Returns the currency code for the balance.

public long getBalanceMicros ()

Returns balance for this card.

public long getBalanceUpdateTime ()

Returns timestamp when the card balance was last updated.

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

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

Returns
  • Identifier for the card.

public String getCardNumber ()

Returns number identifiyng this card.

public String getClassId ()

Returns gift card Class Id.

public String getEventNumber ()

Returns the card's event number, an optional field used by some gift cards.

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 gift card 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 gift card Object messages.

public String getPin ()

Returns pIN to access this card.

public int getState ()

Returns gift card Object state.

public ArrayList<TextModuleData> getTextModulesData ()

Returns text modules.

public String getTitle ()

Returns title of the gift card.

public TimeInterval getValidTimeInterval ()

Returns time interval within which the object is considered valid.

public static GiftCardWalletObject.Builder newBuilder ()

Creates a helper instance whose implementation follows the builder pattern to create new objects of GiftCardWalletObject.

Returns
  • A new builder.

public void writeToParcel (Parcel dest, int flags)