The cl-telegram-bot Reference Manual

Table of Contents

The cl-telegram-bot Reference Manual

This is the cl-telegram-bot Reference Manual, version 0.3.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:24:21 2021 GMT+0.

1 Introduction

Telegram Bot API for Common Lisp

See the Telegram Bot API.

This library uses CLOS to build a processing pipeline.

Quickstart

The system uses CLOS to add new methods to process incoming messages. To create a simple bot, all you need is to define on-message method.

If you want to match on a particular command, like /help or /make-me-happy 7 times, then you better to define a on-command method.

During messages processing, function (reply "some text") is available, which will send given text into the right chat. Also, there is send-message and other function exists which allow your bot to post messages, images and other media into the any chat.

Here is example of a simple bot which reacts on the text message and /echo command:

CL-USER> (defpackage the-bot (:use :cl :cl-telegram-bot))
#<Package "THE-BOT">
CL-USER> (in-package the-bot)
#<Package "THE-BOT">
THE-BOT> (defbot echo-bot)
MAKE-ECHO-BOT
THE-BOT> (defmethod on-message ((bot echo-bot)
                                text)
           (reply text))
#<STANDARD-METHOD ON-MESSAGE (ECHO-BOT T)>
THE-BOT> (defmethod on-command ((bot echo-bot)
                                (command (eql :help))
                                text)
           (declare (ignorable text))
           (reply "Just send me any text and I'll reply with the same text."))
#<STANDARD-METHOD ON-COMMAND (ECHO-BOT (EQL :HELP) T)>
THE-BOT> (defmethod on-command ((bot echo-bot)
                                (command (eql :start))
                                text)
           (declare (ignorable text))
           (reply "Welcome Lisper! Have a fun, playing with cl-telegram-bot!"))
#<STANDARD-METHOD ON-COMMAND (ECHO-BOT (EQL :START) T)>

Now, stop for the minute, open your Telegram client, and create a new bot using the BotFather bot:

When you've got token, return to the REPL and start our bot:

THE-BOT> (start-processing (make-echo-bot "5205125**********************************")
                           :debug t)
 <INFO> [08:31:09] cl-telegram-bot core.lisp (start-processing) - Starting thread to process updates for CL-TELEGRAM-BOT/CORE::BOT: #<ECHO-BOT id=0> 
#<PROCESS telegram-bot(33) [Reset] #x30200709246D>
THE-BOT> 

This will start a new thread for processing incoming messages.

Now, find your bot in the Telegram client:

And start communicating with him:

Credentials

• Rei – initial version.
• Alexander Artemenko – large refactoring, usage of CLOS classes, e

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-telegram-bot

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Description

Telegram Bot API, based on sovietspaceship’s work but mostly rewritten.

Version

0.3.1

Dependency

cl-telegram-bot/core (system)

Source

cl-telegram-bot.asd (file)

2.2 cl-telegram-bot/core

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• bordeaux-threads
• log4cl
• cl-telegram-bot/update (system)
• cl-telegram-bot/bot (system)
• cl-telegram-bot/message (system)
• cl-telegram-bot/entities/command (system)
• trivial-backtrace

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.3 cl-telegram-bot/update

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• log4cl
• cl-telegram-bot/message (system)
• cl-telegram-bot/network (system)
• cl-telegram-bot/bot (system)
• cl-telegram-bot/pipeline (system)

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.4 cl-telegram-bot/entities/command

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• log4cl
• cl-telegram-bot/entities/core (system)
• cl-telegram-bot/message (system)
• cl-telegram-bot/utils (system)
• cl-telegram-bot/pipeline (system)

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.5 cl-telegram-bot/message

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• log4cl
• cl-telegram-bot/chat (system)
• cl-telegram-bot/entities/core (system)
• cl-telegram-bot/network (system)
• cl-telegram-bot/pipeline (system)
• cl-telegram-bot/bot (system)
• serapeum
• cl-telegram-bot/utils (system)

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.6 cl-telegram-bot/chat

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• cl-telegram-bot/network (system)
• cl-telegram-bot/telegram-call (system)
• alexandria

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.7 cl-telegram-bot/telegram-call

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• arrows
• cl-telegram-bot/utils (system)
• cl-telegram-bot/network (system)
• alexandria
• kebab

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.8 cl-telegram-bot/entities/core

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• cl-telegram-bot/utils (system)
• arrows

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.9 cl-telegram-bot/network

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• log4cl
• cl-telegram-bot/utils (system)
• cl-telegram-bot/bot (system)

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.10 cl-telegram-bot/bot

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• log4cl
• dexador
• jonathan

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.11 cl-telegram-bot/utils

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Dependencies

