OfferWalletObject.Builder | Doclava
public final class

OfferWalletObject.Builder

extends Object
java.lang.Object
   ↳ com.google.android.gms.wallet.OfferWalletObject.Builder

Class Overview

Builder to create a OfferWalletObject.

Summary

Public Methods
OfferWalletObject.Builder addImageModuleDataMainImageUri(UriData uri)
Adds an image module data image uri.
OfferWalletObject.Builder addImageModuleDataMainImageUris(Collection<UriData> uris)
Adds a collection of image module data image uris.
OfferWalletObject.Builder addInfoModuleDataLabelValueRow(LabelValueRow row)
Adds an info module data label value row.
OfferWalletObject.Builder addInfoModuleDataLabelValueRows(Collection<LabelValueRow> rows)
Adds a collection of info module data label value rows.
OfferWalletObject.Builder addLinksModuleDataUri(UriData uri)
Add a links module data.
OfferWalletObject.Builder addLinksModuleDataUris(Collection<UriData> uris)
Adds a collection of links module data.
OfferWalletObject.Builder addLocation(LatLng location)
Adds the location where the Wallet Object can be used.
OfferWalletObject.Builder addLocations(Collection<LatLng> locations)
Adds the collection of locations where the Wallet Object can be used.
OfferWalletObject.Builder addMessage(WalletObjectMessage message)
Adds a message to be associated with this object.
OfferWalletObject.Builder addMessages(Collection<WalletObjectMessage> messages)
Adds a collection of messages to be associated with this object.
OfferWalletObject.Builder addTextModuleData(TextModuleData data)
Adds a text module data.
OfferWalletObject.Builder addTextModulesData(Collection<TextModuleData> data)
Adds a collection of text modules data.
OfferWalletObject build()
OfferWalletObject.Builder setBarcodeAlternateText(String barcodeAlternateText)
OfferWalletObject.Builder setBarcodeLabel(String barcodeLabel)
Sets the barcode label describing the contents of the barcode, such as "OFFER CODE" or "MEMBER ID."
OfferWalletObject.Builder setBarcodeType(String barcodeType)
Sets the type of the barcode.
OfferWalletObject.Builder setBarcodeValue(String barcodeValue)
Sets the value encoded in the barcode.
OfferWalletObject.Builder setClassId(String classId)
Sets the id of the class associated with this object.
OfferWalletObject.Builder setId(String id)
OfferWalletObject.Builder setInfoModuleDataHexBackgroundColor(String color)
Sets the background color for the Info Module.
OfferWalletObject.Builder setInfoModuleDataHexFontColor(String color)
Sets the color for the font in this Info Module.
OfferWalletObject.Builder setInfoModuleDataShowLastUpdateTime(boolean show)
Sets the flag which determines whether to display the last update time of the Wallet Object.
OfferWalletObject.Builder setIssuerName(String issuerName)
Sets the issuer name of this offer object.
OfferWalletObject.Builder setRedemptionCode(String redemptionCode)
Sets the redemption code of the offer wallet object.
OfferWalletObject.Builder setState(int state)
Sets offer object state.
OfferWalletObject.Builder setTitle(String title)
Sets the offer title.
OfferWalletObject.Builder setValidTimeInterval(TimeInterval interval)
Sets the time period this object will be active and can be used.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public OfferWalletObject.Builder addImageModuleDataMainImageUri (UriData uri)

Adds an image module data image uri.

If image modules data is also defined on the class, the ones defined here on the object will be displayed first, followed by those defined on the class.

Parameters
uri UriData
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addImageModuleDataMainImageUris (Collection<UriData> uris)

Adds a collection of image module data image uris.

If image modules data is also defined on the class, the ones defined here on the object will be displayed first, followed by those defined on the class.

Parameters
uris Collection
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addInfoModuleDataLabelValueRow (LabelValueRow row)

Adds an info module data label value row.

If info module data is also defined on the class, the one defined here on the object will be displayed first, followed by the one defined on the class.

Parameters
row LabelValueRow
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addInfoModuleDataLabelValueRows (Collection<LabelValueRow> rows)

Adds a collection of info module data label value rows.

If info module data is also defined on the class, the one defined here on the object will be displayed first, followed by the one defined on the class.

Parameters
rows Collection
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addLinksModuleDataUri (UriData uri)

