Safe Haskell	None
Language	Haskell2010

Discord.Internal.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
- CreateMessageDetailed :: ChannelId -> MessageDetailedOpts -> ChannelRequest Message
- CreateReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()
- DeleteOwnReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()
- DeleteUserReaction :: (ChannelId, MessageId) -> UserId -> Text -> ChannelRequest ()
- DeleteSingleReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()
- GetReactions :: (ChannelId, MessageId) -> Text -> (Int, ReactionTiming) -> ChannelRequest [User]
- DeleteAllReactions :: (ChannelId, MessageId) -> ChannelRequest ()
- EditMessage :: (ChannelId, MessageId) -> MessageDetailedOpts -> ChannelRequest Message
- DeleteMessage :: (ChannelId, MessageId) -> ChannelRequest ()
- BulkDeleteMessage :: (ChannelId, [MessageId]) -> ChannelRequest ()
- EditChannelPermissions :: ChannelId -> Either RoleId UserId -> ChannelPermissionsOpts -> ChannelRequest ()
- GetChannelInvites :: ChannelId -> ChannelRequest Object
- CreateChannelInvite :: ChannelId -> ChannelInviteOpts -> ChannelRequest Invite
- DeleteChannelPermission :: ChannelId -> Either RoleId UserId -> ChannelRequest ()
- TriggerTypingIndicator :: ChannelId -> ChannelRequest ()
- GetPinnedMessages :: ChannelId -> ChannelRequest [Message]
- AddPinnedMessage :: (ChannelId, MessageId) -> ChannelRequest ()
- DeletePinnedMessage :: (ChannelId, MessageId) -> ChannelRequest ()
- GroupDMAddRecipient :: ChannelId -> GroupDMAddRecipientOpts -> ChannelRequest ()
- GroupDMRemoveRecipient :: ChannelId -> UserId -> ChannelRequest ()
- StartThreadFromMessage :: ChannelId -> MessageId -> StartThreadOpts -> ChannelRequest Channel
- StartThreadNoMessage :: ChannelId -> StartThreadNoMessageOpts -> ChannelRequest Channel
- JoinThread :: ChannelId -> ChannelRequest ()
- AddThreadMember :: ChannelId -> UserId -> ChannelRequest ()
- LeaveThread :: ChannelId -> ChannelRequest ()
- RemoveThreadMember :: ChannelId -> UserId -> ChannelRequest ()
- GetThreadMember :: ChannelId -> UserId -> ChannelRequest ThreadMember
- ListThreadMembers :: ChannelId -> ChannelRequest [ThreadMember]
- ListPublicArchivedThreads :: ChannelId -> (Maybe UTCTime, Maybe Integer) -> ChannelRequest ListThreads
- ListPrivateArchivedThreads :: ChannelId -> (Maybe UTCTime, Maybe Integer) -> ChannelRequest ListThreads
- ListJoinedPrivateArchivedThreads :: ChannelId -> (Maybe UTCTime, Maybe Integer) -> ChannelRequest ListThreads
data MessageDetailedOpts = MessageDetailedOpts {
- messageDetailedContent :: Text
- messageDetailedTTS :: Bool
- messageDetailedEmbeds :: Maybe [CreateEmbed]
- messageDetailedFile :: Maybe (Text, ByteString)
- messageDetailedAllowedMentions :: Maybe AllowedMentions
- messageDetailedReference :: Maybe MessageReference
- messageDetailedComponents :: Maybe [ActionRow]
- messageDetailedStickerIds :: Maybe [StickerId]
}
data AllowedMentions = AllowedMentions {
- mentionEveryone :: Bool
- mentionUsers :: Bool
- mentionRoles :: Bool
- mentionUserIds :: [UserId]
- mentionRoleIds :: [RoleId]
- mentionRepliedUser :: Bool
}
data ReactionTiming
data MessageTiming
- = AroundMessage MessageId
- | BeforeMessage MessageId
- | AfterMessage MessageId
- | LatestMessages
data ChannelInviteOpts = ChannelInviteOpts {
}
data ModifyChannelOpts = ModifyChannelOpts {
}
data ChannelPermissionsOpts = ChannelPermissionsOpts {
- channelPermissionsOptsAllow :: Integer
- channelPermissionsOptsDeny :: Integer
}
data GroupDMAddRecipientOpts = GroupDMAddRecipientOpts {
}
data StartThreadOpts = StartThreadOpts {
- startThreadName :: Text
- startThreadAutoArchive :: Maybe Integer
- startThreadRateLimit :: Maybe Integer
}
data StartThreadNoMessageOpts = StartThreadNoMessageOpts {
}
data ListThreads = ListThreads {
- listThreadsThreads :: [Channel]
- listThreadsMembers :: [ThreadMember]
- listThreadsHasMore :: Bool
}

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.
CreateMessageDetailed :: ChannelId -> MessageDetailedOpts -> ChannelRequest Message	Sends a message with granular controls.
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
DeleteSingleReaction :: (ChannelId, MessageId) -> Text -> ChannelRequest ()	Deletes all reactions of a single emoji on a message
GetReactions :: (ChannelId, MessageId) -> Text -> (Int, ReactionTiming) -> ChannelRequest [User]	List of users that reacted with this emoji
DeleteAllReactions :: (ChannelId, MessageId) -> ChannelRequest ()	Delete all reactions on a message
EditMessage :: (ChannelId, MessageId) -> MessageDetailedOpts -> ChannelRequest Message	Edits a message content.
DeleteMessage :: (ChannelId, MessageId) -> ChannelRequest ()	Deletes a message.
BulkDeleteMessage :: (ChannelId, [MessageId]) -> ChannelRequest ()	Deletes a group of messages.
EditChannelPermissions :: ChannelId -> Either RoleId UserId -> 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 -> Either RoleId UserId -> 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
StartThreadFromMessage :: ChannelId -> MessageId -> StartThreadOpts -> ChannelRequest Channel	Start a thread from a message
StartThreadNoMessage :: ChannelId -> StartThreadNoMessageOpts -> ChannelRequest Channel	Start a thread without a message
JoinThread :: ChannelId -> ChannelRequest ()	Join a thread
AddThreadMember :: ChannelId -> UserId -> ChannelRequest ()	Add a thread member
LeaveThread :: ChannelId -> ChannelRequest ()	Leave a thread
RemoveThreadMember :: ChannelId -> UserId -> ChannelRequest ()	Remove a thread member
GetThreadMember :: ChannelId -> UserId -> ChannelRequest ThreadMember	Get a thread member
ListThreadMembers :: ChannelId -> ChannelRequest [ThreadMember]	List the thread members
ListPublicArchivedThreads :: ChannelId -> (Maybe UTCTime, Maybe Integer) -> ChannelRequest ListThreads	List public archived threads in the given channel. Optionally before a given time, and optional maximum number of threads. Returns the threads, thread members, and whether there are more to collect. Requires the READ_MESSAGE_HISTORY permission.
ListPrivateArchivedThreads :: ChannelId -> (Maybe UTCTime, Maybe Integer) -> ChannelRequest ListThreads	List private archived threads in the given channel. Optionally before a given time, and optional maximum number of threads. Returns the threads, thread members, and whether there are more to collect. Requires both the READ_MESSAGE_HISTORY and MANAGE_THREADS permissions.
ListJoinedPrivateArchivedThreads :: ChannelId -> (Maybe UTCTime, Maybe Integer) -> ChannelRequest ListThreads	List joined private archived threads in the given channel. Optionally before a given time, and optional maximum number of threads. Returns the threads, thread members, and whether there are more to collect. Requires both the READ_MESSAGE_HISTORY and MANAGE_THREADS permissions.

