Class: Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard

Inherits:

Object

Object
Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard

show all

Defined in:: lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/intent.rb

Overview

Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel

Defined Under Namespace

Modules: ImageDisplayOptions Classes: BrowseCarouselCardItem

Instance Attribute Summary collapse

Instance Attribute Details

#image_display_options ⇒ `Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::ImageDisplayOptions`

Returns Optional. Settings for displaying the image. Applies to every image in items.

Returns:

(Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::ImageDisplayOptions) —
Optional. Settings for displaying the image. Applies to every image in items.

# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/intent.rb', line 515

class BrowseCarouselCard
  # Browsing carousel tile
  # @!attribute [rw] open_uri_action
  #   @return [Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::BrowseCarouselCardItem::OpenUrlAction]
  #     Required. Action to present to the user.
  # @!attribute [rw] title
  #   @return [String]
  #     Required. Title of the carousel item. Maximum of two lines of text.
  # @!attribute [rw] description
  #   @return [String]
  #     Optional. Description of the carousel item. Maximum of four lines of
  #     text.
  # @!attribute [rw] image
  #   @return [Google::Cloud::Dialogflow::V2::Intent::Message::Image]
  #     Optional. Hero image for the carousel item.
  # @!attribute [rw] footer
  #   @return [String]
  #     Optional. Text that appears at the bottom of the Browse Carousel
  #     Card. Maximum of one line of text.
  class BrowseCarouselCardItem
    # Actions on Google action to open a given url.
    # @!attribute [rw] url
    #   @return [String]
    #     Required. URL
    # @!attribute [rw] url_type_hint
    #   @return [Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::BrowseCarouselCardItem::OpenUrlAction::UrlTypeHint]
    #     Optional. Specifies the type of viewer that is used when opening
    #     the URL. Defaults to opening via web browser.
    class OpenUrlAction
      # Type of the URI.
      module UrlTypeHint
        # Unspecified
        URL_TYPE_HINT_UNSPECIFIED = 0

        # Url would be an amp action
        AMP_ACTION = 1

        # URL that points directly to AMP content, or to a canonical URL
        # which refers to AMP content via <link rel="amphtml">.
        AMP_CONTENT = 2
      end
    end
  end

  # Image display options for Actions on Google. This should be used for
  # when the image's aspect ratio does not match the image container's
  # aspect ratio.
  module ImageDisplayOptions
    # Fill the gaps between the image and the image container with gray
    # bars.
    IMAGE_DISPLAY_OPTIONS_UNSPECIFIED = 0

    # Fill the gaps between the image and the image container with gray
    # bars.
    GRAY = 1

    # Fill the gaps between the image and the image container with white
    # bars.
    WHITE = 2

    # Image is scaled such that the image width and height match or exceed
    # the container dimensions. This may crop the top and bottom of the
    # image if the scaled image height is greater than the container
    # height, or crop the left and right of the image if the scaled image
    # width is greater than the container width. This is similar to "Zoom
    # Mode" on a widescreen TV when playing a 4:3 video.
    CROPPED = 3

    # Pad the gaps between image and image frame with a blurred copy of the
    # same image.
    BLURRED_BACKGROUND = 4
  end
end

#items ⇒ `Array<Google::Cloud::Dialogflow::V2::Intent::Message::BrowseCarouselCard::BrowseCarouselCardItem>`

Returns Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.