target.apidocs.com.google.api.services.content.model.ActionFlow.html Maven / Gradle / Ivy
ActionFlow (Content API for Shopping v2.1-rev20240609-2.0.0)
com.google.api.services.content.model
Class ActionFlow
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.content.model.ActionFlow
-
public final class ActionFlow
extends com.google.api.client.json.GenericJson
Flow that can be selected for an action. When merchant selects a flow, application should open a
dialog with more information and input form.
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 Content API for Shopping. 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
ActionFlow()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
ActionFlow
clone()
String
getDialogButtonLabel()
Label for the button to trigger the action from the action dialog.
Callout
getDialogCallout()
Important message to be highlighted in the request dialog.
TextWithTooltip
getDialogMessage()
Message displayed in the request dialog.
String
getDialogTitle()
Title of the request dialog.
String
getId()
Not for display but need to be sent back for the selected action flow.
List<InputField>
getInputs()
A list of input fields.
String
getLabel()
Text value describing the intent for the action flow.
ActionFlow
set(String fieldName,
Object value)
ActionFlow
setDialogButtonLabel(String dialogButtonLabel)
Label for the button to trigger the action from the action dialog.
ActionFlow
setDialogCallout(Callout dialogCallout)
Important message to be highlighted in the request dialog.
ActionFlow
setDialogMessage(TextWithTooltip dialogMessage)
Message displayed in the request dialog.
ActionFlow
setDialogTitle(String dialogTitle)
Title of the request dialog.
ActionFlow
setId(String id)
Not for display but need to be sent back for the selected action flow.
ActionFlow
setInputs(List<InputField> inputs)
A list of input fields.
ActionFlow
setLabel(String label)
Text value describing the intent for the action flow.
-
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
-
getDialogButtonLabel
public String getDialogButtonLabel()
Label for the button to trigger the action from the action dialog. For example: "Request
review"
- Returns:
- value or
null
for none
-
setDialogButtonLabel
public ActionFlow setDialogButtonLabel(String dialogButtonLabel)
Label for the button to trigger the action from the action dialog. For example: "Request
review"
- Parameters:
dialogButtonLabel
- dialogButtonLabel or null
for none
-
getDialogCallout
public Callout getDialogCallout()
Important message to be highlighted in the request dialog. For example: "You can only request a
review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue
and wait a few days before you can request another review."
- Returns:
- value or
null
for none
-
setDialogCallout
public ActionFlow setDialogCallout(Callout dialogCallout)
Important message to be highlighted in the request dialog. For example: "You can only request a
review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue
and wait a few days before you can request another review."
- Parameters:
dialogCallout
- dialogCallout or null
for none
-
getDialogMessage
public TextWithTooltip getDialogMessage()
Message displayed in the request dialog. For example: "Make sure you've fixed all your country-
specific issues. If not, you may have to wait 7 days to request another review". There may be
an more information to be shown in a tooltip.
- Returns:
- value or
null
for none
-
setDialogMessage
public ActionFlow setDialogMessage(TextWithTooltip dialogMessage)
Message displayed in the request dialog. For example: "Make sure you've fixed all your country-
specific issues. If not, you may have to wait 7 days to request another review". There may be
an more information to be shown in a tooltip.
- Parameters:
dialogMessage
- dialogMessage or null
for none
-
getDialogTitle
public String getDialogTitle()
Title of the request dialog. For example: "Before you request a review"
- Returns:
- value or
null
for none
-
setDialogTitle
public ActionFlow setDialogTitle(String dialogTitle)
Title of the request dialog. For example: "Before you request a review"
- Parameters:
dialogTitle
- dialogTitle or null
for none
-
getId
public String getId()
Not for display but need to be sent back for the selected action flow.
- Returns:
- value or
null
for none
-
setId
public ActionFlow setId(String id)
Not for display but need to be sent back for the selected action flow.
- Parameters:
id
- id or null
for none
-
getInputs
public List<InputField> getInputs()
A list of input fields.
- Returns:
- value or
null
for none
-
setInputs
public ActionFlow setInputs(List<InputField> inputs)
A list of input fields.
- Parameters:
inputs
- inputs or null
for none
-
getLabel
public String getLabel()
Text value describing the intent for the action flow. It can be used as an input label if
merchant needs to pick one of multiple flows. For example: "I disagree with the issue"
- Returns:
- value or
null
for none
-
setLabel
public ActionFlow setLabel(String label)
Text value describing the intent for the action flow. It can be used as an input label if
merchant needs to pick one of multiple flows. For example: "I disagree with the issue"
- Parameters:
label
- label or null
for none
-
set
public ActionFlow set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public ActionFlow 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