The cl-telegram-bot Reference Manual

3.1.1 cl-telegram-bot/cl-telegram-bot.asd

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot (system).

ASDF Systems

• cl-telegram-bot.
• cl-telegram-bot/core.
• cl-telegram-bot/update.
• cl-telegram-bot/message.
• cl-telegram-bot/chat.
• cl-telegram-bot/network.
• cl-telegram-bot/utils.
• cl-telegram-bot/bot.
• cl-telegram-bot/telegram-call.
• cl-telegram-bot/entities/core.
• cl-telegram-bot/pipeline.
• cl-telegram-bot/entities/command.

---

3.1.2 cl-telegram-bot/core/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/core (system).

Packages

cl-telegram-bot/core.

Public Interface

• start-processing (function).
• stop-processing (function).

Internals

*threads* (special variable).

---

3.1.3 cl-telegram-bot/update/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/update (system).

Packages

cl-telegram-bot/update.

Public Interface

• get-raw-data (reader method).
• get-update-id (reader method).
• make-update (function).
• process (method).
• process-updates (generic function).

Internals

• get-payload (reader method).
• get-updates (function).
• update (class).

---

3.1.4 cl-telegram-bot/message/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/message (system).

Packages

cl-telegram-bot/message.

Public Interface

• animation (class).
• animation-message (class).
• audio (class).
• audio-message (class).
• delete-message (function).
• document (class).
• document-message (class).
• file (class).
• file-message (class).
• forward-message (function).
• get-caption (reader method).
• get-chat (reader method).
• get-current-chat (function).
• get-duration (reader method).
• get-emoji (reader method).
• get-entities (reader method).
• get-file (reader method).
• get-file-id (reader method).
• get-file-name (reader method).
• get-file-size (reader method).
• get-file-unique-id (reader method).
• get-forward-from (reader method).
• get-forward-from-chat (reader method).
• get-forward-sender-name (reader method).
• get-height (reader method).
• get-is-video (reader method).
• get-length (reader method).
• get-mime-type (reader method).
• get-performer (reader method).
• get-photo-options (reader method).
• get-raw-data (reader method).
• get-reply-to-message (reader method).
• get-set-name (reader method).
• get-text (reader method).
• get-text (reader method).
• get-title (reader method).
• get-width (reader method).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• make-message (function).
• message (class).
• on-message (generic function).
• photo (class).
• photo-message (class).
• print-object (method).
• process (method).
• reply (function).
• reply (class).
• send-animation (method).
• send-animation (method).
• send-audio (method).
• send-audio (method).
• send-document (method).
• send-document (method).
• send-message (function).
• send-photo (method).
• send-photo (method).
• send-sticker (method).
• send-sticker (method).
• send-video (method).
• send-video (method).
• send-video-note (method).
• send-video-note (method).
• send-voice (method).
• send-voice (method).
• sticker (class).
• sticker-message (class).
• video (class).
• video-message (class).
• video-note (class).
• video-note-message (class).
• voice (class).
• voice-message (class).

Internals

• *current-bot* (special variable).
• *current-message* (special variable).
• get-is-animated (reader method).
• get-message-id (reader method).
• get-rest-args (reader method).
• reply-immediately (condition).
• set-file (method).
• set-file (method).
• spatial (class).
• temporal (class).
• unispatial (class).

---

3.1.5 cl-telegram-bot/chat/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/chat (system).

Packages

cl-telegram-bot/chat.

Public Interface

• channel (class).
• chat (class).
• delete-chat-photo (function).
• export-chat-invite-link (function).
• get-chat-administrators (function).
• get-chat-by-id (function).
• get-chat-id (reader method).
• get-chat-member (function).
• get-chat-members-count (function).
• get-first-name (reader method).
• get-last-name (reader method).
• get-raw-data (reader method).
• get-username (reader method).
• group (class).
• initialize-instance (method).
• initialize-instance (method).
• kick-chat-member (function).
• leave-chat (function).
• pin-chat-message (function).
• print-object (method).
• private-chat (class).
• promote-chat-member (function).
• restrict-chat-member (function).
• send-chat-action (function).
• set-chat-description (function).
• set-chat-photo (function).
• set-chat-title (function).
• unban-chat-member (function).
• unpin-chat-message (function).

