com.google.api.services.walletobjects.model

Class Message

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.walletobjects.model.Message

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Message
extends com.google.api.client.json.GenericJson

A message that will be displayed with a Valuable

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Wallet API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
Message	clone()
String	getBody() The message body.
TimeInterval	getDisplayInterval() The period of time that the message will be displayed to users.
String	getHeader() The message header.
String	getId() The ID associated with a message.
String	getKind() Identifies what kind of resource this is.
LocalizedString	getLocalizedBody() Translated strings for the message body.
LocalizedString	getLocalizedHeader() Translated strings for the message header.
String	getMessageType() The type of the message.
Message	set(String fieldName, Object value)
Message	setBody(String body) The message body.
Message	setDisplayInterval(TimeInterval displayInterval) The period of time that the message will be displayed to users.
Message	setHeader(String header) The message header.
Message	setId(String id) The ID associated with a message.
Message	setKind(String kind) Identifies what kind of resource this is.
Message	setLocalizedBody(LocalizedString localizedBody) Translated strings for the message body.
Message	setLocalizedHeader(LocalizedString localizedHeader) Translated strings for the message header.
Message	setMessageType(String messageType) The type of the message.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Message

public Message()

Method Detail

getBody

public String getBody()

The message body.

Returns:

value or null for none

setBody

public Message setBody(String body)

The message body.

Parameters:

body - body or null for none

getDisplayInterval

public TimeInterval getDisplayInterval()

The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.

Returns:

value or null for none

setDisplayInterval

public Message setDisplayInterval(TimeInterval displayInterval)

The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided.

Parameters:

displayInterval - displayInterval or null for none

getHeader

public String getHeader()

The message header.

Returns:

value or null for none

setHeader

public Message setHeader(String header)

The message header.

Parameters:

header - header or null for none

getId

public String getId()

The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.

Returns:

value or null for none

setId

public Message setId(String id)

The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.

Parameters:

id - id or null for none

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.

Returns:

value or null for none

setKind

public Message setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`.

Parameters:

kind - kind or null for none

getLocalizedBody

public LocalizedString getLocalizedBody()

Translated strings for the message body.

Returns:

value or null for none

setLocalizedBody

public Message setLocalizedBody(LocalizedString localizedBody)

Translated strings for the message body.

Parameters:

localizedBody - localizedBody or null for none

getLocalizedHeader

public LocalizedString getLocalizedHeader()

Translated strings for the message header.

Returns:

value or null for none

setLocalizedHeader

public Message setLocalizedHeader(LocalizedString localizedHeader)

Translated strings for the message header.

Parameters:

localizedHeader - localizedHeader or null for none

getMessageType

public String getMessageType()

The type of the message. Currently, this can only be set for offers.

Returns:

value or null for none

setMessageType

public Message setMessageType(String messageType)

The type of the message. Currently, this can only be set for offers.

Parameters:

messageType - messageType or null for none

set

public Message set(String fieldName,
                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Message clone()

Overrides:

clone in class com.google.api.client.json.GenericJson