Safe Haskell	None
Language	Haskell2010

Discord.Internal.Rest.Emoji

Description

Provides actions for Channel API interactions

Synopsis

data EmojiRequest a where
- ListGuildEmojis :: GuildId -> EmojiRequest [Emoji]
- GetGuildEmoji :: GuildId -> EmojiId -> EmojiRequest Emoji
- CreateGuildEmoji :: GuildId -> Text -> Base64Image Emoji -> EmojiRequest Emoji
- ModifyGuildEmoji :: GuildId -> EmojiId -> ModifyGuildEmojiOpts -> EmojiRequest Emoji
- DeleteGuildEmoji :: GuildId -> EmojiId -> EmojiRequest ()
data ModifyGuildEmojiOpts = ModifyGuildEmojiOpts {
- modifyGuildEmojiName :: Text
- modifyGuildEmojiRoles :: [RoleId]
}
parseEmojiImage :: ByteString -> Either Text (Base64Image Emoji)
parseStickerImage :: ByteString -> Either Text (Base64Image Sticker)
data StickerRequest a where
- GetSticker :: StickerId -> StickerRequest Sticker
- ListNitroStickerPacks :: StickerRequest [StickerPack]
- ListGuildStickers :: GuildId -> StickerRequest [Sticker]
- GetGuildSticker :: GuildId -> StickerId -> StickerRequest Sticker
- CreateGuildSticker :: GuildId -> CreateGuildStickerOpts -> StickerRequest Sticker
- ModifyGuildSticker :: GuildId -> StickerId -> EditGuildStickerOpts -> StickerRequest Sticker
- DeleteGuildSticker :: GuildId -> StickerId -> StickerRequest ()
data CreateGuildStickerOpts = CreateGuildStickerOpts {
- guildStickerName :: Text
- guildStickerDescription :: Text
- guildStickerTags :: [Text]
- guildStickerFile :: Base64Image Sticker
}
data EditGuildStickerOpts = EditGuildStickerOpts {
- editGuildStickerName :: Maybe Text
- editGuildStickerDescription :: Maybe Text
- editGuildStickerTags :: Maybe [Text]
}

Documentation

data EmojiRequest a where Source #

Data constructor for requests. See API

Constructors

ListGuildEmojis :: GuildId -> EmojiRequest [Emoji]	List of emoji objects for the given guild. Requires MANAGE_EMOJIS permission.
GetGuildEmoji :: GuildId -> EmojiId -> EmojiRequest Emoji	Emoji object for the given guild and emoji ID
CreateGuildEmoji :: GuildId -> Text -> Base64Image Emoji -> EmojiRequest Emoji	Create a new guild emoji (static&animated). Requires MANAGE_EMOJIS permission.
ModifyGuildEmoji :: GuildId -> EmojiId -> ModifyGuildEmojiOpts -> EmojiRequest Emoji	Requires MANAGE_EMOJIS permission
DeleteGuildEmoji :: GuildId -> EmojiId -> EmojiRequest ()	Requires MANAGE_EMOJIS permission

Instances

Instances details

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

data ModifyGuildEmojiOpts Source #

Constructors

ModifyGuildEmojiOpts
Fields modifyGuildEmojiName :: Text modifyGuildEmojiRoles :: [RoleId]

Instances

Instances details

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

parseEmojiImage :: ByteString -> Either Text (Base64Image Emoji) Source #

parseEmojiImage bs will attempt to convert the given image bytestring bs to the base64 format expected by the Discord API. It may return Left with an error reason if either the bytestring is too large, or if the image format could not be predetermined from the opening few bytes. This function does not validate the rest of the image, nor check that its dimensions are 128x128 as required by Discord. This is up to the library user to check.

This function accepts all file types accepted by getMimeType.

parseStickerImage :: ByteString -> Either Text (Base64Image Sticker) Source #

parseStickerImage bs accepts PNG, APNG, or Lottie JSON bytestring bs and will attempt to convert it to the base64 format expected by the Discord API. It may return Left with an error reason if the image format is unexpected. This function does not validate the contents of the image, this is up to the library user to check.

data StickerRequest a where Source #

Data constructor for requests. See API

Be warned that these are untested due to not having a spare server with boosts. Functionality is at your own risk.

Constructors

GetSticker :: StickerId -> StickerRequest Sticker	Returns a sticker object for the given sticker ID.
ListNitroStickerPacks :: StickerRequest [StickerPack]	Returns the list of sticker packs available to Nitro subscribers.
ListGuildStickers :: GuildId -> StickerRequest [Sticker]	Returns an array of sticker objects for the given guild.
GetGuildSticker :: GuildId -> StickerId -> StickerRequest Sticker	Returns a sticker object for the given guild and sticker ID.
CreateGuildSticker :: GuildId -> CreateGuildStickerOpts -> StickerRequest Sticker	Create a new sticker for the guild.
ModifyGuildSticker :: GuildId -> StickerId -> EditGuildStickerOpts -> StickerRequest Sticker	Modify a sticker for a guild.
DeleteGuildSticker :: GuildId -> StickerId -> StickerRequest ()	Delete a guild sticker

Instances

Instances details

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

data CreateGuildStickerOpts Source #

Options for CreateGuildSticker

Constructors

CreateGuildStickerOpts
Fields guildStickerName :: Text guildStickerDescription :: Text guildStickerTags :: [Text] guildStickerFile :: Base64Image Sticker

Instances

Instances details

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

data EditGuildStickerOpts Source #

Options for ModifyGuildSticker

Constructors

EditGuildStickerOpts
Fields editGuildStickerName :: Maybe Text editGuildStickerDescription :: Maybe Text editGuildStickerTags :: Maybe [Text]

Instances

Instances details

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