Add a links module data.

If links module data is also defined on the class, the one defined here on the object will be displayed first, followed by those defined on the class.

Parameters
uri UriData
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addLinksModuleDataUris (Collection<UriData> uris)

Adds a collection of links module data.

If links module data is also defined on the class, the one defined here on the object will be displayed first, followed by those defined on the class.

Parameters
uris Collection
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addLocation (LatLng location)

Adds the location where the Wallet Object can be used.

The Wallet Object platform uses this information to trigger geolocated notifications to users.

Note that locations in the object override locations in the class which override locations in the Google Places ID.

Parameters
location LatLng
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addLocations (Collection<LatLng> locations)

Adds the collection of locations where the Wallet Object can be used.

The Wallet Object platform uses this information to trigger geolocated notifications to users.

Note that locations in the object override locations in the class which override locations in the Google Places ID.

Parameters
locations Collection
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addMessage (WalletObjectMessage message)

Adds a message to be associated with this object. All users of this Wallet Object will receive its associated messages.

Parameters
message WalletObjectMessage
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addMessages (Collection<WalletObjectMessage> messages)

Adds a collection of messages to be associated with this object. All users of this Wallet Object will receive its associated messages.

Parameters
messages Collection
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addTextModuleData (TextModuleData data)

Adds a text module data.

If text module data is also defined on the class, the ones defined here on the object will be displayed first, followed by those defined on the class.

Parameters
data TextModuleData
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder addTextModulesData (Collection<TextModuleData> data)

Adds a collection of text modules data.

If text module data is also defined on the class, the ones defined here on the object will be displayed first, followed by those defined on the class.

Parameters
data Collection
Returns
OfferWalletObject.Builder

public OfferWalletObject build ()

public OfferWalletObject.Builder setBarcodeAlternateText (String barcodeAlternateText)

Parameters
barcodeAlternateText String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setBarcodeLabel (String barcodeLabel)

Sets the barcode label describing the contents of the barcode, such as "OFFER CODE" or "MEMBER ID."

Parameters
barcodeLabel String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setBarcodeType (String barcodeType)

Sets the type of the barcode.

Acceptable values are:

  • "aztec"
  • "codabar"
  • "code128"
  • "code39"
  • "dataMatrix"
  • "ean13"
  • "ean8"
  • "itf14"
  • "pdf417"
  • "pdf417Compact"
  • "qrCode"
  • "textOnly"
  • "unknownFormat"
  • "upcA"
  • "upcE"

public OfferWalletObject.Builder setBarcodeValue (String barcodeValue)

Sets the value encoded in the barcode.

Parameters
barcodeValue String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setClassId (String classId)

Sets the id of the class associated with this object.

Parameters
classId String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setId (String id)

Parameters
id String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setInfoModuleDataHexBackgroundColor (String color)

Sets the background color for the Info Module.

The format is #hhhhhh where h is a hex digit.

Parameters
color String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setInfoModuleDataHexFontColor (String color)

Sets the color for the font in this Info Module.

The format is #hhhhhh where h is a hex digit.

Parameters
color String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setInfoModuleDataShowLastUpdateTime (boolean show)

Sets the flag which determines whether to display the last update time of the Wallet Object.

Parameters
show boolean
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setIssuerName (String issuerName)

Sets the issuer name of this offer object.

This field is required and should match issuer name specified for the corresponding offer class of the offer object being created. It will be displayed to the user in the accepting offer object confirmation screen.

Parameters
issuerName String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setRedemptionCode (String redemptionCode)

Sets the redemption code of the offer wallet object.

Parameters
redemptionCode String: The redemption code of the offer wallet object.
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setState (int state)

Sets offer object state.

Supported states are defined by WalletObjectsConstants.State

Parameters
state int
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setTitle (String title)

Sets the offer title.

This field is required and should match the title specified for the corresponding offer class of the offer object being created. It will be displayed to the user in the accepting offer object confirmation screen.

Parameters
title String
Returns
OfferWalletObject.Builder

public OfferWalletObject.Builder setValidTimeInterval (TimeInterval interval)

Sets the time period this object will be active and can be used. An object's state will be changed to expired when this time period has passed.

Parameters
interval TimeInterval
Returns
OfferWalletObject.Builder