• arrows
• cl-ppcre
• cl-strings
• kebab

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

2.12 cl-telegram-bot/pipeline

Author

Alexander Artemenko <svetlyak.40wt@gmail.com>

License

MIT

Source

cl-telegram-bot.asd (file)

Component

file-type.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-telegram-bot.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-telegram-bot-20210124-git/cl-telegram-bot.asd

Systems

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

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

Parent

cl-telegram-bot/core (system)

Location

core.lisp

Packages

cl-telegram-bot/core

Exported Definitions

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

Internal Definitions

*threads* (special variable)

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

Parent

cl-telegram-bot/update (system)

Location

update.lisp

Packages

cl-telegram-bot/update

Exported Definitions

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

Internal Definitions

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

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

Parent

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

Location

entities/command.lisp

Packages

cl-telegram-bot/entities/command

Exported Definitions

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

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

Parent

cl-telegram-bot/message (system)

Location

message.lisp

Packages

cl-telegram-bot/message

Exported Definitions

• get-chat (method)
• get-current-chat (function)
• get-entities (method)
• get-raw-data (method)
• get-text (method)
• get-text (method)
• make-message (function)
• message (class)
• on-message (generic function)
• on-message (method)
• process (method)
• reply (function)

Internal Definitions

• *current-bot* (special variable)
• *current-message* (special variable)
• get-rest-args (method)
• reply-immediately (condition)
• send-message (function)

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

Parent

cl-telegram-bot/chat (system)

Location

chat.lisp

Packages

cl-telegram-bot/chat

Exported Definitions

• chat (class)
• delete-chat-photo (function)
• export-chat-invite-link (function)
• get-chat-administrators (function)
• get-chat-by-id (function)
• get-chat-id (method)
• get-chat-member (function)
• get-chat-members-count (function)
• get-first-name (method)
• get-last-name (method)
• get-raw-data (method)
• get-username (method)
• kick-chat-member (function)
• leave-chat (function)
• make-chat (function)
• pin-chat-message (function)
• 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)

Internal Definitions

prepare-arg (method)

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

Parent

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

Location

telegram-call.lisp

Packages

cl-telegram-bot/telegram-call

Internal Definitions

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

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

Parent

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

Location

entities/core.lisp

Packages

cl-telegram-bot/entities/core

Exported Definitions

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

Internal Definitions

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

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

Parent

cl-telegram-bot/network (system)

Location

network.lisp

Packages

cl-telegram-bot/network

Exported Definitions

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

Internal Definitions

what (method)

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

Parent

cl-telegram-bot/bot (system)

Location

bot.lisp

Packages

cl-telegram-bot/bot

Exported Definitions

• bot (class)
• defbot (macro)
• get-last-update-id (method)
• (setf get-last-update-id) (method)

Internal Definitions

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

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

Parent

cl-telegram-bot/utils (system)

Location

utils.lisp

Packages

cl-telegram-bot/utils

Exported Definitions

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

Internal Definitions

make-json-keyword (function)

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

Parent

cl-telegram-bot/pipeline (system)

Location

pipeline.lisp

Packages

cl-telegram-bot/pipeline

Exported Definitions

• process (generic function)
• process (method)

4 Packages

Packages are listed by definition order.

4.1 cl-telegram-bot/core

Source

file-type.lisp (file)

Nickname

