Safe Haskell	None
Language	Haskell2010

Discord.Rest.Channel

Description

Provides actions for Channel API interactions

Synopsis

data ChannelRequest a where
- GetChannel :: ChannelId -> ChannelRequest Channel
- ModifyChannel :: ChannelId -> ModifyChannelOpts -> ChannelRequest Channel
- DeleteChannel :: ChannelId -> ChannelRequest Channel
- GetChannelMessages :: ChannelId -> (Int, MessageTiming) -> ChannelRequest [Message]
- GetChannelMessage :: (ChannelId, MessageId) -> ChannelRequest Message
- CreateMessage :: ChannelId -> Text -> ChannelRequest Message
- CreateMessageEmbed :: ChannelId -> Text -> Embed -> ChannelRequest Message
- CreateMessageUploadFile :: ChannelId -> Text -> ByteString -> ChannelRequest Message
- CreateReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()
- DeleteOwnReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()
- DeleteUserReaction :: (ChannelId, MessageId) -> UserId -> Text -> ChannelRequest ()
- GetReactions :: (ChannelId, MessageId) -> Text -> (Int, ReactionTiming) -> ChannelRequest ()
- DeleteAllReactions :: (ChannelId, MessageId) -> ChannelRequest ()
- EditMessage :: (ChannelId, MessageId) -> Text -> Maybe Embed -> ChannelRequest Message
- DeleteMessage :: (ChannelId, MessageId) -> ChannelRequest ()
- BulkDeleteMessage :: (ChannelId, [MessageId]) -> ChannelRequest ()
- EditChannelPermissions :: ChannelId -> OverwriteId -> ChannelPermissionsOpts -> ChannelRequest ()
- GetChannelInvites :: ChannelId -> ChannelRequest Object
- CreateChannelInvite :: ChannelId -> ChannelInviteOpts -> ChannelRequest Invite
- DeleteChannelPermission :: ChannelId -> OverwriteId -> ChannelRequest ()
- TriggerTypingIndicator :: ChannelId -> ChannelRequest ()
- GetPinnedMessages :: ChannelId -> ChannelRequest [Message]
- AddPinnedMessage :: (ChannelId, MessageId) -> ChannelRequest ()
- DeletePinnedMessage :: (ChannelId, MessageId) -> ChannelRequest ()
- GroupDMAddRecipient :: ChannelId -> GroupDMAddRecipientOpts -> ChannelRequest ()
- GroupDMRemoveRecipient :: ChannelId -> UserId -> ChannelRequest ()
data ReactionTiming
- = BeforeReaction MessageId
- | AfterReaction MessageId
data MessageTiming
- = AroundMessage MessageId
- | BeforeMessage MessageId
- | AfterMessage MessageId
- | LatestMessages
data ChannelInviteOpts = ChannelInviteOpts {
}
data ModifyChannelOpts = ModifyChannelOpts {
- modifyChannelName :: Maybe String
- modifyChannelPosition :: Maybe Integer
- modifyChannelTopic :: Maybe String
- modifyChannelNSFW :: Maybe Bool
- modifyChannelBitrate :: Maybe Integer
- modifyChannelUserRateLimit :: Maybe Integer
- modifyChannelPermissionOverwrites :: Maybe [Overwrite]
- modifyChannelParentId :: Maybe ChannelId
}
data ChannelPermissionsOpts = ChannelPermissionsOpts {
}
data GroupDMAddRecipientOpts = GroupDMAddRecipientOpts {
}
data ChannelPermissionsOptsType
- = ChannelPermissionsOptsUser
- | ChannelPermissionsOptsRole

Documentation

data ChannelRequest a where Source #

Data constructor for requests. See API

Constructors