Instances

Instances details

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

data MessageDetailedOpts Source #

Options for CreateMessageDetailed requests.

Constructors

MessageDetailedOpts

Fields

messageDetailedContent :: Text
The message contents (up to 2000 characters)
messageDetailedTTS :: Bool
True if this is a TTS message
messageDetailedEmbeds :: Maybe [CreateEmbed]
embedded rich content (up to 6000 characters)
messageDetailedFile :: Maybe (Text, ByteString)
the contents of the file being sent
messageDetailedAllowedMentions :: Maybe AllowedMentions
allowed mentions for the message
messageDetailedReference :: Maybe MessageReference
If Just, reply to the message referenced
messageDetailedComponents :: Maybe [ActionRow]
Message components for the message
messageDetailedStickerIds :: Maybe [StickerId]
IDs of up to 3 Sticker in the server to send with the message

Instances

Instances details

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

data AllowedMentions Source #

Data constructor for a part of MessageDetailedOpts.

Constructors

AllowedMentions
Fields mentionEveryone :: Bool Can mention `@everyone` mentionUsers :: Bool Can mention any user mentionRoles :: Bool Can mention any mentionable role mentionUserIds :: [UserId] List of users able to be mentionned mentionRoleIds :: [RoleId] List of roles able to be mentioneed mentionRepliedUser :: Bool Can mention the sender of the replied message

Instances

Instances details

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

data ReactionTiming Source #

Data constructor for GetReactions requests

Constructors

BeforeReaction MessageId
AfterReaction MessageId
LatestReaction

Instances

Instances details

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

data MessageTiming Source #

Data constructor for GetChannelMessages requests.

See https://discord.com/developers/docs/resources/channel#get-channel-messages

Constructors

AroundMessage MessageId
BeforeMessage MessageId
AfterMessage MessageId
LatestMessages

Instances

Instances details

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

data ChannelInviteOpts Source #

