API v2

Useful in cl-telegram-bot2/generics:process-state generic-function methods in case if state has additional handler stored in the slot and this slot can be either state or action or a list of actions and states.

This function is recursive, because processing of an action could return another action and we should call FUNC until a new state or NIL will be returned.

Delete all messages created in the current current state.

Type of prices arguments for send-invoice class.

(SOFT-LIST-OF HASH-TABLE)

Supported values are: "Markdown", "MarkdownV2" or "HTML". Read more about formatting options in the Telegram documentaion: https://core.telegram.org/bots/api#formatting-options

This slot will be filled with cl-telegram-bot/user:user object on first access using a call to cl-telegram-bot/user:get-me function.

When debug mode is T, then interactive debugger will be called on each error.

HTTPS file-endpoint

HTTPS endpoint

Update id

Command processing code will use this cache to update commands list on the server when a new method for cl-telegram-bot/entities/command:on-command generic-function is defined.

This slot is for internal use.

Bot token given by BotFather

When debug mode is T, then interactive debugger will be called on each error.

HTTPS file-endpoint

Update id

Command processing code will use this cache to update commands list on the server when a new method for cl-telegram-bot/entities/command:on-command generic-function is defined.

This slot is for internal use.

Bot token given by BotFather

Use this macro to define a class of your Telegram bot.

Each bot has a state machine inside. The simplest bot has only one state:

(defbot test-bot ()
  ()
  (:initial-state
   (state (send-text "Hello world!"))))

This bot will green each who activates it.

To learn more about bot states and actions see States and Actions section.

Representation of callback handlers to be triggered on given callback data.

Returns state's slots or groups of slots as a list.

Renders a map item for a given handler.

It should use render-mapslot-value-with-link or render-mapslot-value functions for proper rendering of PlantUML.

Renders a map with a list of handlers for some event.

Returns a name for a state slot for such objects as callbacks or commands.

Renders object as an entity on PlantUML diagram.

Returns a state with given ID.

Works only during PlantUML diagram rendering.

Returns an alias of obj to be used in PlantUML diagram as a reference.

Call this function after you've finished rendering of the PlantUML object.

Executes block of code after the PlantUML entity with obj-id alias has been rendered. Useful for ensuring that both objects are known to the PlantUML renderer when rendering a link between objects.

Pre-checkout-query object will be passed as this single arguement and function should return a boolean. When the function return True, user may proceed to the payment.

Pre-checkout queries are not bound the the chat, so current-chat and current-state are not available during processing. This is why methods of this generic function should be defined on bot class.

You can use CL-TELEGRAM-BOT2/API:PRE-CHECKOUT-QUERY-INVOICE-PAYLOAD function to extract payload from the query and find associated invoice.

This method is called when some state exits and returns a result using cl-telegram-bot2/term/back:back function.

This method is called when chat actor's state is changed to a given STATE.

Such hook can be used to send some prompt to the user.

This method is called when chat actor's state is returned from a given STATE back to the previous state.

The method is called only when state is removed from the stack. When a new state is added to the stack, this method will not be called for a previous state.

Such hook can be used to hide a keyboard or to delete temporary messages.

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(bot, update)
new_state = process-state(bot, current_state, update)

This generic-function will be called inside an actor.

Default method resposible for extracting the current state from the stack and calling process-state generic-function to get a new state.

High level API for implementing Telegram bots.

Returns as the first value a list of messages created by reply function called during BODY execution. Values returned by the BODY code are returned as the second, third and following arguments.

Also, messages are collected when these actions are called:

• cl-telegram-bot2/actions/send-text:send-text (1 2)

• cl-telegram-bot2/actions/send-photo:send-photo (1 2)

Extracts callback query data from the UPDATE object.

If "quiz" is passed, the user will be allowed to create only polls in the quiz mode. If "regular" is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.

API: https://core.telegram.org/bots/api#keyboardbuttonpolltype

Makes a call-callback (1 2) button from a (title . data) cons.