cl-telegram-bot

Use List

common-lisp

Exported Definitions

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

Internal Definitions

*threads* (special variable)

4.2 cl-telegram-bot/update

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

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

Internal Definitions

• get-payload (generic function)
• get-payload (method)
• get-updates (function)
• update (class)

4.3 cl-telegram-bot/entities/command

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

• bot-command (class)
• get-command (generic function)
• get-command (method)
• get-rest-text (generic function)
• get-rest-text (method)
• on-command (generic function)
• on-command (method)

4.4 cl-telegram-bot/message

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

• get-chat (generic function)
• get-chat (method)
• get-current-chat (function)
• get-entities (generic function)
• get-entities (method)
• get-raw-data (generic function)
• get-raw-data (method)
• get-text (generic function)
• get-text (method)
• get-text (method)
• make-message (function)
• message (class)
• on-message (generic function)
• on-message (method)
• reply (function)

Internal Definitions

• *current-bot* (special variable)
• *current-message* (special variable)
• get-rest-args (generic function)
• get-rest-args (method)
• reply-immediately (condition)
• send-message (function)

4.5 cl-telegram-bot/chat

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

• chat (class)
• delete-chat-photo (function)
• export-chat-invite-link (function)
• get-chat-administrators (function)
• get-chat-by-id (function)
• get-chat-id (generic function)
• get-chat-id (method)
• get-chat-member (function)
• get-chat-members-count (function)
• get-first-name (generic function)
• get-first-name (method)
• get-last-name (generic function)
• get-last-name (method)
• get-raw-data (generic function)
• get-raw-data (method)
• get-username (generic function)
• get-username (method)
• kick-chat-member (function)
• leave-chat (function)
• make-chat (function)
• pin-chat-message (function)
• 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)

4.6 cl-telegram-bot/telegram-call

Source

file-type.lisp (file)

Use List

common-lisp

Internal Definitions

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

4.7 cl-telegram-bot/entities/core

Source

file-type.lisp (file)

Nickname

cl-telegram-bot/entities

Use List

common-lisp

Exported Definitions

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

Internal Definitions

• entity (class)
• get-raw-data (generic function)
• get-raw-data (method)
• unsupported-entity (class)

4.8 cl-telegram-bot/network

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

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

Internal Definitions

• what (generic function)
• what (method)

4.9 cl-telegram-bot/bot

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

• bot (class)
• defbot (macro)
• get-last-update-id (generic function)
• get-last-update-id (method)
• (setf get-last-update-id) (method)
• (setf get-last-update-id) (generic function)

Internal Definitions

• api-uri (generic function)
• api-uri (method)
• (setf api-uri) (method)
• (setf api-uri) (generic function)
• file-endpoint (generic function)
• file-endpoint (method)
• (setf file-endpoint) (method)
• (setf file-endpoint) (generic function)
• get-endpoint (generic function)
• get-endpoint (method)
• token (generic function)
• token (method)
• (setf token) (method)
• (setf token) (generic function)

4.10 cl-telegram-bot/utils

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

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

Internal Definitions

make-json-keyword (function)

4.11 cl-telegram-bot/pipeline

Source

file-type.lisp (file)

Use List

common-lisp

Exported Definitions

• process (generic function)
• process (method)
• process (method)
• process (method)
• process (method)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Macros

Macro: defbot NAME

Package

cl-telegram-bot/bot

Source

file-type.lisp (file)

5.1.2 Functions

Function: delete-chat-photo BOT-VAR1 CHAT

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: export-chat-invite-link BOT-VAR1 CHAT

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: get-chat-administrators BOT-VAR1 CHAT

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

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 (file)

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 (file)

Function: get-chat-members-count BOT-VAR1 CHAT

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: get-current-chat ()

Returns a chat where currently processing message was received.

Package

cl-telegram-bot/message

Source

file-type.lisp (file)

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 (file)

Function: leave-chat BOT-VAR1 CHAT

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: make-chat DATA

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: make-entity PAYLOAD DATA

Package

