Safe Haskell	Safe-Inferred
Language	Haskell2010

Discord.Internal.Rest.Webhook

Description

Provides actions for Webhook API interactions

Synopsis

data CreateWebhookOpts = CreateWebhookOpts {
- createWebhookOptsName :: Text
- createWebhookOptsAvatar :: Maybe Text
}
data ExecuteWebhookWithTokenOpts = ExecuteWebhookWithTokenOpts {
- executeWebhookWithTokenOptsUsername :: Maybe Text
- executeWebhookWithTokenOptsContent :: WebhookContent
}
data ModifyWebhookOpts = ModifyWebhookOpts {
}
data WebhookContent
data WebhookRequest a where
- CreateWebhook :: ChannelId -> CreateWebhookOpts -> WebhookRequest Webhook
- GetChannelWebhooks :: ChannelId -> WebhookRequest [Webhook]
- GetGuildWebhooks :: GuildId -> WebhookRequest [Webhook]
- GetWebhook :: WebhookId -> Maybe WebhookToken -> WebhookRequest Webhook
- ModifyWebhook :: WebhookId -> Maybe WebhookToken -> ModifyWebhookOpts -> WebhookRequest Webhook
- DeleteWebhook :: WebhookId -> Maybe WebhookToken -> WebhookRequest ()
- ExecuteWebhook :: WebhookId -> WebhookToken -> ExecuteWebhookWithTokenOpts -> WebhookRequest ()
- GetWebhookMessage :: WebhookId -> WebhookToken -> MessageId -> WebhookRequest Message
- EditWebhookMessage :: WebhookId -> WebhookToken -> MessageId -> Text -> WebhookRequest Message
- DeleteWebhookMessage :: WebhookId -> WebhookToken -> MessageId -> WebhookRequest ()

Documentation

data CreateWebhookOpts Source #

Options for CreateWebhook

Constructors

CreateWebhookOpts
Fields createWebhookOptsName :: Text createWebhookOptsAvatar :: Maybe Text

Instances

Instances details

ToJSON CreateWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods toJSON :: CreateWebhookOpts -> Value # toEncoding :: CreateWebhookOpts -> Encoding # toJSONList :: [CreateWebhookOpts] -> Value # toEncodingList :: [CreateWebhookOpts] -> Encoding # omitField :: CreateWebhookOpts -> Bool #
Read CreateWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods readsPrec :: Int -> ReadS CreateWebhookOpts # readList :: ReadS [CreateWebhookOpts] # readPrec :: ReadPrec CreateWebhookOpts # readListPrec :: ReadPrec [CreateWebhookOpts] #
Show CreateWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods showsPrec :: Int -> CreateWebhookOpts -> ShowS # show :: CreateWebhookOpts -> String # showList :: [CreateWebhookOpts] -> ShowS #
Eq CreateWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods (==) :: CreateWebhookOpts -> CreateWebhookOpts -> Bool # (/=) :: CreateWebhookOpts -> CreateWebhookOpts -> Bool #
Ord CreateWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods compare :: CreateWebhookOpts -> CreateWebhookOpts -> Ordering # (<) :: CreateWebhookOpts -> CreateWebhookOpts -> Bool # (<=) :: CreateWebhookOpts -> CreateWebhookOpts -> Bool # (>) :: CreateWebhookOpts -> CreateWebhookOpts -> Bool # (>=) :: CreateWebhookOpts -> CreateWebhookOpts -> Bool # max :: CreateWebhookOpts -> CreateWebhookOpts -> CreateWebhookOpts # min :: CreateWebhookOpts -> CreateWebhookOpts -> CreateWebhookOpts #

data ExecuteWebhookWithTokenOpts Source #

Options for ExecuteWebhookWithToken

Constructors

ExecuteWebhookWithTokenOpts
Fields executeWebhookWithTokenOptsUsername :: Maybe Text executeWebhookWithTokenOptsContent :: WebhookContent

Instances

Instances details

ToJSON ExecuteWebhookWithTokenOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods toJSON :: ExecuteWebhookWithTokenOpts -> Value # toEncoding :: ExecuteWebhookWithTokenOpts -> Encoding # toJSONList :: [ExecuteWebhookWithTokenOpts] -> Value # toEncodingList :: [ExecuteWebhookWithTokenOpts] -> Encoding # omitField :: ExecuteWebhookWithTokenOpts -> Bool #
Read ExecuteWebhookWithTokenOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods readsPrec :: Int -> ReadS ExecuteWebhookWithTokenOpts # readList :: ReadS [ExecuteWebhookWithTokenOpts] # readPrec :: ReadPrec ExecuteWebhookWithTokenOpts # readListPrec :: ReadPrec [ExecuteWebhookWithTokenOpts] #
Show ExecuteWebhookWithTokenOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods showsPrec :: Int -> ExecuteWebhookWithTokenOpts -> ShowS # show :: ExecuteWebhookWithTokenOpts -> String # showList :: [ExecuteWebhookWithTokenOpts] -> ShowS #
Eq ExecuteWebhookWithTokenOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods (==) :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> Bool # (/=) :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> Bool #
Ord ExecuteWebhookWithTokenOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods compare :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> Ordering # (<) :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> Bool # (<=) :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> Bool # (>) :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> Bool # (>=) :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> Bool # max :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts # min :: ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts -> ExecuteWebhookWithTokenOpts #

data ModifyWebhookOpts Source #

Options for ModifyWebhook and ModifyWebhookWithToken

Constructors

