telegrambot-lib.api.stickers — telegrambot-lib 2.13.0

Telegram Stickers - function implementations.

• https://core.telegram.org/bots/api#stickers

Most functions are multi-arity with the following options:

• Send all parameters in a 'content' map.
• Send only the required parameters as simple values.
• Send the required paraemters as simple values and then 'optional' parameters in a map.

add-sticker-to-set clj

(add-sticker-to-set this content)

(add-sticker-to-set this user_id name sticker)

Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

Required

• this ; a bot instance
• user_id ; id of sticker set owner
• name ; sticker set name
• sticker ; A JSON-serialized object(InputSticker) with info about the added sticker.

create-new-sticker-set clj

(create-new-sticker-set this content)

(create-new-sticker-set this user_id name title stickers)

(create-new-sticker-set this user_id name title stickers & optional)

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.

Required

• this ; a bot instance
• user_id ; id of created sticker set owner
• name ; short name of sticker set for use in URLs
• title ; sticker set title
• stickers ; A JSON-serialized list of 1-50 stickers to be added to the set.

Optional

• sticker_type ; Type of stickers, 'regular' (default), 'mask', 'custom_emoji'.
• needs_repainting ; True if stickers must be repainted to color of text in messages. (custom emoji sets only)

delete-sticker-from-set clj multimethod

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Required

• this ; a bot instance
• sticker ; file id of the sticker

delete-sticker-set clj multimethod

Use this method to delete a sticker set that was created by the bot. Returns True on success.

Required

• this ; a bot instance
• name ; Sticker set name.

get-custom-emoji-stickers clj multimethod

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Required

• this ; a bot instance
• custom_emoji_ids ; a list of emoji identifiers

get-sticker-set clj multimethod

Use this method to get a sticker set. On success, a StickerSet object is returned.

Required

• this ; a bot instance
• name ; name of the sticker set

replace-sticker-in-set clj

(replace-sticker-in-set this content)

(replace-sticker-in-set this user_id name old_sticker sticker)

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

Required

• this ; a bot instance
• user_id ; id of sticker set owner
• name ; sticker set name
• old_sticker ; File ID of the replaced sticker.
• sticker ; A JSON-serialized object(InputSticker) with info about the added sticker.

send-sticker clj

(send-sticker this content)

(send-sticker this chat_id sticker)

(send-sticker this chat_id sticker & optional)

Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.

Required

• this ; a bot instance
• chat_id ; target chat or username (@user)
• sticker ; sticker to send, file_id for existing on Telegram servers

Optional

• business_connection_id ; Unique id of the business connection.
• message_thread_id ; id of the target thread of the forum.
• emoji ; Emoji associated with the recently uploaded sticker.
• disable_notification ; true to send message silently
• protect_content ; protect content from forwarding/saving
• reply_parameters ; Description of the message to reply to
• reply_markup ; additional interface options

set-custom-emoji-sticker-set-thumbnail clj multimethod

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

Required

• this ; a bot instance
• name ; Sticker set name.

Optional

• custom_emoji_id ; Emoji ID of a sticker from the sticker set. Empty string to drop the thumbnail and use the first sticker as the thumbnail.

set-sticker-emoji-list clj

(set-sticker-emoji-list this content)

(set-sticker-emoji-list this sticker emoji_list)

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Required

• this ; a bot instance
• sticker ; File id of the sticker.
• emoji_list ; A JSON-serialized list of 1-20 emoji associated with the sticker.

set-sticker-keywords clj multimethod

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Required

• this ; a bot instance
• sticker ; File id of the sticker.

Optional

• keywords ; A JSON-serialized list of 0-20 search keywords for the sticker.

set-sticker-mask-position clj multimethod

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

Required

• this ; a bot instance
• sticker ; File id of the sticker.

Optional

• mask_position ; A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.

set-sticker-position-in-set clj

(set-sticker-position-in-set this content)

(set-sticker-position-in-set this sticker position)

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Required

• this ; a bot instance
• sticker ; file id of the sticker
• position ; new sticker position in the set

set-sticker-set-thumb clj deprecated

(set-sticker-set-thumb this content)

(set-sticker-set-thumb this name user_id)

(set-sticker-set-thumb this name user_id & optional)

DEPRECATED: Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

Required

• this ; a bot instance
• name ; sticker set name
• user_id ; id of the sticker set owner

Optional

• thumbnail ; A .WEBP or .PNG image with the thumbnail, or .TGS animation, or WEBM video. More information: https://core.telegram.org/bots/api#sending-files

set-sticker-set-thumbnail clj

(set-sticker-set-thumbnail this content)

(set-sticker-set-thumbnail this name user_id format)

(set-sticker-set-thumbnail this name user_id format & optional)

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

Required

• this ; a bot instance
• name ; sticker set name
• user_id ; id of the sticker set owner
• format ; Format of the thumbnail: static, animated, or video.

Optional

• thumbnail ; A .WEBP or .PNG image with the thumbnail, or .TGS animation, or WEBM video. More information: https://core.telegram.org/bots/api#sending-files

set-sticker-set-title clj

(set-sticker-set-title this content)

(set-sticker-set-title this name title)

Use this method to set the title of a created sticker set. Returns True on success.

Required

• this ; a bot instance
• name ; Sticker set name.
• title ; Sticker set title.

upload-sticker-file clj

(upload-sticker-file this content)

(upload-sticker-file this user_id sticker sticker_format)

Use this method to upload a .PNG file with a sticker for later use in create-new-sticker-set and add-sticker-to-set methods (can be used multiple times). Returns the uploaded File on success.

Required

• this ; a bot instance
• user_id ; id of sticker file owner
• sticker ; A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements.
• sticker_format ; Format of sticker, 'static', 'animated', or 'video'.