cl-telegram-bot/entities/core

Source

file-type.lisp (file)

Function: make-keyword TEXT

Package

cl-telegram-bot/utils

Source

file-type.lisp (file)

Function: make-message DATA

Package

cl-telegram-bot/message

Source

file-type.lisp (file)

Function: make-request BOT NAME OPTIONS &key STREAMP TIMEOUT

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

Package

cl-telegram-bot/network

Source

file-type.lisp (file)

Function: make-update DATA

Package

cl-telegram-bot/update

Source

file-type.lisp (file)

Function: obfuscate URL

Package

cl-telegram-bot/utils

Source

file-type.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: send-chat-action BOT-VAR1 CHAT ACTION

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: set-chat-description BOT-VAR1 CHAT DESCRIPTION

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: set-chat-photo BOT-VAR1 CHAT PHOTO

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: set-chat-title BOT-VAR1 CHAT TITLE

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Function: start-processing BOT &key DEBUG DELAY-BETWEEN-RETRIES

Package

cl-telegram-bot/core

Source

file-type.lisp (file)

Function: stop-processing BOT

Package

cl-telegram-bot/core

Source

file-type.lisp (file)

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 (file)

Function: unpin-chat-message BOT-VAR1 CHAT

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

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

5.1.3 Generic functions

Generic Function: get-chat OBJECT

Package

cl-telegram-bot/message

Methods

Method: get-chat (MESSAGE message)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-chat-id OBJECT

Package

cl-telegram-bot/chat

Methods

Method: get-chat-id (CHAT chat)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-command OBJECT

Package

cl-telegram-bot/entities/command

Methods

Method: get-command (BOT-COMMAND bot-command)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-entities OBJECT

Package

cl-telegram-bot/message

Methods

Method: get-entities (MESSAGE message)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-first-name OBJECT

Package

cl-telegram-bot/chat

Methods

Method: get-first-name (PRIVATE-CHAT private-chat)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-last-name OBJECT

Package

cl-telegram-bot/chat

Methods

Method: get-last-name (PRIVATE-CHAT private-chat)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-last-update-id OBJECT

Generic Function: (setf get-last-update-id) NEW-VALUE OBJECT

Package

cl-telegram-bot/bot

Methods

Method: get-last-update-id (BOT bot)

Method: (setf get-last-update-id) NEW-VALUE (BOT bot)

Update id

Source

file-type.lisp (file)

Generic Function: get-raw-data OBJECT

Package

cl-telegram-bot/update

Methods

Method: get-raw-data (UPDATE update)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-raw-data OBJECT

Package

cl-telegram-bot/message

Methods

Method: get-raw-data (MESSAGE message)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-raw-data OBJECT

Package

cl-telegram-bot/chat

Methods

Method: get-raw-data (CHAT chat)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-rest-text OBJECT

Package

cl-telegram-bot/entities/command

Methods

Method: get-rest-text (BOT-COMMAND bot-command)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-text OBJECT

Package

cl-telegram-bot/message

Methods

Method: get-text (CONDITION reply-immediately)

Source

file-type.lisp (file)

Method: get-text (MESSAGE message)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-update-id OBJECT

Package

cl-telegram-bot/update

Methods

Method: get-update-id (UPDATE update)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-username OBJECT

Package

cl-telegram-bot/chat

Methods

Method: get-username (PRIVATE-CHAT private-chat)

automatically generated reader method

Source

file-type.lisp (file)

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 (file)

Methods

Method: make-entity-internal (ENTITY-TYPE (eql bot-command)) (PAYLOAD message) DATA

Source

file-type.lisp (file)

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 (file)

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 (file)

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 (file)

Methods

Method: process BOT (COMMAND bot-command)

Source

file-type.lisp (file)

Method: process BOT (UPDATE update)

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

Source

file-type.lisp (file)

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 (file)

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 (file)

Methods

Method: process-updates BOT

Starts inifinite loop to process updates using long polling.

5.1.4 Conditions

Condition: request-error ()

Package

cl-telegram-bot/network

Source

file-type.lisp (file)

Direct superclasses

error (condition)

Direct methods

what (method)

Direct slots

Slot: what

Initargs

:what

Readers

what (generic function)

5.1.5 Classes

Class: bot ()

Package

cl-telegram-bot/bot

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

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

Direct slots

Slot: id

Update id

Initform

0

Readers

get-last-update-id (generic function)

Writers

(setf get-last-update-id) (generic function)

Slot: token

Bot token given by BotFather

Initargs

:token

Readers

token (generic function)

Writers

(setf token) (generic function)

Slot: api-uri

Initargs

:api-uri

Initform

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

Readers

api-uri (generic function)

Writers

(setf api-uri) (generic function)

Slot: endpoint

HTTPS endpoint

Initargs

:endpoint

Readers

get-endpoint (generic function)

Slot: file-endpoint

HTTPS file-endpoint

Initargs

:file-endpoint

Readers

file-endpoint (generic function)

Writers

(setf file-endpoint) (generic function)

Class: bot-command ()

Package

cl-telegram-bot/entities/command

Source

file-type.lisp (file)

Direct superclasses

entity (class)

Direct methods

• process (method)
• get-rest-text (method)
• get-command (method)

Direct slots

Slot: command

Type

:keyword

Initargs

:command

Readers

get-command (generic function)

Slot: rest-text

Type

string

Initargs

:rest-text

Readers

get-rest-text (generic function)

Class: chat ()

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

private-chat (class)

Direct methods

• get-raw-data (method)
• get-chat-id (method)

Direct slots

Slot: id

Initargs

:id

Readers

get-chat-id (generic function)

Slot: raw-data

Initargs

:raw-data

Readers

get-raw-data (generic function)

Class: message ()

Package

cl-telegram-bot/message

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• make-entity-internal (method)
• process (method)
• print-object (method)
• get-raw-data (method)
• get-entities (method)
• get-chat (method)
• get-text (method)

Direct slots

Slot: text

Initargs

:text

Readers

get-text (generic function)

Slot: chat

Initargs

:chat

Readers

get-chat (generic function)

Slot: entities

Initargs

:entities

Readers

get-entities (generic function)

Slot: raw-data

Initargs

:raw-data

Readers

get-raw-data (generic function)

Class: private-chat ()

Package

cl-telegram-bot/chat

Source

file-type.lisp (file)

Direct superclasses

chat (class)

Direct methods

• print-object (method)
• get-last-name (method)
• get-first-name (method)
• get-username (method)

Direct slots

Slot: username

Initargs

:username

Readers

get-username (generic function)

Slot: first-name

Initargs

:first-name

Readers

get-first-name (generic function)

Slot: last-name

Initargs

:last-name

Readers

