Dialogflow.V2.Fulfillment.Payload.Google

This module contains types for the Google Actions payload to be included in the webhook reponse. See the Dialogflow documentation.

Documentation

newtype GooglePayload

This field can be used to provide responses for different platforms like Actions on Google.

Constructors

GooglePayload

Fields

• unGooglePayload :: Response

Instances

Eq GooglePayload

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: GooglePayload -> GooglePayload -> Bool

(/=) :: GooglePayload -> GooglePayload -> Bool

Show GooglePayload

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> GooglePayload -> ShowS

show :: GooglePayload -> String

showList :: [GooglePayload] -> ShowS

ToJSON GooglePayload

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: GooglePayload -> Value

toEncoding :: GooglePayload -> Encoding

toJSONList :: [GooglePayload] -> Value

toEncodingList :: [GooglePayload] -> Encoding

data Image

An image.

Constructors

Image

Fields

• iUrl :: String
• iAccessibilityText :: String
• iHeight :: Maybe Int
• iWidth :: Maybe Int

Instances

Eq Image

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: Image -> Image -> Bool

(/=) :: Image -> Image -> Bool

Show Image

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

ToJSON Image

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: Image -> Value

toEncoding :: Image -> Encoding

toJSONList :: [Image] -> Value

toEncodingList :: [Image] -> Encoding

FromJSON Image

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser Image

parseJSONList :: Value -> Parser [Image]

data BasicCardContent

A BasicCard can either contain an image or formatted text.

Constructors

BasicCardImage Image

BasicCardFormattedText String

Instances

Eq BasicCardContent

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: BasicCardContent -> BasicCardContent -> Bool

(/=) :: BasicCardContent -> BasicCardContent -> Bool

Show BasicCardContent

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> BasicCardContent -> ShowS

show :: BasicCardContent -> String

showList :: [BasicCardContent] -> ShowS

ToJSON BasicCardContent

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: BasicCardContent -> Value

toEncoding :: BasicCardContent -> Encoding

toJSONList :: [BasicCardContent] -> Value

toEncodingList :: [BasicCardContent] -> Encoding

FromJSON BasicCardContent

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser BasicCardContent

parseJSONList :: Value -> Parser [BasicCardContent]

data ImageDisplayOption

Possible image display options for affecting the presentation of an Image. This should be used for when the Image's aspect ratio does not match the Image container's aspect ratio.

Constructors

DEFAULT

Fill the gaps between the Image and the Image container with gray bars.

WHITE

Fill the gaps between the Image and the Image container with white bars.

CROPPED

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.

Instances

Eq ImageDisplayOption

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: ImageDisplayOption -> ImageDisplayOption -> Bool

(/=) :: ImageDisplayOption -> ImageDisplayOption -> Bool

Read ImageDisplayOption

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

readsPrec :: Int -> ReadS ImageDisplayOption

readList :: ReadS [ImageDisplayOption]

readPrec :: ReadPrec ImageDisplayOption

readListPrec :: ReadPrec [ImageDisplayOption]

Show ImageDisplayOption

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> ImageDisplayOption -> ShowS

show :: ImageDisplayOption -> String

showList :: [ImageDisplayOption] -> ShowS

ToJSON ImageDisplayOption

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: ImageDisplayOption -> Value

toEncoding :: ImageDisplayOption -> Encoding

toJSONList :: [ImageDisplayOption] -> Value

toEncodingList :: [ImageDisplayOption] -> Encoding

FromJSON ImageDisplayOption

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser ImageDisplayOption

parseJSONList :: Value -> Parser [ImageDisplayOption]

data MediaType

The type of the media within the response.

Constructors

MEDIA_TYPE_UNSPECIFIED

Unspecified.

AUDIO

Audio stream.

Instances

Eq MediaType

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: MediaType -> MediaType -> Bool

(/=) :: MediaType -> MediaType -> Bool

Read MediaType

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

readsPrec :: Int -> ReadS MediaType

readList :: ReadS [MediaType]

readPrec :: ReadPrec MediaType

readListPrec :: ReadPrec [MediaType]

Show MediaType

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> MediaType -> ShowS

show :: MediaType -> String

showList :: [MediaType] -> ShowS

ToJSON MediaType

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: MediaType -> Value

toEncoding :: MediaType -> Encoding

toJSONList :: [MediaType] -> Value

toEncodingList :: [MediaType] -> Encoding

FromJSON MediaType

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser MediaType

parseJSONList :: Value -> Parser [MediaType]

data MediaObject

Represents one media noNullObjects which is returned with MediaResponse. Contains information about the media, such as name, description, url, etc.

Constructors

MediaObject

Fields

• moName :: String

  Name of the MediaObject.

• moDescription :: String

  Description of the MediaObject.

• moContentUrl :: String

  The url pointing to the media content.

• moLargeImage :: Image

  A large Image, such as the cover of the album, etc.

• moIcon :: Image

  A small Image icon displayed on the right from the title. It's resized to 36x36 dp.

Instances

Eq MediaObject

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: MediaObject -> MediaObject -> Bool

(/=) :: MediaObject -> MediaObject -> Bool

Show MediaObject

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> MediaObject -> ShowS

show :: MediaObject -> String

showList :: [MediaObject] -> ShowS

ToJSON MediaObject

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: MediaObject -> Value

toEncoding :: MediaObject -> Encoding

toJSONList :: [MediaObject] -> Value

toEncodingList :: [MediaObject] -> Encoding

FromJSON MediaObject

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser MediaObject

parseJSONList :: Value -> Parser [MediaObject]

data RichMessageType

The possible types of RichMessages.

Constructors

RMTSimpleResponse

RMTBasicCard

RMTMediaResponse

data Res t where

The response items.

Constructors

SimpleResponse :: SimpleResponse -> Res 'RMTSimpleResponse

A simple response containing speech or text to show the user.

BasicCard

A basic card for displaying some information, e.g. an image and/or text.

Fields

• :: Maybe String

  Title.

• -> Maybe String

  Subtitle.

• -> BasicCardContent

  Card content can be an image of formatted text.

• -> [BasicCardButton]

  Buttons. Currently supports at most 1.

• -> ImageDisplayOption

  Type of display option.

• -> Res 'RMTBasicCard

MediaResponse

The response indicating a set of media to be played within the conversation.

Fields

• :: MediaType

  Type of the media within this response.

• -> [MediaObject]

  The list of MediaObjects.

• -> Res 'RMTMediaResponse

Instances

Eq (Res t)

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: Res t -> Res t -> Bool

(/=) :: Res t -> Res t -> Bool

Show (Res t)

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> Res t -> ShowS

show :: Res t -> String

showList :: [Res t] -> ShowS

ToJSON (Res t)

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: Res t -> Value

toEncoding :: Res t -> Encoding

toJSONList :: [Res t] -> Value

toEncodingList :: [Res t] -> Encoding

FromJSON (Res 'RMTSimpleResponse)

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser (Res 'RMTSimpleResponse)

parseJSONList :: Value -> Parser [Res 'RMTSimpleResponse]

FromJSON (Res 'RMTBasicCard)

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser (Res 'RMTBasicCard)

parseJSONList :: Value -> Parser [Res 'RMTBasicCard]

FromJSON (Res 'RMTMediaResponse)

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser (Res 'RMTMediaResponse)

parseJSONList :: Value -> Parser [Res 'RMTMediaResponse]

data Item where

The items to include in the RichResponse

Constructors

Item :: Show (Res t) => Res t -> Item

Instances

Eq Item

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: Item -> Item -> Bool

(/=) :: Item -> Item -> Bool

Show Item

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

ToJSON Item

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: Item -> Value

toEncoding :: Item -> Encoding

toJSONList :: [Item] -> Value

toEncodingList :: [Item] -> Encoding

data RichResponse

A rich response that can include audio, text, cards, suggestions and structured data.

Constructors

RichResponse

Fields

• items :: [Item]

  A list of UI elements which compose the response. The items must meet the following requirements: 1. The first item must be a SimpleResponse 2. At most two SimpleResponse 3. At most one rich response item (e.g. BasicCard, StructuredResponse, MediaResponse, or HtmlResponse) 4. You cannot use a rich response item if you're using an actions.intent.OPTION intent ie ListSelect or CarouselSelect

• suggestions :: [Suggestion]

  A list of suggested replies. These will always appear at the end of the response.

• linkOutSuggestion :: Maybe LinkOutSuggestion

  An additional suggestion chip that can link out to the associated app or site.

Instances

Eq RichResponse

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: RichResponse -> RichResponse -> Bool

(/=) :: RichResponse -> RichResponse -> Bool

Show RichResponse

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> RichResponse -> ShowS

show :: RichResponse -> String

showList :: [RichResponse] -> ShowS

ToJSON RichResponse

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: RichResponse -> Value

toEncoding :: RichResponse -> Encoding

toJSONList :: [RichResponse] -> Value

toEncodingList :: [RichResponse] -> Encoding

data Response

The response sent by the fulfillment to Google Assistant.

Constructors

Response

Fields

• expectUserResponse :: Bool

  Indicates whether your fulfillment expects a user response. Set the value to true when to keep the conversation going and false to end the conversation.

• userStorage :: Maybe String

  Stores persistent data tied to a specific user. The total storage amount is 10,000 bytes.

• richResponse :: RichResponse

  This field contains audio, text, cards, suggestions, or structured data for the Assistant to render. To learn more about using rich responses for Actions on Google, see Res.

Instances

Eq Response

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: Response -> Response -> Bool

(/=) :: Response -> Response -> Bool

Show Response

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

ToJSON Response

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: Response -> Value

toEncoding :: Response -> Encoding

toJSONList :: [Response] -> Value

toEncodingList :: [Response] -> Encoding

data UrlTypeHint

Different types of url hints.

Constructors

URL_TYPE_HINT_UNSPECIFIED

Unspecified.

AMP_CONTENT

URL that points directly to AMP content, or to a canonical URL which refers to AMP content via .

Instances

Eq UrlTypeHint

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: UrlTypeHint -> UrlTypeHint -> Bool

(/=) :: UrlTypeHint -> UrlTypeHint -> Bool

Read UrlTypeHint

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

readsPrec :: Int -> ReadS UrlTypeHint

readList :: ReadS [UrlTypeHint]

readPrec :: ReadPrec UrlTypeHint

readListPrec :: ReadPrec [UrlTypeHint]

Show UrlTypeHint

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> UrlTypeHint -> ShowS

show :: UrlTypeHint -> String

showList :: [UrlTypeHint] -> ShowS

ToJSON UrlTypeHint

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: UrlTypeHint -> Value

toEncoding :: UrlTypeHint -> Encoding

toJSONList :: [UrlTypeHint] -> Value

toEncodingList :: [UrlTypeHint] -> Encoding

FromJSON UrlTypeHint

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser UrlTypeHint

parseJSONList :: Value -> Parser [UrlTypeHint]

data VersionFilter

VersionFilter should be included if specific version/s of the App are required.

Constructors

VersionFilter

Fields

• minVersion :: Int

  Min version code or 0, inclusive.

• maxVersion :: Int

  Max version code, inclusive. The range considered is [minVersion:maxVersion]. A null range implies any version.

Instances

Eq VersionFilter

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: VersionFilter -> VersionFilter -> Bool

(/=) :: VersionFilter -> VersionFilter -> Bool

Read VersionFilter

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

readsPrec :: Int -> ReadS VersionFilter

readList :: ReadS [VersionFilter]

readPrec :: ReadPrec VersionFilter

readListPrec :: ReadPrec [VersionFilter]

Show VersionFilter

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> VersionFilter -> ShowS

show :: VersionFilter -> String

showList :: [VersionFilter] -> ShowS

ToJSON VersionFilter

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: VersionFilter -> Value

toEncoding :: VersionFilter -> Encoding

toJSONList :: [VersionFilter] -> Value

toEncodingList :: [VersionFilter] -> Encoding

FromJSON VersionFilter

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser VersionFilter

parseJSONList :: Value -> Parser [VersionFilter]

data AndroidApp

Specification of the Android App for fulfillment restrictions.

Constructors

AndroidApp

Fields

• aaPackageName :: String

  Package name must be specified when specifing Android Fulfillment.

• aaVersions :: [VersionFilter]

  When multiple filters are specified, any filter match will trigger the app.

Instances

Eq AndroidApp

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: AndroidApp -> AndroidApp -> Bool

(/=) :: AndroidApp -> AndroidApp -> Bool

Read AndroidApp

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

readsPrec :: Int -> ReadS AndroidApp

readList :: ReadS [AndroidApp]

readPrec :: ReadPrec AndroidApp

readListPrec :: ReadPrec [AndroidApp]

Show AndroidApp

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> AndroidApp -> ShowS

show :: AndroidApp -> String

showList :: [AndroidApp] -> ShowS

ToJSON AndroidApp

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: AndroidApp -> Value

toEncoding :: AndroidApp -> Encoding

toJSONList :: [AndroidApp] -> Value

toEncodingList :: [AndroidApp] -> Encoding

FromJSON AndroidApp

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser AndroidApp

parseJSONList :: Value -> Parser [AndroidApp]

data OpenUrlAction

Opens the given url.

Constructors

OpenUrlAction

Fields

• ouaUrl :: String

  The url field which could be any of: - http/https urls for opening an App-linked App or a webpage.

• ouaAndroidApp :: AndroidApp

  Information about the Android App if the URL is expected to be fulfilled by an Android App.

• ouaUrlTypeHint :: UrlTypeHint

  Indicates a hint for the url type.

Instances

Eq OpenUrlAction

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: OpenUrlAction -> OpenUrlAction -> Bool

(/=) :: OpenUrlAction -> OpenUrlAction -> Bool

Read OpenUrlAction

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

readsPrec :: Int -> ReadS OpenUrlAction

readList :: ReadS [OpenUrlAction]

readPrec :: ReadPrec OpenUrlAction

readListPrec :: ReadPrec [OpenUrlAction]

Show OpenUrlAction

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> OpenUrlAction -> ShowS

show :: OpenUrlAction -> String

showList :: [OpenUrlAction] -> ShowS

ToJSON OpenUrlAction

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: OpenUrlAction -> Value

toEncoding :: OpenUrlAction -> Encoding

toJSONList :: [OpenUrlAction] -> Value

toEncodingList :: [OpenUrlAction] -> Encoding

FromJSON OpenUrlAction

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser OpenUrlAction

parseJSONList :: Value -> Parser [OpenUrlAction]

data LinkOutSuggestion

Creates a suggestion chip that allows the user to jump out to the App or Website associated with this agent.

Constructors

LinkOutSuggestion

Fields

• losDestinationName :: String

  The name of the app or site this chip is linking to. The chip will be rendered with the title "Open ". Max 20 chars.

• losUrl :: String

  Deprecated. Use OpenUrlAction instead.

• losOpenUrlAction :: OpenUrlAction

  The URL of the App or Site to open when the user taps the suggestion chip. Ownership of this App/URL must be validated in the actions on Google developer console, or the suggestion will not be shown to the user.

Instances

Eq LinkOutSuggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: LinkOutSuggestion -> LinkOutSuggestion -> Bool

(/=) :: LinkOutSuggestion -> LinkOutSuggestion -> Bool

Show LinkOutSuggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> LinkOutSuggestion -> ShowS

show :: LinkOutSuggestion -> String

showList :: [LinkOutSuggestion] -> ShowS

ToJSON LinkOutSuggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: LinkOutSuggestion -> Value

toEncoding :: LinkOutSuggestion -> Encoding

toJSONList :: [LinkOutSuggestion] -> Value

toEncodingList :: [LinkOutSuggestion] -> Encoding

FromJSON LinkOutSuggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser LinkOutSuggestion

parseJSONList :: Value -> Parser [LinkOutSuggestion]

newtype Suggestion

A suggestion chip that the user can tap to quickly post a reply to the conversation.

Constructors

Suggestion

Fields

• unSuggestion :: String

Instances

Eq Suggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

(==) :: Suggestion -> Suggestion -> Bool

(/=) :: Suggestion -> Suggestion -> Bool

Show Suggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

showsPrec :: Int -> Suggestion -> ShowS

show :: Suggestion -> String

showList :: [Suggestion] -> ShowS

ToJSON Suggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

toJSON :: Suggestion -> Value

toEncoding :: Suggestion -> Encoding

toJSONList :: [Suggestion] -> Value

toEncodingList :: [Suggestion] -> Encoding

FromJSON Suggestion

Defined in Dialogflow.V2.Fulfillment.Payload.Google

Methods

parseJSON :: Value -> Parser Suggestion

parseJSONList :: Value -> Parser [Suggestion]