Safe Haskell	Safe-Inferred
Language	Haskell2010

MSAzureAPI.BotService

Contents

Types
- Adaptive Card
  - adaptive card elements

Description

Azure Bot Framework

https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-quickstart?view=azure-bot-service-4.0

Synopsis

sendMessage :: FromJSON b => Text -> Text -> Activity -> AccessToken -> Req b
sendReply :: Activity -> Text -> [Attachment] -> AccessToken -> Req ()
data Activity = Activity {
- aType :: ActivityType
- aId :: Maybe Text
- aChannelId :: Maybe Text
- aConversation :: ConversationAccount
- aFrom :: ChannelAccount
- aRecipient :: ChannelAccount
- aServiceUrl :: Text
- aReplyToId :: Maybe Text
- aText :: Text
- aAttachments :: [Attachment]
}
data Attachment = Attachment {
- attContent :: AdaptiveCard
}
data AdaptiveCard = AdaptiveCard {
- acBody :: [ACElement]
}
data ACElement
- = ACEColumnSet ColumnSet
- | ACEColumn Column
- | ACETextBlock TextBlock
- | ACEImage Image
data Image = Image {
- imgUrl :: Text
}
newtype TextBlock = TextBlock {
- tbText :: Text
}
data ColumnSet = ColumnSet {
- colsColumns :: [Column]
}
data Column = Column {
- colItems :: [ACElement]
}

Documentation

sendMessage Source #

Arguments

:: FromJSON b
=> Text	base URI, taken from the `serviceUrl` property in the incoming `Activity` object
-> Text	conversation ID
-> Activity	message payload
-> AccessToken
-> Req b

Send a standalone message

https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-send-and-receive-messages?view=azure-bot-service-4.0#send-a-non-reply-message

sendReply Source #

Arguments

:: Activity	data from the user
-> Text	reply text
-> [Attachment]	reply attachments
-> AccessToken
-> Req ()

Send a reply to a user message

https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-send-and-receive-messages?view=azure-bot-service-4.0#create-a-reply

Types

data Activity Source #

Activity object. Defines a message that is exchanged between bot and user.

https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?view=azure-bot-service-4.0#activity-object

Constructors

Activity
Fields aType :: ActivityType aId :: Maybe Text aChannelId :: Maybe Text aConversation :: ConversationAccount aFrom :: ChannelAccount sender aRecipient :: ChannelAccount recipient aServiceUrl :: Text URL that specifies the channel's service endpoint. Set by the channel. aReplyToId :: Maybe Text aText :: Text message text aAttachments :: [Attachment] message attachments

Instances

Instances details

FromJSON Activity Source #
Instance details Defined in MSAzureAPI.BotService Methods parseJSON :: Value -> Parser Activity # parseJSONList :: Value -> Parser [Activity] #
ToJSON Activity Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: Activity -> Value # toEncoding :: Activity -> Encoding # toJSONList :: [Activity] -> Value # toEncodingList :: [Activity] -> Encoding #
Generic Activity Source #
Instance details Defined in MSAzureAPI.BotService Associated Types type Rep Activity :: Type -> Type # Methods from :: Activity -> Rep Activity x # to :: Rep Activity x -> Activity #
Show Activity Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> Activity -> ShowS # show :: Activity -> String # showList :: [Activity] -> ShowS #
type Rep Activity Source #
Instance details Defined in MSAzureAPI.BotService type Rep Activity

data Attachment Source #

Message attachments

https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?view=azure-bot-service-4.0#attachment-object

Attachments can be of many types but we currently only support adaptive cards

Constructors

Attachment
Fields attContent :: AdaptiveCard

Instances

Instances details