Options for CreateChannelInvite requests

Constructors

ChannelInviteOpts

Fields

channelInviteOptsMaxAgeSeconds :: Maybe Integer
How long the invite is valid for (in seconds)
channelInviteOptsMaxUsages :: Maybe Integer
How many uses the invite is valid for
channelInviteOptsIsTemporary :: Maybe Bool
Whether this invite only grants temporary membership
channelInviteOptsDontReuseSimilarInvite :: Maybe Bool
Don't reuse a similar invite. Useful for creating many unique one time use invites

Instances

Instances details

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

data ModifyChannelOpts Source #

Options for ModifyChannel requests

Constructors

ModifyChannelOpts

Fields

modifyChannelName :: Maybe Text
(All) The name of the channel (max 100 characters)
modifyChannelPosition :: Maybe Integer
(All) Position of the channel in the listing
modifyChannelTopic :: Maybe Text
(Text) The channel topic text (max 1024 characters)
modifyChannelNSFW :: Maybe Bool
(Text) Wether the channel is tagged as NSFW
modifyChannelBitrate :: Maybe Integer
(Voice) Bitrate (in bps) of a voice channel. Min 8000, max 96000 (128000 for boosted servers)
modifyChannelUserRateLimit :: Maybe Integer
(Text) The rate limit of the channel, in seconds (0-21600), does not affect bots and users with manage_channel or manage_messages permissons
modifyChannelUserLimit :: Maybe Integer
(Voice) the user limit of the voice channel, max 99
modifyChannelPermissionOverwrites :: Maybe [Overwrite]
(All) The channel permissions
modifyChannelParentId :: Maybe ChannelId
(All) The parent category of the channel
modifyChannelDefaultAutoArchive :: Maybe Integer
(Text) Auto-archive duration for Threads
modifyChannelThreadArchived :: Maybe Bool
(Thread) Whether the thread is archived
modifyChannelThreadAutoArchive :: Maybe Integer
(Thread) duration in minutes to automatically archive the thread after recent activity, can be set to: 60, 1440, 4320 or 10080
modifyChannelThreadLocked :: Maybe Bool
(Thread) Whether the thread is locked. When a thread is locked, only users with manage_threads can unarchive it
modifyChannelThreadInvitable :: Maybe Bool
(Thread) Whether non-moderators can add other non-moderators to a thread. Only available on private threads

Instances

Instances details

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

data ChannelPermissionsOpts Source #

Options for The EditChannelPermissions request

Since the JSON encoding of this datatype will require information in the route (the Either decides whether the overwrite is for a user or a role), we do not provide a ToJSON instance. Instead, the JSON is manually constructed in the channelJsonRequest function.

Constructors

ChannelPermissionsOpts
Fields channelPermissionsOptsAllow :: Integer The permission integer for the explicitly allowed permissions channelPermissionsOptsDeny :: Integer The permission integer for the explicitly denied permissions

Instances

Instances details

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

data GroupDMAddRecipientOpts Source #

Options for GroupDMAddRecipient request

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

Constructors

GroupDMAddRecipientOpts
Fields groupDMAddRecipientUserToAdd :: UserId The id of the user to add to the Group DM groupDMAddRecipientUserToAddNickName :: Text The nickname given to the user being added groupDMAddRecipientGDMJoinAccessToken :: Text Access token of the user. That user must have granted your app the `gdm.join` scope.

Instances

Instances details

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

data StartThreadOpts Source #

Options for StartThreadFromMessage request

Constructors

StartThreadOpts
Fields startThreadName :: Text Name of the thread startThreadAutoArchive :: Maybe Integer Period of innactivity after which the thread gets archived in minutes. Can be one of 60, 1440, 4320, 10080 startThreadRateLimit :: Maybe Integer Amount of seconds a user has to wait before sending another message (0-21600)

Instances

Instances details

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

data StartThreadNoMessageOpts Source #

Options for StartThreadNoMessage request

Constructors

StartThreadNoMessageOpts

Fields

startThreadNoMessageBaseOpts :: StartThreadOpts
Base options for the thread
startThreadNoMessageType :: Integer
The type of thread to create
Can be 10, 11, or 12. See https://discord.com/developers/docs/resources/channel#channel-object-channel-types
startThreadNoMessageInvitable :: Maybe Bool
Whether non-moderators can add other non-moderators to a thread. Only available when creating a private thread.

Instances

Instances details

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

data ListThreads Source #

Result type of ListJoinedPrivateArchivedThreads, ListPrivateArchivedThreads and ListPublicArchivedThreads

Constructors

ListThreads
Fields listThreadsThreads :: [Channel] The returned threads listThreadsMembers :: [ThreadMember] A thread member object for each returned thread the current user has joined listThreadsHasMore :: Bool Whether there is more data to retrieve

Instances

Instances details

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