Internals

• base-group (class).
• get-bio (reader method).
• get-can-set-sticker-set (reader method).
• get-description (reader method).
• get-has-private-forwards (reader method).
• get-has-protected-content (reader method).
• get-invite-link (reader method).
• get-join-by-request (reader method).
• get-join-to-send-messages (reader method).
• get-linked-chat-id (reader method).
• get-message-auto-delete-time (reader method).
• get-pinned-message (reader method).
• get-slow-mode-delay (reader method).
• get-sticker-set-name (reader method).
• get-title (reader method).
• make-chat (function).
• prepare-arg (method).
• super-group (class).

---

3.1.6 cl-telegram-bot/network/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/network (system).

Packages

cl-telegram-bot/network.

Public Interface

• make-request (function).
• request-error (condition).

Internals

what (reader method).

---

3.1.7 cl-telegram-bot/utils/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/utils (system).

Packages

cl-telegram-bot/utils.

Public Interface

• make-keyword (function).
• obfuscate (function).

Internals

make-json-keyword (function).

---

3.1.8 cl-telegram-bot/bot/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/bot (system).

Packages

cl-telegram-bot/bot.

Public Interface

• bot (class).
• defbot (macro).
• get-last-update-id (reader method).
• (setf get-last-update-id) (writer method).
• initialize-instance (method).
• print-object (method).

Internals

• api-uri (reader method).
• (setf api-uri) (writer method).
• file-endpoint (reader method).
• (setf file-endpoint) (writer method).
• get-endpoint (reader method).
• token (reader method).
• (setf token) (writer method).

---

3.1.9 cl-telegram-bot/telegram-call/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/telegram-call (system).

Packages

cl-telegram-bot/telegram-call.

Internals

• def-telegram-call (macro).
• get-docstring (function).
• get-func-name (function).
• get-method-name (function).
• prepare-arg (generic function).
• without-docstring (function).

---

3.1.10 cl-telegram-bot/entities/core/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/entities/core (system).

Packages

cl-telegram-bot/entities/core.

Public Interface

• make-entity (function).
• make-entity-internal (generic function).

Internals

• entity (class).
• get-raw-data (reader method).
• unsupported-entity (class).

---

3.1.11 cl-telegram-bot/pipeline/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/pipeline (system).

Packages

cl-telegram-bot/pipeline.

Public Interface

process (generic function).

---

3.1.12 cl-telegram-bot/entities/command/file-type.lisp

Source

cl-telegram-bot.asd.

Parent Component

cl-telegram-bot/entities/command (system).

Packages

cl-telegram-bot/entities/command.

Public Interface

• bot-command (class).
• get-command (reader method).
• get-rest-text (reader method).
• make-entity-internal (method).
• on-command (generic function).
• process (method).

---

5.1.1 Macros

Macro: defbot (name) ¶

Package

cl-telegram-bot/bot.

Source

file-type.lisp.

---

5.1.2 Ordinary functions

Function: delete-chat-photo (bot-var1 chat) ¶

https://core.telegram.org/bots/api#deletechatphoto

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: delete-message (bot chat message) ¶

https://core.telegram.org/bots/api#deletemessage

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Function: export-chat-invite-link (bot-var1 chat) ¶

https://core.telegram.org/bots/api#exportchatinvitelink

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: forward-message (bot chat from-chat message &key disable-notification) ¶

https://core.telegram.org/bots/api#forwardmessage

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Function: get-chat-administrators (bot-var1 chat) ¶

https://core.telegram.org/bots/api#getchatadministrators

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: get-chat-by-id (bot-var1 chat-id) ¶

https://core.telegram.org/bots/api#getchat

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: get-chat-member (bot-var1 chat user-id) ¶

https://core.telegram.org/bots/api#getchatmember

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: get-chat-members-count (bot-var1 chat) ¶

https://core.telegram.org/bots/api#getchatmemberscount

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: get-current-chat () ¶

Returns a chat where currently processing message was received.

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Function: kick-chat-member (bot-var1 chat user-id until-date) ¶

https://core.telegram.org/bots/api#kickchatmember

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: leave-chat (bot-var1 chat) ¶