get-last-name (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *current-bot*

An internal variable to hold current bot for replying.

Package

cl-telegram-bot/message

Source

file-type.lisp (file)

Special Variable: *current-message*

An internal variable to hold current message for replying.

Package

cl-telegram-bot/message

Source

file-type.lisp (file)

Special Variable: *threads*

Package

cl-telegram-bot/core

Source

file-type.lisp (file)

5.2.2 Macros

Macro: def-telegram-call NAME ARGS &body BODY

During the body evaluaction, result of call to API will be available as ‘response’

Package

cl-telegram-bot/telegram-call

Source

file-type.lisp (file)

5.2.3 Functions

Function: get-docstring BODY

Package

cl-telegram-bot/telegram-call

Source

file-type.lisp (file)

Function: get-func-name NAME

Returns a name for the Lisp function to call a Telegram’s method.

Package

cl-telegram-bot/telegram-call

Source

file-type.lisp (file)

Function: get-method-name NAME

Returns a name for Telegram method.
It is a camelcased string.
As input, receives either a symbol or a list with two items.

Package

cl-telegram-bot/telegram-call

Source

file-type.lisp (file)

Function: get-updates BOT &key LIMIT TIMEOUT

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

Package

cl-telegram-bot/update

Source

file-type.lisp (file)

Function: make-json-keyword ARG

Package

cl-telegram-bot/utils

Source

file-type.lisp (file)

Function: send-message BOT CHAT TEXT &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 (file)

Function: without-docstring BODY

Strips docstring if it was provided.

Package

cl-telegram-bot/telegram-call

Source

file-type.lisp (file)

5.2.4 Generic functions

Generic Function: api-uri OBJECT

Generic Function: (setf api-uri) NEW-VALUE OBJECT

Package

cl-telegram-bot/bot

Methods

Method: api-uri (BOT bot)

automatically generated reader method

Source

file-type.lisp (file)

Method: (setf api-uri) NEW-VALUE (BOT bot)

automatically generated writer method

Source

file-type.lisp (file)

Generic Function: file-endpoint OBJECT

Generic Function: (setf file-endpoint) NEW-VALUE OBJECT

Package

cl-telegram-bot/bot

Methods

Method: file-endpoint (BOT bot)

Method: (setf file-endpoint) NEW-VALUE (BOT bot)

HTTPS file-endpoint

Source

file-type.lisp (file)

Generic Function: get-endpoint OBJECT

Package

cl-telegram-bot/bot

Methods

Method: get-endpoint (BOT bot)

HTTPS endpoint

Source

file-type.lisp (file)

Generic Function: get-payload OBJECT

Package

cl-telegram-bot/update

Methods

Method: get-payload (UPDATE update)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-raw-data OBJECT

Package

cl-telegram-bot/entities/core

Methods

Method: get-raw-data (ENTITY entity)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-rest-args CONDITION

Package

cl-telegram-bot/message

Methods

Method: get-rest-args (CONDITION reply-immediately)

Source

file-type.lisp (file)

Generic Function: prepare-arg ARG

Returns argument as a list with two values.
Input argument is a keyword.

For example, if arg is :user-id, then output will be:
(list :|user_id| user-id)

You can redefine this method to process special cases, for example, :chat is such special case. Ee should transform it to pass chat_id: (list :|chat_id| (get-chat-id chat))

Package

cl-telegram-bot/telegram-call

Source

file-type.lisp (file)

Methods

Method: prepare-arg (ARG (eql chat))

Source

file-type.lisp (file)

Method: prepare-arg ARG

Generic Function: token OBJECT

Generic Function: (setf token) NEW-VALUE OBJECT

Package

cl-telegram-bot/bot

Methods

Method: token (BOT bot)

Method: (setf token) NEW-VALUE (BOT bot)

Bot token given by BotFather

Source

file-type.lisp (file)

Generic Function: what CONDITION

Package

cl-telegram-bot/network

Methods

Method: what (CONDITION request-error)

Source

file-type.lisp (file)

5.2.5 Conditions

Condition: reply-immediately ()

Package

cl-telegram-bot/message

Source

file-type.lisp (file)

Direct superclasses

condition (condition)

Direct methods

• get-rest-args (method)
• get-text (method)

Direct slots

Slot: text

Initargs

:text

Readers

get-text (generic function)

Slot: args

Initargs

:args

Readers

get-rest-args (generic function)

5.2.6 Classes

Class: entity ()

Package

cl-telegram-bot/entities/core

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• unsupported-entity (class)
• bot-command (class)

Direct methods

get-raw-data (method)

Direct slots

Slot: raw-data

Initargs

:raw-data

Readers

get-raw-data (generic function)

Class: unsupported-entity ()

Package

cl-telegram-bot/entities/core

Source

file-type.lisp (file)

Direct superclasses

entity (class)

Class: update ()

Package

cl-telegram-bot/update

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• process (method)
• get-raw-data (method)
• get-payload (method)
• get-update-id (method)

Direct slots

Slot: id

Initargs

:id

Readers

get-update-id (generic function)

Slot: payload

Initargs

:payload

Readers

get-payload (generic function)

Slot: raw-data

Initargs

:raw-data

Readers

get-raw-data (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions