
target.apidocs.com.google.api.services.walletobjects.model.ValueAddedModuleData.html Maven / Gradle / Ivy
ValueAddedModuleData (Google Wallet API v1-rev20241017-2.0.0)
com.google.api.services.walletobjects.model
Class ValueAddedModuleData
- 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.ValueAddedModuleData
-
public final class ValueAddedModuleData
extends com.google.api.client.json.GenericJson
Data for Value Added module. Required fields are header and uri.
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>
-
Constructor Summary
Constructors
Constructor and Description
ValueAddedModuleData()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
ValueAddedModuleData
clone()
LocalizedString
getBody()
Body to be displayed on the module.
LocalizedString
getHeader()
Header to be displayed on the module.
Image
getImage()
Image to be displayed on the module.
Integer
getSortIndex()
The index for sorting the modules.
String
getUri()
URI that the module leads to on click.
ModuleViewConstraints
getViewConstraints()
Constraints that all must be met for the module to be shown.
ValueAddedModuleData
set(String fieldName,
Object value)
ValueAddedModuleData
setBody(LocalizedString body)
Body to be displayed on the module.
ValueAddedModuleData
setHeader(LocalizedString header)
Header to be displayed on the module.
ValueAddedModuleData
setImage(Image image)
Image to be displayed on the module.
ValueAddedModuleData
setSortIndex(Integer sortIndex)
The index for sorting the modules.
ValueAddedModuleData
setUri(String uri)
URI that the module leads to on click.
ValueAddedModuleData
setViewConstraints(ModuleViewConstraints viewConstraints)
Constraints that all must be met for the module to be shown.
-
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
-
-
Method Detail
-
getBody
public LocalizedString getBody()
Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
- Returns:
- value or
null
for none
-
setBody
public ValueAddedModuleData setBody(LocalizedString body)
Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
- Parameters:
body
- body or null
for none
-
getHeader
public LocalizedString getHeader()
Header to be displayed on the module. Character limit is 60 and longer strings will be
truncated.
- Returns:
- value or
null
for none
-
setHeader
public ValueAddedModuleData setHeader(LocalizedString header)
Header to be displayed on the module. Character limit is 60 and longer strings will be
truncated.
- Parameters:
header
- header or null
for none
-
getImage
public Image getImage()
Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to
fit this ratio.
- Returns:
- value or
null
for none
-
setImage
public ValueAddedModuleData setImage(Image image)
Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to
fit this ratio.
- Parameters:
image
- image or null
for none
-
getSortIndex
public Integer getSortIndex()
The index for sorting the modules. Modules with a lower sort index are shown before modules
with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two
modules with the same index, the sorting behavior is undefined.
- Returns:
- value or
null
for none
-
setSortIndex
public ValueAddedModuleData setSortIndex(Integer sortIndex)
The index for sorting the modules. Modules with a lower sort index are shown before modules
with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two
modules with the same index, the sorting behavior is undefined.
- Parameters:
sortIndex
- sortIndex or null
for none
-
getUri
public String getUri()
URI that the module leads to on click. This can be a web link or a deep link as mentioned in
https://developer.android.com/training/app-links/deep-linking.
- Returns:
- value or
null
for none
-
setUri
public ValueAddedModuleData setUri(String uri)
URI that the module leads to on click. This can be a web link or a deep link as mentioned in
https://developer.android.com/training/app-links/deep-linking.
- Parameters:
uri
- uri or null
for none
-
getViewConstraints
public ModuleViewConstraints getViewConstraints()
Constraints that all must be met for the module to be shown.
- Returns:
- value or
null
for none
-
setViewConstraints
public ValueAddedModuleData setViewConstraints(ModuleViewConstraints viewConstraints)
Constraints that all must be met for the module to be shown.
- Parameters:
viewConstraints
- viewConstraints or null
for none
-
set
public ValueAddedModuleData set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public ValueAddedModuleData clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy