Copyright	(c) Mauricio Fierro 2019
License	BSD3-Clause
Maintainer	Mauricio Fierro <mauriciofierrom@gmail.com>
Safe Haskell	None
Language	Haskell2010

Dialogflow.V2.Fulfillment.Message

Description

This module contains types for Dialogflow messages to be used in a fulfillment webhook response. See the Dialogflow documentation.

Synopsis

data CardButton = CardButton {
- cbText :: Maybe String
- cbPostback :: Maybe String
}
data BasicCardContent
- = BasicCardImage (Msg 'MsgImage)
- | BasicCardFormattedText String
data BasicCardButton = BasicCardButton {
- bcbTitle :: String
- bcbOpenUriAction :: OpenUriAction
}
data Item = Item {
- iInfo :: SelectItemInfo
- iTitle :: String
- iDescription :: Maybe String
- iImage :: Msg 'MsgImage
}
newtype OpenUriAction = OpenUriAction {
- unOpenUriAction :: String
}
data SpeechText
- = TextToSpeech String
- | SSML String
data SimpleResponse = SimpleResponse {
- simpleResponseText :: SpeechText
- displayText :: Maybe String
}
newtype Suggestion = Suggestion {
- unSuggestionTitle :: String
}
data SelectItemInfo = SelectItemInfo {
- siiKey :: String
- siiSynonyms :: Maybe [String]
}
data MsgType
- = MsgText
- | MsgImage
- | MsgQuickReplies
- | MsgCard
- | MsgSimpleResponses
- | MsgBasicCard
- | MsgSuggestions
- | MsgLinkOutSuggestion
- | MsgListSelect
- | MsgCarouselSelect
data Msg t where
- Text :: Maybe [String] -> Msg 'MsgText
- Image :: String -> Maybe String -> Msg 'MsgImage
- QuickReplies :: Maybe String -> [String] -> Msg 'MsgQuickReplies
- Card :: Maybe String -> Maybe String -> Maybe String -> Maybe [CardButton] -> Msg 'MsgCard
- SimpleResponses :: [SimpleResponse] -> Msg 'MsgSimpleResponses
- BasicCard :: Maybe String -> Maybe String -> BasicCardContent -> Maybe [BasicCardButton] -> Msg 'MsgBasicCard
- Suggestions :: [Suggestion] -> Msg 'MsgSuggestions
- LinkOutSuggestion :: String -> String -> Msg 'MsgLinkOutSuggestion
- ListSelect :: Maybe String -> [Item] -> Msg 'MsgListSelect
- CarouselSelect :: [Item] -> Msg 'MsgCarouselSelect
data Message where
- Message :: Show (Msg t) => Msg t -> Message

Documentation

data CardButton Source #

Button for a Card message

Constructors

CardButton
Fields cbText :: Maybe String The text to show on the button. cbPostback :: Maybe String The text to send to the Dialogflow API or URI to open.

Instances

Instances details

Eq CardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: CardButton -> CardButton -> Bool # (/=) :: CardButton -> CardButton -> Bool #
Show CardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> CardButton -> ShowS # show :: CardButton -> String # showList :: [CardButton] -> ShowS #
ToJSON CardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: CardButton -> Value # toEncoding :: CardButton -> Encoding # toJSONList :: [CardButton] -> Value # toEncodingList :: [CardButton] -> Encoding #
FromJSON CardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser CardButton # parseJSONList :: Value -> Parser [CardButton] #

data BasicCardContent Source #

The BasicCard message can have either an Image or formatted text as content.

Constructors

BasicCardImage (Msg 'MsgImage)
BasicCardFormattedText String

Instances

Instances details

Eq BasicCardContent Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: BasicCardContent -> BasicCardContent -> Bool # (/=) :: BasicCardContent -> BasicCardContent -> Bool #
Show BasicCardContent Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> BasicCardContent -> ShowS # show :: BasicCardContent -> String # showList :: [BasicCardContent] -> ShowS #
ToJSON BasicCardContent Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: BasicCardContent -> Value # toEncoding :: BasicCardContent -> Encoding # toJSONList :: [BasicCardContent] -> Value # toEncodingList :: [BasicCardContent] -> Encoding #
FromJSON BasicCardContent Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser BasicCardContent # parseJSONList :: Value -> Parser [BasicCardContent] #

data BasicCardButton Source #

Buttons for BasicCards.

Constructors

BasicCardButton
Fields bcbTitle :: String The title of the button bcbOpenUriAction :: OpenUriAction Action to take when a user taps on the button

Instances

Instances details

Eq BasicCardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: BasicCardButton -> BasicCardButton -> Bool # (/=) :: BasicCardButton -> BasicCardButton -> Bool #
Show BasicCardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> BasicCardButton -> ShowS # show :: BasicCardButton -> String # showList :: [BasicCardButton] -> ShowS #
ToJSON BasicCardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: BasicCardButton -> Value # toEncoding :: BasicCardButton -> Encoding # toJSONList :: [BasicCardButton] -> Value # toEncodingList :: [BasicCardButton] -> Encoding #
FromJSON BasicCardButton Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser BasicCardButton # parseJSONList :: Value -> Parser [BasicCardButton] #

data Item Source #

An item in ListSelect and CarouselSelect.

Constructors

Item
Fields iInfo :: SelectItemInfo Additional information about this option iTitle :: String The title of the list item iDescription :: Maybe String The main text describing the item iImage :: Msg 'MsgImage The image to display

Instances

Instances details

Eq Item Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: Item -> Item -> Bool # (/=) :: Item -> Item -> Bool #
Show Item Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> Item -> ShowS # show :: Item -> String # showList :: [Item] -> ShowS #
ToJSON Item Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: Item -> Value # toEncoding :: Item -> Encoding # toJSONList :: [Item] -> Value # toEncodingList :: [Item] -> Encoding #
FromJSON Item Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser Item # parseJSONList :: Value -> Parser [Item] #

newtype OpenUriAction Source #

An action to open the given URI. Used in BasicCardButtons.

Constructors

OpenUriAction
Fields unOpenUriAction :: String The HTTP or HTTPS scheme URI

Instances

Instances details

Eq OpenUriAction Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: OpenUriAction -> OpenUriAction -> Bool # (/=) :: OpenUriAction -> OpenUriAction -> Bool #
Show OpenUriAction Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> OpenUriAction -> ShowS # show :: OpenUriAction -> String # showList :: [OpenUriAction] -> ShowS #
ToJSON OpenUriAction Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: OpenUriAction -> Value # toEncoding :: OpenUriAction -> Encoding # toJSONList :: [OpenUriAction] -> Value # toEncodingList :: [OpenUriAction] -> Encoding #
FromJSON OpenUriAction Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser OpenUriAction # parseJSONList :: Value -> Parser [OpenUriAction] #

data SpeechText Source #

A SimpleResponse can have text-to-speech in plain text or SSML format.

Constructors

TextToSpeech String	The plain text of the speech output
SSML String	Structured spoken response to the user in SSML format

Instances

Instances details

Eq SpeechText Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: SpeechText -> SpeechText -> Bool # (/=) :: SpeechText -> SpeechText -> Bool #
Show SpeechText Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> SpeechText -> ShowS # show :: SpeechText -> String # showList :: [SpeechText] -> ShowS #
ToJSON SpeechText Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: SpeechText -> Value # toEncoding :: SpeechText -> Encoding # toJSONList :: [SpeechText] -> Value # toEncodingList :: [SpeechText] -> Encoding #
FromJSON SpeechText Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser SpeechText # parseJSONList :: Value -> Parser [SpeechText] #

data SimpleResponse Source #

A simple response message containing speech or text

Constructors

SimpleResponse
Fields simpleResponseText :: SpeechText The speech text displayText :: Maybe String The text to display

Instances

Instances details

Eq SimpleResponse Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: SimpleResponse -> SimpleResponse -> Bool # (/=) :: SimpleResponse -> SimpleResponse -> Bool #
Show SimpleResponse Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> SimpleResponse -> ShowS # show :: SimpleResponse -> String # showList :: [SimpleResponse] -> ShowS #
ToJSON SimpleResponse Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: SimpleResponse -> Value # toEncoding :: SimpleResponse -> Encoding # toJSONList :: [SimpleResponse] -> Value # toEncodingList :: [SimpleResponse] -> Encoding #
FromJSON SimpleResponse Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser SimpleResponse # parseJSONList :: Value -> Parser [SimpleResponse] #

newtype Suggestion Source #

Suggestion chips.

Constructors

Suggestion
Fields unSuggestionTitle :: String The text shown in the suggestion chip

Instances

Instances details

Eq Suggestion Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: Suggestion -> Suggestion -> Bool # (/=) :: Suggestion -> Suggestion -> Bool #
Show Suggestion Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> Suggestion -> ShowS # show :: Suggestion -> String # showList :: [Suggestion] -> ShowS #
ToJSON Suggestion Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: Suggestion -> Value # toEncoding :: Suggestion -> Encoding # toJSONList :: [Suggestion] -> Value # toEncodingList :: [Suggestion] -> Encoding #
FromJSON Suggestion Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser Suggestion # parseJSONList :: Value -> Parser [Suggestion] #

data SelectItemInfo Source #

Additional information about an Item for when it is triggered in a dialog.

Constructors

SelectItemInfo
Fields siiKey :: String A unique key that will be sent back to the agent if this response is given. siiSynonyms :: Maybe [String] A list of synonyms that can also be used to trigger this item in dialog.

Instances

Instances details

Eq SelectItemInfo Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: SelectItemInfo -> SelectItemInfo -> Bool # (/=) :: SelectItemInfo -> SelectItemInfo -> Bool #
Show SelectItemInfo Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> SelectItemInfo -> ShowS # show :: SelectItemInfo -> String # showList :: [SelectItemInfo] -> ShowS #
ToJSON SelectItemInfo Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: SelectItemInfo -> Value # toEncoding :: SelectItemInfo -> Encoding # toJSONList :: [SelectItemInfo] -> Value # toEncodingList :: [SelectItemInfo] -> Encoding #
FromJSON SelectItemInfo Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser SelectItemInfo # parseJSONList :: Value -> Parser [SelectItemInfo] #

data MsgType Source #

The possible types of Message.

Constructors

MsgText
MsgImage
MsgQuickReplies
MsgCard
MsgSimpleResponses
MsgBasicCard
MsgSuggestions
MsgLinkOutSuggestion
MsgListSelect
MsgCarouselSelect

data Msg t where Source #

The messages to be included in the Response.

Constructors

Text	The text response message.
Fields :: Maybe [String] The collection of the agent's responses -> Msg 'MsgText
Image	The image response message.
Fields :: String The public URI to an image file -> Maybe String A text description of the image to be used for accessibility -> Msg 'MsgImage
QuickReplies	The quick replies response message.
Fields :: Maybe String The title of the collection of quick replies -> [String] The collection of quick replies -> Msg 'MsgQuickReplies
Card	The card response.
Fields :: Maybe String The title of the card -> Maybe String The subtitle of the card -> Maybe String The public URI to an image file for the card -> Maybe [CardButton] The collection of card buttons -> Msg 'MsgCard
SimpleResponses	The collection of `SimpleResponse` candidates.
Fields :: [SimpleResponse] The list of simple responses -> Msg 'MsgSimpleResponses
BasicCard	The basic card message. Useful for displaying information.
Fields :: Maybe String The title of the card -> Maybe String The subtitle of the card -> BasicCardContent The body text or image of the card -> Maybe [BasicCardButton] The collection of card buttons -> Msg 'MsgBasicCard
Suggestions	The collection of `Suggestion`.
Fields :: [Suggestion] The list of suggested replies -> Msg 'MsgSuggestions
LinkOutSuggestion	The suggestion chip message that allows the user to jump out to the app or the website associated with this agent.
Fields :: String The name of the app or site this chip is linking to -> String The URI of the app or site to open when the user taps the suggestion chip -> Msg 'MsgLinkOutSuggestion
ListSelect	The card for presenting a list of options to select from.
Fields :: Maybe String The overall title of the list -> [Item] List items -> Msg 'MsgListSelect
CarouselSelect	The card for representing a carousel of options to select from.
Fields :: [Item] Carousel items -> Msg 'MsgCarouselSelect

Instances

Instances details

Eq (Msg t) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: Msg t -> Msg t -> Bool # (/=) :: Msg t -> Msg t -> Bool #
Show (Msg t) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> Msg t -> ShowS # show :: Msg t -> String # showList :: [Msg t] -> ShowS #
ToJSON (Msg t) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: Msg t -> Value # toEncoding :: Msg t -> Encoding # toJSONList :: [Msg t] -> Value # toEncodingList :: [Msg t] -> Encoding #
FromJSON (Msg 'MsgText) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgText) # parseJSONList :: Value -> Parser [Msg 'MsgText] #
FromJSON (Msg 'MsgImage) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgImage) # parseJSONList :: Value -> Parser [Msg 'MsgImage] #
FromJSON (Msg 'MsgQuickReplies) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgQuickReplies) # parseJSONList :: Value -> Parser [Msg 'MsgQuickReplies] #
FromJSON (Msg 'MsgCard) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgCard) # parseJSONList :: Value -> Parser [Msg 'MsgCard] #
FromJSON (Msg 'MsgSimpleResponses) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgSimpleResponses) # parseJSONList :: Value -> Parser [Msg 'MsgSimpleResponses] #
FromJSON (Msg 'MsgBasicCard) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgBasicCard) # parseJSONList :: Value -> Parser [Msg 'MsgBasicCard] #
FromJSON (Msg 'MsgSuggestions) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgSuggestions) # parseJSONList :: Value -> Parser [Msg 'MsgSuggestions] #
FromJSON (Msg 'MsgLinkOutSuggestion) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgLinkOutSuggestion) # parseJSONList :: Value -> Parser [Msg 'MsgLinkOutSuggestion] #
FromJSON (Msg 'MsgListSelect) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgListSelect) # parseJSONList :: Value -> Parser [Msg 'MsgListSelect] #
FromJSON (Msg 'MsgCarouselSelect) Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods parseJSON :: Value -> Parser (Msg 'MsgCarouselSelect) # parseJSONList :: Value -> Parser [Msg 'MsgCarouselSelect] #

data Message where Source #

This type is used to wrap the messages under one type.

Constructors

Message :: Show (Msg t) => Msg t -> Message

Instances

Instances details

Eq Message Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Show Message Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
ToJSON Message Source #
Instance details Defined in Dialogflow.V2.Fulfillment.Message Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #