package telegraml

  1. Overview
  2. Docs

The base module for the API, equivalent to TelegramApi

include module type of struct include TelegramApi end
exception ApiException of string

An exception thrown if some rules specified in the API are invalidated by incorrectly formatted data of some type

module ParseMode = TelegramApi.ParseMode

This module deals with the parse mode used for formatting certain messages according to markup languages

module User = TelegramApi.User
module Chat = TelegramApi.Chat

Used to represent private messages, groupchats, and other types of Telegram chats

module InputFile = TelegramApi.InputFile

Used for handling, loading, and sending outgoing files in messages

module MessageEntity = TelegramApi.MessageEntity

Used to represent formatting options for a message's text

module KeyboardButton = TelegramApi.KeyboardButton

Used to represent an individual button on a custom keyboard

module InlineKeyboardButton = TelegramApi.InlineKeyboardButton

Used to represent an individual button on a custom inline keyboard

module ReplyMarkup = TelegramApi.ReplyMarkup

Markup options for users to reply to sent messages

module PhotoSize = TelegramApi.PhotoSize

This module is used for all images sent in chats

module Audio = TelegramApi.Audio
module Document = TelegramApi.Document
module Sticker = TelegramApi.Sticker
module Video = TelegramApi.Video
module Voice = TelegramApi.Voice
module Contact = TelegramApi.Contact
module Location = TelegramApi.Location
module Venue = TelegramApi.Venue
module UserProfilePhotos = TelegramApi.UserProfilePhotos
module Message = TelegramApi.Message
module File = TelegramApi.File

This module is used for downloadable files uploaded to the Telegram servers

module CallbackQuery = TelegramApi.CallbackQuery

This module is used for dealing with the results returned by clicking on callback buttons on inline keyboards

module ChatMember = TelegramApi.ChatMember

This module is used to deal with information about an individual member of a chat

module InputMessageContent = TelegramApi.InputMessageContent

This module is used to deal with the content being sent as the result of an inline query

module InlineQuery = TelegramApi.InlineQuery

This module is used for InlineQuery bots

module ChatAction = TelegramApi.ChatAction

Actions that can be sent as user statuses

module Update = TelegramApi.Update
module Result = TelegramApi.Result

Used for representing results of various actions where a success or failure can occur. Contains helper functions to implement a monadic and functorial interface.

module Command = TelegramApi.Command
module type BOT = TelegramApi.BOT

BOT is strictly used for customization of a TELEGRAM_BOT module. Once your customizations have been applied, pass it into Api.Mk to create the usable TELEGRAM_BOT interface.

module type TELEGRAM_BOT = TelegramApi.TELEGRAM_BOT

TELEGRAM_BOT represents the interface to a running bot

module Mk = TelegramApi.Mk

Generate a bot's interface to allow for direct calls to functions