Safe Haskell | None |
---|---|
Language | Haskell2010 |
Telegram.Bot.API.Stickers
Synopsis
- data StickerType
- data StickerFile = StickerFile {}
- data SendStickerRequest = SendStickerRequest {
- sendStickerBusinessConnectionId :: Maybe BusinessConnectionId
- sendStickerChatId :: SomeChatId
- sendStickerMessageThreadId :: Maybe MessageThreadId
- sendStickerEmoji :: Maybe Text
- sendStickerSticker :: InputFile
- sendStickerDisableNotification :: Maybe Bool
- sendStickerProtectContent :: Maybe Bool
- sendStickerMessageEffectId :: Maybe Text
- sendStickerReplyToMessageId :: Maybe MessageId
- sendStickerReplyParameters :: Maybe ReplyParameters
- sendStickerReplyMarkup :: Maybe InlineKeyboardMarkup
- type SendStickerContent = "sendSticker" :> (MultipartForm Tmp SendStickerRequest :> Post '[JSON] (Response Message))
- type SendStickerLink = "sendSticker" :> (ReqBody '[JSON] SendStickerRequest :> Post '[JSON] (Response Message))
- sendSticker :: SendStickerRequest -> ClientM (Response Message)
- newtype GetCustomEmojiStickersRequest = GetCustomEmojiStickersRequest {}
- type GetCustomEmojiStickers = "getCustomEmojiStickers" :> (ReqBody '[JSON] GetCustomEmojiStickersRequest :> Post '[JSON] (Response [Sticker]))
- getCustomEmojiStickers :: GetCustomEmojiStickersRequest -> ClientM (Response [Sticker])
- data UploadStickerFileRequest = UploadStickerFileRequest {}
- type UploadStickerFileContent = "uploadStickerFile" :> (MultipartForm Tmp UploadStickerFileRequest :> Post '[JSON] (Response File))
- type UploadStickerFileLink = "uploadStickerFile" :> (ReqBody '[JSON] UploadStickerFileRequest :> Post '[JSON] (Response File))
- uploadStickerFile :: UploadStickerFileRequest -> ClientM (Response File)
- data CreateNewStickerSetRequest = CreateNewStickerSetRequest {}
- type CreateNewStickerSet = "createNewStickerSet" :> (ReqBody '[JSON] CreateNewStickerSetRequest :> Post '[JSON] (Response Bool))
- createNewStickerSet :: CreateNewStickerSetRequest -> ClientM (Response Bool)
- data AddStickerToSetRequest = AddStickerToSetRequest {}
- type AddStickerToSet = "addStickerToSet" :> (ReqBody '[JSON] AddStickerToSetRequest :> Post '[JSON] (Response Bool))
- addStickerToSet :: AddStickerToSetRequest -> ClientM (Response Bool)
- type GetStickerSet = "getStickerSet" :> (RequiredQueryParam "name" Text :> Get '[JSON] (Response StickerSet))
- getStickerSet :: Text -> ClientM (Response StickerSet)
- type SetStickerPositionInSet = "setStickerPositionInSet" :> (RequiredQueryParam "sticker" Text :> (RequiredQueryParam "position" Integer :> Post '[JSON] (Response Bool)))
- setStickerPositionInSet :: Text -> Integer -> ClientM (Response Bool)
- type DeleteStickerFromSet = "deleteStickerFromSet" :> (RequiredQueryParam "sticker" Text :> Post '[JSON] (Response Bool))
- deleteStickerFromSet :: Text -> ClientM (Response Bool)
- data SetStickerSetThumbnailRequest = SetStickerSetThumbnailRequest {}
- type SetStickerSetThumbnailContent = "setStickerSetThumbnail" :> (MultipartForm Tmp SetStickerSetThumbnailRequest :> Post '[JSON] (Response Bool))
- type SetStickerSetThumbnailLink = "setStickerSetThumbnail" :> (ReqBody '[JSON] SetStickerSetThumbnailRequest :> Post '[JSON] (Response Bool))
- setStickerSetThumbnail :: SetStickerSetThumbnailRequest -> ClientM (Response Bool)
- defSendSticker :: SomeChatId -> InputFile -> SendStickerRequest
- defGetCustomEmojiStickers :: [Text] -> GetCustomEmojiStickersRequest
- defUploadStickerFile :: UserId -> InputFile -> Text -> UploadStickerFileRequest
- defCreateNewStickerSet :: UserId -> Text -> Text -> [InputSticker] -> CreateNewStickerSetRequest
- defAddStickerToSet :: UserId -> Text -> InputSticker -> AddStickerToSetRequest
- defSetStickerSetThumbnail :: Text -> UserId -> InputFile -> Text -> SetStickerSetThumbnailRequest
Documentation
data StickerType Source #
Type of uploaded sticker file. Static or animated.
Constructors
PngSticker | PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. |
TgsSticker | TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements. |
WebmSticker | WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements. |
sendSticker
data SendStickerRequest Source #
Request parameters for sendSticker
.
Constructors
SendStickerRequest | |
Fields
|
Instances
type SendStickerContent = "sendSticker" :> (MultipartForm Tmp SendStickerRequest :> Post '[JSON] (Response Message)) Source #
type SendStickerLink = "sendSticker" :> (ReqBody '[JSON] SendStickerRequest :> Post '[JSON] (Response Message)) Source #
sendSticker :: SendStickerRequest -> ClientM (Response Message) Source #
Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
getCustomEmojiStickers
newtype GetCustomEmojiStickersRequest Source #
Request parameters for getCustomEmojiStickers
.
Constructors
GetCustomEmojiStickersRequest | |
Fields
|
Instances
ToJSON GetCustomEmojiStickersRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers | |||||
Generic GetCustomEmojiStickersRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Associated Types
| |||||
type Rep GetCustomEmojiStickersRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers type Rep GetCustomEmojiStickersRequest = D1 ('MetaData "GetCustomEmojiStickersRequest" "Telegram.Bot.API.Stickers" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'True) (C1 ('MetaCons "GetCustomEmojiStickersRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "getCustomEmojiStickersRequestCustomEmojiIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]))) |
type GetCustomEmojiStickers = "getCustomEmojiStickers" :> (ReqBody '[JSON] GetCustomEmojiStickersRequest :> Post '[JSON] (Response [Sticker])) Source #
uploadStickerFile
data UploadStickerFileRequest Source #
Request parameters for uploadStickerFile
.
Constructors
UploadStickerFileRequest | |
Fields
|
Instances
ToJSON UploadStickerFileRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Methods toJSON :: UploadStickerFileRequest -> Value # toEncoding :: UploadStickerFileRequest -> Encoding # toJSONList :: [UploadStickerFileRequest] -> Value # | |||||
Generic UploadStickerFileRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Associated Types
Methods from :: UploadStickerFileRequest -> Rep UploadStickerFileRequest x # to :: Rep UploadStickerFileRequest x -> UploadStickerFileRequest # | |||||
ToMultipart Tmp UploadStickerFileRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Methods toMultipart :: UploadStickerFileRequest -> MultipartData Tmp # | |||||
type Rep UploadStickerFileRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers type Rep UploadStickerFileRequest = D1 ('MetaData "UploadStickerFileRequest" "Telegram.Bot.API.Stickers" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "UploadStickerFileRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "uploadStickerFileUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: (S1 ('MetaSel ('Just "uploadStickerFileSticker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile) :*: S1 ('MetaSel ('Just "uploadStickerFileStickerFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) |
type UploadStickerFileContent = "uploadStickerFile" :> (MultipartForm Tmp UploadStickerFileRequest :> Post '[JSON] (Response File)) Source #
type UploadStickerFileLink = "uploadStickerFile" :> (ReqBody '[JSON] UploadStickerFileRequest :> Post '[JSON] (Response File)) Source #
uploadStickerFile :: UploadStickerFileRequest -> ClientM (Response File) Source #
Use this method to upload f file in .WEBP, .PNG, .TGS, or .WEBM format with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
createNewStickerSet
data CreateNewStickerSetRequest Source #
Request parameters for createNewStickerSet
.
Constructors
CreateNewStickerSetRequest | |
Fields
|
Instances
ToJSON CreateNewStickerSetRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Methods toJSON :: CreateNewStickerSetRequest -> Value # toEncoding :: CreateNewStickerSetRequest -> Encoding # toJSONList :: [CreateNewStickerSetRequest] -> Value # toEncodingList :: [CreateNewStickerSetRequest] -> Encoding # | |||||
Generic CreateNewStickerSetRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Associated Types
Methods from :: CreateNewStickerSetRequest -> Rep CreateNewStickerSetRequest x # to :: Rep CreateNewStickerSetRequest x -> CreateNewStickerSetRequest # | |||||
type Rep CreateNewStickerSetRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers type Rep CreateNewStickerSetRequest = D1 ('MetaData "CreateNewStickerSetRequest" "Telegram.Bot.API.Stickers" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "CreateNewStickerSetRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createNewStickerSetUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: (S1 ('MetaSel ('Just "createNewStickerSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "createNewStickerSetTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "createNewStickerSetStickers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [InputSticker]) :*: (S1 ('MetaSel ('Just "createNewStickerSetStickerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe StickerSetType)) :*: S1 ('MetaSel ('Just "createNewStickerSetNeedsRepainting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))) |
type CreateNewStickerSet = "createNewStickerSet" :> (ReqBody '[JSON] CreateNewStickerSetRequest :> Post '[JSON] (Response Bool)) Source #
createNewStickerSet :: CreateNewStickerSetRequest -> ClientM (Response Bool) Source #
Use this method to create a new sticker
set owned by a user. The bot will be able
to edit the sticker set thus created. Returns True
on success.
addStickerToSet
data AddStickerToSetRequest Source #
Request parameters for addStickerToSet
.
Constructors
AddStickerToSetRequest | |
Fields
|
Instances
ToJSON AddStickerToSetRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Methods toJSON :: AddStickerToSetRequest -> Value # toEncoding :: AddStickerToSetRequest -> Encoding # toJSONList :: [AddStickerToSetRequest] -> Value # toEncodingList :: [AddStickerToSetRequest] -> Encoding # omitField :: AddStickerToSetRequest -> Bool # | |||||
Generic AddStickerToSetRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Associated Types
Methods from :: AddStickerToSetRequest -> Rep AddStickerToSetRequest x # to :: Rep AddStickerToSetRequest x -> AddStickerToSetRequest # | |||||
type Rep AddStickerToSetRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers type Rep AddStickerToSetRequest = D1 ('MetaData "AddStickerToSetRequest" "Telegram.Bot.API.Stickers" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "AddStickerToSetRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "addStickerToSetUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: (S1 ('MetaSel ('Just "addStickerToSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "addStickerToSetStickers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputSticker)))) |
type AddStickerToSet = "addStickerToSet" :> (ReqBody '[JSON] AddStickerToSetRequest :> Post '[JSON] (Response Bool)) Source #
addStickerToSet :: AddStickerToSetRequest -> ClientM (Response Bool) Source #
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
getStickerSet
type GetStickerSet = "getStickerSet" :> (RequiredQueryParam "name" Text :> Get '[JSON] (Response StickerSet)) Source #
Arguments
:: Text | Name of the sticker set |
-> ClientM (Response StickerSet) |
Use this method to get a sticker set. On success, a StickerSet object is returned.
setStickerPositionInSet
type SetStickerPositionInSet = "setStickerPositionInSet" :> (RequiredQueryParam "sticker" Text :> (RequiredQueryParam "position" Integer :> Post '[JSON] (Response Bool))) Source #
setStickerPositionInSet Source #
Arguments
:: Text | File identifier of the sticker |
-> Integer | New sticker position in the set, zero-based |
-> ClientM (Response Bool) |
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
deleteStickerFromSet
type DeleteStickerFromSet = "deleteStickerFromSet" :> (RequiredQueryParam "sticker" Text :> Post '[JSON] (Response Bool)) Source #
Use this method to delete a sticker from a set created by the bot. Returns True on success.
setStickerSetThumbnail
data SetStickerSetThumbnailRequest Source #
Request parameters for setStickerSetThumbnail
.
Constructors
SetStickerSetThumbnailRequest | |
Fields
|
Instances
ToJSON SetStickerSetThumbnailRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers | |||||
Generic SetStickerSetThumbnailRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Associated Types
| |||||
ToMultipart Tmp SetStickerSetThumbnailRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers Methods toMultipart :: SetStickerSetThumbnailRequest -> MultipartData Tmp # | |||||
type Rep SetStickerSetThumbnailRequest Source # | |||||
Defined in Telegram.Bot.API.Stickers type Rep SetStickerSetThumbnailRequest = D1 ('MetaData "SetStickerSetThumbnailRequest" "Telegram.Bot.API.Stickers" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "SetStickerSetThumbnailRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "setStickerSetThumbnailName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "setStickerSetThumbnailUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId)) :*: (S1 ('MetaSel ('Just "setStickerSetThumbnailThumbnail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile) :*: S1 ('MetaSel ('Just "setStickerSetThumbnailFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) |
type SetStickerSetThumbnailContent = "setStickerSetThumbnail" :> (MultipartForm Tmp SetStickerSetThumbnailRequest :> Post '[JSON] (Response Bool)) Source #
type SetStickerSetThumbnailLink = "setStickerSetThumbnail" :> (ReqBody '[JSON] SetStickerSetThumbnailRequest :> Post '[JSON] (Response Bool)) Source #
setStickerSetThumbnail :: SetStickerSetThumbnailRequest -> ClientM (Response Bool) Source #
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
defUploadStickerFile :: UserId -> InputFile -> Text -> UploadStickerFileRequest Source #
defCreateNewStickerSet :: UserId -> Text -> Text -> [InputSticker] -> CreateNewStickerSetRequest Source #
defAddStickerToSet :: UserId -> Text -> InputSticker -> AddStickerToSetRequest Source #
defSetStickerSetThumbnail :: Text -> UserId -> InputFile -> Text -> SetStickerSetThumbnailRequest Source #