FromJSON Attachment Source #
Instance details Defined in MSAzureAPI.BotService Methods parseJSON :: Value -> Parser Attachment # parseJSONList :: Value -> Parser [Attachment] #
ToJSON Attachment Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: Attachment -> Value # toEncoding :: Attachment -> Encoding # toJSONList :: [Attachment] -> Value # toEncodingList :: [Attachment] -> Encoding #
Generic Attachment Source #
Instance details Defined in MSAzureAPI.BotService Associated Types type Rep Attachment :: Type -> Type # Methods from :: Attachment -> Rep Attachment x # to :: Rep Attachment x -> Attachment #
Show Attachment Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> Attachment -> ShowS # show :: Attachment -> String # showList :: [Attachment] -> ShowS #
type Rep Attachment Source #
Instance details Defined in MSAzureAPI.BotService type Rep Attachment = D1 ('MetaData "Attachment" "MSAzureAPI.BotService" "ms-azure-api-0.6.0.1-9AqtB8TNiqqGzZl2uZcaR4" 'False) (C1 ('MetaCons "Attachment" 'PrefixI 'True) (S1 ('MetaSel ('Just "attContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AdaptiveCard)))

Adaptive Card

data AdaptiveCard Source #

Adaptive Card API

https://adaptivecards.io/explorer/AdaptiveCard.html

Constructors

AdaptiveCard
Fields acBody :: [ACElement]

Instances

Instances details

FromJSON AdaptiveCard Source #
Instance details Defined in MSAzureAPI.BotService Methods parseJSON :: Value -> Parser AdaptiveCard # parseJSONList :: Value -> Parser [AdaptiveCard] #
ToJSON AdaptiveCard Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: AdaptiveCard -> Value # toEncoding :: AdaptiveCard -> Encoding # toJSONList :: [AdaptiveCard] -> Value # toEncodingList :: [AdaptiveCard] -> Encoding #
Generic AdaptiveCard Source #
Instance details Defined in MSAzureAPI.BotService Associated Types type Rep AdaptiveCard :: Type -> Type # Methods from :: AdaptiveCard -> Rep AdaptiveCard x # to :: Rep AdaptiveCard x -> AdaptiveCard #
Show AdaptiveCard Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> AdaptiveCard -> ShowS # show :: AdaptiveCard -> String # showList :: [AdaptiveCard] -> ShowS #
type Rep AdaptiveCard Source #
Instance details Defined in MSAzureAPI.BotService type Rep AdaptiveCard = D1 ('MetaData "AdaptiveCard" "MSAzureAPI.BotService" "ms-azure-api-0.6.0.1-9AqtB8TNiqqGzZl2uZcaR4" 'False) (C1 ('MetaCons "AdaptiveCard" 'PrefixI 'True) (S1 ('MetaSel ('Just "acBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ACElement])))

data ACElement Source #

Constructors

ACEColumnSet ColumnSet
ACEColumn Column
ACETextBlock TextBlock
ACEImage Image

Instances

Instances details

FromJSON ACElement Source #
Instance details Defined in MSAzureAPI.BotService Methods parseJSON :: Value -> Parser ACElement # parseJSONList :: Value -> Parser [ACElement] #
ToJSON ACElement Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: ACElement -> Value # toEncoding :: ACElement -> Encoding # toJSONList :: [ACElement] -> Value # toEncodingList :: [ACElement] -> Encoding #
Show ACElement Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> ACElement -> ShowS # show :: ACElement -> String # showList :: [ACElement] -> ShowS #

adaptive card elements

data Image Source #

Constructors

Image
Fields imgUrl :: Text

Instances

Instances details

ToJSON Image Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: Image -> Value # toEncoding :: Image -> Encoding # toJSONList :: [Image] -> Value # toEncodingList :: [Image] -> Encoding #
Generic Image Source #
Instance details Defined in MSAzureAPI.BotService Associated Types type Rep Image :: Type -> Type # Methods from :: Image -> Rep Image x # to :: Rep Image x -> Image #
Show Image Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
type Rep Image Source #
Instance details Defined in MSAzureAPI.BotService type Rep Image = D1 ('MetaData "Image" "MSAzureAPI.BotService" "ms-azure-api-0.6.0.1-9AqtB8TNiqqGzZl2uZcaR4" 'False) (C1 ('MetaCons "Image" 'PrefixI 'True) (S1 ('MetaSel ('Just "imgUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype TextBlock Source #

Constructors

TextBlock
Fields tbText :: Text

Instances

Instances details

ToJSON TextBlock Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: TextBlock -> Value # toEncoding :: TextBlock -> Encoding # toJSONList :: [TextBlock] -> Value # toEncodingList :: [TextBlock] -> Encoding #
IsString TextBlock Source #
Instance details Defined in MSAzureAPI.BotService Methods fromString :: String -> TextBlock #
Generic TextBlock Source #
Instance details Defined in MSAzureAPI.BotService Associated Types type Rep TextBlock :: Type -> Type # Methods from :: TextBlock -> Rep TextBlock x # to :: Rep TextBlock x -> TextBlock #
Show TextBlock Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> TextBlock -> ShowS # show :: TextBlock -> String # showList :: [TextBlock] -> ShowS #
type Rep TextBlock Source #
Instance details Defined in MSAzureAPI.BotService type Rep TextBlock = D1 ('MetaData "TextBlock" "MSAzureAPI.BotService" "ms-azure-api-0.6.0.1-9AqtB8TNiqqGzZl2uZcaR4" 'True) (C1 ('MetaCons "TextBlock" 'PrefixI 'True) (S1 ('MetaSel ('Just "tbText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ColumnSet Source #

Constructors

ColumnSet
Fields colsColumns :: [Column]

Instances

Instances details

FromJSON ColumnSet Source #
Instance details Defined in MSAzureAPI.BotService Methods parseJSON :: Value -> Parser ColumnSet # parseJSONList :: Value -> Parser [ColumnSet] #
ToJSON ColumnSet Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: ColumnSet -> Value # toEncoding :: ColumnSet -> Encoding # toJSONList :: [ColumnSet] -> Value # toEncodingList :: [ColumnSet] -> Encoding #
Generic ColumnSet Source #
Instance details Defined in MSAzureAPI.BotService Associated Types type Rep ColumnSet :: Type -> Type # Methods from :: ColumnSet -> Rep ColumnSet x # to :: Rep ColumnSet x -> ColumnSet #
Show ColumnSet Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> ColumnSet -> ShowS # show :: ColumnSet -> String # showList :: [ColumnSet] -> ShowS #
type Rep ColumnSet Source #
Instance details Defined in MSAzureAPI.BotService type Rep ColumnSet = D1 ('MetaData "ColumnSet" "MSAzureAPI.BotService" "ms-azure-api-0.6.0.1-9AqtB8TNiqqGzZl2uZcaR4" 'False) (C1 ('MetaCons "ColumnSet" 'PrefixI 'True) (S1 ('MetaSel ('Just "colsColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Column])))

data Column Source #

Constructors

Column
Fields colItems :: [ACElement]

Instances

Instances details

FromJSON Column Source #
Instance details Defined in MSAzureAPI.BotService Methods parseJSON :: Value -> Parser Column # parseJSONList :: Value -> Parser [Column] #
ToJSON Column Source #
Instance details Defined in MSAzureAPI.BotService Methods toJSON :: Column -> Value # toEncoding :: Column -> Encoding # toJSONList :: [Column] -> Value # toEncodingList :: [Column] -> Encoding #
Generic Column Source #
Instance details Defined in MSAzureAPI.BotService Associated Types type Rep Column :: Type -> Type # Methods from :: Column -> Rep Column x # to :: Rep Column x -> Column #
Show Column Source #
Instance details Defined in MSAzureAPI.BotService Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #
type Rep Column Source #
Instance details Defined in MSAzureAPI.BotService type Rep Column = D1 ('MetaData "Column" "MSAzureAPI.BotService" "ms-azure-api-0.6.0.1-9AqtB8TNiqqGzZl2uZcaR4" 'False) (C1 ('MetaCons "Column" 'PrefixI 'True) (S1 ('MetaSel ('Just "colItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ACElement])))