Class: Google::Apis::ContentV2_1::ActionFlow

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Overview

Flow that can be selected for an action. When merchant selects a flow, application should open a dialog with more information and input form.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ActionFlow

Returns a new instance of ActionFlow.



2233
2234
2235
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2233

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dialog_button_label ⇒ String

Label for the button to trigger the action from the action dialog. For example: "Request review" Corresponds to the JSON property dialogButtonLabel

Returns:

  • (String) 


2199
2200
2201
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2199

def dialog_button_label
  @dialog_button_label
end

#dialog_callout ⇒ Google::Apis::ContentV2_1::Callout

An important message that should be highlighted. Usually displayed as a banner. Corresponds to the JSON property dialogCallout

Returns:



2204
2205
2206
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2204

def dialog_callout
  @dialog_callout
end

#dialog_message ⇒ Google::Apis::ContentV2_1::TextWithTooltip

Block of text that may contain a tooltip with more information. Corresponds to the JSON property dialogMessage

Returns:



2209
2210
2211
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2209

def dialog_message
  @dialog_message
end

#dialog_title ⇒ String

Title of the request dialog. For example: "Before you request a review" Corresponds to the JSON property dialogTitle

Returns:

  • (String) 


2214
2215
2216
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2214

def dialog_title
  @dialog_title
end

#id ⇒ String

Not for display but need to be sent back for the selected action flow. Corresponds to the JSON property id

Returns:

  • (String) 


2219
2220
2221
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2219

def id
  @id
end

#inputs ⇒ Array<Google::Apis::ContentV2_1::InputField>

A list of input fields. Corresponds to the JSON property inputs

Returns:



2224
2225
2226
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2224

def inputs
  @inputs
end

#label ⇒ String

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" Corresponds to the JSON property label

Returns:

  • (String) 


2231
2232
2233
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2231

def label
  @label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2238
2239
2240
2241
2242
2243
2244
2245
2246
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2238

def update!(**args)
  @dialog_button_label = args[:dialog_button_label] if args.key?(:dialog_button_label)
  @dialog_callout = args[:dialog_callout] if args.key?(:dialog_callout)
  @dialog_message = args[:dialog_message] if args.key?(:dialog_message)
  @dialog_title = args[:dialog_title] if args.key?(:dialog_title)
  @id = args[:id] if args.key?(:id)
  @inputs = args[:inputs] if args.key?(:inputs)
  @label = args[:label] if args.key?(:label)
end