GetChannel :: ChannelId -> ChannelRequest Channel	Gets a channel by its id.
ModifyChannel :: ChannelId -> ModifyChannelOpts -> ChannelRequest Channel	Edits channels options.
DeleteChannel :: ChannelId -> ChannelRequest Channel	Deletes a channel if its id doesn't equal to the id of guild.
GetChannelMessages :: ChannelId -> (Int, MessageTiming) -> ChannelRequest [Message]	Gets a messages from a channel with limit of 100 per request.
GetChannelMessage :: (ChannelId, MessageId) -> ChannelRequest Message	Gets a message in a channel by its id.
CreateMessage :: ChannelId -> Text -> ChannelRequest Message	Sends a message to a channel.
CreateMessageEmbed :: ChannelId -> Text -> Embed -> ChannelRequest Message	Sends a message with an Embed to a channel.
CreateMessageUploadFile :: ChannelId -> Text -> ByteString -> ChannelRequest Message	Sends a message with a file to a channel.
CreateReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()	Add an emoji reaction to a message. ID must be present for custom emoji
DeleteOwnReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()	Remove a Reaction this bot added
DeleteUserReaction :: (ChannelId, MessageId) -> UserId -> Text -> ChannelRequest ()	Remove a Reaction someone else added
GetReactions :: (ChannelId, MessageId) -> Text -> (Int, ReactionTiming) -> ChannelRequest ()	List of users that reacted with this emoji
DeleteAllReactions :: (ChannelId, MessageId) -> ChannelRequest ()	Delete all reactions on a message
EditMessage :: (ChannelId, MessageId) -> Text -> Maybe Embed -> ChannelRequest Message	Edits a message content.
DeleteMessage :: (ChannelId, MessageId) -> ChannelRequest ()	Deletes a message.
BulkDeleteMessage :: (ChannelId, [MessageId]) -> ChannelRequest ()	Deletes a group of messages.
EditChannelPermissions :: ChannelId -> OverwriteId -> ChannelPermissionsOpts -> ChannelRequest ()	Edits a permission overrides for a channel.
GetChannelInvites :: ChannelId -> ChannelRequest Object	Gets all instant invites to a channel.
CreateChannelInvite :: ChannelId -> ChannelInviteOpts -> ChannelRequest Invite	Creates an instant invite to a channel.
DeleteChannelPermission :: ChannelId -> OverwriteId -> ChannelRequest ()	Deletes a permission override from a channel.
TriggerTypingIndicator :: ChannelId -> ChannelRequest ()	Sends a typing indicator a channel which lasts 10 seconds.
GetPinnedMessages :: ChannelId -> ChannelRequest [Message]	Gets all pinned messages of a channel.
AddPinnedMessage :: (ChannelId, MessageId) -> ChannelRequest ()	Pins a message.
DeletePinnedMessage :: (ChannelId, MessageId) -> ChannelRequest ()	Unpins a message.
GroupDMAddRecipient :: ChannelId -> GroupDMAddRecipientOpts -> ChannelRequest ()	Adds a recipient to a Group DM using their access token
GroupDMRemoveRecipient :: ChannelId -> UserId -> ChannelRequest ()	Removes a recipient from a Group DM

Instances

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

data ReactionTiming Source #

Data constructor for GetReaction requests

Constructors

BeforeReaction MessageId
AfterReaction MessageId

data MessageTiming Source #

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

Constructors

AroundMessage MessageId
BeforeMessage MessageId
AfterMessage MessageId
LatestMessages

data ChannelInviteOpts Source #

Constructors

ChannelInviteOpts
Fields channelInviteOptsMaxAgeSeconds :: Maybe Integer channelInviteOptsMaxUsages :: Maybe Integer channelInviteOptsIsTemporary :: Maybe Bool channelInviteOptsDontReuseSimilarInvite :: Maybe Bool

Instances

ToJSON ChannelInviteOpts Source #
Instance details Defined in Discord.Rest.Channel Methods toJSON :: ChannelInviteOpts -> Value # toEncoding :: ChannelInviteOpts -> Encoding # toJSONList :: [ChannelInviteOpts] -> Value # toEncodingList :: [ChannelInviteOpts] -> Encoding #

data ModifyChannelOpts Source #

Constructors

ModifyChannelOpts
Fields modifyChannelName :: Maybe String modifyChannelPosition :: Maybe Integer modifyChannelTopic :: Maybe String modifyChannelNSFW :: Maybe Bool modifyChannelBitrate :: Maybe Integer modifyChannelUserRateLimit :: Maybe Integer modifyChannelPermissionOverwrites :: Maybe [Overwrite] modifyChannelParentId :: Maybe ChannelId

Instances

ToJSON ModifyChannelOpts Source #
Instance details Defined in Discord.Rest.Channel Methods toJSON :: ModifyChannelOpts -> Value # toEncoding :: ModifyChannelOpts -> Encoding # toJSONList :: [ModifyChannelOpts] -> Value # toEncodingList :: [ModifyChannelOpts] -> Encoding #

data ChannelPermissionsOpts Source #

Constructors

ChannelPermissionsOpts
Fields channelPermissionsOptsAllow :: Integer channelPermissionsOptsDeny :: Integer channelPermissionsOptsType :: ChannelPermissionsOptsType

Instances

ToJSON ChannelPermissionsOpts Source #
Instance details Defined in Discord.Rest.Channel Methods toJSON :: ChannelPermissionsOpts -> Value # toEncoding :: ChannelPermissionsOpts -> Encoding # toJSONList :: [ChannelPermissionsOpts] -> Value # toEncodingList :: [ChannelPermissionsOpts] -> Encoding #

data GroupDMAddRecipientOpts Source #

https://discordapp.com/developers/docs/resources/channel#group-dm-add-recipient

Constructors

GroupDMAddRecipientOpts
Fields groupDMAddRecipientUserToAdd :: UserId groupDMAddRecipientUserToAddNickName :: Text groupDMAddRecipientGDMJoinAccessToken :: Text

data ChannelPermissionsOptsType Source #

Constructors

ChannelPermissionsOptsUser
ChannelPermissionsOptsRole

Instances

ToJSON ChannelPermissionsOptsType Source #
Instance details Defined in Discord.Rest.Channel Methods toJSON :: ChannelPermissionsOptsType -> Value # toEncoding :: ChannelPermissionsOptsType -> Encoding # toJSONList :: [ChannelPermissionsOptsType] -> Value # toEncodingList :: [ChannelPermissionsOptsType] -> Encoding #