https://core.telegram.org/bots/api#leavechat

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: make-entity (payload data) ¶

Package

cl-telegram-bot/entities/core.

Source

file-type.lisp.

Function: make-keyword (text) ¶

Package

cl-telegram-bot/utils.

Source

file-type.lisp.

Function: make-message (data) ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Function: make-request (bot name &rest options &key streamp timeout &allow-other-keys) ¶

Perform HTTP request to ’name API method with ’options JSON-encoded object.

Package

cl-telegram-bot/network.

Source

file-type.lisp.

Function: make-update (data) ¶

Package

cl-telegram-bot/update.

Source

file-type.lisp.

Function: obfuscate (url) ¶

Package

cl-telegram-bot/utils.

Source

file-type.lisp.

Function: pin-chat-message (bot-var1 chat message-id disable-notification) ¶

https://core.telegram.org/bots/api#pinchatmessage

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: promote-chat-member (bot-var1 chat user-id can-change-info can-post-messages can-edit-messages can-delete-messages can-invite-users can-restrict-members can-pin-messages can-promote-members) ¶

https://core.telegram.org/bots/api#promotechatmember

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: reply (text &rest args &key parse-mode disable-web-page-preview disable-notification reply-to-message-id reply-markup) ¶

Works like a send-message, but only when an incoming message is processed. Automatically sends reply to a chat from where current message came from.

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Function: restrict-chat-member (bot-var1 chat user-id until-date can-send-messages can-send-media-messages can-send-other-messages can-add-web-page-previews) ¶

https://core.telegram.org/bots/api#restrictchatmember

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: send-chat-action (bot-var1 chat action) ¶

https://core.telegram.org/bots/api#sendchataction

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: send-message (bot chat text &rest options &key parse-mode disable-web-page-preview disable-notification reply-to-message-id reply-markup) ¶

https://core.telegram.org/bots/api#sendmessage

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Function: set-chat-description (bot-var1 chat description) ¶

https://core.telegram.org/bots/api#setchatdescription

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: set-chat-photo (bot-var1 chat photo) ¶

https://core.telegram.org/bots/api#setchatphoto

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: set-chat-title (bot-var1 chat title) ¶

https://core.telegram.org/bots/api#setchattitle

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: start-processing (bot &key debug delay-between-retries) ¶

Package

cl-telegram-bot/core.

Source

file-type.lisp.

Function: stop-processing (bot) ¶

Package

cl-telegram-bot/core.

Source

file-type.lisp.

Function: unban-chat-member (bot-var1 chat user-id) ¶

https://core.telegram.org/bots/api#unbanchatmember

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Function: unpin-chat-message (bot-var1 chat) ¶

https://core.telegram.org/bots/api#unpinchatmessage

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

---

5.1.3 Generic functions