Returns object of CL-TELEGRAM-BOT2/API:INLINE-KEYBOARD-MARKUP class.

API docs: https://core.telegram.org/bots/api#replykeyboardmarkup

Returns object of CL-TELEGRAM-BOT2/API:REPLY-KEYBOARD-MARKUP class.

API docs: https://core.telegram.org/bots/api#replykeyboardmarkup

API docs: https://core.telegram.org/bots/api#chatadministratorrights

(MEMBER :IS-ANONYMOUS :CAN-MANAGE-CHAT :CAN-DELETE-MESSAGES
        :CAN-MANAGE-VIDEO-CHATS :CAN-RESTRICT-MEMBERS :CAN-PROMOTE-MEMBERS
        :CAN-CHANGE-INFO :CAN-INVITE-USERS :CAN-POST-STORIES :CAN-EDIT-STORIES
        :CAN-DELETE-STORIES :CAN-POST-MESSAGES :CAN-EDIT-MESSAGES
        :CAN-PIN-MESSAGES :CAN-MANAGE-TOPICS)

(SOFT-LIST-OF CHAT-ADMINISTRATION-PERMISSION)

Should return T if OBJ match to the matcher. The simples matcher compares two strings.

If some state class processes update and don't call CALL-NEXT-METHOD, then it have to call this function to register received message id.

If you don't do this, then received messages deletion will not work for this state.

Use this macro to capture messages end during process-state generic-function handling in case if your state inherits from base-state but does not call CALL-NEXT-METHOD.

Start processing new updates from the Telegram API.

Pass bot instance as the first argument and maybe some other optional arguments.

If DEBUG argument is T, then bot will ignore updates which it can't to process without errors. Otherwise, an interactive debugger will popup.

Result of these handlers is ignored, but they can be used for side-effects.

Generic-function cl-telegram-bot2/generics:on-state-deletion will be called on these handlers.

Validates if argument is valid for passing as :ON-DELETION argument to the state constructor.

It also normalizes an argument and return it as a list of workflow blocks.

Type of ON-CALLBACK-QUERY argument of the state class.

(SOFT-LIST-OF CALLBACK)

A command description like "/start" or "/help".

An fbound symbol of two arguments (command-argument update-obj) or a workflow object to return from process-state generic-function.

A command name like "/start" or "/help".

This type of command is available only in the state where it is defined.

This command will be available during in all bot states.

(OR SYMBOL WORKFLOW-BLOCK WORKFLOW-BLOCKS)

Delete message with the keyboard and all warning messages when the choice was made or a new state was added to the stack.

Delete usual user messages which he might send by a mistake.

On success could be an fbound symbol which function returns a list of workflow blocks or a list of workflow blocks.

(OR CL-TELEGRAM-BOT2/API:REPLY-KEYBOARD-MARKUP
    CL-TELEGRAM-BOT2/API:REPLY-KEYBOARD-REMOVE
    CL-TELEGRAM-BOT2/API:INLINE-KEYBOARD-MARKUP
    CL-TELEGRAM-BOT2/API:FORCE-REPLY)

Does a general deep-copy on the given object and sub-pieces. Returns atoms, numbers and chars. Runs copy-tree on lists, and copy-seq on other sequences. Runs copy-structure on pathnames, hash tables and other structure-objects

If value is a fbound SYMBOL, then calls as a function and then returns a result.

If value is a fbound SYMBOL, then calls as a function with given ARG or without it depending on function arity.

This type denotes symbols bound to the functions. Such symbol could be funcalled.

(AND SYMBOL (SATISFIES FBOUNDP))

This variable holds an alist associating special variable symbols to forms to evaluate.

State processing might be done by different threads that is why you might want to keep some context around.

Don't modify this variable, just cons onto it. Preceeding values will take a priority.

(AND SYMBOL (SATISFIES FBOUNDP))

(OR FUNCALLABLE-SYMBOL BASE-STATE ACTION BACK)

(SOFT-LIST-OF WORKFLOW-BLOCK)