Discord.Rest.Channel

Provides actions for Channel API interactions

Documentation

data ChannelRequest a where

Data constructor for requests. See API

Constructors

GetChannel :: Snowflake -> ChannelRequest Channel

Gets a channel by its id.

ModifyChannel :: Snowflake -> ModifyChannelOptions -> ChannelRequest Channel

Edits channels options.

DeleteChannel :: Snowflake -> ChannelRequest Channel

Deletes a channel if its id doesn't equal to the id of guild.

GetChannelMessages :: Snowflake -> (Int, MessageTiming) -> ChannelRequest [Message]

Gets a messages from a channel with limit of 100 per request.

GetChannelMessage :: (Snowflake, Snowflake) -> ChannelRequest Message

Gets a message in a channel by its id.

CreateMessage :: Snowflake -> Text -> Maybe Embed -> ChannelRequest Message

Sends a message to a channel.

UploadFile :: Snowflake -> FilePath -> ByteString -> ChannelRequest Message

Sends a message with a file to a channel.

CreateReaction :: (Snowflake, Snowflake) -> (Text, Maybe Snowflake) -> ChannelRequest ()

Add an emoji reaction to a message. ID must be present for custom emoji

DeleteOwnReaction :: (Snowflake, Snowflake) -> (Text, Maybe Snowflake) -> ChannelRequest ()

Remove a Reaction this bot added

DeleteUserReaction :: (Snowflake, Snowflake) -> (Text, Maybe Snowflake) -> Snowflake -> ChannelRequest ()

Remove a Reaction someone else added

GetReactions :: (Snowflake, Snowflake) -> (Text, Maybe Snowflake) -> (Int, ReactionTiming) -> ChannelRequest ()

List of users that reacted with this emoji

DeleteAllReactions :: (Snowflake, Snowflake) -> ChannelRequest ()

Delete all reactions on a message

EditMessage :: (Snowflake, Snowflake) -> Text -> Maybe Embed -> ChannelRequest Message

Edits a message content.

DeleteMessage :: (Snowflake, Snowflake) -> ChannelRequest ()

Deletes a message.

BulkDeleteMessage :: (Snowflake, [Snowflake]) -> ChannelRequest ()

Deletes a group of messages.

GetChannelInvites :: Snowflake -> ChannelRequest Object

Gets all instant invites to a channel.

DeleteChannelPermission :: Snowflake -> Snowflake -> ChannelRequest ()

Deletes a permission override from a channel.

TriggerTypingIndicator :: Snowflake -> ChannelRequest ()

Sends a typing indicator a channel which lasts 10 seconds.

GetPinnedMessages :: Snowflake -> ChannelRequest [Message]

Gets all pinned messages of a channel.

AddPinnedMessage :: (Snowflake, Snowflake) -> ChannelRequest ()

Pins a message.

DeletePinnedMessage :: (Snowflake, Snowflake) -> ChannelRequest ()

Unpins a message.

Instances

Request (ChannelRequest a)

Methods

majorRoute :: ChannelRequest a -> String

jsonRequest :: ChannelRequest a -> JsonRequest

data ReactionTiming

Data constructor for GetReaction requests

Constructors

BeforeReaction Snowflake

AfterReaction Snowflake

data MessageTiming

Data constructor for GetChannelMessages requests. See https://discordapp.com/developers/docs/resources/channel#get-channel-messages

Constructors

AroundMessage Snowflake

BeforeMessage Snowflake

AfterMessage Snowflake

data ModifyChannelOptions

Constructors

ModifyChannelOptions

Fields

• modifyChannelName :: Maybe String
• modifyChannelPosition :: Maybe Integer
• modifyChannelTopic :: Maybe String
• modifyChannelNSFW :: Maybe Bool
• modifyChannelBitrate :: Maybe Integer
• modifyChannelUserRateLimit :: Maybe Integer
• modifyChannelPermissionOverwrites :: Maybe [Overwrite]
• modifyChannelParentId :: Maybe Snowflake

Instances

ToJSON ModifyChannelOptions

Methods

toJSON :: ModifyChannelOptions -> Value

toEncoding :: ModifyChannelOptions -> Encoding

toJSONList :: [ModifyChannelOptions] -> Value

toEncodingList :: [ModifyChannelOptions] -> Encoding