ModifyWebhookOpts
Fields modifyWebhookOptsName :: Maybe Text modifyWebhookOptsAvatar :: Maybe Text modifyWebhookOptsChannelId :: Maybe ChannelId

Instances

Instances details

ToJSON ModifyWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods toJSON :: ModifyWebhookOpts -> Value # toEncoding :: ModifyWebhookOpts -> Encoding # toJSONList :: [ModifyWebhookOpts] -> Value # toEncodingList :: [ModifyWebhookOpts] -> Encoding # omitField :: ModifyWebhookOpts -> Bool #
Read ModifyWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods readsPrec :: Int -> ReadS ModifyWebhookOpts # readList :: ReadS [ModifyWebhookOpts] # readPrec :: ReadPrec ModifyWebhookOpts # readListPrec :: ReadPrec [ModifyWebhookOpts] #
Show ModifyWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods showsPrec :: Int -> ModifyWebhookOpts -> ShowS # show :: ModifyWebhookOpts -> String # showList :: [ModifyWebhookOpts] -> ShowS #
Eq ModifyWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods (==) :: ModifyWebhookOpts -> ModifyWebhookOpts -> Bool # (/=) :: ModifyWebhookOpts -> ModifyWebhookOpts -> Bool #
Ord ModifyWebhookOpts Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods compare :: ModifyWebhookOpts -> ModifyWebhookOpts -> Ordering # (<) :: ModifyWebhookOpts -> ModifyWebhookOpts -> Bool # (<=) :: ModifyWebhookOpts -> ModifyWebhookOpts -> Bool # (>) :: ModifyWebhookOpts -> ModifyWebhookOpts -> Bool # (>=) :: ModifyWebhookOpts -> ModifyWebhookOpts -> Bool # max :: ModifyWebhookOpts -> ModifyWebhookOpts -> ModifyWebhookOpts # min :: ModifyWebhookOpts -> ModifyWebhookOpts -> ModifyWebhookOpts #

data WebhookContent Source #

A webhook's content

Constructors

WebhookContentText Text
WebhookContentFile Text ByteString
WebhookContentEmbeds [CreateEmbed]

Instances

Instances details

Read WebhookContent Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods readsPrec :: Int -> ReadS WebhookContent # readList :: ReadS [WebhookContent] # readPrec :: ReadPrec WebhookContent # readListPrec :: ReadPrec [WebhookContent] #
Show WebhookContent Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods showsPrec :: Int -> WebhookContent -> ShowS # show :: WebhookContent -> String # showList :: [WebhookContent] -> ShowS #
Eq WebhookContent Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods (==) :: WebhookContent -> WebhookContent -> Bool # (/=) :: WebhookContent -> WebhookContent -> Bool #
Ord WebhookContent Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods compare :: WebhookContent -> WebhookContent -> Ordering # (<) :: WebhookContent -> WebhookContent -> Bool # (<=) :: WebhookContent -> WebhookContent -> Bool # (>) :: WebhookContent -> WebhookContent -> Bool # (>=) :: WebhookContent -> WebhookContent -> Bool # max :: WebhookContent -> WebhookContent -> WebhookContent # min :: WebhookContent -> WebhookContent -> WebhookContent #

data WebhookRequest a where Source #

Data constructors for webhook requests.

Constructors

CreateWebhook :: ChannelId -> CreateWebhookOpts -> WebhookRequest Webhook	Creates a new webhook and returns a webhook object on success. Requires the `MANAGE_WEBHOOKS` permission. An error will be returned if a webhook name (name) is not valid. A webhook name is valid if: It does not contain the substring `clyde` (case-insensitive) It follows the nickname guidelines in the Usernames and Nicknames documentation, with an exception that webhook names can be up to 80 characters
GetChannelWebhooks :: ChannelId -> WebhookRequest [Webhook]	Returns a channel's `Webhook`s as a list. Requires the `MANAGE_WEBHOOKS` permission.
GetGuildWebhooks :: GuildId -> WebhookRequest [Webhook]	Returns a guild's `Webhook`s as a list. Requires the `MANAGE_WEBHOOKS` permission.
GetWebhook :: WebhookId -> Maybe WebhookToken -> WebhookRequest Webhook	Returns the `Webhook` for the given id. If a token is given, authentication is not required.
ModifyWebhook :: WebhookId -> Maybe WebhookToken -> ModifyWebhookOpts -> WebhookRequest Webhook	Modify a webhook. Requires the `MANAGE_WEBHOOKS` permission. Returns the updated `Webhook` on success. If a token is given, authentication is not required.
DeleteWebhook :: WebhookId -> Maybe WebhookToken -> WebhookRequest ()	Delete a webhook permanently. Requires the `MANAGE_WEBHOOKS` permission. If a token is given, authentication is not required.
ExecuteWebhook :: WebhookId -> WebhookToken -> ExecuteWebhookWithTokenOpts -> WebhookRequest ()	Executes a Webhook. Refer to Uploading Files for details on attachments and `multipart/form-data` requests.
GetWebhookMessage :: WebhookId -> WebhookToken -> MessageId -> WebhookRequest Message	Returns a previously-sent webhook message from the same token.
EditWebhookMessage :: WebhookId -> WebhookToken -> MessageId -> Text -> WebhookRequest Message	Edits a previously-sent webhook message from the same token.
DeleteWebhookMessage :: WebhookId -> WebhookToken -> MessageId -> WebhookRequest ()	Deletes a previously-sent webhook message from the same token.

Instances

Instances details

Request (WebhookRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods majorRoute :: WebhookRequest a -> String Source # jsonRequest :: WebhookRequest a -> JsonRequest Source #