class Tourmaline::Client

• Tourmaline::Client
• Reference
• Object

Overview

The Client class is the base class for all Tourmaline based bots. Extend this class to create your own bots, or create an instance of Client and add event handlers to it.

Included Modules

• Tourmaline::Client::Api
• Tourmaline::Logger

Defined in:

Constant Summary

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

Constructors

• .new(bot_token : String, endpoint : String = DEFAULT_API_URL, default_parse_mode : ParseMode = ParseMode::Markdown, pool_capacity = 200, initial_pool_size = 20, pool_timeout = 0.1, proxy = nil, proxy_uri = nil, proxy_host = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil)

  Create a new instance of Tourmaline::Client.

Class Method Summary

• .build_inline_keyboard_markup(*args, columns = nil, **options, &block : InlineKeyboardMarkupBuilder -> )
• .build_inline_query_result(&block : InlineQueryResultBuilder -> )
• .build_reply_keyboard_markup(*args, columns = nil, **options, &block : ReplyKeyboardMarkupBuilder -> )

Instance Method Summary

• #bot : User

  Gets the name of the Client at the time the Client was started.

• #bot? : User | Nil

  Gets the name of the Client at the time the Client was started.

• #bot_token : String
• #build_inline_keyboard_markup(*args, columns = nil, **options, &block : InlineKeyboardMarkupBuilder -> )
• #build_inline_query_result(&block : InlineQueryResultBuilder -> )
• #build_reply_keyboard_markup(*args, columns = nil, **options, &block : ReplyKeyboardMarkupBuilder -> )
• #default_parse_mode : ParseMode
• #default_parse_mode=(default_parse_mode : ParseMode)
• #dispatcher
• #on(action : UpdateAction, &block : Context -> )
• #on(*actions : Symbol | UpdateAction, &block : Context -> )
• #poll
• #register(*handlers : EventHandler)
• #request(type : U.class, method, params = {} of String => String) forall U

  Sends a request to the Telegram Client API.

• #request_raw(method : String, params = {} of String => String)

  Sends a request to the Telegram Client API.

• #serve(path = "/", host = "127.0.0.1", port = 8081, ssl_certificate_path = nil, ssl_key_path = nil, no_middleware_check = false)
• #use(middleware : Middleware)

Constructor Detail

Class Method Detail

Instance Method Detail