Generic Reader: get-caption (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-caption ((message message)) ¶

Caption for the animation, audio, document, photo, video or voice.

Source

file-type.lisp.

Target Slot

caption.

Generic Reader: get-chat (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-chat ((message message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

chat.

Generic Reader: get-chat-id (object) ¶

Package

cl-telegram-bot/chat.

Methods

Reader Method: get-chat-id ((chat chat)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

id.

Generic Reader: get-command (object) ¶

Package

cl-telegram-bot/entities/command.

Methods

Reader Method: get-command ((bot-command bot-command)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

command.

Generic Reader: get-duration (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-duration ((temporal temporal)) ¶

Duration of the file in seconds as defined by sender.

Source

file-type.lisp.

Target Slot

duration.

Generic Reader: get-emoji (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-emoji ((sticker sticker)) ¶

Emoji associated with the sticker

Source

file-type.lisp.

Target Slot

emoji.

Generic Reader: get-entities (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-entities ((message message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

entities.

Generic Reader: get-file (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-file ((file-message file-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

file.

Generic Reader: get-file-id (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-file-id ((file file)) ¶

Identifier for this file, which can be used to download or reuse the file.

Source

file-type.lisp.

Target Slot

file-id.

Generic Reader: get-file-name (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-file-name ((file file)) ¶

Original filename as defined by sender.

Source

file-type.lisp.

Target Slot

file-name.

Generic Reader: get-file-size (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-file-size ((file file)) ¶

File size in bytes.

Source

file-type.lisp.

Target Slot

file-size.

Generic Reader: get-file-unique-id (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-file-unique-id ((file file)) ¶

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

Source

file-type.lisp.

Target Slot

file-unique-id.

Generic Reader: get-first-name (object) ¶

Package

cl-telegram-bot/chat.

Methods

Reader Method: get-first-name ((private-chat private-chat)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

first-name.

Generic Reader: get-forward-from (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-forward-from ((message message)) ¶

For forwarded messages, sender of the original message.

Source

file-type.lisp.

Target Slot

forward-from.

Generic Reader: get-forward-from-chat (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-forward-from-chat ((message message)) ¶

For messages forwarded from channels or from anonymous administrators, information about the original sender chat.

Source

file-type.lisp.

Target Slot

forward-from-chat.

Generic Reader: get-forward-sender-name (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-forward-sender-name ((message message)) ¶

For forwarded messages, sender of the original message.

Source

file-type.lisp.

Target Slot

forward-sender-name.

Generic Reader: get-height (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-height ((spatial spatial)) ¶

File height as defined by sender.

Source

file-type.lisp.

Target Slot

height.

Generic Reader: get-is-video (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-is-video ((sticker sticker)) ¶

True if the sticker is a video sticker.

Source

file-type.lisp.

Target Slot

is-video.

Generic Reader: get-last-name (object) ¶

Package

cl-telegram-bot/chat.

Methods

Reader Method: get-last-name ((private-chat private-chat)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

last-name.

Generic Reader: get-last-update-id (object) ¶

Generic Writer: (setf get-last-update-id) (object) ¶

Package

cl-telegram-bot/bot.

Methods

Reader Method: get-last-update-id ((bot bot)) ¶

Writer Method: (setf get-last-update-id) ((bot bot)) ¶

Update id

Source

file-type.lisp.

Target Slot

id.

Generic Reader: get-length (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-length ((unispatial unispatial)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

length.

Generic Reader: get-mime-type (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-mime-type ((file file)) ¶

MIME type of the file as defined by sender.

Source

file-type.lisp.

Target Slot

mime-type.

Generic Reader: get-performer (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-performer ((audio audio)) ¶

Performer of the audio as defined by sender or by audio tags.

Source

file-type.lisp.

Target Slot

performer.

Generic Reader: get-photo-options (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-photo-options ((photo-message photo-message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

photo-options.

Generic Reader: get-raw-data (object) ¶

Package

cl-telegram-bot/chat.

Methods

Reader Method: get-raw-data ((chat chat)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

raw-data.

Generic Reader: get-raw-data (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-raw-data ((message message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

raw-data.

Generic Reader: get-raw-data (object) ¶

Package

cl-telegram-bot/update.

Methods

Reader Method: get-raw-data ((update update)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

raw-data.

Generic Reader: get-reply-to-message (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-reply-to-message ((reply reply)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

reply-to-message.

Generic Reader: get-rest-text (object) ¶

Package

cl-telegram-bot/entities/command.

Methods

Reader Method: get-rest-text ((bot-command bot-command)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

rest-text.

Generic Reader: get-set-name (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-set-name ((sticker sticker)) ¶

Name of the sticker set to which the sticker belongs.

Source

file-type.lisp.

Target Slot

set-name.

Generic Reader: get-text (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-text ((condition reply-immediately)) ¶

Source

file-type.lisp.

Target Slot

text.

Reader Method: get-text ((message message)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

text.

Generic Reader: get-title (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-title ((audio audio)) ¶

Title of the audio as defined by sender or by audio tags.

Source

file-type.lisp.

Target Slot

title.

Generic Reader: get-update-id (object) ¶

Package

cl-telegram-bot/update.

Methods

Reader Method: get-update-id ((update update)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

id.

Generic Reader: get-username (object) ¶

Package

cl-telegram-bot/chat.

Methods

Reader Method: get-username ((chat chat)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

username.

Generic Reader: get-width (object) ¶

Package

cl-telegram-bot/message.

Methods

Reader Method: get-width ((spatial spatial)) ¶

File width as defined by sender.

Source

file-type.lisp.

Target Slot

width.

Generic Function: make-entity-internal (entity-type payload data) ¶

Extendable protocol to support entities of different kinds.
First argument is a keyword, denoting a type of the entity. Payload is an object of type ‘message’.
And data is a plist with data, describing the entity.

Package

cl-telegram-bot/entities/core.

Source

file-type.lisp.

Methods

Method: make-entity-internal ((entity-type (eql :bot-command)) (payload message) data) ¶

Source

file-type.lisp.

Method: make-entity-internal (entity-type payload data) ¶

Generic Function: on-command (bot command rest-text) ¶

This method will be called for each command.
First argument is a keyword. If user input was /save_note, then first argument will be :save-note.

By default, logs call and does nothing.

Package

cl-telegram-bot/entities/command.

Source

file-type.lisp.

Methods

Method: on-command (bot command rest-text) ¶

Generic Function: on-message (bot text) ¶

This method gets called with raw text from the message. By default it does nothing.

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Methods

Method: on-message (bot text) ¶

Generic Function: process (bot object) ¶

This method is called by when processing a single update.
It is called multiple times on different parts of an update. Whole pipeline looks like that:

For each update we call: process(update) process(update.payload)
For each entity in payload: process(entity)

Package

cl-telegram-bot/pipeline.

Source

file-type.lisp.

Methods

Method: process (bot (command bot-command)) ¶

Source

file-type.lisp.

Method: process (bot (update update)) ¶

By default, just calls ‘process’ on the payload.

Source

file-type.lisp.

Method: process (bot (message message)) ¶

By default, just calls ‘process’ on each entity. And after that calls (on-message bot text).

This method binds its arguments to *current-bot* and *current-message*
to make it easier to use (reply "text") in 99% usecases.

If (reply "text") is called during processing of some entity or inside the on-message, then whole processing pipeline will be stopped and next update will be processed.

Source

file-type.lisp.

Method: process (bot object) ¶

By default, processing does nothing

Generic Function: process-updates (bot) ¶

By default, this method starts an infinite loop and fetching new updates using long polling.

Package

cl-telegram-bot/update.

Source

file-type.lisp.

Methods

Method: process-updates (bot) ¶

Starts inifinite loop to process updates using long polling.

Generic Function: send-animation (bot chat animation &rest options &key caption parse-mode caption-entities duration width height thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-animation (bot chat (animation animation) &rest options &key caption parse-mode caption-entities duration width height thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for animation sending based on animation object.

https://core.telegram.org/bots/api#sendanimation

Source

file-type.lisp.

Method: send-animation (bot chat (animation string) &rest options &key caption parse-mode caption-entities duration width height thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for animation sending based on ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#sendanimation

Source

file-type.lisp.

Generic Function: send-audio (bot chat audio &rest options &key caption parse-mode caption-entities duration performer title thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-audio (bot chat (audio audio) &rest options &key caption parse-mode caption-entities duration performer title thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for audio sending based on audio object.

https://core.telegram.org/bots/api#sendaudio

Source

file-type.lisp.

Method: send-audio (bot chat (audio string) &rest options &key caption parse-mode caption-entities duration performer title thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for audio sending based on its ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#sendaudio

Source

file-type.lisp.

Generic Function: send-document (bot chat document &rest options &key caption parse-mode caption-entities disable-content-type-detection thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-document (bot chat (document document) &rest options &key caption parse-mode caption-entities disable-content-type-detection thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for document sending based on document object.

https://core.telegram.org/bots/api#senddocument

Source

file-type.lisp.

Method: send-document (bot chat (document string) &rest options &key caption parse-mode caption-entities disable-content-type-detection thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for document sending based on ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#senddocument

Source

file-type.lisp.

Generic Function: send-photo (bot chat photo &rest options &key caption parse-mode caption-entities disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-photo (bot chat (photo photo) &rest options &key caption parse-mode caption-entities disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for photo sending based on photo object.

https://core.telegram.org/bots/api#sendphoto

Source

file-type.lisp.

Method: send-photo (bot chat (photo string) &rest options &key caption parse-mode caption-entities disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for photo sending based on photo ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#sendphoto

Source

file-type.lisp.

Generic Function: send-sticker (bot chat sticker &rest options &key disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-sticker (bot chat (sticker sticker) &rest options &key disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for sticker sending based on sticker object.

https://core.telegram.org/bots/api#sendsticker

Source

file-type.lisp.

Method: send-sticker (bot chat (sticker string) &rest options &key disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for sticker sending based on ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#sendsticker

Source

file-type.lisp.

Generic Function: send-video (bot chat video &rest options &key caption parse-mode caption-entities duration width height thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-video (bot chat (video video) &rest options &key caption parse-mode caption-entities duration width height thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for video sending based on video object.

https://core.telegram.org/bots/api#sendvideo

Source

file-type.lisp.

Method: send-video (bot chat (video string) &rest options &key caption parse-mode caption-entities duration width height thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for video sending based on ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#sendvideo

Source

file-type.lisp.

Generic Function: send-video-note (bot chat video-note &rest options &key caption parse-mode caption-entities duration length thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-video-note (bot chat (video-note video-note) &rest options &key caption parse-mode caption-entities duration length thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for video note sending based on video-note object.

https://core.telegram.org/bots/api#sendvideonote

Source

file-type.lisp.

Method: send-video-note (bot chat (video-note string) &rest options &key caption parse-mode caption-entities duration length thumb disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for video note sending based on ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#sendvideonote

Source

file-type.lisp.

Generic Function: send-voice (bot chat voice &rest options &key caption parse-mode caption-entities duration disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

Package

cl-telegram-bot/message.

Methods

Method: send-voice (bot chat (voice voice) &rest options &key caption parse-mode caption-entities duration disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for voice sending based on voice object.

https://core.telegram.org/bots/api#sendvoice

Source

file-type.lisp.

Method: send-voice (bot chat (voice string) &rest options &key caption parse-mode caption-entities duration disable-notification protect-content reply-to-message-id allow-sending-without-reply reply-markup) ¶

A method for voice message sending based on its ID.

The file-based method does not work yet.

https://core.telegram.org/bots/api#sendvoice

Source

file-type.lisp.

---

5.1.4 Standalone methods

Method: initialize-instance :after ((chat chat) &key data &allow-other-keys) ¶

Source

file-type.lisp.

Method: initialize-instance :after ((chat base-group) &key data &allow-other-keys) ¶

Source

file-type.lisp.

Method: initialize-instance :after ((message message) &key data &allow-other-keys) ¶

Source

file-type.lisp.

Method: initialize-instance :after ((message file-message) &key data file-attribute-name file-class &allow-other-keys) ¶

Source

file-type.lisp.

Method: initialize-instance :after ((reply reply) &key data &allow-other-keys) ¶

Source

file-type.lisp.

Method: initialize-instance :after ((file file) &key data &allow-other-keys) ¶

Source

file-type.lisp.

Method: initialize-instance :after ((bot bot) &key &allow-other-keys) ¶

Source

file-type.lisp.

Method: print-object ((chat private-chat) stream) ¶

Source

file-type.lisp.

Method: print-object ((message message) stream) ¶

Source

file-type.lisp.

Method: print-object ((bot bot) stream) ¶

Source

file-type.lisp.

---

5.1.5 Conditions

Condition: request-error ¶

Package

cl-telegram-bot/network.

Source

file-type.lisp.

Direct superclasses

error.

Direct methods

what.

Direct slots

Slot: what ¶

Initargs

:what

Readers

what.

Writers

This slot is read-only.

---

5.1.6 Classes

Class: animation ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

• file.
• spatial.
• temporal.

Direct methods

send-animation.

Class: animation-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

Class: audio ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

• file.
• temporal.

Direct methods

• get-performer.
• get-title.
• send-audio.

Direct slots

Slot: performer ¶

Performer of the audio as defined by sender or by audio tags.

Type

(or null string)

Initargs

:performer

Readers

get-performer.

Writers

This slot is read-only.

Slot: title ¶

Title of the audio as defined by sender or by audio tags.

Type

(or null string)

Initargs

:title

Readers

get-title.

Writers

This slot is read-only.

Class: audio-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

Class: bot ¶

Package

cl-telegram-bot/bot.

Source

file-type.lisp.

Direct methods

• (setf api-uri).
• api-uri.
• (setf file-endpoint).
• file-endpoint.
• get-endpoint.
• (setf get-last-update-id).
• get-last-update-id.
• initialize-instance.
• print-object.
• (setf token).
• token.

Direct slots

Slot: id ¶

Update id

Initform

0

Readers

get-last-update-id.

Writers

(setf get-last-update-id).

Slot: token ¶

Bot token given by BotFather

Initargs

:token

Readers

token.

Writers

(setf token).

Slot: api-uri ¶

Initform

"https://api.telegram.org/"

Initargs

:api-uri

Readers

api-uri.

Writers

(setf api-uri).

Slot: endpoint ¶

HTTPS endpoint

Initargs

:endpoint

Readers

get-endpoint.

Writers

This slot is read-only.

Slot: file-endpoint ¶

HTTPS file-endpoint

Initargs

:file-endpoint

Readers

file-endpoint.

Writers

(setf file-endpoint).

Class: bot-command ¶

Package

cl-telegram-bot/entities/command.

Source

file-type.lisp.

Direct superclasses

entity.

Direct methods

• get-command.
• get-rest-text.
• process.

Direct slots

Slot: command ¶

Type

:keyword

Initargs

:command

Readers

get-command.

Writers

This slot is read-only.

Slot: rest-text ¶

Type

string

Initargs

:rest-text

Readers

get-rest-text.

Writers

This slot is read-only.

Class: channel ¶

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Direct superclasses

base-group.

Class: chat ¶

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Direct subclasses

• base-group.
• private-chat.

Direct methods

• get-chat-id.
• get-has-protected-content.
• get-message-auto-delete-time.
• get-raw-data.
• get-username.
• initialize-instance.

Direct slots

Slot: id ¶

Initargs

:id

Readers

get-chat-id.

Writers

This slot is read-only.

Slot: username ¶

Initargs

:username

Readers

get-username.

Writers

This slot is read-only.

Slot: has-protected-content ¶

Initargs

:has-protected-content

Readers

get-has-protected-content.

Writers

This slot is read-only.

Slot: message-auto-delete-time ¶

Initargs

:message-auto-delete-time

Readers

get-message-auto-delete-time.

Writers

This slot is read-only.

Slot: raw-data ¶

Initargs

:raw-data

Readers

get-raw-data.

Writers

This slot is read-only.

Class: document ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file.

Direct methods

send-document.

Class: document-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

Class: file ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct subclasses

• animation.
• audio.
• document.
• photo.
• sticker.
• video.
• video-note.
• voice.

Direct methods

• get-file-id.
• get-file-name.
• get-file-size.
• get-file-unique-id.
• get-mime-type.
• initialize-instance.

Direct slots

Slot: file-id ¶

Identifier for this file, which can be used to download or reuse the file.

Type

(or null string)

Initargs

:file-id

Readers

get-file-id.

Writers

This slot is read-only.

Slot: file-unique-id ¶

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

Type

(or null string)

Initargs

:file-unique-id

Readers

get-file-unique-id.

Writers

This slot is read-only.

Slot: file-name ¶

Original filename as defined by sender.

Type

(or null string)

Initargs

:file-name

Readers

get-file-name.

Writers

This slot is read-only.

Slot: file-size ¶

File size in bytes.

Type

(or null integer)

Initargs

:file-size

Readers

get-file-size.

Writers

This slot is read-only.

Slot: mime-type ¶

MIME type of the file as defined by sender.

Type

(or null string)

Initargs

:mime-type

Readers

get-mime-type.

Writers

This slot is read-only.

Class: file-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

message.

Direct subclasses

• animation-message.
• audio-message.
• document-message.
• photo-message.
• sticker-message.
• video-message.
• video-note-message.
• voice-message.

Direct methods

• get-file.
• initialize-instance.
• set-file.

Direct slots

Slot: file ¶

Initargs

:file

Readers

get-file.

Writers

This slot is read-only.

Class: group ¶

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Direct superclasses

base-group.

Class: message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct subclasses

• file-message.
• reply.

Direct methods

• get-caption.
• get-chat.
• get-entities.
• get-forward-from.
• get-forward-from-chat.
• get-forward-sender-name.
• get-message-id.
• get-raw-data.
• get-text.
• initialize-instance.
• make-entity-internal.
• print-object.
• process.

Direct slots

Slot: id ¶

Initargs

:id

Readers

get-message-id.

Writers

This slot is read-only.

Slot: text ¶

Type

(or null string)

Initargs

:text

Readers

get-text.

Writers

This slot is read-only.

Slot: caption ¶

Caption for the animation, audio, document, photo, video or voice.

Type

(or null string)

Initargs

:caption

Readers

get-caption.

Writers

This slot is read-only.

Slot: chat ¶

Package

cl-telegram-bot/chat.

Type

cl-telegram-bot/chat:chat

Initargs

:chat

Readers

get-chat.

Writers

This slot is read-only.

Slot: entities ¶

Type

list

Initargs

:entities

Readers

get-entities.

Writers

This slot is read-only.

Slot: raw-data ¶

Initargs

:raw-data

Readers

get-raw-data.

Writers

This slot is read-only.

Slot: forward-from ¶

For forwarded messages, sender of the original message.

Type

(or null cl-telegram-bot/chat:chat)

Initargs

:forward-from

Readers

get-forward-from.

Writers

This slot is read-only.

Slot: forward-sender-name ¶

For forwarded messages, sender of the original message.

Type

(or null string)

Initargs

:forward-sender-name

Readers

get-forward-sender-name.

Writers

This slot is read-only.

Slot: forward-from-chat ¶

For messages forwarded from channels or from anonymous administrators, information about the original sender chat.

Type

(or null cl-telegram-bot/chat:chat)

Initargs

:forward-from-chat

Readers

get-forward-from-chat.

Writers

This slot is read-only.

Class: photo ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

• file.
• spatial.

Direct methods

send-photo.

Class: photo-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

Direct methods

• get-photo-options.
• set-file.

Direct slots

Slot: photo-options ¶

Initargs

:photo-options

Readers

get-photo-options.

Writers

This slot is read-only.

Class: private-chat ¶

Package

cl-telegram-bot/chat.

Source

file-type.lisp.

Direct superclasses

chat.

Direct methods

• get-bio.
• get-first-name.
• get-has-private-forwards.
• get-last-name.
• print-object.

Direct slots

Slot: first-name ¶

Initargs

:first-name

Readers

get-first-name.

Writers

This slot is read-only.

Slot: last-name ¶

Initargs

:last-name

Readers

get-last-name.

Writers

This slot is read-only.

Slot: bio ¶

Initargs

:bio

Readers

get-bio.

Writers

This slot is read-only.

Slot: has-private-forwards ¶

Initargs

:has-private-forwards

Readers

get-has-private-forwards.

Writers

This slot is read-only.

Class: reply ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

message.

Direct methods

• get-reply-to-message.
• initialize-instance.

Direct slots

Slot: reply-to-message ¶

Initargs

:reply-to-message

Readers

get-reply-to-message.

Writers

This slot is read-only.

Class: sticker ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

• file.
• spatial.

Direct methods

• get-emoji.
• get-is-animated.
• get-is-video.
• get-set-name.
• send-sticker.

Direct slots

Slot: is-animated ¶

True if the sticker is animated.

Initargs

:is-animated

Readers

get-is-animated.

Writers

This slot is read-only.

Slot: is-video ¶

True if the sticker is a video sticker.

Initargs

:is-video

Readers

get-is-video.

Writers

This slot is read-only.

Slot: emoji ¶

Emoji associated with the sticker

Initargs

:emoji

Readers

get-emoji.

Writers

This slot is read-only.

Slot: set-name ¶

Name of the sticker set to which the sticker belongs.

Type

(or null string)

Initargs

:set-name

Readers

get-set-name.

Writers

This slot is read-only.

Class: sticker-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

Class: video ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

• file.
• spatial.
• temporal.

Direct methods

send-video.

Class: video-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

Class: video-note ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

• file.
• temporal.
• unispatial.

Direct methods

send-video-note.

Class: video-note-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

Class: voice ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

• file.
• temporal.

Direct methods

send-voice.

Class: voice-message ¶

Package

cl-telegram-bot/message.

Source

file-type.lisp.

Direct superclasses

file-message.

---