Liking cljdoc? Tell your friends :D

telegrambot-lib.stickers.core

Telegram Stickers - function implementations.

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.
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.
raw docstring

add-sticker-to-setclj

(add-sticker-to-set this content)
(add-sticker-to-set this user_id name emojis)
(add-sticker-to-set this user_id name emojis & optional)

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.

Required

  • this ; a bot instance
  • user_id ; id of sticker set owner
  • name ; sticker set name
  • emojis ; one or more emoji corresponding to the sticker

Optional

  • png_sticker ; PNG image with the sticker
  • tgs_sticker ; TGS animation with the sticker
  • mask_position ; json object for where the mask should be placed on faces
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.

Required
- this ; a bot instance
- user_id ; id of sticker set owner
- name ; sticker set name
- emojis ; one or more emoji corresponding to the sticker

Optional
- png_sticker ; PNG image with the sticker
- tgs_sticker ; TGS animation with the sticker
- mask_position ; json object for where the mask should be placed on faces
sourceraw docstring

behaviorclj

Map for extending the core TBot record with functions.

Map for extending the core TBot record with functions.
sourceraw docstring

content-map?clj

(content-map? _ content & _)

Used throughout the multi-methods in order to check if content is a map or not.

Used throughout the multi-methods in order to check if content is a map or not.
sourceraw docstring

create-new-sticker-setclj

(create-new-sticker-set this content)
(create-new-sticker-set this user_id name title emojis)
(create-new-sticker-set this user_id name title emojis & 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. You must use exactly one of the fields png_sticker or tgs_sticker. 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
  • emojis ; one or more emoji corresponding to the sticker

Optional

  • png_sticker ; PNG image with the sticker
  • tgs_sticker ; TGS animation with the sticker
  • contains_masks ; true to create a set of mask stickers
  • mask_position ; json object for where the mask should be placed on faces
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.
You must use exactly one of the fields png_sticker or tgs_sticker.
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
- emojis ; one or more emoji corresponding to the sticker

Optional
- png_sticker ; PNG image with the sticker
- tgs_sticker ; TGS animation with the sticker
- contains_masks ; true to create a set of mask stickers
- mask_position ; json object for where the mask should be placed on faces
sourceraw docstring

delete-sticker-from-setcljmultimethod

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
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
sourceraw docstring

get-sticker-setcljmultimethod

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
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
sourceraw docstring

send-stickerclj

(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

  • disable_notification ; true to send message silently
  • reply_to_message_id ; id of original message if reply
  • allow_sending_without_reply ; true to send message even if replied-to message is not found
  • reply_markup ; additional interface options
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
- disable_notification ; true to send message silently
- reply_to_message_id ; id of original message if reply
- allow_sending_without_reply ; true to send message even if replied-to message is not found
- reply_markup ; additional interface options
sourceraw docstring

set-sticker-position-in-setclj

(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
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
sourceraw docstring

set-sticker-set-thumbclj

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

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.

Required

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

Optional

  • thumb ; PNG image with the thumbnail
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.

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

Optional
- thumb ; PNG image with the thumbnail
sourceraw docstring

upload-sticker-fileclj

(upload-sticker-file this content)
(upload-sticker-file this user_id png_sticker)

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

Required

  • this ; a bot instance
  • user_id ; id of sticker file owner
  • png_sticker ; PNG image with the sticker
Use this method to upload a .PNG file with a sticker for later use
in createNewStickerSet and addStickerToSet methods (can be used multiple times).
Returns the uploaded File on success.

Required
- this ; a bot instance
- user_id ; id of sticker file owner
- png_sticker ; PNG image with the sticker
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close