| (<$>) [Api.Result] |
Functorial map
|
| (>>=) [Api.Result] |
Monadic bind
|
C | |
| commands [Api.BOT] |
The list of commands that the bot will be able to use
|
| commands [Api.TELEGRAM_BOT] |
A list of all commands supported by the bot
|
| create [Api.Update] |
Read an `update` out of some JSON
|
| create [Api.Message] |
Read a `message` out of some JSON
|
| create [Api.Location] |
Read a `location` out of some JSON
|
| create [Api.Contact] |
Read a `contact` out of some JSON
|
| create [Api.Voice.Out] |
Prepare a `voice` for sending -- used in the case of a file id
|
| create [Api.Voice] |
Read a `voice` out of some JSON
|
| create [Api.Video] |
Read a `video` out of some JSON
|
| create [Api.Sticker] |
Read a `sticker` out of some JSON
|
| create [Api.Document] |
Read a `document` out of some JSON
|
| create [Api.Audio.Out] |
Prepare an `audio` for sending -- used in the case of a file id
|
| create [Api.Audio] |
Read an `audio` out of some JSON
|
| create [Api.PhotoSize.Out] |
Prepare a `photo_size` for sending -- used in the case of a file id
|
| create [Api.PhotoSize] |
Read a `photo_size` out of some JSON
|
| create [Api.Chat] |
Read a `chat` out of some JSON
|
| create [Api.User] |
Read a `user` out of some JSON
|
D | |
| default [Api.Result] |
Take the value of the result, if it succeeded, or the other argument by default and return that
|
G | |
| get_me [Api.TELEGRAM_BOT] |
Get the user information for the bot; use to test connection to the Telegram server
|
| get_sender [Api.Message] | |
| get_sender_first_name [Api.Message] |
Get the first name of the user who sent the message
|
| get_sender_username [Api.Message] |
Get a formatted name for the user who sent the message: first name, with the username in parentheses if it exists
|
| get_updates [Api.TELEGRAM_BOT] |
Get a list of all available updates that the bot has received
|
I | |
| is_command [Api.Command] |
Tests to see whether an update from the update queue invoked a command
|
L | |
| load [Api.InputFile] |
Loads a file (by filename) and returns the raw bytes inside of it
|
M | |
| multipart_body [Api.InputFile] | |
P | |
| peek_update [Api.TELEGRAM_BOT] |
Get the first available update from the update queue
|
| pop_update [Api.TELEGRAM_BOT] |
Get the first available update from the update queue and mark it as read (deletes the update)
|
| prepare [Api.Voice.Out] |
Prepare a `voice` for sending -- used in the case of the raw bytes
|
| prepare [Api.Audio.Out] |
Prepare an `audio` for sending -- used in the case of the raw bytes
|
| prepare [Api.PhotoSize.Out] |
Prepare a `photo_size` for sending -- used in the case of the raw bytes
|
| prepare_multipart [Api.Voice.Out] | |
| prepare_multipart [Api.Audio.Out] | |
| prepare_multipart [Api.PhotoSize.Out] | |
R | |
| read [Api.Update] | |
| read [Api.Message] | |
| read [Api.Location] | |
| read [Api.Contact] | |
| read [Api.Voice] | |
| read [Api.Video] | |
| read [Api.Sticker] | |
| read [Api.Document] | |
| read [Api.Audio] | |
| read [Api.PhotoSize] | |
| read [Api.Chat] | |
| read [Api.User] | |
| read_command [Api.Command] |
Takes a message, known to represent a command, and a list of possible commands.
|
| read_type [Api.Chat] | |
| read_update [Api.Command] |
Reads a single update and, given a list of commands, matches it to a correct command that can be invoked
|
| resend_audio [Api.TELEGRAM_BOT] |
Send an existing audio file (mp3) to a specified chat.
|
| resend_photo [Api.TELEGRAM_BOT] |
Send an existing image file (jpeg/png) to a specified chat.
|
| resend_voice [Api.TELEGRAM_BOT] |
Send an existing voice message (ogg) to a specified chat.
|
| return [Api.Result] |
Raise a normal value into a result (Success)
|
S | |
| send_audio [Api.TELEGRAM_BOT] |
Send a new audio file (mp3) to a specified chat.
|
| send_message [Api.TELEGRAM_BOT] |
Send a text message to a specified chat
|
| send_photo [Api.TELEGRAM_BOT] |
Send a new image file (jpeg/png) to a specified chat.
|
| send_voice [Api.TELEGRAM_BOT] |
Send a new voice message (ogg) to a specified chat.
|
T | |
| token [Api.BOT] |
The API token to use for the bot.
|
| tokenize [Api.Command] |
Turns a string into the args list that a command may choose to work with
|
U | |
| url [Api.TELEGRAM_BOT] |
The base url for all connections to the API
|