Module: TD::ClientMethods

Included in:
Client
Defined in:
lib/tdlib/client_methods.rb

Overview

This is a generated module from current TDLib scheme It contains all available TDLib methods

Instance Method Summary collapse

Instance Method Details

#accept_call(call_id, protocol) ⇒ TD::Types::Ok

Accepts an incoming call.

Parameters:

  • call_id (Integer) —

    Call identifier.

  • protocol (TD::Types::CallProtocol) —

    Description of the call protocols supported by the client.

Returns:



9
10
11
12
13
 
# File 'lib/tdlib/client_methods.rb', line 9

def accept_call(call_id, protocol)
  broadcast('@type'    => 'acceptCall',
            'call_id'  => call_id,
            'protocol' => protocol)
end

#accept_terms_of_service(terms_of_service_id) ⇒ TD::Types::Ok

Accepts Telegram terms of services.

Parameters:

  • terms_of_service_id (String) —

    Terms of service identifier.

Returns:



19
20
21
22
 
# File 'lib/tdlib/client_methods.rb', line 19

def accept_terms_of_service(terms_of_service_id)
  broadcast('@type'               => 'acceptTermsOfService',
            'terms_of_service_id' => terms_of_service_id)
end

#add_chat_member(chat_id, user_id, forward_limit) ⇒ TD::Types::Ok

Adds a new member to a chat. Members can't be added to private or secret chats. Members will not be added until the chat state has been synchronized with the server.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • user_id (Integer) —

    Identifier of the user.

  • forward_limit (Integer) —

    The number of earlier messages from the chat to be forwarded to the new member; up to 100. Ignored for supergroups and channels.

Returns:



34
35
36
37
38
39
 
# File 'lib/tdlib/client_methods.rb', line 34

def add_chat_member(chat_id, user_id, forward_limit)
  broadcast('@type'         => 'addChatMember',
            'chat_id'       => chat_id,
            'user_id'       => user_id,
            'forward_limit' => forward_limit)
end

#add_chat_members(chat_id, user_ids) ⇒ TD::Types::Ok

Adds multiple new members to a chat. Currently this option is only available for supergroups and channels. This option can't be used to join a chat. Members can't be added to a channel if it has more than 200 members. Members will not be added until the chat state has been synchronized with the server.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • user_ids (Array<Integer>) —

    Identifiers of the users to be added to the chat.

Returns:



50
51
52
53
54
 
# File 'lib/tdlib/client_methods.rb', line 50

def add_chat_members(chat_id, user_ids)
  broadcast('@type'    => 'addChatMembers',
            'chat_id'  => chat_id,
            'user_ids' => user_ids)
end

#add_custom_server_language_pack(language_pack_id) ⇒ TD::Types::Ok

Adds a custom server language pack to the list of installed language packs in current localization target. Can be called before authorization.

Parameters:

  • language_pack_id (String) —

    Identifier of a language pack to be added; may be different from a name that is used in an "https://t.me/setlanguage/" link.

Returns:



62
63
64
65
 
# File 'lib/tdlib/client_methods.rb', line 62

def add_custom_server_language_pack(language_pack_id)
  broadcast('@type'            => 'addCustomServerLanguagePack',
            'language_pack_id' => language_pack_id)
end

#add_favorite_sticker(sticker) ⇒ TD::Types::Ok

Adds a new sticker to the list of favorite stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list.

Parameters:

Returns:



74
75
76
77
 
# File 'lib/tdlib/client_methods.rb', line 74

def add_favorite_sticker(sticker)
  broadcast('@type'   => 'addFavoriteSticker',
            'sticker' => sticker)
end

#add_local_message(chat_id, sender_user_id, reply_to_message_id, disable_notification, input_message_content) ⇒ TD::Types::Message

Adds a local message to a chat. The message is persistent across application restarts only if the message database is used. Returns the added message.

Parameters:

  • chat_id (Integer) —

    Target chat.

  • sender_user_id (Integer) —

    Identifier of the user who will be shown as the sender of the message; may be 0 for channel posts.

  • reply_to_message_id (Integer) —

    Identifier of the message to reply to or 0.

  • disable_notification (Boolean) —

    Pass true to disable notification for the message.

  • input_message_content (TD::Types::InputMessageContent) —

    The content of the message to be added.

Returns:



90
91
92
93
94
95
96
97
 
# File 'lib/tdlib/client_methods.rb', line 90

def add_local_message(chat_id, sender_user_id, reply_to_message_id, disable_notification, input_message_content)
  broadcast('@type'                 => 'addLocalMessage',
            'chat_id'               => chat_id,
            'sender_user_id'        => sender_user_id,
            'reply_to_message_id'   => reply_to_message_id,
            'disable_notification'  => disable_notification,
            'input_message_content' => input_message_content)
end

#add_log_message(verbosity_level, text) ⇒ TD::Types::Ok

Adds a message to TDLib internal log. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • verbosity_level (Integer) —

    Minimum verbosity level needed for the message to be logged, 0-1023.

  • text (String) —

    Text of a message to log.

Returns:



107
108
109
110
111
 
# File 'lib/tdlib/client_methods.rb', line 107

def add_log_message(verbosity_level, text)
  broadcast('@type'           => 'addLogMessage',
            'verbosity_level' => verbosity_level,
            'text'            => text)
end

#add_network_statistics(entry) ⇒ TD::Types::Ok

Adds the specified data to data usage statistics. Can be called before authorization.

Parameters:

Returns:



119
120
121
122
 
# File 'lib/tdlib/client_methods.rb', line 119

def add_network_statistics(entry)
  broadcast('@type' => 'addNetworkStatistics',
            'entry' => entry)
end

#add_proxy(server, port, enable, type) ⇒ TD::Types::Proxy

Adds a proxy server for network requests. Can be called before authorization.

Parameters:

  • server (String) —

    Proxy server IP address.

  • port (Integer) —

    Proxy server port.

  • enable (Boolean) —

    True, if the proxy should be enabled.

  • type (TD::Types::ProxyType) —

    Proxy type.

Returns:



132
133
134
135
136
137
138
 
# File 'lib/tdlib/client_methods.rb', line 132

def add_proxy(server, port, enable, type)
  broadcast('@type'  => 'addProxy',
            'server' => server,
            'port'   => port,
            'enable' => enable,
            'type'   => type)
end

#add_recent_sticker(is_attached, sticker) ⇒ TD::Types::Stickers

Manually adds a new sticker to the list of recently used stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list.

Parameters:

  • is_attached (Boolean) —

    Pass true to add the sticker to the list of stickers recently attached to photo or video files; pass false to add the sticker to the list of recently sent stickers.

  • sticker (TD::Types::InputFile) —

    Sticker file to add.

Returns:



149
150
151
152
153
 
# File 'lib/tdlib/client_methods.rb', line 149

def add_recent_sticker(is_attached, sticker)
  broadcast('@type'       => 'addRecentSticker',
            'is_attached' => is_attached,
            'sticker'     => sticker)
end

#add_recently_found_chat(chat_id) ⇒ TD::Types::Ok

Adds a chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is already in the list, it will be removed from the list first.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to add.

Returns:



161
162
163
164
 
# File 'lib/tdlib/client_methods.rb', line 161

def add_recently_found_chat(chat_id)
  broadcast('@type'   => 'addRecentlyFoundChat',
            'chat_id' => chat_id)
end

#add_saved_animation(animation) ⇒ TD::Types::Ok

Manually adds a new animation to the list of saved animations. The new animation is added to the beginning of the list. If the animation was already in the list, it is removed first. Only non-secret video animations with MIME type "video/mp4" can be added to the list.

Parameters:

  • animation (TD::Types::InputFile) —

    The animation file to be added. Only animations known to the server (i.e. successfully sent via a message) can be added to the list.

Returns:



175
176
177
178
 
# File 'lib/tdlib/client_methods.rb', line 175

def add_saved_animation(animation)
  broadcast('@type'     => 'addSavedAnimation',
            'animation' => animation)
end

#add_sticker_to_set(user_id, name, sticker) ⇒ TD::Types::StickerSet

Adds a new sticker to a set; for bots only. Returns the sticker set.

Parameters:

  • user_id (Integer) —

    Sticker set owner.

  • name (String) —

    Sticker set name.

  • sticker (TD::Types::InputSticker) —

    Sticker to add to the set.

Returns:



187
188
189
190
191
192
 
# File 'lib/tdlib/client_methods.rb', line 187

def add_sticker_to_set(user_id, name, sticker)
  broadcast('@type'   => 'addStickerToSet',
            'user_id' => user_id,
            'name'    => name,
            'sticker' => sticker)
end

#answer_callback_query(callback_query_id, text, show_alert, url, cache_time) ⇒ TD::Types::Ok

Sets the result of a callback query; for bots only.

Parameters:

  • callback_query_id (Integer) —

    Identifier of the callback query.

  • text (String) —

    Text of the answer.

  • show_alert (Boolean) —

    If true, an alert should be shown to the user instead of a toast notification.

  • url (String) —

    URL to be opened.

  • cache_time (Integer) —

    Time during which the result of the query can be cached, in seconds.

Returns:



202
203
204
205
206
207
208
209
 
# File 'lib/tdlib/client_methods.rb', line 202

def answer_callback_query(callback_query_id, text, show_alert, url, cache_time)
  broadcast('@type'             => 'answerCallbackQuery',
            'callback_query_id' => callback_query_id,
            'text'              => text,
            'show_alert'        => show_alert,
            'url'               => url,
            'cache_time'        => cache_time)
end

#answer_custom_query(custom_query_id, data) ⇒ TD::Types::Ok

Answers a custom query; for bots only.

Parameters:

  • custom_query_id (Integer) —

    Identifier of a custom query.

  • data (String) —

    JSON-serialized answer to the query.

Returns:



216
217
218
219
220
 
# File 'lib/tdlib/client_methods.rb', line 216

def answer_custom_query(custom_query_id, data)
  broadcast('@type'           => 'answerCustomQuery',
            'custom_query_id' => custom_query_id,
            'data'            => data)
end

#answer_inline_query(inline_query_id, is_personal, results, cache_time, next_offset, switch_pm_text, switch_pm_parameter) ⇒ TD::Types::Ok

Sets the result of an inline query; for bots only.

Parameters:

  • inline_query_id (Integer) —

    Identifier of the inline query.

  • is_personal (Boolean) —

    True, if the result of the query can be cached for the specified user.

  • results (Array<TD::Types::InputInlineQueryResult>) —

    The results of the query.

  • cache_time (Integer) —

    Allowed time to cache the results of the query, in seconds.

  • next_offset (String) —

    Offset for the next inline query; pass an empty string if there are no more results.

  • switch_pm_text (String) —

    If non-empty, this text should be shown on the button that opens a private chat with the bot and sends a start message to the bot with the parameter switch_pm_parameter.

  • switch_pm_parameter (String) —

    The parameter for the bot start message.

Returns:



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/tdlib/client_methods.rb', line 233

def answer_inline_query(inline_query_id, is_personal, results, cache_time, next_offset, switch_pm_text,
                        switch_pm_parameter)
  broadcast('@type'               => 'answerInlineQuery',
            'inline_query_id'     => inline_query_id,
            'is_personal'         => is_personal,
            'results'             => results,
            'cache_time'          => cache_time,
            'next_offset'         => next_offset,
            'switch_pm_text'      => switch_pm_text,
            'switch_pm_parameter' => switch_pm_parameter)
end

#answer_pre_checkout_query(pre_checkout_query_id, error_message) ⇒ TD::Types::Ok

Sets the result of a pre-checkout query; for bots only.

Parameters:

  • pre_checkout_query_id (Integer) —

    Identifier of the pre-checkout query.

  • error_message (String) —

    An error message, empty on success.

Returns:



250
251
252
253
254
 
# File 'lib/tdlib/client_methods.rb', line 250

def answer_pre_checkout_query(pre_checkout_query_id, error_message)
  broadcast('@type'                 => 'answerPreCheckoutQuery',
            'pre_checkout_query_id' => pre_checkout_query_id,
            'error_message'         => error_message)
end

#answer_shipping_query(shipping_query_id, shipping_options, error_message) ⇒ TD::Types::Ok

Sets the result of a shipping query; for bots only.

Parameters:

  • shipping_query_id (Integer) —

    Identifier of the shipping query.

  • shipping_options (Array<TD::Types::ShippingOption>) —

    Available shipping options.

  • error_message (String) —

    An error message, empty on success.

Returns:



262
263
264
265
266
267
 
# File 'lib/tdlib/client_methods.rb', line 262

def answer_shipping_query(shipping_query_id, shipping_options, error_message)
  broadcast('@type'             => 'answerShippingQuery',
            'shipping_query_id' => shipping_query_id,
            'shipping_options'  => shipping_options,
            'error_message'     => error_message)
end

#block_user(user_id) ⇒ TD::Types::Ok

Adds a user to the blacklist.

Parameters:

  • user_id (Integer) —

    User identifier.

Returns:



273
274
275
276
 
# File 'lib/tdlib/client_methods.rb', line 273

def block_user(user_id)
  broadcast('@type'   => 'blockUser',
            'user_id' => user_id)
end

#cancel_download_file(file_id, only_if_pending) ⇒ TD::Types::Ok

Stops the downloading of a file. If a file has already been downloaded, does nothing.

Parameters:

  • file_id (Integer) —

    Identifier of a file to stop downloading.

  • only_if_pending (Boolean) —

    Pass true to stop downloading only if it hasn't been started, i.e. request hasn't been sent to server.

Returns:



285
286
287
288
289
 
# File 'lib/tdlib/client_methods.rb', line 285

def cancel_download_file(file_id, only_if_pending)
  broadcast('@type'           => 'cancelDownloadFile',
            'file_id'         => file_id,
            'only_if_pending' => only_if_pending)
end

#cancel_upload_file(file_id) ⇒ TD::Types::Ok

Stops the uploading of a file. Supported only for files uploaded by using uploadFile. For other files the behavior is undefined.

Parameters:

  • file_id (Integer) —

    Identifier of the file to stop uploading.

Returns:



297
298
299
300
 
# File 'lib/tdlib/client_methods.rb', line 297

def cancel_upload_file(file_id)
  broadcast('@type'   => 'cancelUploadFile',
            'file_id' => file_id)
end

#change_chat_report_spam_state(chat_id, is_spam_chat) ⇒ TD::Types::Ok

Reports to the server whether a chat is a spam chat or not. Can be used only if ChatReportSpamState.can_report_spam is true. After this request, ChatReportSpamState.can_report_spam becomes false forever.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • is_spam_chat (Boolean) —

    If true, the chat will be reported as spam; otherwise it will be marked as not spam.

Returns:



309
310
311
312
313
 
# File 'lib/tdlib/client_methods.rb', line 309

def change_chat_report_spam_state(chat_id, is_spam_chat)
  broadcast('@type'        => 'changeChatReportSpamState',
            'chat_id'      => chat_id,
            'is_spam_chat' => is_spam_chat)
end

#change_imported_contacts(contacts) ⇒ TD::Types::ImportedContacts

Changes imported contacts using the list of current user contacts saved on the device. Imports newly added contacts and, if at least the file database is enabled, deletes recently deleted contacts. Query result depends on the result of the previous query, so only one query is possible at the same time.

Parameters:

  • contacts (Array<TD::Types::Contact>) —

    The new list of contacts, contact's vCard are ignored and are not imported.

Returns:



322
323
324
325
 
# File 'lib/tdlib/client_methods.rb', line 322

def change_imported_contacts(contacts)
  broadcast('@type'    => 'changeImportedContacts',
            'contacts' => contacts)
end

#change_phone_number(phone_number, settings) ⇒ TD::Types::AuthenticationCodeInfo

Changes the phone number of the user and sends an authentication code to the user's new phone number. On success, returns information about the sent code.

Parameters:

Returns:



334
335
336
337
338
 
# File 'lib/tdlib/client_methods.rb', line 334

def change_phone_number(phone_number, settings)
  broadcast('@type'        => 'changePhoneNumber',
            'phone_number' => phone_number,
            'settings'     => settings)
end

#change_sticker_set(set_id, is_installed, is_archived) ⇒ TD::Types::Ok

Installs/uninstalls or activates/archives a sticker set.

Parameters:

  • set_id (Integer) —

    Identifier of the sticker set.

  • is_installed (Boolean) —

    The new value of is_installed.

  • is_archived (Boolean) —

    The new value of is_archived. A sticker set can't be installed and archived simultaneously.

Returns:



347
348
349
350
351
352
 
# File 'lib/tdlib/client_methods.rb', line 347

def change_sticker_set(set_id, is_installed, is_archived)
  broadcast('@type'        => 'changeStickerSet',
            'set_id'       => set_id,
            'is_installed' => is_installed,
            'is_archived'  => is_archived)
end

#check_authentication_bot_token(token) ⇒ TD::Types::Ok

Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is authorizationStateWaitPhoneNumber. Can be used instead of setAuthenticationPhoneNumber and checkAuthenticationCode to log in.

Parameters:

  • token (String) —

    The bot token.

Returns:



360
361
362
363
 
# File 'lib/tdlib/client_methods.rb', line 360

def check_authentication_bot_token(token)
  broadcast('@type' => 'checkAuthenticationBotToken',
            'token' => token)
end

#check_authentication_code(code) ⇒ TD::Types::Ok

Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode.

Parameters:

  • code (String) —

    The verification code received via SMS, Telegram message, phone call, or flash call.

Returns:



370
371
372
373
 
# File 'lib/tdlib/client_methods.rb', line 370

def check_authentication_code(code)
  broadcast('@type' => 'checkAuthenticationCode',
            'code'  => code)
end

#check_authentication_password(password) ⇒ TD::Types::Ok

Checks the authentication password for correctness. Works only when the current authorization state is authorizationStateWaitPassword.

Parameters:

  • password (String) —

    The password to check.

Returns:



380
381
382
383
 
# File 'lib/tdlib/client_methods.rb', line 380

def check_authentication_password(password)
  broadcast('@type'    => 'checkAuthenticationPassword',
            'password' => password)
end

#check_change_phone_number_code(code) ⇒ TD::Types::Ok

Checks the authentication code sent to confirm a new phone number of the user.

Parameters:

  • code (String) —

    Verification code received by SMS, phone call or flash call.

Returns:



389
390
391
392
 
# File 'lib/tdlib/client_methods.rb', line 389

def check_change_phone_number_code(code)
  broadcast('@type' => 'checkChangePhoneNumberCode',
            'code'  => code)
end

#check_chat_invite_link(invite_link) ⇒ TD::Types::ChatInviteLinkInfo

Checks the validity of an invite link for a chat and returns information about the corresponding chat.

Parameters:

Returns:



399
400
401
402
 
# File 'lib/tdlib/client_methods.rb', line 399

def check_chat_invite_link(invite_link)
  broadcast('@type'       => 'checkChatInviteLink',
            'invite_link' => invite_link)
end

#check_chat_username(chat_id, username) ⇒ TD::Types::CheckChatUsernameResult

Checks whether a username can be set for a chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier; should be identifier of a supergroup chat, or a channel chat, or a private chat with self, or zero if chat is being created.

  • username (String) —

    Username to be checked.

Returns:



410
411
412
413
414
 
# File 'lib/tdlib/client_methods.rb', line 410

def check_chat_username(chat_id, username)
  broadcast('@type'    => 'checkChatUsername',
            'chat_id'  => chat_id,
            'username' => username)
end

#check_database_encryption_key(encryption_key) ⇒ TD::Types::Ok

Checks the database encryption key for correctness. Works only when the current authorization state is authorizationStateWaitEncryptionKey.

Parameters:

  • encryption_key (String) —

    Encryption key to check or set up.

Returns:



421
422
423
424
 
# File 'lib/tdlib/client_methods.rb', line 421

def check_database_encryption_key(encryption_key)
  broadcast('@type'          => 'checkDatabaseEncryptionKey',
            'encryption_key' => encryption_key)
end

#check_email_address_verification_code(code) ⇒ TD::Types::Ok

Checks the email address verification code for Telegram Passport.

Parameters:

  • code (String) —

    Verification code.

Returns:



430
431
432
433
 
# File 'lib/tdlib/client_methods.rb', line 430

def check_email_address_verification_code(code)
  broadcast('@type' => 'checkEmailAddressVerificationCode',
            'code'  => code)
end

#check_phone_number_confirmation_code(code) ⇒ TD::Types::Ok

Checks phone number confirmation code.

Parameters:

  • code (String) —

    The phone number confirmation code.

Returns:



439
440
441
442
 
# File 'lib/tdlib/client_methods.rb', line 439

def check_phone_number_confirmation_code(code)
  broadcast('@type' => 'checkPhoneNumberConfirmationCode',
            'code'  => code)
end

#check_phone_number_verification_code(code) ⇒ TD::Types::Ok

Checks the phone number verification code for Telegram Passport.

Parameters:

  • code (String) —

    Verification code.

Returns:



448
449
450
451
 
# File 'lib/tdlib/client_methods.rb', line 448

def check_phone_number_verification_code(code)
  broadcast('@type' => 'checkPhoneNumberVerificationCode',
            'code'  => code)
end

#check_recovery_email_address_code(code) ⇒ TD::Types::PasswordState

Checks the 2-step verification recovery email address verification code.

Parameters:

  • code (String) —

    Verification code.

Returns:



457
458
459
460
 
# File 'lib/tdlib/client_methods.rb', line 457

def check_recovery_email_address_code(code)
  broadcast('@type' => 'checkRecoveryEmailAddressCode',
            'code'  => code)
end

#clean_file_name(file_name) ⇒ TD::Types::Text

Removes potentially dangerous characters from the name of a file. The encoding of the file name is supposed to be UTF-8. Returns an empty string on failure. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • file_name (String) —

    File name or path to the file.

Returns:



471
472
473
474
 
# File 'lib/tdlib/client_methods.rb', line 471

def clean_file_name(file_name)
  broadcast('@type'     => 'cleanFileName',
            'file_name' => file_name)
end

#clear_all_draft_messages(exclude_secret_chats) ⇒ TD::Types::Ok

Clears draft messages in all chats.

Parameters:

  • exclude_secret_chats (Boolean) —

    If true, local draft messages in secret chats will not be cleared.

Returns:



480
481
482
483
 
# File 'lib/tdlib/client_methods.rb', line 480

def clear_all_draft_messages(exclude_secret_chats)
  broadcast('@type'                => 'clearAllDraftMessages',
            'exclude_secret_chats' => exclude_secret_chats)
end

#clear_imported_contacts ⇒ TD::Types::Ok

Clears all imported contacts, contact list remains unchanged.

Returns:



488
489
490
 
# File 'lib/tdlib/client_methods.rb', line 488

def clear_imported_contacts
  broadcast('@type' => 'clearImportedContacts')
end

#clear_recent_stickers(is_attached) ⇒ TD::Types::Ok

Clears the list of recently used stickers.

Parameters:

  • is_attached (Boolean) —

    Pass true to clear the list of stickers recently attached to photo or video files; pass false to clear the list of recently sent stickers.

Returns:



497
498
499
500
 
# File 'lib/tdlib/client_methods.rb', line 497

def clear_recent_stickers(is_attached)
  broadcast('@type'       => 'clearRecentStickers',
            'is_attached' => is_attached)
end

#clear_recently_found_chats ⇒ TD::Types::Ok

Clears the list of recently found chats.

Returns:



505
506
507
 
# File 'lib/tdlib/client_methods.rb', line 505

def clear_recently_found_chats
  broadcast('@type' => 'clearRecentlyFoundChats')
end

#close ⇒ TD::Types::Ok

Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, updateAuthorizationState with authorizationStateClosed will be sent.

Returns:



514
515
516
 
# File 'lib/tdlib/client_methods.rb', line 514

def close
  broadcast('@type' => 'close')
end

#close_chat(chat_id) ⇒ TD::Types::Ok

Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



523
524
525
526
 
# File 'lib/tdlib/client_methods.rb', line 523

def close_chat(chat_id)
  broadcast('@type'   => 'closeChat',
            'chat_id' => chat_id)
end

#close_secret_chat(secret_chat_id) ⇒ TD::Types::Ok

Closes a secret chat, effectively transfering its state to secretChatStateClosed.

Parameters:

  • secret_chat_id (Integer) —

    Secret chat identifier.

Returns:



532
533
534
535
 
# File 'lib/tdlib/client_methods.rb', line 532

def close_secret_chat(secret_chat_id)
  broadcast('@type'          => 'closeSecretChat',
            'secret_chat_id' => secret_chat_id)
end

#create_basic_group_chat(basic_group_id, force) ⇒ TD::Types::Chat

Returns an existing chat corresponding to a known basic group.

Parameters:

  • basic_group_id (Integer) —

    Basic group identifier.

  • force (Boolean) —

    If true, the chat will be created without network request. In this case all information about the chat except its type, title and photo can be incorrect.

Returns:



543
544
545
546
547
 
# File 'lib/tdlib/client_methods.rb', line 543

def create_basic_group_chat(basic_group_id, force)
  broadcast('@type'          => 'createBasicGroupChat',
            'basic_group_id' => basic_group_id,
            'force'          => force)
end

#create_call(user_id, protocol) ⇒ TD::Types::CallId

Creates a new call.

Parameters:

  • user_id (Integer) —

    Identifier of the user to be called.

  • protocol (TD::Types::CallProtocol) —

    Description of the call protocols supported by the client.

Returns:



554
555
556
557
558
 
# File 'lib/tdlib/client_methods.rb', line 554

def create_call(user_id, protocol)
  broadcast('@type'    => 'createCall',
            'user_id'  => user_id,
            'protocol' => protocol)
end

#create_new_basic_group_chat(user_ids, title) ⇒ TD::Types::Chat

Creates a new basic group and sends a corresponding messageBasicGroupChatCreate. Returns the newly created chat.

Parameters:

  • user_ids (Array<Integer>) —

    Identifiers of users to be added to the basic group.

  • title (String) —

    Title of the new basic group; 1-128 characters.

Returns:



566
567
568
569
570
 
# File 'lib/tdlib/client_methods.rb', line 566

def create_new_basic_group_chat(user_ids, title)
  broadcast('@type'    => 'createNewBasicGroupChat',
            'user_ids' => user_ids,
            'title'    => title)
end

#create_new_secret_chat(user_id) ⇒ TD::Types::Chat

Creates a new secret chat. Returns the newly created chat.

Parameters:

  • user_id (Integer) —

    Identifier of the target user.

Returns:



577
578
579
580
 
# File 'lib/tdlib/client_methods.rb', line 577

def create_new_secret_chat(user_id)
  broadcast('@type'   => 'createNewSecretChat',
            'user_id' => user_id)
end

#create_new_sticker_set(user_id, title, name, is_masks, stickers) ⇒ TD::Types::StickerSet

Creates a new sticker set; for bots only. Returns the newly created sticker set.

Parameters:

  • user_id (Integer) —

    Sticker set owner.

  • title (String) —

    Sticker set title; 1-64 characters.

  • name (String) —

    Sticker set name. Can contain only English letters, digits and underscores. Must end with "by" ( is case insensitive); 1-64 characters.

  • is_masks (Boolean) —

    True, if stickers are masks.

  • stickers (Array<TD::Types::InputSticker>) —

    List of stickers to be added to the set.

Returns:



593
594
595
596
597
598
599
600
 
# File 'lib/tdlib/client_methods.rb', line 593

def create_new_sticker_set(user_id, title, name, is_masks, stickers)
  broadcast('@type'    => 'createNewStickerSet',
            'user_id'  => user_id,
            'title'    => title,
            'name'     => name,
            'is_masks' => is_masks,
            'stickers' => stickers)
end

#create_new_supergroup_chat(title, is_channel, description) ⇒ TD::Types::Chat

Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat.

Parameters:

  • title (String) —

    Title of the new chat; 1-128 characters.

  • is_channel (Boolean) —

    True, if a channel chat should be created.

  • description (String) —

    Chat description; 0-255 characters.

Returns:



609
610
611
612
613
614
 
# File 'lib/tdlib/client_methods.rb', line 609

def create_new_supergroup_chat(title, is_channel, description)
  broadcast('@type'       => 'createNewSupergroupChat',
            'title'       => title,
            'is_channel'  => is_channel,
            'description' => description)
end

#create_private_chat(user_id, force) ⇒ TD::Types::Chat

Returns an existing chat corresponding to a given user.

Parameters:

  • user_id (Integer) —

    User identifier.

  • force (Boolean) —

    If true, the chat will be created without network request. In this case all information about the chat except its type, title and photo can be incorrect.

Returns:



622
623
624
625
626
 
# File 'lib/tdlib/client_methods.rb', line 622

def create_private_chat(user_id, force)
  broadcast('@type'   => 'createPrivateChat',
            'user_id' => user_id,
            'force'   => force)
end

#create_secret_chat(secret_chat_id) ⇒ TD::Types::Chat

Returns an existing chat corresponding to a known secret chat.

Parameters:

  • secret_chat_id (Integer) —

    Secret chat identifier.

Returns:



632
633
634
635
 
# File 'lib/tdlib/client_methods.rb', line 632

def create_secret_chat(secret_chat_id)
  broadcast('@type'          => 'createSecretChat',
            'secret_chat_id' => secret_chat_id)
end

#create_supergroup_chat(supergroup_id, force) ⇒ TD::Types::Chat

Returns an existing chat corresponding to a known supergroup or channel.

Parameters:

  • supergroup_id (Integer) —

    Supergroup or channel identifier.

  • force (Boolean) —

    If true, the chat will be created without network request. In this case all information about the chat except its type, title and photo can be incorrect.

Returns:



643
644
645
646
647
 
# File 'lib/tdlib/client_methods.rb', line 643

def create_supergroup_chat(supergroup_id, force)
  broadcast('@type'         => 'createSupergroupChat',
            'supergroup_id' => supergroup_id,
            'force'         => force)
end

#create_temporary_password(password, valid_for) ⇒ TD::Types::TemporaryPasswordState

Creates a new temporary password for processing payments.

Parameters:

  • password (String) —

    Persistent user password.

  • valid_for (Integer) —

    Time during which the temporary password will be valid, in seconds; should be between 60 and 86400.

Returns:



655
656
657
658
659
 
# File 'lib/tdlib/client_methods.rb', line 655

def create_temporary_password(password, valid_for)
  broadcast('@type'     => 'createTemporaryPassword',
            'password'  => password,
            'valid_for' => valid_for)
end

#delete_account(reason = nil) ⇒ TD::Types::Ok

Deletes the account of the current user, deleting all information associated with the user from the server. The phone number of the account can be used to create a new account. Can be called before authorization when the current authorization state is authorizationStateWaitPassword.

Parameters:

  • reason (String, nil) (defaults to: nil) —

    The reason why the account was deleted; optional.

Returns:



667
668
669
670
 
# File 'lib/tdlib/client_methods.rb', line 667

def (reason = nil)
  broadcast('@type'  => 'deleteAccount',
            'reason' => reason)
end

#delete_chat_history(chat_id, remove_from_chat_list, revoke) ⇒ TD::Types::Ok

Deletes all messages in the chat. Use Chat.can_be_deleted_only_for_self and Chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • remove_from_chat_list (Boolean) —

    Pass true if the chat should be removed from the chat list.

  • revoke (Boolean) —

    Pass true to try to delete chat history for all users.

Returns:



680
681
682
683
684
685
 
# File 'lib/tdlib/client_methods.rb', line 680

def delete_chat_history(chat_id, remove_from_chat_list, revoke)
  broadcast('@type'                 => 'deleteChatHistory',
            'chat_id'               => chat_id,
            'remove_from_chat_list' => remove_from_chat_list,
            'revoke'                => revoke)
end

#delete_chat_messages_from_user(chat_id, user_id) ⇒ TD::Types::Ok

Deletes all messages sent by the specified user to a chat. Supported only in supergroups; requires can_delete_messages administrator privileges.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • user_id (Integer) —

    User identifier.

Returns:



693
694
695
696
697
 
# File 'lib/tdlib/client_methods.rb', line 693

def delete_chat_messages_from_user(chat_id, user_id)
  broadcast('@type'   => 'deleteChatMessagesFromUser',
            'chat_id' => chat_id,
            'user_id' => user_id)
end

#delete_chat_reply_markup(chat_id, message_id) ⇒ TD::Types::Ok

Deletes the default reply markup from a chat. Must be called after a one-time keyboard or a ForceReply reply markup has been used. UpdateChatReplyMarkup will be sent if the reply markup will be changed.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • message_id (Integer) —

    The message identifier of the used keyboard.

Returns:



706
707
708
709
710
 
# File 'lib/tdlib/client_methods.rb', line 706

def delete_chat_reply_markup(chat_id, message_id)
  broadcast('@type'      => 'deleteChatReplyMarkup',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#delete_file(file_id) ⇒ TD::Types::Ok

Deletes a file from the TDLib file cache.

Parameters:

  • file_id (Integer) —

    Identifier of the file to delete.

Returns:



716
717
718
719
 
# File 'lib/tdlib/client_methods.rb', line 716

def delete_file(file_id)
  broadcast('@type'   => 'deleteFile',
            'file_id' => file_id)
end

#delete_language_pack(language_pack_id) ⇒ TD::Types::Ok

Deletes all information about a language pack in the current localization target. The language pack which is currently in use (including base language pack) or is being synchronized can't be deleted. Can be called before authorization.

Parameters:

  • language_pack_id (String) —

    Identifier of the language pack to delete.

Returns:



728
729
730
731
 
# File 'lib/tdlib/client_methods.rb', line 728

def delete_language_pack(language_pack_id)
  broadcast('@type'            => 'deleteLanguagePack',
            'language_pack_id' => language_pack_id)
end

#delete_messages(chat_id, message_ids, revoke) ⇒ TD::Types::Ok

Deletes messages.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • message_ids (Array<Integer>) —

    Identifiers of the messages to be deleted.

  • revoke (Boolean) —

    Pass true to try to delete messages for all chat members. Always true for supergroups, channels and secret chats.

Returns:



740
741
742
743
744
745
 
# File 'lib/tdlib/client_methods.rb', line 740

def delete_messages(chat_id, message_ids, revoke)
  broadcast('@type'       => 'deleteMessages',
            'chat_id'     => chat_id,
            'message_ids' => message_ids,
            'revoke'      => revoke)
end

#delete_passport_element(type) ⇒ TD::Types::Ok

Deletes a Telegram Passport element.

Parameters:

Returns:



751
752
753
754
 
# File 'lib/tdlib/client_methods.rb', line 751

def delete_passport_element(type)
  broadcast('@type' => 'deletePassportElement',
            'type'  => type)
end

#delete_profile_photo(profile_photo_id) ⇒ TD::Types::Ok

Deletes a profile photo. If something changes, updateUser will be sent.

Parameters:

  • profile_photo_id (Integer) —

    Identifier of the profile photo to delete.

Returns:



761
762
763
764
 
# File 'lib/tdlib/client_methods.rb', line 761

def delete_profile_photo(profile_photo_id)
  broadcast('@type'            => 'deleteProfilePhoto',
            'profile_photo_id' => profile_photo_id)
end

#delete_saved_credentials ⇒ TD::Types::Ok

Deletes saved credentials for all payment provider bots.

Returns:



769
770
771
 
# File 'lib/tdlib/client_methods.rb', line 769

def delete_saved_credentials
  broadcast('@type' => 'deleteSavedCredentials')
end

#delete_saved_order_info ⇒ TD::Types::Ok

Deletes saved order info.

Returns:



776
777
778
 
# File 'lib/tdlib/client_methods.rb', line 776

def delete_saved_order_info
  broadcast('@type' => 'deleteSavedOrderInfo')
end

#delete_supergroup(supergroup_id) ⇒ TD::Types::Ok

Deletes a supergroup or channel along with all messages in the corresponding chat. This will release the supergroup or channel username and remove all members; requires creator privileges in the supergroup or channel. Chats with more than 1000 members can't be deleted using this method.

Parameters:

  • supergroup_id (Integer) —

    Identifier of the supergroup or channel.

Returns:



787
788
789
790
 
# File 'lib/tdlib/client_methods.rb', line 787

def delete_supergroup(supergroup_id)
  broadcast('@type'         => 'deleteSupergroup',
            'supergroup_id' => supergroup_id)
end

#destroy ⇒ TD::Types::Ok

Closes the TDLib instance, destroying all local data without a proper logout. The current user session will remain in the list of all active sessions. All local data will be destroyed. After the destruction completes updateAuthorizationState with authorizationStateClosed will be sent.

Returns:



798
799
800
 
# File 'lib/tdlib/client_methods.rb', line 798

def destroy
  broadcast('@type' => 'destroy')
end

#disable_proxy ⇒ TD::Types::Ok

Disables the currently enabled proxy. Can be called before authorization.

Returns:



806
807
808
 
# File 'lib/tdlib/client_methods.rb', line 806

def disable_proxy
  broadcast('@type' => 'disableProxy')
end

#discard_call(call_id, is_disconnected, duration, connection_id) ⇒ TD::Types::Ok

Discards a call.

Parameters:

  • call_id (Integer) —

    Call identifier.

  • is_disconnected (Boolean) —

    True, if the user was disconnected.

  • duration (Integer) —

    The call duration, in seconds.

  • connection_id (Integer) —

    Identifier of the connection used during the call.

Returns:



817
818
819
820
821
822
823
 
# File 'lib/tdlib/client_methods.rb', line 817

def discard_call(call_id, is_disconnected, duration, connection_id)
  broadcast('@type'           => 'discardCall',
            'call_id'         => call_id,
            'is_disconnected' => is_disconnected,
            'duration'        => duration,
            'connection_id'   => connection_id)
end

#disconnect_all_websites ⇒ TD::Types::Ok

Disconnects all websites from the current user's Telegram account.

Returns:



828
829
830
 
# File 'lib/tdlib/client_methods.rb', line 828

def disconnect_all_websites
  broadcast('@type' => 'disconnectAllWebsites')
end

#disconnect_website(website_id) ⇒ TD::Types::Ok

Disconnects website from the current user's Telegram account.

Parameters:

  • website_id (Integer) —

    Website identifier.

Returns:



836
837
838
839
 
# File 'lib/tdlib/client_methods.rb', line 836

def disconnect_website(website_id)
  broadcast('@type'      => 'disconnectWebsite',
            'website_id' => website_id)
end

#download_file(file_id, priority, offset, limit, synchronous) ⇒ TD::Types::File

Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates.

Parameters:

  • file_id (Integer) —

    Identifier of the file to download.

  • priority (Integer) —

    Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile was called will be downloaded first.

  • offset (Integer) —

    The starting position from which the file should be downloaded.

  • limit (Integer) —

    Number of bytes which should be downloaded starting from the "offset" position before the download will be automatically cancelled; use 0 to download without a limit.

  • synchronous (Boolean) —

    If false, this request returns file state just after the download has been started. If true, this request returns file state only after the download has succeeded, has failed, has been cancelled or a new downloadFile request with different offset/limit parameters was sent.

Returns:



856
857
858
859
860
861
862
863
 
# File 'lib/tdlib/client_methods.rb', line 856

def download_file(file_id, priority, offset, limit, synchronous)
  broadcast('@type'       => 'downloadFile',
            'file_id'     => file_id,
            'priority'    => priority,
            'offset'      => offset,
            'limit'       => limit,
            'synchronous' => synchronous)
end

#edit_custom_language_pack_info(info) ⇒ TD::Types::Ok

Edits information about a custom local language pack in the current localization target. Can be called before authorization.

Parameters:

Returns:



870
871
872
873
 
# File 'lib/tdlib/client_methods.rb', line 870

def edit_custom_language_pack_info(info)
  broadcast('@type' => 'editCustomLanguagePackInfo',
            'info'  => info)
end

#edit_inline_message_caption(inline_message_id, reply_markup, caption) ⇒ TD::Types::Ok

Edits the caption of an inline message sent via a bot; for bots only.

Parameters:

  • inline_message_id (String) —

    Inline message identifier.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup.

  • caption (TD::Types::FormattedText) —

    New message content caption; 0-GetOption("message_caption_length_max") characters.

Returns:



882
883
884
885
886
887
 
# File 'lib/tdlib/client_methods.rb', line 882

def edit_inline_message_caption(inline_message_id, reply_markup, caption)
  broadcast('@type'             => 'editInlineMessageCaption',
            'inline_message_id' => inline_message_id,
            'reply_markup'      => reply_markup,
            'caption'           => caption)
end

#edit_inline_message_live_location(inline_message_id, reply_markup, location = nil) ⇒ TD::Types::Ok

Edits the content of a live location in an inline message sent via a bot; for bots only.

Parameters:

  • inline_message_id (String) —

    Inline message identifier.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup.

  • location (TD::Types::Location, nil) (defaults to: nil) —

    New location content of the message; may be null. Pass null to stop sharing the live location.

Returns:



896
897
898
899
900
901
 
# File 'lib/tdlib/client_methods.rb', line 896

def edit_inline_message_live_location(inline_message_id, reply_markup, location = nil)
  broadcast('@type'             => 'editInlineMessageLiveLocation',
            'inline_message_id' => inline_message_id,
            'reply_markup'      => reply_markup,
            'location'          => location)
end

#edit_inline_message_media(inline_message_id, reply_markup, input_message_content) ⇒ TD::Types::Ok

Edits the content of a message with an animation, an audio, a document, a photo or a video in an inline message sent via a bot; for bots only.

Parameters:

  • inline_message_id (String) —

    Inline message identifier.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup; for bots only.

  • input_message_content (TD::Types::InputMessageContent) —

    New content of the message. Must be one of the following types: InputMessageAnimation, InputMessageAudio, InputMessageDocument, InputMessagePhoto or InputMessageVideo.

Returns:



912
913
914
915
916
917
 
# File 'lib/tdlib/client_methods.rb', line 912

def edit_inline_message_media(inline_message_id, reply_markup, input_message_content)
  broadcast('@type'                 => 'editInlineMessageMedia',
            'inline_message_id'     => inline_message_id,
            'reply_markup'          => reply_markup,
            'input_message_content' => input_message_content)
end

#edit_inline_message_reply_markup(inline_message_id, reply_markup) ⇒ TD::Types::Ok

Edits the reply markup of an inline message sent via a bot; for bots only.

Parameters:

  • inline_message_id (String) —

    Inline message identifier.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup.

Returns:



924
925
926
927
928
 
# File 'lib/tdlib/client_methods.rb', line 924

def edit_inline_message_reply_markup(inline_message_id, reply_markup)
  broadcast('@type'             => 'editInlineMessageReplyMarkup',
            'inline_message_id' => inline_message_id,
            'reply_markup'      => reply_markup)
end

#edit_inline_message_text(inline_message_id, reply_markup, input_message_content) ⇒ TD::Types::Ok

Edits the text of an inline text or game message sent via a bot; for bots only.

Parameters:

Returns:



937
938
939
940
941
942
 
# File 'lib/tdlib/client_methods.rb', line 937

def edit_inline_message_text(inline_message_id, reply_markup, input_message_content)
  broadcast('@type'                 => 'editInlineMessageText',
            'inline_message_id'     => inline_message_id,
            'reply_markup'          => reply_markup,
            'input_message_content' => input_message_content)
end

#edit_message_caption(chat_id, message_id, reply_markup, caption) ⇒ TD::Types::Message

Edits the message content caption. Returns the edited message after the edit is completed on the server side.

Parameters:

  • chat_id (Integer) —

    The chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup; for bots only.

  • caption (TD::Types::FormattedText) —

    New message content caption; 0-GetOption("message_caption_length_max") characters.

Returns:



953
954
955
956
957
958
959
 
# File 'lib/tdlib/client_methods.rb', line 953

def edit_message_caption(chat_id, message_id, reply_markup, caption)
  broadcast('@type'        => 'editMessageCaption',
            'chat_id'      => chat_id,
            'message_id'   => message_id,
            'reply_markup' => reply_markup,
            'caption'      => caption)
end

#edit_message_live_location(chat_id, message_id, reply_markup, location = nil) ⇒ TD::Types::Message

Edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side.

Parameters:

  • chat_id (Integer) —

    The chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup; for bots only.

  • location (TD::Types::Location, nil) (defaults to: nil) —

    New location content of the message; may be null. Pass null to stop sharing the live location.

Returns:



971
972
973
974
975
976
977
 
# File 'lib/tdlib/client_methods.rb', line 971

def edit_message_live_location(chat_id, message_id, reply_markup, location = nil)
  broadcast('@type'        => 'editMessageLiveLocation',
            'chat_id'      => chat_id,
            'message_id'   => message_id,
            'reply_markup' => reply_markup,
            'location'     => location)
end

#edit_message_media(chat_id, message_id, reply_markup, input_message_content) ⇒ TD::Types::Message

Edits the content of a message with an animation, an audio, a document, a photo or a video. The media in the message can't be replaced if the message was set to self-destruct. Media can't be replaced by self-destructing media. Media in an album can be edited only to contain a photo or a video. Returns the edited message after the edit is completed on the server side.

Parameters:

  • chat_id (Integer) —

    The chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup; for bots only.

  • input_message_content (TD::Types::InputMessageContent) —

    New content of the message. Must be one of the following types: InputMessageAnimation, InputMessageAudio, InputMessageDocument, InputMessagePhoto or InputMessageVideo.

Returns:



992
993
994
995
996
997
998
 
# File 'lib/tdlib/client_methods.rb', line 992

def edit_message_media(chat_id, message_id, reply_markup, input_message_content)
  broadcast('@type'                 => 'editMessageMedia',
            'chat_id'               => chat_id,
            'message_id'            => message_id,
            'reply_markup'          => reply_markup,
            'input_message_content' => input_message_content)
end

#edit_message_reply_markup(chat_id, message_id, reply_markup) ⇒ TD::Types::Message

Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side.

Parameters:

  • chat_id (Integer) —

    The chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup.

Returns:



1007
1008
1009
1010
1011
1012
 
# File 'lib/tdlib/client_methods.rb', line 1007

def edit_message_reply_markup(chat_id, message_id, reply_markup)
  broadcast('@type'        => 'editMessageReplyMarkup',
            'chat_id'      => chat_id,
            'message_id'   => message_id,
            'reply_markup' => reply_markup)
end

#edit_message_text(chat_id, message_id, reply_markup, input_message_content) ⇒ TD::Types::Message

Edits the text of a message (or a text of a game message). Returns the edited message after the edit is completed on the server side.

Parameters:

  • chat_id (Integer) —

    The chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup; for bots only.

  • input_message_content (TD::Types::InputMessageContent) —

    New text content of the message. Should be of type InputMessageText.

Returns:



1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/tdlib/client_methods.rb', line 1023

def edit_message_text(chat_id, message_id, reply_markup, input_message_content)
  broadcast('@type'                 => 'editMessageText',
            'chat_id'               => chat_id,
            'message_id'            => message_id,
            'reply_markup'          => reply_markup,
            'input_message_content' => input_message_content)
end

#edit_proxy(proxy_id, server, port, enable, type) ⇒ TD::Types::Proxy

Edits an existing proxy server for network requests. Can be called before authorization.

Parameters:

  • proxy_id (Integer) —

    Proxy identifier.

  • server (String) —

    Proxy server IP address.

  • port (Integer) —

    Proxy server port.

  • enable (Boolean) —

    True, if the proxy should be enabled.

  • type (TD::Types::ProxyType) —

    Proxy type.

Returns:



1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/tdlib/client_methods.rb', line 1040

def edit_proxy(proxy_id, server, port, enable, type)
  broadcast('@type'    => 'editProxy',
            'proxy_id' => proxy_id,
            'server'   => server,
            'port'     => port,
            'enable'   => enable,
            'type'     => type)
end

#enable_proxy(proxy_id) ⇒ TD::Types::Ok

Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization.

Parameters:

  • proxy_id (Integer) —

    Proxy identifier.

Returns:



1055
1056
1057
1058
 
# File 'lib/tdlib/client_methods.rb', line 1055

def enable_proxy(proxy_id)
  broadcast('@type'    => 'enableProxy',
            'proxy_id' => proxy_id)
end

#finish_file_generation(generation_id, error) ⇒ TD::Types::Ok

Finishes the file generation.

Parameters:

  • generation_id (Integer) —

    The identifier of the generation process.

  • error (TD::Types::Error) —

    If set, means that file generation has failed and should be terminated.

Returns:



1065
1066
1067
1068
1069
 
# File 'lib/tdlib/client_methods.rb', line 1065

def finish_file_generation(generation_id, error)
  broadcast('@type'         => 'finishFileGeneration',
            'generation_id' => generation_id,
            'error'         => error)
end

#forward_messages(chat_id, from_chat_id, message_ids, disable_notification, from_background, as_album, send_copy, remove_caption) ⇒ TD::Types::Messages

Forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can't be forwarded, null will be returned instead of the message.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to which to forward messages.

  • from_chat_id (Integer) —

    Identifier of the chat from which to forward messages.

  • message_ids (Array<Integer>) —

    Identifiers of the messages to forward.

  • disable_notification (Boolean) —

    Pass true to disable notification for the message, doesn't work if messages are forwarded to a secret chat.

  • from_background (Boolean) —

    Pass true if the messages are sent from the background.

  • as_album (Boolean) —

    True, if the messages should be grouped into an album after forwarding. For this to work, no more than 10 messages may be forwarded, and all of them must be photo or video messages.

  • send_copy (Boolean) —

    True, if content of the messages needs to be copied without links to the original messages. Always true if the messages are forwarded to a secret chat.

  • remove_caption (Boolean) —

    True, if media captions of message copies needs to be removed. Ignored if send_copy is false.

Returns:



1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/tdlib/client_methods.rb', line 1089

def forward_messages(chat_id, from_chat_id, message_ids, disable_notification, from_background, as_album, send_copy,
                     remove_caption)
  broadcast('@type'                => 'forwardMessages',
            'chat_id'              => chat_id,
            'from_chat_id'         => from_chat_id,
            'message_ids'          => message_ids,
            'disable_notification' => disable_notification,
            'from_background'      => from_background,
            'as_album'             => as_album,
            'send_copy'            => send_copy,
            'remove_caption'       => remove_caption)
end

#generate_chat_invite_link(chat_id) ⇒ TD::Types::ChatInviteLink

Generates a new invite link for a chat; the previously generated link is revoked. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



1108
1109
1110
1111
 
# File 'lib/tdlib/client_methods.rb', line 1108

def generate_chat_invite_link(chat_id)
  broadcast('@type'   => 'generateChatInviteLink',
            'chat_id' => chat_id)
end

#get_account_ttl ⇒ TD::Types::AccountTtl

Returns the period of inactivity after which the account of the current user will automatically be deleted.

Returns:



1116
1117
1118
 
# File 'lib/tdlib/client_methods.rb', line 1116

def 
  broadcast('@type' => 'getAccountTtl')
end

#get_active_live_location_messages ⇒ TD::Types::Messages

Returns all active live locations that should be updated by the client. The list is persistent across application restarts only if the message database is used.

Returns:



1124
1125
1126
 
# File 'lib/tdlib/client_methods.rb', line 1124

def get_active_live_location_messages
  broadcast('@type' => 'getActiveLiveLocationMessages')
end

#get_active_sessions ⇒ TD::Types::Sessions

Returns all active sessions of the current user.

Returns:



1131
1132
1133
 
# File 'lib/tdlib/client_methods.rb', line 1131

def get_active_sessions
  broadcast('@type' => 'getActiveSessions')
end

#get_all_passport_elements(password) ⇒ TD::Types::PassportElements

Returns all available Telegram Passport elements.

Parameters:

  • password (String) —

    Password of the current user.

Returns:



1139
1140
1141
1142
 
# File 'lib/tdlib/client_methods.rb', line 1139

def get_all_passport_elements(password)
  broadcast('@type'    => 'getAllPassportElements',
            'password' => password)
end

#get_application_config ⇒ TD::Types::JsonValue

Returns application config, provided by the server. Can be called before authorization.

Returns:



1148
1149
1150
 
# File 'lib/tdlib/client_methods.rb', line 1148

def get_application_config
  broadcast('@type' => 'getApplicationConfig')
end

#get_archived_sticker_sets(is_masks, offset_sticker_set_id, limit) ⇒ TD::Types::StickerSets

Returns a list of archived sticker sets.

Parameters:

  • is_masks (Boolean) —

    Pass true to return mask stickers sets; pass false to return ordinary sticker sets.

  • offset_sticker_set_id (Integer) —

    Identifier of the sticker set from which to return the result.

  • limit (Integer) —

    Maximum number of sticker sets to return.

Returns:



1158
1159
1160
1161
1162
1163
 
# File 'lib/tdlib/client_methods.rb', line 1158

def get_archived_sticker_sets(is_masks, offset_sticker_set_id, limit)
  broadcast('@type'                 => 'getArchivedStickerSets',
            'is_masks'              => is_masks,
            'offset_sticker_set_id' => offset_sticker_set_id,
            'limit'                 => limit)
end

#get_attached_sticker_sets(file_id) ⇒ TD::Types::StickerSets

Returns a list of sticker sets attached to a file. Currently only photos and videos can have attached sticker sets.

Parameters:

  • file_id (Integer) —

    File identifier.

Returns:



1170
1171
1172
1173
 
# File 'lib/tdlib/client_methods.rb', line 1170

def get_attached_sticker_sets(file_id)
  broadcast('@type'   => 'getAttachedStickerSets',
            'file_id' => file_id)
end

#get_authorization_state ⇒ TD::Types::AuthorizationState

Returns the current authorization state; this is an offline request. For informational purposes only. Use updateAuthorizationState instead to maintain the current authorization state.

Returns:



1180
1181
1182
 
# File 'lib/tdlib/client_methods.rb', line 1180

def get_authorization_state
  broadcast('@type' => 'getAuthorizationState')
end

#get_auto_download_settings_presets ⇒ TD::Types::AutoDownloadSettingsPresets

Returns auto-download settings presets for the currently logged in user.

Returns:



1187
1188
1189
 
# File 'lib/tdlib/client_methods.rb', line 1187

def get_auto_download_settings_presets
  broadcast('@type' => 'getAutoDownloadSettingsPresets')
end

#get_background_url(name, type) ⇒ TD::Types::HttpUrl

Constructs a persistent HTTP URL for a background.

Parameters:

Returns:



1196
1197
1198
1199
1200
 
# File 'lib/tdlib/client_methods.rb', line 1196

def get_background_url(name, type)
  broadcast('@type' => 'getBackgroundUrl',
            'name'  => name,
            'type'  => type)
end

#get_backgrounds(for_dark_theme) ⇒ TD::Types::Backgrounds

Returns backgrounds installed by the user.

Parameters:

  • for_dark_theme (Boolean) —

    True, if the backgrounds needs to be ordered for dark theme.

Returns:



1206
1207
1208
1209
 
# File 'lib/tdlib/client_methods.rb', line 1206

def get_backgrounds(for_dark_theme)
  broadcast('@type'          => 'getBackgrounds',
            'for_dark_theme' => for_dark_theme)
end

#get_basic_group(basic_group_id) ⇒ TD::Types::BasicGroup

Returns information about a basic group by its identifier. This is an offline request if the current user is not a bot.

Parameters:

  • basic_group_id (Integer) —

    Basic group identifier.

Returns:



1216
1217
1218
1219
 
# File 'lib/tdlib/client_methods.rb', line 1216

def get_basic_group(basic_group_id)
  broadcast('@type'          => 'getBasicGroup',
            'basic_group_id' => basic_group_id)
end

#get_basic_group_full_info(basic_group_id) ⇒ TD::Types::BasicGroupFullInfo

Returns full information about a basic group by its identifier.

Parameters:

  • basic_group_id (Integer) —

    Basic group identifier.

Returns:



1225
1226
1227
1228
 
# File 'lib/tdlib/client_methods.rb', line 1225

def get_basic_group_full_info(basic_group_id)
  broadcast('@type'          => 'getBasicGroupFullInfo',
            'basic_group_id' => basic_group_id)
end

#get_blocked_users(offset, limit) ⇒ TD::Types::Users

Returns users that were blocked by the current user.

Parameters:

  • offset (Integer) —

    Number of users to skip in the result; must be non-negative.

  • limit (Integer) —

    Maximum number of users to return; up to 100.

Returns:



1235
1236
1237
1238
1239
 
# File 'lib/tdlib/client_methods.rb', line 1235

def get_blocked_users(offset, limit)
  broadcast('@type'  => 'getBlockedUsers',
            'offset' => offset,
            'limit'  => limit)
end

#get_callback_query_answer(chat_id, message_id, payload) ⇒ TD::Types::CallbackQueryAnswer

Sends a callback query to a bot and returns an answer. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat with the message.

  • message_id (Integer) —

    Identifier of the message from which the query originated.

  • payload (TD::Types::CallbackQueryPayload) —

    Query payload.

Returns:



1248
1249
1250
1251
1252
1253
 
# File 'lib/tdlib/client_methods.rb', line 1248

def get_callback_query_answer(chat_id, message_id, payload)
  broadcast('@type'      => 'getCallbackQueryAnswer',
            'chat_id'    => chat_id,
            'message_id' => message_id,
            'payload'    => payload)
end

#get_chat(chat_id) ⇒ TD::Types::Chat

Returns information about a chat by its identifier, this is an offline request if the current user is not a bot.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



1259
1260
1261
1262
 
# File 'lib/tdlib/client_methods.rb', line 1259

def get_chat(chat_id)
  broadcast('@type'   => 'getChat',
            'chat_id' => chat_id)
end

#get_chat_administrators(chat_id) ⇒ TD::Types::Users

Returns a list of users who are administrators of the chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



1268
1269
1270
1271
 
# File 'lib/tdlib/client_methods.rb', line 1268

def get_chat_administrators(chat_id)
  broadcast('@type'   => 'getChatAdministrators',
            'chat_id' => chat_id)
end

#get_chat_event_log(chat_id, query, from_event_id, limit, filters, user_ids) ⇒ TD::Types::ChatEvents

Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only in supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i. e., in order of decreasing event_id).

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • query (String) —

    Search query by which to filter events.

  • from_event_id (Integer) —

    Identifier of an event from which to return results. Use 0 to get results from the latest events.

  • limit (Integer) —

    Maximum number of events to return; up to 100.

  • filters (TD::Types::ChatEventLogFilters) —

    The types of events to return. By default, all types will be returned.

  • user_ids (Array<Integer>) —

    User identifiers by which to filter events. By default, events relating to all users will be returned.

Returns:



1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/tdlib/client_methods.rb', line 1289

def get_chat_event_log(chat_id, query, from_event_id, limit, filters, user_ids)
  broadcast('@type'         => 'getChatEventLog',
            'chat_id'       => chat_id,
            'query'         => query,
            'from_event_id' => from_event_id,
            'limit'         => limit,
            'filters'       => filters,
            'user_ids'      => user_ids)
end

#get_chat_history(chat_id, from_message_id, offset, limit, only_local) ⇒ TD::Types::Messages

Returns messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance the number of returned messages is chosen by the library. This is an offline request if only_local is true.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • from_message_id (Integer) —

    Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.

  • offset (Integer) —

    Specify 0 to get results from exactly the from_message_id or a negative offset up to 99 to get additionally some newer messages.

  • limit (Integer) —

    The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater or equal to -offset. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.

  • only_local (Boolean) —

    If true, returns only messages that are available locally without sending network requests.

Returns:



1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/tdlib/client_methods.rb', line 1317

def get_chat_history(chat_id, from_message_id, offset, limit, only_local)
  broadcast('@type'           => 'getChatHistory',
            'chat_id'         => chat_id,
            'from_message_id' => from_message_id,
            'offset'          => offset,
            'limit'           => limit,
            'only_local'      => only_local)
end

#get_chat_member(chat_id, user_id) ⇒ TD::Types::ChatMember

Returns information about a single member of a chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • user_id (Integer) —

    User identifier.

Returns:



1331
1332
1333
1334
1335
 
# File 'lib/tdlib/client_methods.rb', line 1331

def get_chat_member(chat_id, user_id)
  broadcast('@type'   => 'getChatMember',
            'chat_id' => chat_id,
            'user_id' => user_id)
end

#get_chat_message_by_date(chat_id, date) ⇒ TD::Types::Message

Returns the last message sent in a chat no later than the specified date.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • date (Integer) —

    Point in time (Unix timestamp) relative to which to search for messages.

Returns:



1342
1343
1344
1345
1346
 
# File 'lib/tdlib/client_methods.rb', line 1342

def get_chat_message_by_date(chat_id, date)
  broadcast('@type'   => 'getChatMessageByDate',
            'chat_id' => chat_id,
            'date'    => date)
end

#get_chat_message_count(chat_id, filter, return_local) ⇒ TD::Types::Count

Returns approximate number of messages of the specified type in the chat.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat in which to count messages.

  • filter (TD::Types::SearchMessagesFilter) —

    Filter for message content; Types::SearchMessagesFilter::Empty is unsupported in this function.

  • return_local (Boolean) —

    If true, returns count that is available locally without sending network requests, returning -1 if the number of messages is unknown.

Returns:



1356
1357
1358
1359
1360
1361
 
# File 'lib/tdlib/client_methods.rb', line 1356

def get_chat_message_count(chat_id, filter, return_local)
  broadcast('@type'        => 'getChatMessageCount',
            'chat_id'      => chat_id,
            'filter'       => filter,
            'return_local' => return_local)
end

#get_chat_notification_settings_exceptions(scope, compare_sound) ⇒ TD::Types::Chats

Returns list of chats with non-default notification settings.

Parameters:

  • scope (TD::Types::NotificationSettingsScope) —

    If specified, only chats from the specified scope will be returned.

  • compare_sound (Boolean) —

    If true, also chats with non-default sound will be returned.

Returns:



1369
1370
1371
1372
1373
 
# File 'lib/tdlib/client_methods.rb', line 1369

def get_chat_notification_settings_exceptions(scope, compare_sound)
  broadcast('@type'         => 'getChatNotificationSettingsExceptions',
            'scope'         => scope,
            'compare_sound' => compare_sound)
end

#get_chat_pinned_message(chat_id) ⇒ TD::Types::Message

Returns information about a pinned chat message.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat the message belongs to.

Returns:



1379
1380
1381
1382
 
# File 'lib/tdlib/client_methods.rb', line 1379

def get_chat_pinned_message(chat_id)
  broadcast('@type'   => 'getChatPinnedMessage',
            'chat_id' => chat_id)
end

#get_chat_report_spam_state(chat_id) ⇒ TD::Types::ChatReportSpamState

Returns information on whether the current chat can be reported as spam.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



1388
1389
1390
1391
 
# File 'lib/tdlib/client_methods.rb', line 1388

def get_chat_report_spam_state(chat_id)
  broadcast('@type'   => 'getChatReportSpamState',
            'chat_id' => chat_id)
end

#get_chat_statistics_url(chat_id, parameters, is_dark) ⇒ TD::Types::HttpUrl

Returns an HTTP URL with the chat statistics. Currently this method can be used only for channels.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • parameters (String) —

    Parameters from "tg://statsrefresh?params=******" link.

  • is_dark (Boolean) —

    Pass true if a URL with the dark theme must be returned.

Returns:



1400
1401
1402
1403
1404
1405
 
# File 'lib/tdlib/client_methods.rb', line 1400

def get_chat_statistics_url(chat_id, parameters, is_dark)
  broadcast('@type'      => 'getChatStatisticsUrl',
            'chat_id'    => chat_id,
            'parameters' => parameters,
            'is_dark'    => is_dark)
end

#get_chats(offset_order, offset_chat_id, limit) ⇒ TD::Types::Chats

Returns an ordered list of chats. Chats are sorted by the pair (order, chat_id) in decreasing order. (For example, to get a list of chats from the beginning, the offset_order should be equal to a biggest signed 64-bit number 9223372036854775807 == 2^63 - 1). For optimal performance the number of returned chats is chosen by the library.

Parameters:

  • offset_order (Integer) —

    Chat order to return chats from.

  • offset_chat_id (Integer) —

    Chat identifier to return chats from.

  • limit (Integer) —

    The maximum number of chats to be returned. It is possible that fewer chats than the limit are returned even if the end of the list is not reached.

Returns:



1418
1419
1420
1421
1422
1423
 
# File 'lib/tdlib/client_methods.rb', line 1418

def get_chats(offset_order, offset_chat_id, limit)
  broadcast('@type'          => 'getChats',
            'offset_order'   => offset_order,
            'offset_chat_id' => offset_chat_id,
            'limit'          => limit)
end

#get_connected_websites ⇒ TD::Types::ConnectedWebsites

Returns all website where the current user used Telegram to log in.

Returns:



1428
1429
1430
 
# File 'lib/tdlib/client_methods.rb', line 1428

def get_connected_websites
  broadcast('@type' => 'getConnectedWebsites')
end

#get_contacts ⇒ TD::Types::Users

Returns all user contacts.

Returns:



1435
1436
1437
 
# File 'lib/tdlib/client_methods.rb', line 1435

def get_contacts
  broadcast('@type' => 'getContacts')
end

#get_country_code ⇒ TD::Types::Text

Uses current user IP to found their country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization.

Returns:



1444
1445
1446
 
# File 'lib/tdlib/client_methods.rb', line 1444

def get_country_code
  broadcast('@type' => 'getCountryCode')
end

#get_created_public_chats ⇒ TD::Types::Chats

Returns a list of public chats with username created by the user.

Returns:



1451
1452
1453
 
# File 'lib/tdlib/client_methods.rb', line 1451

def get_created_public_chats
  broadcast('@type' => 'getCreatedPublicChats')
end

#get_current_state ⇒ TD::Types::Updates

Returns all updates needed to restore current TDLib state, i.e. all actual UpdateAuthorizationState/UpdateUser/UpdateNewChat and others. This is especially usefull if TDLib is run in a separate process. This is an offline method. Can be called before authorization.

Returns:



1462
1463
1464
 
# File 'lib/tdlib/client_methods.rb', line 1462

def get_current_state
  broadcast('@type' => 'getCurrentState')
end

#get_database_statistics ⇒ TD::Types::DatabaseStatistics

Returns database statistics.

Returns:



1469
1470
1471
 
# File 'lib/tdlib/client_methods.rb', line 1469

def get_database_statistics
  broadcast('@type' => 'getDatabaseStatistics')
end

#get_deep_link_info(link) ⇒ TD::Types::DeepLinkInfo

Returns information about a tg:// deep link. Use "tg://need_update_for_some_feature" or "tg:some_unsupported_feature" for testing. Returns a 404 error for unknown links. Can be called before authorization.

Parameters:

  • link (String) —

    The link.

Returns:



1480
1481
1482
1483
 
# File 'lib/tdlib/client_methods.rb', line 1480

def get_deep_link_info(link)
  broadcast('@type' => 'getDeepLinkInfo',
            'link'  => link)
end

#get_emoji_suggestions_url(language_code) ⇒ TD::Types::HttpUrl

Returns an HTTP URL which can be used to automatically log in to the translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation.

Parameters:

  • language_code (String) —

    Language code for which the emoji replacements will be suggested.

Returns:



1491
1492
1493
1494
 
# File 'lib/tdlib/client_methods.rb', line 1491

def get_emoji_suggestions_url(language_code)
  broadcast('@type'         => 'getEmojiSuggestionsUrl',
            'language_code' => language_code)
end

#get_favorite_stickers ⇒ TD::Types::Stickers

Returns favorite stickers.

Returns:



1499
1500
1501
 
# File 'lib/tdlib/client_methods.rb', line 1499

def get_favorite_stickers
  broadcast('@type' => 'getFavoriteStickers')
end

#get_file(file_id) ⇒ TD::Types::File

Returns information about a file; this is an offline request.

Parameters:

  • file_id (Integer) —

    Identifier of the file to get.

Returns:



1507
1508
1509
1510
 
# File 'lib/tdlib/client_methods.rb', line 1507

def get_file(file_id)
  broadcast('@type'   => 'getFile',
            'file_id' => file_id)
end

#get_file_downloaded_prefix_size(file_id, offset) ⇒ TD::Types::Count

Returns file downloaded prefix size from a given offset.

Parameters:

  • file_id (Integer) —

    Identifier of the file.

  • offset (Integer) —

    Offset from which downloaded prefix size should be calculated.

Returns:



1517
1518
1519
1520
1521
 
# File 'lib/tdlib/client_methods.rb', line 1517

def get_file_downloaded_prefix_size(file_id, offset)
  broadcast('@type'   => 'getFileDownloadedPrefixSize',
            'file_id' => file_id,
            'offset'  => offset)
end

#get_file_extension(mime_type) ⇒ TD::Types::Text

Returns the extension of a file, guessed by its MIME type. Returns an empty string on failure. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • mime_type (String) —

    The MIME type of the file.

Returns:



1531
1532
1533
1534
 
# File 'lib/tdlib/client_methods.rb', line 1531

def get_file_extension(mime_type)
  broadcast('@type'     => 'getFileExtension',
            'mime_type' => mime_type)
end

#get_file_mime_type(file_name) ⇒ TD::Types::Text

Returns the MIME type of a file, guessed by its extension. Returns an empty string on failure. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • file_name (String) —

    The name of the file or path to the file.

Returns:



1544
1545
1546
1547
 
# File 'lib/tdlib/client_methods.rb', line 1544

def get_file_mime_type(file_name)
  broadcast('@type'     => 'getFileMimeType',
            'file_name' => file_name)
end

#get_game_high_scores(chat_id, message_id, user_id) ⇒ TD::Types::GameHighScores

Returns the high scores for a game and some part of the high score table in the range of the specified user; for bots only.

Parameters:

  • chat_id (Integer) —

    The chat that contains the message with the game.

  • message_id (Integer) —

    Identifier of the message.

  • user_id (Integer) —

    User identifier.

Returns:



1556
1557
1558
1559
1560
1561
 
# File 'lib/tdlib/client_methods.rb', line 1556

def get_game_high_scores(chat_id, message_id, user_id)
  broadcast('@type'      => 'getGameHighScores',
            'chat_id'    => chat_id,
            'message_id' => message_id,
            'user_id'    => user_id)
end

#get_groups_in_common(user_id, offset_chat_id, limit) ⇒ TD::Types::Chats

Returns a list of common group chats with a given user. Chats are sorted by their type and creation date.

Parameters:

  • user_id (Integer) —

    User identifier.

  • offset_chat_id (Integer) —

    Chat identifier starting from which to return chats; use 0 for the first request.

  • limit (Integer) —

    Maximum number of chats to be returned; up to 100.

Returns:



1570
1571
1572
1573
1574
1575
 
# File 'lib/tdlib/client_methods.rb', line 1570

def get_groups_in_common(user_id, offset_chat_id, limit)
  broadcast('@type'          => 'getGroupsInCommon',
            'user_id'        => user_id,
            'offset_chat_id' => offset_chat_id,
            'limit'          => limit)
end

#get_imported_contact_count ⇒ TD::Types::Count

Returns the total number of imported contacts.

Returns:



1580
1581
1582
 
# File 'lib/tdlib/client_methods.rb', line 1580

def get_imported_contact_count
  broadcast('@type' => 'getImportedContactCount')
end

#get_inline_game_high_scores(inline_message_id, user_id) ⇒ TD::Types::GameHighScores

Returns game high scores and some part of the high score table in the range of the specified user; for bots only.

Parameters:

  • inline_message_id (String) —

    Inline message identifier.

  • user_id (Integer) —

    User identifier.

Returns:



1589
1590
1591
1592
1593
 
# File 'lib/tdlib/client_methods.rb', line 1589

def get_inline_game_high_scores(inline_message_id, user_id)
  broadcast('@type'             => 'getInlineGameHighScores',
            'inline_message_id' => inline_message_id,
            'user_id'           => user_id)
end

#get_inline_query_results(bot_user_id, chat_id, user_location, query, offset) ⇒ TD::Types::InlineQueryResults

Sends an inline query to a bot and returns its results. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires.

Parameters:

  • bot_user_id (Integer) —

    The identifier of the target bot.

  • chat_id (Integer) —

    Identifier of the chat, where the query was sent.

  • user_location (TD::Types::Location) —

    Location of the user, only if needed.

  • query (String) —

    Text of the query.

  • offset (String) —

    Offset of the first entry to return.

Returns:



1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/tdlib/client_methods.rb', line 1604

def get_inline_query_results(bot_user_id, chat_id, user_location, query, offset)
  broadcast('@type'         => 'getInlineQueryResults',
            'bot_user_id'   => bot_user_id,
            'chat_id'       => chat_id,
            'user_location' => user_location,
            'query'         => query,
            'offset'        => offset)
end

#get_installed_sticker_sets(is_masks) ⇒ TD::Types::StickerSets

Returns a list of installed sticker sets.

Parameters:

  • is_masks (Boolean) —

    Pass true to return mask sticker sets; pass false to return ordinary sticker sets.

Returns:



1617
1618
1619
1620
 
# File 'lib/tdlib/client_methods.rb', line 1617

def get_installed_sticker_sets(is_masks)
  broadcast('@type'    => 'getInstalledStickerSets',
            'is_masks' => is_masks)
end

#get_invite_text ⇒ TD::Types::Text

Returns the default text for invitation messages to be used as a placeholder when the current user invites friends to Telegram.

Returns:



1626
1627
1628
 
# File 'lib/tdlib/client_methods.rb', line 1626

def get_invite_text
  broadcast('@type' => 'getInviteText')
end

#get_json_string(json_value) ⇒ TD::Types::Text

Converts a JsonValue object to corresponding JSON-serialized string. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

Returns:



1637
1638
1639
1640
 
# File 'lib/tdlib/client_methods.rb', line 1637

def get_json_string(json_value)
  broadcast('@type'      => 'getJsonString',
            'json_value' => json_value)
end

#get_json_value(json) ⇒ TD::Types::JsonValue

Converts a JSON-serialized string to corresponding JsonValue object. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • json (String) —

    The JSON-serialized string.

Returns:



1649
1650
1651
1652
 
# File 'lib/tdlib/client_methods.rb', line 1649

def get_json_value(json)
  broadcast('@type' => 'getJsonValue',
            'json'  => json)
end

#get_language_pack_info(language_pack_id) ⇒ TD::Types::LanguagePackInfo

Returns information about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization.

Parameters:

  • language_pack_id (String) —

    Language pack identifier.

Returns:



1660
1661
1662
1663
 
# File 'lib/tdlib/client_methods.rb', line 1660

def get_language_pack_info(language_pack_id)
  broadcast('@type'            => 'getLanguagePackInfo',
            'language_pack_id' => language_pack_id)
end

#get_language_pack_string(language_pack_database_path, localization_target, language_pack_id, key) ⇒ TD::Types::LanguagePackStringValue

Returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • language_pack_database_path (String) —

    Path to the language pack database in which strings are stored.

  • localization_target (String) —

    Localization target to which the language pack belongs.

  • language_pack_id (String) —

    Language pack identifier.

  • key (String) —

    Language pack key of the string to be returned.

Returns:



1676
1677
1678
1679
1680
1681
1682
 
# File 'lib/tdlib/client_methods.rb', line 1676

def get_language_pack_string(language_pack_database_path, localization_target, language_pack_id, key)
  broadcast('@type'                       => 'getLanguagePackString',
            'language_pack_database_path' => language_pack_database_path,
            'localization_target'         => localization_target,
            'language_pack_id'            => language_pack_id,
            'key'                         => key)
end

#get_language_pack_strings(language_pack_id, keys) ⇒ TD::Types::LanguagePackStrings

Returns strings from a language pack in the current localization target by their keys. Can be called before authorization.

Parameters:

  • language_pack_id (String) —

    Language pack identifier of the strings to be returned.

  • keys (Array<String>) —

    Language pack keys of the strings to be returned; leave empty to request all available strings.

Returns:



1691
1692
1693
1694
1695
 
# File 'lib/tdlib/client_methods.rb', line 1691

def get_language_pack_strings(language_pack_id, keys)
  broadcast('@type'            => 'getLanguagePackStrings',
            'language_pack_id' => language_pack_id,
            'keys'             => keys)
end

#get_localization_target_info(only_local) ⇒ TD::Types::LocalizationTargetInfo

Returns information about the current localization target. This is an offline request if only_local is true. Can be called before authorization.

Parameters:

  • only_local (Boolean) —

    If true, returns only locally available information without sending network requests.

Returns:



1703
1704
1705
1706
 
# File 'lib/tdlib/client_methods.rb', line 1703

def get_localization_target_info(only_local)
  broadcast('@type'      => 'getLocalizationTargetInfo',
            'only_local' => only_local)
end

#get_log_stream ⇒ TD::Types::LogStream

Returns information about currently used log stream for internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously.

Returns:



1714
1715
1716
 
# File 'lib/tdlib/client_methods.rb', line 1714

def get_log_stream
  broadcast('@type' => 'getLogStream')
end

#get_log_tag_verbosity_level(tag) ⇒ TD::Types::LogVerbosityLevel

Returns current verbosity level for a specified TDLib internal log tag. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • tag (String) —

    Logging tag to change verbosity level.

Returns:



1725
1726
1727
1728
 
# File 'lib/tdlib/client_methods.rb', line 1725

def get_log_tag_verbosity_level(tag)
  broadcast('@type' => 'getLogTagVerbosityLevel',
            'tag'   => tag)
end

#get_log_tags ⇒ TD::Types::LogTags

Returns list of available TDLib internal log tags, for example, ["actor", "binlog", "connections", "notifications", "proxy"]. This is an offline method. Can be called before authorization. Can be called synchronously.

Returns:



1737
1738
1739
 
# File 'lib/tdlib/client_methods.rb', line 1737

def get_log_tags
  broadcast('@type' => 'getLogTags')
end

#get_log_verbosity_level ⇒ TD::Types::LogVerbosityLevel

Returns current verbosity level of the internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously.

Returns:



1747
1748
1749
 
# File 'lib/tdlib/client_methods.rb', line 1747

def get_log_verbosity_level
  broadcast('@type' => 'getLogVerbosityLevel')
end

#get_map_thumbnail_file(location, zoom, width, height, scale, chat_id) ⇒ TD::Types::File

Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded.

Parameters:

  • location (TD::Types::Location) —

    Location of the map center.

  • zoom (Integer) —

    Map zoom level; 13-20.

  • width (Integer) —

    Map width in pixels before applying scale; 16-1024.

  • height (Integer) —

    Map height in pixels before applying scale; 16-1024.

  • scale (Integer) —

    Map scale; 1-3.

  • chat_id (Integer) —

    Identifier of a chat, in which the thumbnail will be shown. Use 0 if unknown.

Returns:



1762
1763
1764
1765
1766
1767
1768
1769
1770
 
# File 'lib/tdlib/client_methods.rb', line 1762

def get_map_thumbnail_file(location, zoom, width, height, scale, chat_id)
  broadcast('@type'    => 'getMapThumbnailFile',
            'location' => location,
            'zoom'     => zoom,
            'width'    => width,
            'height'   => height,
            'scale'    => scale,
            'chat_id'  => chat_id)
end

#get_me ⇒ TD::Types::User

Returns the current user.

Returns:



1775
1776
1777
 
# File 'lib/tdlib/client_methods.rb', line 1775

def get_me
  broadcast('@type' => 'getMe')
end

#get_message(chat_id, message_id) ⇒ TD::Types::Message

Returns information about a message.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message to get.

Returns:



1784
1785
1786
1787
1788
 
# File 'lib/tdlib/client_methods.rb', line 1784

def get_message(chat_id, message_id)
  broadcast('@type'      => 'getMessage',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#get_message_link(chat_id, message_id) ⇒ TD::Types::HttpUrl

Returns a private HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels. The link will work only for members of the chat.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to which the message belongs.

  • message_id (Integer) —

    Identifier of the message.

Returns:



1797
1798
1799
1800
1801
 
# File 'lib/tdlib/client_methods.rb', line 1797

def get_message_link(chat_id, message_id)
  broadcast('@type'      => 'getMessageLink',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#get_message_link_info(url) ⇒ TD::Types::MessageLinkInfo

Returns information about a public or private message link.

Parameters:

Returns:



1808
1809
1810
1811
 
# File 'lib/tdlib/client_methods.rb', line 1808

def get_message_link_info(url)
  broadcast('@type' => 'getMessageLinkInfo',
            'url'   => url)
end

#get_message_locally(chat_id, message_id) ⇒ TD::Types::Message

Returns information about a message, if it is available locally without sending network request. This is an offline request.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message to get.

Returns:



1819
1820
1821
1822
1823
 
# File 'lib/tdlib/client_methods.rb', line 1819

def get_message_locally(chat_id, message_id)
  broadcast('@type'      => 'getMessageLocally',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#get_messages(chat_id, message_ids) ⇒ TD::Types::Messages

Returns information about messages. If a message is not found, returns null on the corresponding position of the result.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat the messages belong to.

  • message_ids (Array<Integer>) —

    Identifiers of the messages to get.

Returns:



1831
1832
1833
1834
1835
 
# File 'lib/tdlib/client_methods.rb', line 1831

def get_messages(chat_id, message_ids)
  broadcast('@type'       => 'getMessages',
            'chat_id'     => chat_id,
            'message_ids' => message_ids)
end

#get_network_statistics(only_current) ⇒ TD::Types::NetworkStatistics

Returns network data usage statistics. Can be called before authorization.

Parameters:

  • only_current (Boolean) —

    If true, returns only data for the current library launch.

Returns:



1842
1843
1844
1845
 
# File 'lib/tdlib/client_methods.rb', line 1842

def get_network_statistics(only_current)
  broadcast('@type'        => 'getNetworkStatistics',
            'only_current' => only_current)
end

#get_option(name) ⇒ TD::Types::OptionValue

Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization.

Parameters:

  • name (String) —

    The name of the option.

Returns:



1853
1854
1855
1856
 
# File 'lib/tdlib/client_methods.rb', line 1853

def get_option(name)
  broadcast('@type' => 'getOption',
            'name'  => name)
end

#get_passport_authorization_form(bot_user_id, scope, public_key, nonce) ⇒ TD::Types::PassportAuthorizationForm

Returns a Telegram Passport authorization form for sharing data with a service.

Parameters:

  • bot_user_id (Integer) —

    User identifier of the service's bot.

  • scope (String) —

    Telegram Passport element types requested by the service.

  • public_key (String) —

    Service's public_key.

  • nonce (String) —

    Authorization form nonce provided by the service.

Returns:



1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/tdlib/client_methods.rb', line 1865

def get_passport_authorization_form(bot_user_id, scope, public_key, nonce)
  broadcast('@type'       => 'getPassportAuthorizationForm',
            'bot_user_id' => bot_user_id,
            'scope'       => scope,
            'public_key'  => public_key,
            'nonce'       => nonce)
end

#get_passport_authorization_form_available_elements(autorization_form_id, password) ⇒ TD::Types::PassportElementsWithErrors

Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. Result can be received only once for each authorization form.

Parameters:

  • autorization_form_id (Integer) —

    Authorization form identifier.

  • password (String) —

    Password of the current user.

Returns:



1880
1881
1882
1883
1884
 
# File 'lib/tdlib/client_methods.rb', line 1880

def get_passport_authorization_form_available_elements(autorization_form_id, password)
  broadcast('@type'                => 'getPassportAuthorizationFormAvailableElements',
            'autorization_form_id' => autorization_form_id,
            'password'             => password)
end

#get_passport_element(type, password) ⇒ TD::Types::PassportElement

Returns one of the available Telegram Passport elements.

Parameters:

Returns:



1891
1892
1893
1894
1895
 
# File 'lib/tdlib/client_methods.rb', line 1891

def get_passport_element(type, password)
  broadcast('@type'    => 'getPassportElement',
            'type'     => type,
            'password' => password)
end

#get_password_state ⇒ TD::Types::PasswordState

Returns the current state of 2-step verification.

Returns:



1900
1901
1902
 
# File 'lib/tdlib/client_methods.rb', line 1900

def get_password_state
  broadcast('@type' => 'getPasswordState')
end

#get_payment_form(chat_id, message_id) ⇒ TD::Types::PaymentForm

Returns an invoice payment form. This method should be called when the user presses inlineKeyboardButtonBuy.

Parameters:

  • chat_id (Integer) —

    Chat identifier of the Invoice message.

  • message_id (Integer) —

    Message identifier.

Returns:



1910
1911
1912
1913
1914
 
# File 'lib/tdlib/client_methods.rb', line 1910

def get_payment_form(chat_id, message_id)
  broadcast('@type'      => 'getPaymentForm',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#get_payment_receipt(chat_id, message_id) ⇒ TD::Types::PaymentReceipt

Returns information about a successful payment.

Parameters:

  • chat_id (Integer) —

    Chat identifier of the PaymentSuccessful message.

  • message_id (Integer) —

    Message identifier.

Returns:



1921
1922
1923
1924
1925
 
# File 'lib/tdlib/client_methods.rb', line 1921

def get_payment_receipt(chat_id, message_id)
  broadcast('@type'      => 'getPaymentReceipt',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#get_preferred_country_language(country_code) ⇒ TD::Types::Text

Returns an IETF language tag of the language preferred in the country, which should be used to fill native fields in Telegram Passport personal details. Returns a 404 error if unknown.

Parameters:

  • country_code (String) —

    A two-letter ISO 3166-1 alpha-2 country code.

Returns:



1933
1934
1935
1936
 
# File 'lib/tdlib/client_methods.rb', line 1933

def get_preferred_country_language(country_code)
  broadcast('@type'        => 'getPreferredCountryLanguage',
            'country_code' => country_code)
end

#get_proxies ⇒ TD::Types::Proxies

Returns list of proxies that are currently set up. Can be called before authorization.

Returns:



1942
1943
1944
 
# File 'lib/tdlib/client_methods.rb', line 1942

def get_proxies
  broadcast('@type' => 'getProxies')
end

#get_proxy_link(proxy_id) ⇒ TD::Types::Text

Returns an HTTPS link, which can be used to add a proxy. Available only for SOCKS5 and MTProto proxies. Can be called before authorization.

Parameters:

  • proxy_id (Integer) —

    Proxy identifier.

Returns:



1952
1953
1954
1955
 
# File 'lib/tdlib/client_methods.rb', line 1952

def get_proxy_link(proxy_id)
  broadcast('@type'    => 'getProxyLink',
            'proxy_id' => proxy_id)
end

#get_public_message_link(chat_id, message_id, for_album) ⇒ TD::Types::PublicMessageLink

Returns a public HTTPS link to a message. Available only for messages in supergroups and channels with username.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to which the message belongs.

  • message_id (Integer) —

    Identifier of the message.

  • for_album (Boolean) —

    Pass true if a link for a whole media album should be returned.

Returns:



1964
1965
1966
1967
1968
1969
 
# File 'lib/tdlib/client_methods.rb', line 1964

def get_public_message_link(chat_id, message_id, for_album)
  broadcast('@type'      => 'getPublicMessageLink',
            'chat_id'    => chat_id,
            'message_id' => message_id,
            'for_album'  => for_album)
end

#get_push_receiver_id(payload) ⇒ TD::Types::PushReceiverId

Returns a globally unique push notification subscription identifier for identification of an account, which has received a push notification. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • payload (String) —

    JSON-encoded push notification payload.

Returns:



1979
1980
1981
1982
 
# File 'lib/tdlib/client_methods.rb', line 1979

def get_push_receiver_id(payload)
  broadcast('@type'   => 'getPushReceiverId',
            'payload' => payload)
end

#get_recent_inline_bots ⇒ TD::Types::Users

Returns up to 20 recently used inline bots in the order of their last usage.

Returns:



1987
1988
1989
 
# File 'lib/tdlib/client_methods.rb', line 1987

def get_recent_inline_bots
  broadcast('@type' => 'getRecentInlineBots')
end

#get_recent_stickers(is_attached) ⇒ TD::Types::Stickers

Returns a list of recently used stickers.

Parameters:

  • is_attached (Boolean) —

    Pass true to return stickers and masks that were recently attached to photos or video files; pass false to return recently sent stickers.

Returns:



1996
1997
1998
1999
 
# File 'lib/tdlib/client_methods.rb', line 1996

def get_recent_stickers(is_attached)
  broadcast('@type'       => 'getRecentStickers',
            'is_attached' => is_attached)
end

#get_recently_visited_t_me_urls(referrer) ⇒ TD::Types::TMeUrls

Returns t.me URLs recently visited by a newly registered user.

Parameters:

  • referrer (String) —

    Google Play referrer to identify the user.

Returns:



2005
2006
2007
2008
 
# File 'lib/tdlib/client_methods.rb', line 2005

def get_recently_visited_t_me_urls(referrer)
  broadcast('@type'    => 'getRecentlyVisitedTMeUrls',
            'referrer' => referrer)
end

#get_recovery_email_address(password) ⇒ TD::Types::RecoveryEmailAddress

Returns a 2-step verification recovery email address that was previously set up. This method can be used to verify a password provided by the user.

Parameters:

  • password (String) —

    The password for the current user.

Returns:



2015
2016
2017
2018
 
# File 'lib/tdlib/client_methods.rb', line 2015

def get_recovery_email_address(password)
  broadcast('@type'    => 'getRecoveryEmailAddress',
            'password' => password)
end

#get_remote_file(remote_file_id, file_type) ⇒ TD::Types::File

Returns information about a file by its remote ID; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message.

Parameters:

  • remote_file_id (String) —

    Remote identifier of the file to get.

  • file_type (TD::Types::FileType) —

    File type, if known.

Returns:



2026
2027
2028
2029
2030
 
# File 'lib/tdlib/client_methods.rb', line 2026

def get_remote_file(remote_file_id, file_type)
  broadcast('@type'          => 'getRemoteFile',
            'remote_file_id' => remote_file_id,
            'file_type'      => file_type)
end

#get_replied_message(chat_id, message_id) ⇒ TD::Types::Message

Returns information about a message that is replied by given message.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat the message belongs to.

  • message_id (Integer) —

    Identifier of the message reply to which get.

Returns:



2037
2038
2039
2040
2041
 
# File 'lib/tdlib/client_methods.rb', line 2037

def get_replied_message(chat_id, message_id)
  broadcast('@type'      => 'getRepliedMessage',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#get_saved_animations ⇒ TD::Types::Animations

Returns saved animations.

Returns:



2046
2047
2048
 
# File 'lib/tdlib/client_methods.rb', line 2046

def get_saved_animations
  broadcast('@type' => 'getSavedAnimations')
end

#get_saved_order_info ⇒ TD::Types::OrderInfo

Returns saved order info, if any.

Returns:



2053
2054
2055
 
# File 'lib/tdlib/client_methods.rb', line 2053

def get_saved_order_info
  broadcast('@type' => 'getSavedOrderInfo')
end

#get_scope_notification_settings(scope) ⇒ TD::Types::ScopeNotificationSettings

Returns the notification settings for chats of a given type.

Parameters:

Returns:



2062
2063
2064
2065
 
# File 'lib/tdlib/client_methods.rb', line 2062

def get_scope_notification_settings(scope)
  broadcast('@type' => 'getScopeNotificationSettings',
            'scope' => scope)
end

#get_secret_chat(secret_chat_id) ⇒ TD::Types::SecretChat

Returns information about a secret chat by its identifier. This is an offline request.

Parameters:

  • secret_chat_id (Integer) —

    Secret chat identifier.

Returns:



2072
2073
2074
2075
 
# File 'lib/tdlib/client_methods.rb', line 2072

def get_secret_chat(secret_chat_id)
  broadcast('@type'          => 'getSecretChat',
            'secret_chat_id' => secret_chat_id)
end

#get_sticker_emojis(sticker) ⇒ TD::Types::Emojis

Returns emoji corresponding to a sticker. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object.

Parameters:

Returns:



2083
2084
2085
2086
 
# File 'lib/tdlib/client_methods.rb', line 2083

def get_sticker_emojis(sticker)
  broadcast('@type'   => 'getStickerEmojis',
            'sticker' => sticker)
end

#get_sticker_set(set_id) ⇒ TD::Types::StickerSet

Returns information about a sticker set by its identifier.

Parameters:

  • set_id (Integer) —

    Identifier of the sticker set.

Returns:



2092
2093
2094
2095
 
# File 'lib/tdlib/client_methods.rb', line 2092

def get_sticker_set(set_id)
  broadcast('@type'  => 'getStickerSet',
            'set_id' => set_id)
end

#get_stickers(emoji, limit) ⇒ TD::Types::Stickers

Returns stickers from the installed sticker sets that correspond to a given emoji. If the emoji is not empty, favorite and recently used stickers may also be returned.

Parameters:

  • emoji (String) —

    String representation of emoji. If empty, returns all known installed stickers.

  • limit (Integer) —

    Maximum number of stickers to be returned.

Returns:



2104
2105
2106
2107
2108
 
# File 'lib/tdlib/client_methods.rb', line 2104

def get_stickers(emoji, limit)
  broadcast('@type' => 'getStickers',
            'emoji' => emoji,
            'limit' => limit)
end

#get_storage_statistics(chat_limit) ⇒ TD::Types::StorageStatistics

Returns storage usage statistics. Can be called before authorization.

Parameters:

  • chat_limit (Integer) —

    Maximum number of chats with the largest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If the chat info database is not used, the chat_limit is ignored and is always set to 0.

Returns:



2118
2119
2120
2121
 
# File 'lib/tdlib/client_methods.rb', line 2118

def get_storage_statistics(chat_limit)
  broadcast('@type'      => 'getStorageStatistics',
            'chat_limit' => chat_limit)
end

#get_storage_statistics_fast ⇒ TD::Types::StorageStatisticsFast

Quickly returns approximate storage usage statistics. Can be called before authorization.

Returns:



2127
2128
2129
 
# File 'lib/tdlib/client_methods.rb', line 2127

def get_storage_statistics_fast
  broadcast('@type' => 'getStorageStatisticsFast')
end

#get_supergroup(supergroup_id) ⇒ TD::Types::Supergroup

Returns information about a supergroup or channel by its identifier. This is an offline request if the current user is not a bot.

Parameters:

  • supergroup_id (Integer) —

    Supergroup or channel identifier.

Returns:



2136
2137
2138
2139
 
# File 'lib/tdlib/client_methods.rb', line 2136

def get_supergroup(supergroup_id)
  broadcast('@type'         => 'getSupergroup',
            'supergroup_id' => supergroup_id)
end

#get_supergroup_full_info(supergroup_id) ⇒ TD::Types::SupergroupFullInfo

Returns full information about a supergroup or channel by its identifier, cached for up to 1 minute.

Parameters:

  • supergroup_id (Integer) —

    Supergroup or channel identifier.

Returns:



2145
2146
2147
2148
 
# File 'lib/tdlib/client_methods.rb', line 2145

def get_supergroup_full_info(supergroup_id)
  broadcast('@type'         => 'getSupergroupFullInfo',
            'supergroup_id' => supergroup_id)
end

#get_supergroup_members(supergroup_id, filter, offset, limit) ⇒ TD::Types::ChatMembers

Returns information about members or banned users in a supergroup or channel. Can be used only if SupergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters.

Parameters:

  • supergroup_id (Integer) —

    Identifier of the supergroup or channel.

  • filter (TD::Types::SupergroupMembersFilter) —

    The type of users to return. By default, supergroupMembersRecent.

  • offset (Integer) —

    Number of users to skip.

  • limit (Integer) —

    The maximum number of users be returned; up to 200.

Returns:



2160
2161
2162
2163
2164
2165
2166
 
# File 'lib/tdlib/client_methods.rb', line 2160

def get_supergroup_members(supergroup_id, filter, offset, limit)
  broadcast('@type'         => 'getSupergroupMembers',
            'supergroup_id' => supergroup_id,
            'filter'        => filter,
            'offset'        => offset,
            'limit'         => limit)
end

#get_support_user ⇒ TD::Types::User

Returns a user that can be contacted to get support.

Returns:



2171
2172
2173
 
# File 'lib/tdlib/client_methods.rb', line 2171

def get_support_user
  broadcast('@type' => 'getSupportUser')
end

#get_temporary_password_state ⇒ TD::Types::TemporaryPasswordState

Returns information about the current temporary password.

Returns:



2178
2179
2180
 
# File 'lib/tdlib/client_methods.rb', line 2178

def get_temporary_password_state
  broadcast('@type' => 'getTemporaryPasswordState')
end

#get_text_entities(text) ⇒ TD::Types::TextEntities

Returns all entities (mentions, hashtags, cashtags, bot commands, URLs, and email addresses) contained in the text. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • text (String) —

    The text in which to look for entites.

Returns:



2189
2190
2191
2192
 
# File 'lib/tdlib/client_methods.rb', line 2189

def get_text_entities(text)
  broadcast('@type' => 'getTextEntities',
            'text'  => text)
end

#get_top_chats(category, limit) ⇒ TD::Types::Chats

Returns a list of frequently used chats. Supported only if the chat info database is enabled.

Parameters:

  • category (TD::Types::TopChatCategory) —

    Category of chats to be returned.

  • limit (Integer) —

    Maximum number of chats to be returned; up to 30.

Returns:



2200
2201
2202
2203
2204
 
# File 'lib/tdlib/client_methods.rb', line 2200

def get_top_chats(category, limit)
  broadcast('@type'    => 'getTopChats',
            'category' => category,
            'limit'    => limit)
end

#get_trending_sticker_sets ⇒ TD::Types::StickerSets

Returns a list of trending sticker sets.

Returns:



2209
2210
2211
 
# File 'lib/tdlib/client_methods.rb', line 2209

def get_trending_sticker_sets
  broadcast('@type' => 'getTrendingStickerSets')
end

#get_user(user_id) ⇒ TD::Types::User

Returns information about a user by their identifier. This is an offline request if the current user is not a bot.

Parameters:

  • user_id (Integer) —

    User identifier.

Returns:



2218
2219
2220
2221
 
# File 'lib/tdlib/client_methods.rb', line 2218

def get_user(user_id)
  broadcast('@type'   => 'getUser',
            'user_id' => user_id)
end

#get_user_full_info(user_id) ⇒ TD::Types::UserFullInfo

Returns full information about a user by their identifier.

Parameters:

  • user_id (Integer) —

    User identifier.

Returns:



2227
2228
2229
2230
 
# File 'lib/tdlib/client_methods.rb', line 2227

def get_user_full_info(user_id)
  broadcast('@type'   => 'getUserFullInfo',
            'user_id' => user_id)
end

#get_user_privacy_setting_rules(setting) ⇒ TD::Types::UserPrivacySettingRules

Returns the current privacy settings.

Parameters:

Returns:



2236
2237
2238
2239
 
# File 'lib/tdlib/client_methods.rb', line 2236

def get_user_privacy_setting_rules(setting)
  broadcast('@type'   => 'getUserPrivacySettingRules',
            'setting' => setting)
end

#get_user_profile_photos(user_id, offset, limit) ⇒ TD::Types::UserProfilePhotos

Returns the profile photos of a user. The result of this query may be outdated: some photos might have been deleted already.

Parameters:

  • user_id (Integer) —

    User identifier.

  • offset (Integer) —

    The number of photos to skip; must be non-negative.

  • limit (Integer) —

    Maximum number of photos to be returned; up to 100.

Returns:



2248
2249
2250
2251
2252
2253
 
# File 'lib/tdlib/client_methods.rb', line 2248

def (user_id, offset, limit)
  broadcast('@type'   => 'getUserProfilePhotos',
            'user_id' => user_id,
            'offset'  => offset,
            'limit'   => limit)
end

#get_web_page_instant_view(url, force_full) ⇒ TD::Types::WebPageInstantView

Returns an instant view version of a web page if available. Returns a 404 error if the web page has no instant view page.

Parameters:

  • url (String) —

    The web page URL.

  • force_full (Boolean) —

    If true, the full instant view for the web page will be returned.

Returns:



2261
2262
2263
2264
2265
 
# File 'lib/tdlib/client_methods.rb', line 2261

def get_web_page_instant_view(url, force_full)
  broadcast('@type'      => 'getWebPageInstantView',
            'url'        => url,
            'force_full' => force_full)
end

#get_web_page_preview(text) ⇒ TD::Types::WebPage

Returns a web page preview by the text of the message. Do not call this function too often. Returns a 404 error if the web page has no preview.

Parameters:

Returns:



2273
2274
2275
2276
 
# File 'lib/tdlib/client_methods.rb', line 2273

def get_web_page_preview(text)
  broadcast('@type' => 'getWebPagePreview',
            'text'  => text)
end

#import_contacts(contacts) ⇒ TD::Types::ImportedContacts

Adds new contacts or edits existing contacts; contacts' user identifiers are ignored.

Parameters:

  • contacts (Array<TD::Types::Contact>) —

    The list of contacts to import or edit, contact's vCard are ignored and are not imported.

Returns:



2283
2284
2285
2286
 
# File 'lib/tdlib/client_methods.rb', line 2283

def import_contacts(contacts)
  broadcast('@type'    => 'importContacts',
            'contacts' => contacts)
end

#join_chat(chat_id) ⇒ TD::Types::Ok

Adds current user as a new member to a chat. Private and secret chats can't be joined using this method.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



2293
2294
2295
2296
 
# File 'lib/tdlib/client_methods.rb', line 2293

def join_chat(chat_id)
  broadcast('@type'   => 'joinChat',
            'chat_id' => chat_id)
end

#join_chat_by_invite_link(invite_link) ⇒ TD::Types::Chat

Uses an invite link to add the current user to the chat if possible. The new member will not be added until the chat state has been synchronized with the server.

Parameters:

Returns:



2304
2305
2306
2307
 
# File 'lib/tdlib/client_methods.rb', line 2304

def join_chat_by_invite_link(invite_link)
  broadcast('@type'       => 'joinChatByInviteLink',
            'invite_link' => invite_link)
end

#leave_chat(chat_id) ⇒ TD::Types::Ok

Removes current user from chat members. Private and secret chats can't be left using this method.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



2314
2315
2316
2317
 
# File 'lib/tdlib/client_methods.rb', line 2314

def leave_chat(chat_id)
  broadcast('@type'   => 'leaveChat',
            'chat_id' => chat_id)
end

#log_out ⇒ TD::Types::Ok

Closes the TDLib instance after a proper logout. Requires an available network connection. All local data will be destroyed. After the logout completes, updateAuthorizationState with authorizationStateClosed will be sent.

Returns:



2325
2326
2327
 
# File 'lib/tdlib/client_methods.rb', line 2325

def log_out
  broadcast('@type' => 'logOut')
end

#open_chat(chat_id) ⇒ TD::Types::Ok

Informs TDLib that the chat is opened by the user. Many useful activities depend on the chat being opened or closed (e.g., in supergroups and channels all updates are received only for opened chats).

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



2335
2336
2337
2338
 
# File 'lib/tdlib/client_methods.rb', line 2335

def open_chat(chat_id)
  broadcast('@type'   => 'openChat',
            'chat_id' => chat_id)
end

#open_message_content(chat_id, message_id) ⇒ TD::Types::Ok

Informs TDLib that the message content has been opened (e.g., the user has opened a photo, video, document, location or venue, or has listened to an audio file or voice note message). An updateMessageContentOpened update will be generated if something has changed.

Parameters:

  • chat_id (Integer) —

    Chat identifier of the message.

  • message_id (Integer) —

    Identifier of the message with the opened content.

Returns:



2347
2348
2349
2350
2351
 
# File 'lib/tdlib/client_methods.rb', line 2347

def open_message_content(chat_id, message_id)
  broadcast('@type'      => 'openMessageContent',
            'chat_id'    => chat_id,
            'message_id' => message_id)
end

#optimize_storage(size, ttl, count, immunity_delay, file_types, chat_ids, exclude_chat_ids, chat_limit) ⇒ TD::Types::StorageStatistics

Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted.

Parameters:

  • size (Integer) —

    Limit on the total size of files after deletion. Pass -1 to use the default limit.

  • ttl (Integer) —

    Limit on the time that has passed since the last time a file was accessed (or creation time for some filesystems). Pass -1 to use the default limit.

  • count (Integer) —

    Limit on the total count of files after deletion. Pass -1 to use the default limit.

  • immunity_delay (Integer) —

    The amount of time after the creation of a file during which it can't be deleted, in seconds. Pass -1 to use the default value.

  • file_types (Array<TD::Types::FileType>) —

    If not empty, only files with the given type(s) are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted.

  • chat_ids (Array<Integer>) —

    If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat (e.g., profile photos).

  • exclude_chat_ids (Array<Integer>) —

    If not empty, files from the given chats are excluded. Use 0 as chat identifier to exclude all files not belonging to any chat (e.g., profile photos).

  • chat_limit (Integer) —

    Same as in getStorageStatistics. Affects only returned statistics.

Returns:



2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'lib/tdlib/client_methods.rb', line 2376

def optimize_storage(size, ttl, count, immunity_delay, file_types, chat_ids, exclude_chat_ids, chat_limit)
  broadcast('@type'            => 'optimizeStorage',
            'size'             => size,
            'ttl'              => ttl,
            'count'            => count,
            'immunity_delay'   => immunity_delay,
            'file_types'       => file_types,
            'chat_ids'         => chat_ids,
            'exclude_chat_ids' => exclude_chat_ids,
            'chat_limit'       => chat_limit)
end

#parse_text_entities(text, parse_mode) ⇒ TD::Types::FormattedText

Parses Bold, Italic, Code, Pre, PreCode and TextUrl entities contained in the text. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

Returns:



2396
2397
2398
2399
2400
 
# File 'lib/tdlib/client_methods.rb', line 2396

def parse_text_entities(text, parse_mode)
  broadcast('@type'      => 'parseTextEntities',
            'text'       => text,
            'parse_mode' => parse_mode)
end

#pin_chat_message(chat_id, message_id, disable_notification) ⇒ TD::Types::Ok

Pins a message in a chat; requires can_pin_messages rights.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat.

  • message_id (Integer) —

    Identifier of the new pinned message.

  • disable_notification (Boolean) —

    True, if there should be no notification about the pinned message.

Returns:



2408
2409
2410
2411
2412
2413
 
# File 'lib/tdlib/client_methods.rb', line 2408

def pin_chat_message(chat_id, message_id, disable_notification)
  broadcast('@type'                => 'pinChatMessage',
            'chat_id'              => chat_id,
            'message_id'           => message_id,
            'disable_notification' => disable_notification)
end

#ping_proxy(proxy_id) ⇒ TD::Types::Seconds

Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization.

Parameters:

  • proxy_id (Integer) —

    Proxy identifier. Use 0 to ping a Telegram server without a proxy.

Returns:



2421
2422
2423
2424
 
# File 'lib/tdlib/client_methods.rb', line 2421

def ping_proxy(proxy_id)
  broadcast('@type'    => 'pingProxy',
            'proxy_id' => proxy_id)
end

#process_push_notification(payload) ⇒ TD::Types::Ok

Handles a push notification. Returns error with code 406 if the push notification is not supported and connection to the server is required to fetch new data. Can be called before authorization.

Parameters:

  • payload (String) —

    JSON-encoded push notification payload with all fields sent by the server, and "google.sent_time" and "google.notification.sound" fields added.

Returns:



2434
2435
2436
2437
 
# File 'lib/tdlib/client_methods.rb', line 2434

def process_push_notification(payload)
  broadcast('@type'   => 'processPushNotification',
            'payload' => payload)
end

#read_all_chat_mentions(chat_id) ⇒ TD::Types::Ok

Marks all mentions in a chat as read.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



2443
2444
2445
2446
 
# File 'lib/tdlib/client_methods.rb', line 2443

def read_all_chat_mentions(chat_id)
  broadcast('@type'   => 'readAllChatMentions',
            'chat_id' => chat_id)
end

#read_file_part(file_id, offset, count) ⇒ TD::Types::FilePart

Reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the client has no direct access to TDLib's file system, because it is usually slower than a direct read from the file.

Parameters:

  • file_id (Integer) —

    Identifier of the file. The file must be located in the TDLib file cache.

  • offset (Integer) —

    The offset from which to read the file.

  • count (Integer) —

    Number of bytes to read. An error will be returned if there are not enough bytes available in the file from the specified position. Pass 0 to read all available data from the specified position.

Returns:



2459
2460
2461
2462
2463
2464
 
# File 'lib/tdlib/client_methods.rb', line 2459

def read_file_part(file_id, offset, count)
  broadcast('@type'   => 'readFilePart',
            'file_id' => file_id,
            'offset'  => offset,
            'count'   => count)
end

#recover_authentication_password(recovery_code) ⇒ TD::Types::Ok

Recovers the password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword.

Parameters:

  • recovery_code (String) —

    Recovery code to check.

Returns:



2471
2472
2473
2474
 
# File 'lib/tdlib/client_methods.rb', line 2471

def recover_authentication_password(recovery_code)
  broadcast('@type'         => 'recoverAuthenticationPassword',
            'recovery_code' => recovery_code)
end

#recover_password(recovery_code) ⇒ TD::Types::PasswordState

Recovers the password using a recovery code sent to an email address that was previously set up.

Parameters:

  • recovery_code (String) —

    Recovery code to check.

Returns:



2480
2481
2482
2483
 
# File 'lib/tdlib/client_methods.rb', line 2480

def recover_password(recovery_code)
  broadcast('@type'         => 'recoverPassword',
            'recovery_code' => recovery_code)
end

#register_device(device_token, other_user_ids) ⇒ TD::Types::PushReceiverId

Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the push notification subscription.

Parameters:

  • device_token (TD::Types::DeviceToken) —

    Device token.

  • other_user_ids (Array<Integer>) —

    List of user identifiers of other users currently using the client.

Returns:



2491
2492
2493
2494
2495
 
# File 'lib/tdlib/client_methods.rb', line 2491

def register_device(device_token, other_user_ids)
  broadcast('@type'          => 'registerDevice',
            'device_token'   => device_token,
            'other_user_ids' => other_user_ids)
end

#register_user(first_name, last_name) ⇒ TD::Types::Ok

Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration.

Parameters:

  • first_name (String) —

    The first name of the user; 1-64 characters.

  • last_name (String) —

    The last name of the user; 0-64 characters.

Returns:



2503
2504
2505
2506
2507
 
# File 'lib/tdlib/client_methods.rb', line 2503

def register_user(first_name, last_name)
  broadcast('@type'      => 'registerUser',
            'first_name' => first_name,
            'last_name'  => last_name)
end

#remove_background(background_id) ⇒ TD::Types::Ok

Removes background from the list of installed backgrounds.

Parameters:

  • background_id (Integer) —

    The background indentifier.

Returns:



2513
2514
2515
2516
 
# File 'lib/tdlib/client_methods.rb', line 2513

def remove_background(background_id)
  broadcast('@type'         => 'removeBackground',
            'background_id' => background_id)
end

#remove_contacts(user_ids) ⇒ TD::Types::Ok

Removes users from the contact list.

Parameters:

  • user_ids (Array<Integer>) —

    Identifiers of users to be deleted.

Returns:



2522
2523
2524
2525
 
# File 'lib/tdlib/client_methods.rb', line 2522

def remove_contacts(user_ids)
  broadcast('@type'    => 'removeContacts',
            'user_ids' => user_ids)
end

#remove_favorite_sticker(sticker) ⇒ TD::Types::Ok

Removes a sticker from the list of favorite stickers.

Parameters:

Returns:



2531
2532
2533
2534
 
# File 'lib/tdlib/client_methods.rb', line 2531

def remove_favorite_sticker(sticker)
  broadcast('@type'   => 'removeFavoriteSticker',
            'sticker' => sticker)
end

#remove_notification(notification_group_id, notification_id) ⇒ TD::Types::Ok

Removes an active notification from notification list. Needs to be called only if the notification is removed by the current user.

Parameters:

  • notification_group_id (Integer) —

    Identifier of notification group to which the notification belongs.

  • notification_id (Integer) —

    Identifier of removed notification.

Returns:



2542
2543
2544
2545
2546
 
# File 'lib/tdlib/client_methods.rb', line 2542

def remove_notification(notification_group_id, notification_id)
  broadcast('@type'                 => 'removeNotification',
            'notification_group_id' => notification_group_id,
            'notification_id'       => notification_id)
end

#remove_notification_group(notification_group_id, max_notification_id) ⇒ TD::Types::Ok

Removes a group of active notifications. Needs to be called only if the notification group is removed by the current user.

Parameters:

  • notification_group_id (Integer) —

    Notification group identifier.

  • max_notification_id (Integer) —

    Maximum identifier of removed notifications.

Returns:



2554
2555
2556
2557
2558
 
# File 'lib/tdlib/client_methods.rb', line 2554

def remove_notification_group(notification_group_id, max_notification_id)
  broadcast('@type'                 => 'removeNotificationGroup',
            'notification_group_id' => notification_group_id,
            'max_notification_id'   => max_notification_id)
end

#remove_proxy(proxy_id) ⇒ TD::Types::Ok

Removes a proxy server. Can be called before authorization.

Parameters:

  • proxy_id (Integer) —

    Proxy identifier.

Returns:



2565
2566
2567
2568
 
# File 'lib/tdlib/client_methods.rb', line 2565

def remove_proxy(proxy_id)
  broadcast('@type'    => 'removeProxy',
            'proxy_id' => proxy_id)
end

#remove_recent_hashtag(hashtag) ⇒ TD::Types::Ok

Removes a hashtag from the list of recently used hashtags.

Parameters:

  • hashtag (String) —

    Hashtag to delete.

Returns:



2574
2575
2576
2577
 
# File 'lib/tdlib/client_methods.rb', line 2574

def remove_recent_hashtag(hashtag)
  broadcast('@type'   => 'removeRecentHashtag',
            'hashtag' => hashtag)
end

#remove_recent_sticker(is_attached, sticker) ⇒ TD::Types::Ok

Removes a sticker from the list of recently used stickers.

Parameters:

  • is_attached (Boolean) —

    Pass true to remove the sticker from the list of stickers recently attached to photo or video files; pass false to remove the sticker from the list of recently sent stickers.

  • sticker (TD::Types::InputFile) —

    Sticker file to delete.

Returns:



2585
2586
2587
2588
2589
 
# File 'lib/tdlib/client_methods.rb', line 2585

def remove_recent_sticker(is_attached, sticker)
  broadcast('@type'       => 'removeRecentSticker',
            'is_attached' => is_attached,
            'sticker'     => sticker)
end

#remove_recently_found_chat(chat_id) ⇒ TD::Types::Ok

Removes a chat from the list of recently found chats.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to be removed.

Returns:



2595
2596
2597
2598
 
# File 'lib/tdlib/client_methods.rb', line 2595

def remove_recently_found_chat(chat_id)
  broadcast('@type'   => 'removeRecentlyFoundChat',
            'chat_id' => chat_id)
end

#remove_saved_animation(animation) ⇒ TD::Types::Ok

Removes an animation from the list of saved animations.

Parameters:

Returns:



2604
2605
2606
2607
 
# File 'lib/tdlib/client_methods.rb', line 2604

def remove_saved_animation(animation)
  broadcast('@type'     => 'removeSavedAnimation',
            'animation' => animation)
end

#remove_sticker_from_set(sticker) ⇒ TD::Types::Ok

Removes a sticker from the set to which it belongs; for bots only. The sticker set must have been created by the bot.

Parameters:

Returns:



2614
2615
2616
2617
 
# File 'lib/tdlib/client_methods.rb', line 2614

def remove_sticker_from_set(sticker)
  broadcast('@type'   => 'removeStickerFromSet',
            'sticker' => sticker)
end

#remove_top_chat(category, chat_id) ⇒ TD::Types::Ok

Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled.

Parameters:

Returns:



2625
2626
2627
2628
2629
 
# File 'lib/tdlib/client_methods.rb', line 2625

def remove_top_chat(category, chat_id)
  broadcast('@type'    => 'removeTopChat',
            'category' => category,
            'chat_id'  => chat_id)
end

#reorder_installed_sticker_sets(is_masks, sticker_set_ids) ⇒ TD::Types::Ok

Changes the order of installed sticker sets.

Parameters:

  • is_masks (Boolean) —

    Pass true to change the order of mask sticker sets; pass false to change the order of ordinary sticker sets.

  • sticker_set_ids (Array<Integer>) —

    Identifiers of installed sticker sets in the new correct order.

Returns:



2637
2638
2639
2640
2641
 
# File 'lib/tdlib/client_methods.rb', line 2637

def reorder_installed_sticker_sets(is_masks, sticker_set_ids)
  broadcast('@type'           => 'reorderInstalledStickerSets',
            'is_masks'        => is_masks,
            'sticker_set_ids' => sticker_set_ids)
end

#report_chat(chat_id, reason, message_ids) ⇒ TD::Types::Ok

Reports a chat to the Telegram moderators. Supported only for supergroups, channels, or private chats with bots, since other chats can't be checked by moderators.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • reason (TD::Types::ChatReportReason) —

    The reason for reporting the chat.

  • message_ids (Array<Integer>) —

    Identifiers of reported messages, if any.

Returns:



2651
2652
2653
2654
2655
2656
 
# File 'lib/tdlib/client_methods.rb', line 2651

def report_chat(chat_id, reason, message_ids)
  broadcast('@type'       => 'reportChat',
            'chat_id'     => chat_id,
            'reason'      => reason,
            'message_ids' => message_ids)
end

#report_supergroup_spam(supergroup_id, user_id, message_ids) ⇒ TD::Types::Ok

Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup.

Parameters:

  • supergroup_id (Integer) —

    Supergroup identifier.

  • user_id (Integer) —

    User identifier.

  • message_ids (Array<Integer>) —

    Identifiers of messages sent in the supergroup by the user. This list must be non-empty.

Returns:



2665
2666
2667
2668
2669
2670
 
# File 'lib/tdlib/client_methods.rb', line 2665

def report_supergroup_spam(supergroup_id, user_id, message_ids)
  broadcast('@type'         => 'reportSupergroupSpam',
            'supergroup_id' => supergroup_id,
            'user_id'       => user_id,
            'message_ids'   => message_ids)
end

#request_authentication_password_recovery ⇒ TD::Types::Ok

Requests to send a password recovery code to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword.

Returns:



2676
2677
2678
 
# File 'lib/tdlib/client_methods.rb', line 2676

def request_authentication_password_recovery
  broadcast('@type' => 'requestAuthenticationPasswordRecovery')
end

#request_password_recovery ⇒ TD::Types::EmailAddressAuthenticationCodeInfo

Requests to send a password recovery code to an email address that was previously set up.

Returns:



2683
2684
2685
 
# File 'lib/tdlib/client_methods.rb', line 2683

def request_password_recovery
  broadcast('@type' => 'requestPasswordRecovery')
end

#resend_authentication_code ⇒ TD::Types::Ok

Re-sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitCode and the next_code_type of the result is not null.

Returns:



2692
2693
2694
 
# File 'lib/tdlib/client_methods.rb', line 2692

def resend_authentication_code
  broadcast('@type' => 'resendAuthenticationCode')
end

#resend_change_phone_number_code ⇒ TD::Types::AuthenticationCodeInfo

Re-sends the authentication code sent to confirm a new phone number for the user. Works only if the previously received authenticationCodeInfo next_code_type was not null.

Returns:



2700
2701
2702
 
# File 'lib/tdlib/client_methods.rb', line 2700

def resend_change_phone_number_code
  broadcast('@type' => 'resendChangePhoneNumberCode')
end

#resend_email_address_verification_code ⇒ TD::Types::EmailAddressAuthenticationCodeInfo

Re-sends the code to verify an email address to be added to a user's Telegram Passport.

Returns:



2707
2708
2709
 
# File 'lib/tdlib/client_methods.rb', line 2707

def resend_email_address_verification_code
  broadcast('@type' => 'resendEmailAddressVerificationCode')
end

#resend_messages(chat_id, message_ids) ⇒ TD::Types::Messages

Resends messages which failed to send. Can be called only for messages for which messageSendingStateFailed.can_retry is true and after specified in messageSendingStateFailed.retry_after time passed. If a message is re-sent, the corresponding failed to send message is deleted. Returns the sent messages in the same order as the message identifiers passed in message_ids. If a message can't be re-sent, null will be returned instead of the message.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to send messages.

  • message_ids (Array<Integer>) —

    Identifiers of the messages to resend. Message identifiers must be in a strictly increasing order.

Returns:



2722
2723
2724
2725
2726
 
# File 'lib/tdlib/client_methods.rb', line 2722

def resend_messages(chat_id, message_ids)
  broadcast('@type'       => 'resendMessages',
            'chat_id'     => chat_id,
            'message_ids' => message_ids)
end

#resend_phone_number_confirmation_code ⇒ TD::Types::AuthenticationCodeInfo

Resends phone number confirmation code.

Returns:



2731
2732
2733
 
# File 'lib/tdlib/client_methods.rb', line 2731

def resend_phone_number_confirmation_code
  broadcast('@type' => 'resendPhoneNumberConfirmationCode')
end

#resend_phone_number_verification_code ⇒ TD::Types::AuthenticationCodeInfo

Re-sends the code to verify a phone number to be added to a user's Telegram Passport.

Returns:



2738
2739
2740
 
# File 'lib/tdlib/client_methods.rb', line 2738

def resend_phone_number_verification_code
  broadcast('@type' => 'resendPhoneNumberVerificationCode')
end

#resend_recovery_email_address_code ⇒ TD::Types::PasswordState

Resends the 2-step verification recovery email address verification code.

Returns:



2745
2746
2747
 
# File 'lib/tdlib/client_methods.rb', line 2745

def resend_recovery_email_address_code
  broadcast('@type' => 'resendRecoveryEmailAddressCode')
end

#reset_all_notification_settings ⇒ TD::Types::Ok

Resets all notification settings to their default values. By default, all chats are unmuted, the sound is set to "default" and message previews are shown.

Returns:



2753
2754
2755
 
# File 'lib/tdlib/client_methods.rb', line 2753

def reset_all_notification_settings
  broadcast('@type' => 'resetAllNotificationSettings')
end

#reset_backgrounds ⇒ TD::Types::Ok

Resets list of installed backgrounds to its default value.

Returns:



2760
2761
2762
 
# File 'lib/tdlib/client_methods.rb', line 2760

def reset_backgrounds
  broadcast('@type' => 'resetBackgrounds')
end

#reset_network_statistics ⇒ TD::Types::Ok

Resets all network data usage statistics to zero. Can be called before authorization.

Returns:



2768
2769
2770
 
# File 'lib/tdlib/client_methods.rb', line 2768

def reset_network_statistics
  broadcast('@type' => 'resetNetworkStatistics')
end

#save_application_log_event(type, chat_id, data) ⇒ TD::Types::Ok

Saves application log event on the server. Can be called before authorization.

Parameters:

  • type (String) —

    Event type.

  • chat_id (Integer) —

    Optional chat identifier, associated with the event.

  • data (TD::Types::JsonValue) —

    The log event data.

Returns:



2779
2780
2781
2782
2783
2784
 
# File 'lib/tdlib/client_methods.rb', line 2779

def save_application_log_event(type, chat_id, data)
  broadcast('@type'   => 'saveApplicationLogEvent',
            'type'    => type,
            'chat_id' => chat_id,
            'data'    => data)
end

#search_background(name) ⇒ TD::Types::Background

Searches for a background by its name.

Parameters:

  • name (String) —

    The name of the background.

Returns:



2790
2791
2792
2793
 
# File 'lib/tdlib/client_methods.rb', line 2790

def search_background(name)
  broadcast('@type' => 'searchBackground',
            'name'  => name)
end

#search_call_messages(from_message_id, limit, only_missed) ⇒ TD::Types::Messages

Searches for call messages. Returns the results in reverse chronological order (i. e., in order of decreasing message_id). For optimal performance the number of returned messages is chosen by the library.

Parameters:

  • from_message_id (Integer) —

    Identifier of the message from which to search; use 0 to get results from the last message.

  • limit (Integer) —

    The maximum number of messages to be returned; up to 100. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.

  • only_missed (Boolean) —

    If true, returns only messages with missed calls.

Returns:



2807
2808
2809
2810
2811
2812
 
# File 'lib/tdlib/client_methods.rb', line 2807

def search_call_messages(from_message_id, limit, only_missed)
  broadcast('@type'           => 'searchCallMessages',
            'from_message_id' => from_message_id,
            'limit'           => limit,
            'only_missed'     => only_missed)
end

#search_chat_members(chat_id, query, limit, filter) ⇒ TD::Types::ChatMembers

Searches for a specified query in the first name, last name and username of the members of a specified chat. Requires administrator rights in channels.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • query (String) —

    Query to search for.

  • limit (Integer) —

    The maximum number of users to be returned.

  • filter (TD::Types::ChatMembersFilter) —

    The type of users to return. By default, chatMembersFilterMembers.

Returns:



2823
2824
2825
2826
2827
2828
2829
 
# File 'lib/tdlib/client_methods.rb', line 2823

def search_chat_members(chat_id, query, limit, filter)
  broadcast('@type'   => 'searchChatMembers',
            'chat_id' => chat_id,
            'query'   => query,
            'limit'   => limit,
            'filter'  => filter)
end

#search_chat_messages(chat_id, query, sender_user_id, from_message_id, offset, limit, filter) ⇒ TD::Types::Messages

Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages should be used instead), or without an enabled message database. For optimal performance the number of returned messages is chosen by the library.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat in which to search messages.

  • query (String) —

    Query to search for.

  • sender_user_id (Integer) —

    If not 0, only messages sent by the specified user will be returned. Not supported in secret chats.

  • from_message_id (Integer) —

    Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.

  • offset (Integer) —

    Specify 0 to get results from exactly the from_message_id or a negative offset to get the specified message and some newer messages.

  • limit (Integer) —

    The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.

  • filter (TD::Types::SearchMessagesFilter) —

    Filter for message content in the search results.

Returns:



2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
 
# File 'lib/tdlib/client_methods.rb', line 2853

def search_chat_messages(chat_id, query, sender_user_id, from_message_id, offset, limit, filter)
  broadcast('@type'           => 'searchChatMessages',
            'chat_id'         => chat_id,
            'query'           => query,
            'sender_user_id'  => sender_user_id,
            'from_message_id' => from_message_id,
            'offset'          => offset,
            'limit'           => limit,
            'filter'          => filter)
end

#search_chat_recent_location_messages(chat_id, limit) ⇒ TD::Types::Messages

Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1 location message per user.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • limit (Integer) —

    Maximum number of messages to be returned.

Returns:



2870
2871
2872
2873
2874
 
# File 'lib/tdlib/client_methods.rb', line 2870

def search_chat_recent_location_messages(chat_id, limit)
  broadcast('@type'   => 'searchChatRecentLocationMessages',
            'chat_id' => chat_id,
            'limit'   => limit)
end

#search_chats(query, limit) ⇒ TD::Types::Chats

Searches for the specified query in the title and username of already known chats, this is an offline request. Returns chats in the order seen in the chat list.

Parameters:

  • query (String) —

    Query to search for. If the query is empty, returns up to 20 recently found chats.

  • limit (Integer) —

    Maximum number of chats to be returned.

Returns:



2883
2884
2885
2886
2887
 
# File 'lib/tdlib/client_methods.rb', line 2883

def search_chats(query, limit)
  broadcast('@type' => 'searchChats',
            'query' => query,
            'limit' => limit)
end

#search_chats_on_server(query, limit) ⇒ TD::Types::Chats

Searches for the specified query in the title and username of already known chats via request to the server. Returns chats in the order seen in the chat list.

Parameters:

  • query (String) —

    Query to search for.

  • limit (Integer) —

    Maximum number of chats to be returned.

Returns:



2895
2896
2897
2898
2899
 
# File 'lib/tdlib/client_methods.rb', line 2895

def search_chats_on_server(query, limit)
  broadcast('@type' => 'searchChatsOnServer',
            'query' => query,
            'limit' => limit)
end

#search_contacts(query = nil, limit) ⇒ TD::Types::Users

Searches for the specified query in the first names, last names and usernames of the known user contacts.

Parameters:

  • query (String, nil) (defaults to: nil) —

    Query to search for; may be empty to return all contacts.

  • limit (Integer) —

    Maximum number of users to be returned.

Returns:



2906
2907
2908
2909
2910
 
# File 'lib/tdlib/client_methods.rb', line 2906

def search_contacts(query = nil, limit)
  broadcast('@type' => 'searchContacts',
            'query' => query,
            'limit' => limit)
end

#search_emojis(text, exact_match) ⇒ TD::Types::Emojis

Searches for emojis by keywords. Supported only if the file database is enabled.

Parameters:

  • text (String) —

    Text to search for.

  • exact_match (Boolean) —

    True, if only emojis, which exactly match text needs to be returned.

Returns:



2918
2919
2920
2921
2922
 
# File 'lib/tdlib/client_methods.rb', line 2918

def search_emojis(text, exact_match)
  broadcast('@type'       => 'searchEmojis',
            'text'        => text,
            'exact_match' => exact_match)
end

#search_hashtags(prefix, limit) ⇒ TD::Types::Hashtags

Searches for recently used hashtags by their prefix.

Parameters:

  • prefix (String) —

    Hashtag prefix to search for.

  • limit (Integer) —

    Maximum number of hashtags to be returned.

Returns:



2929
2930
2931
2932
2933
 
# File 'lib/tdlib/client_methods.rb', line 2929

def search_hashtags(prefix, limit)
  broadcast('@type'  => 'searchHashtags',
            'prefix' => prefix,
            'limit'  => limit)
end

#search_installed_sticker_sets(is_masks, query, limit) ⇒ TD::Types::StickerSets

Searches for installed sticker sets by looking for specified query in their title and name.

Parameters:

  • is_masks (Boolean) —

    Pass true to return mask sticker sets; pass false to return ordinary sticker sets.

  • query (String) —

    Query to search for.

  • limit (Integer) —

    Maximum number of sticker sets to return.

Returns:



2941
2942
2943
2944
2945
2946
 
# File 'lib/tdlib/client_methods.rb', line 2941

def search_installed_sticker_sets(is_masks, query, limit)
  broadcast('@type'    => 'searchInstalledStickerSets',
            'is_masks' => is_masks,
            'query'    => query,
            'limit'    => limit)
end

#search_messages(query, offset_date, offset_chat_id, offset_message_id, limit) ⇒ TD::Types::Messages

Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance the number of returned messages is chosen by the library.

Parameters:

  • query (String) —

    Query to search for.

  • offset_date (Integer) —

    The date of the message starting from which the results should be fetched. Use 0 or any date in the future to get results from the last message.

  • offset_chat_id (Integer) —

    The chat identifier of the last found message, or 0 for the first request.

  • offset_message_id (Integer) —

    The message identifier of the last found message, or 0 for the first request.

  • limit (Integer) —

    The maximum number of messages to be returned, up to 100. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.

Returns:



2961
2962
2963
2964
2965
2966
2967
2968
 
# File 'lib/tdlib/client_methods.rb', line 2961

def search_messages(query, offset_date, offset_chat_id, offset_message_id, limit)
  broadcast('@type'             => 'searchMessages',
            'query'             => query,
            'offset_date'       => offset_date,
            'offset_chat_id'    => offset_chat_id,
            'offset_message_id' => offset_message_id,
            'limit'             => limit)
end

#search_public_chat(username) ⇒ TD::Types::Chat

Searches a public chat by its username. Currently only private chats, supergroups and channels can be public. Returns the chat if found; otherwise an error is returned.

Parameters:

  • username (String) —

    Username to be resolved.

Returns:



2976
2977
2978
2979
 
# File 'lib/tdlib/client_methods.rb', line 2976

def search_public_chat(username)
  broadcast('@type'    => 'searchPublicChat',
            'username' => username)
end

#search_public_chats(query) ⇒ TD::Types::Chats

Searches public chats by looking for specified query in their username and title. Currently only private chats, supergroups and channels can be public. Returns a meaningful number of results. Returns nothing if the length of the searched username prefix is less than 5. Excludes private chats with contacts and chats from the chat list from the results.

Parameters:

  • query (String) —

    Query to search for.

Returns:



2989
2990
2991
2992
 
# File 'lib/tdlib/client_methods.rb', line 2989

def search_public_chats(query)
  broadcast('@type' => 'searchPublicChats',
            'query' => query)
end

#search_secret_messages(chat_id, query, from_search_id, limit, filter) ⇒ TD::Types::FoundMessages

Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance the number of returned messages is chosen by the library.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat in which to search. Specify 0 to search in all secret chats.

  • query (String) —

    Query to search for. If empty, searchChatMessages should be used instead.

  • from_search_id (Integer) —

    The identifier from the result of a previous request, use 0 to get results from the last message.

  • limit (Integer) —

    Maximum number of messages to be returned; up to 100. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.

  • filter (TD::Types::SearchMessagesFilter) —

    A filter for the content of messages in the search results.

Returns:



3009
3010
3011
3012
3013
3014
3015
3016
 
# File 'lib/tdlib/client_methods.rb', line 3009

def search_secret_messages(chat_id, query, from_search_id, limit, filter)
  broadcast('@type'          => 'searchSecretMessages',
            'chat_id'        => chat_id,
            'query'          => query,
            'from_search_id' => from_search_id,
            'limit'          => limit,
            'filter'         => filter)
end

#search_sticker_set(name) ⇒ TD::Types::StickerSet

Searches for a sticker set by its name.

Parameters:

  • name (String) —

    Name of the sticker set.

Returns:



3022
3023
3024
3025
 
# File 'lib/tdlib/client_methods.rb', line 3022

def search_sticker_set(name)
  broadcast('@type' => 'searchStickerSet',
            'name'  => name)
end

#search_sticker_sets(query) ⇒ TD::Types::StickerSets

Searches for ordinary sticker sets by looking for specified query in their title and name. Excludes installed sticker sets from the results.

Parameters:

  • query (String) —

    Query to search for.

Returns:



3032
3033
3034
3035
 
# File 'lib/tdlib/client_methods.rb', line 3032

def search_sticker_sets(query)
  broadcast('@type' => 'searchStickerSets',
            'query' => query)
end

#search_stickers(emoji, limit = nil) ⇒ TD::Types::Stickers

Searches for stickers from public sticker sets that correspond to a given emoji.

Parameters:

  • emoji (String) —

    String representation of emoji; must be non-empty.

  • limit (Integer, nil) (defaults to: nil) —

    Maximum number of stickers to be returned.

Returns:



3042
3043
3044
3045
3046
 
# File 'lib/tdlib/client_methods.rb', line 3042

def search_stickers(emoji, limit = nil)
  broadcast('@type' => 'searchStickers',
            'emoji' => emoji,
            'limit' => limit)
end

#send_bot_start_message(bot_user_id, chat_id, parameter) ⇒ TD::Types::Message

Invites a bot to a chat (if it is not yet a member) and sends it the /start command. Bots can't be invited to a private chat other than the chat with the bot. Bots can't be invited to channels (although they can be added as admins) and secret chats. Returns the sent message.

Parameters:

  • bot_user_id (Integer) —

    Identifier of the bot.

  • chat_id (Integer) —

    Identifier of the target chat.

  • parameter (String) —

    A hidden parameter sent to the bot for deep linking purposes (https://core.telegram.org/bots#deep-linking).

Returns:



3058
3059
3060
3061
3062
3063
 
# File 'lib/tdlib/client_methods.rb', line 3058

def send_bot_start_message(bot_user_id, chat_id, parameter)
  broadcast('@type'       => 'sendBotStartMessage',
            'bot_user_id' => bot_user_id,
            'chat_id'     => chat_id,
            'parameter'   => parameter)
end

#send_call_debug_information(call_id, debug_information) ⇒ TD::Types::Ok

Sends debug information for a call.

Parameters:

  • call_id (Integer) —

    Call identifier.

  • debug_information (String) —

    Debug information in application-specific format.

Returns:



3070
3071
3072
3073
3074
 
# File 'lib/tdlib/client_methods.rb', line 3070

def send_call_debug_information(call_id, debug_information)
  broadcast('@type'             => 'sendCallDebugInformation',
            'call_id'           => call_id,
            'debug_information' => debug_information)
end

#send_call_rating(call_id, rating, comment, problems) ⇒ TD::Types::Ok

Sends a call rating.

Parameters:

  • call_id (Integer) —

    Call identifier.

  • rating (Integer) —

    Call rating; 1-5.

  • comment (String) —

    An optional user comment if the rating is less than 5.

  • problems (Array<TD::Types::CallProblem>) —

    List of the exact types of problems with the call, specified by the user.

Returns:



3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/tdlib/client_methods.rb', line 3084

def send_call_rating(call_id, rating, comment, problems)
  broadcast('@type'    => 'sendCallRating',
            'call_id'  => call_id,
            'rating'   => rating,
            'comment'  => comment,
            'problems' => problems)
end

#send_chat_action(chat_id, action) ⇒ TD::Types::Ok

Sends a notification about user activity in a chat.

Parameters:

Returns:



3097
3098
3099
3100
3101
 
# File 'lib/tdlib/client_methods.rb', line 3097

def send_chat_action(chat_id, action)
  broadcast('@type'   => 'sendChatAction',
            'chat_id' => chat_id,
            'action'  => action)
end

#send_chat_screenshot_taken_notification(chat_id) ⇒ TD::Types::Ok

Sends a notification about a screenshot taken in a chat. Supported only in private and secret chats.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

Returns:



3108
3109
3110
3111
 
# File 'lib/tdlib/client_methods.rb', line 3108

def send_chat_screenshot_taken_notification(chat_id)
  broadcast('@type'   => 'sendChatScreenshotTakenNotification',
            'chat_id' => chat_id)
end

#send_chat_set_ttl_message(chat_id, ttl) ⇒ TD::Types::Message

Changes the current TTL setting (sets a new self-destruct timer) in a secret chat and sends the corresponding message.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • ttl (Integer) —

    New TTL value, in seconds.

Returns:



3119
3120
3121
3122
3123
 
# File 'lib/tdlib/client_methods.rb', line 3119

def send_chat_set_ttl_message(chat_id, ttl)
  broadcast('@type'   => 'sendChatSetTtlMessage',
            'chat_id' => chat_id,
            'ttl'     => ttl)
end

#send_custom_request(method, parameters) ⇒ TD::Types::CustomRequestResult

Sends a custom request; for bots only.

Parameters:

  • method (String) —

    The method name.

  • parameters (String) —

    JSON-serialized method parameters.

Returns:



3130
3131
3132
3133
3134
 
# File 'lib/tdlib/client_methods.rb', line 3130

def send_custom_request(method, parameters)
  broadcast('@type'      => 'sendCustomRequest',
            'method'     => method,
            'parameters' => parameters)
end

#send_email_address_verification_code(email_address) ⇒ TD::Types::EmailAddressAuthenticationCodeInfo

Sends a code to verify an email address to be added to a user's Telegram Passport.

Parameters:

  • email_address (String) —

    Email address.

Returns:



3140
3141
3142
3143
 
# File 'lib/tdlib/client_methods.rb', line 3140

def send_email_address_verification_code(email_address)
  broadcast('@type'         => 'sendEmailAddressVerificationCode',
            'email_address' => email_address)
end

#send_inline_query_result_message(chat_id, reply_to_message_id, disable_notification, from_background, query_id, result_id, hide_via_bot) ⇒ TD::Types::Message

Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message.

Parameters:

  • chat_id (Integer) —

    Target chat.

  • reply_to_message_id (Integer) —

    Identifier of a message to reply to or 0.

  • disable_notification (Boolean) —

    Pass true to disable notification for the message. Not supported in secret chats.

  • from_background (Boolean) —

    Pass true if the message is sent from background.

  • query_id (Integer) —

    Identifier of the inline query.

  • result_id (String) —

    Identifier of the inline result.

  • hide_via_bot (Boolean) —

    If true, there will be no mention of a bot, via which the message is sent. Can be used only for bots GetOption("animation_search_bot_username"), GetOption("photo_search_bot_username") and GetOption("venue_search_bot_username").

Returns:



3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
 
# File 'lib/tdlib/client_methods.rb', line 3160

def send_inline_query_result_message(chat_id, reply_to_message_id, disable_notification, from_background, query_id,
                                     result_id, hide_via_bot)
  broadcast('@type'                => 'sendInlineQueryResultMessage',
            'chat_id'              => chat_id,
            'reply_to_message_id'  => reply_to_message_id,
            'disable_notification' => disable_notification,
            'from_background'      => from_background,
            'query_id'             => query_id,
            'result_id'            => result_id,
            'hide_via_bot'         => hide_via_bot)
end

#send_message(chat_id, reply_to_message_id, disable_notification, from_background, reply_markup, input_message_content) ⇒ TD::Types::Message

Sends a message. Returns the sent message.

Parameters:

  • chat_id (Integer) —

    Target chat.

  • reply_to_message_id (Integer) —

    Identifier of the message to reply to or 0.

  • disable_notification (Boolean) —

    Pass true to disable notification for the message. Not supported in secret chats.

  • from_background (Boolean) —

    Pass true if the message is sent from the background.

  • reply_markup (TD::Types::ReplyMarkup) —

    Markup for replying to the message; for bots only.

  • input_message_content (TD::Types::InputMessageContent) —

    The content of the message to be sent.

Returns:



3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
 
# File 'lib/tdlib/client_methods.rb', line 3183

def send_message(chat_id, reply_to_message_id, disable_notification, from_background, reply_markup,
                 input_message_content)
  broadcast('@type'                 => 'sendMessage',
            'chat_id'               => chat_id,
            'reply_to_message_id'   => reply_to_message_id,
            'disable_notification'  => disable_notification,
            'from_background'       => from_background,
            'reply_markup'          => reply_markup,
            'input_message_content' => input_message_content)
end

#send_message_album(chat_id, reply_to_message_id, disable_notification, from_background, input_message_contents) ⇒ TD::Types::Messages

Sends messages grouped together into an album. Currently only photo and video messages can be grouped into an album. Returns sent messages.

Parameters:

  • chat_id (Integer) —

    Target chat.

  • reply_to_message_id (Integer) —

    Identifier of a message to reply to or 0.

  • disable_notification (Boolean) —

    Pass true to disable notification for the messages. Not supported in secret chats.

  • from_background (Boolean) —

    Pass true if the messages are sent from the background.

  • input_message_contents (Array<TD::Types::InputMessageContent>) —

    Contents of messages to be sent.

Returns:



3205
3206
3207
3208
3209
3210
3211
3212
 
# File 'lib/tdlib/client_methods.rb', line 3205

def send_message_album(chat_id, reply_to_message_id, disable_notification, from_background, input_message_contents)
  broadcast('@type'                  => 'sendMessageAlbum',
            'chat_id'                => chat_id,
            'reply_to_message_id'    => reply_to_message_id,
            'disable_notification'   => disable_notification,
            'from_background'        => from_background,
            'input_message_contents' => input_message_contents)
end

#send_passport_authorization_form(autorization_form_id, types) ⇒ TD::Types::Ok

Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after getPassportAuthorizationFormAvailableElements if some previously available elements need to be used.

Parameters:

  • autorization_form_id (Integer) —

    Authorization form identifier.

  • types (Array<TD::Types::PassportElementType>) —

    Types of Telegram Passport elements chosen by user to complete the authorization form.

Returns:



3222
3223
3224
3225
3226
 
# File 'lib/tdlib/client_methods.rb', line 3222

def send_passport_authorization_form(autorization_form_id, types)
  broadcast('@type'                => 'sendPassportAuthorizationForm',
            'autorization_form_id' => autorization_form_id,
            'types'                => types)
end

#send_payment_form(chat_id, message_id, order_info_id, shipping_option_id, credentials) ⇒ TD::Types::PaymentResult

Sends a filled-out payment form to the bot for final verification.

Parameters:

  • chat_id (Integer) —

    Chat identifier of the Invoice message.

  • message_id (Integer) —

    Message identifier.

  • order_info_id (String) —

    Identifier returned by ValidateOrderInfo, or an empty string.

  • shipping_option_id (String) —

    Identifier of a chosen shipping option, if applicable.

  • credentials (TD::Types::InputCredentials) —

    The credentials chosen by user for payment.

Returns:



3236
3237
3238
3239
3240
3241
3242
3243
 
# File 'lib/tdlib/client_methods.rb', line 3236

def send_payment_form(chat_id, message_id, order_info_id, shipping_option_id, credentials)
  broadcast('@type'              => 'sendPaymentForm',
            'chat_id'            => chat_id,
            'message_id'         => message_id,
            'order_info_id'      => order_info_id,
            'shipping_option_id' => shipping_option_id,
            'credentials'        => credentials)
end

#send_phone_number_confirmation_code(hash, phone_number, settings) ⇒ TD::Types::AuthenticationCodeInfo

Sends phone number confirmation code. Should be called when user presses "https://t.me/confirmphone?phone=*******&hash=**********" or "tg://confirmphone?phone=****&hash=*******" link.

Parameters:

  • hash (String) —

    Value of the "hash" parameter from the link.

  • phone_number (String) —

    Value of the "phone" parameter from the link.

  • settings (TD::Types::PhoneNumberAuthenticationSettings) —

    Settings for the authentication of the user's phone number.

Returns:



3254
3255
3256
3257
3258
3259
 
# File 'lib/tdlib/client_methods.rb', line 3254

def send_phone_number_confirmation_code(hash, phone_number, settings)
  broadcast('@type'        => 'sendPhoneNumberConfirmationCode',
            'hash'         => hash,
            'phone_number' => phone_number,
            'settings'     => settings)
end

#send_phone_number_verification_code(phone_number, settings) ⇒ TD::Types::AuthenticationCodeInfo

Sends a code to verify a phone number to be added to a user's Telegram Passport.

Parameters:

Returns:



3267
3268
3269
3270
3271
 
# File 'lib/tdlib/client_methods.rb', line 3267

def send_phone_number_verification_code(phone_number, settings)
  broadcast('@type'        => 'sendPhoneNumberVerificationCode',
            'phone_number' => phone_number,
            'settings'     => settings)
end

#set_account_ttl(ttl) ⇒ TD::Types::Ok

Changes the period of inactivity after which the account of the current user will automatically be deleted.

Parameters:

Returns:



3277
3278
3279
3280
 
# File 'lib/tdlib/client_methods.rb', line 3277

def (ttl)
  broadcast('@type' => 'setAccountTtl',
            'ttl'   => ttl)
end

#set_alarm(seconds) ⇒ TD::Types::Ok

Succeeds after a specified amount of time has passed. Can be called before authorization. Can be called before initialization.

Parameters:

  • seconds (Float) —

    Number of seconds before the function returns.

Returns:



3288
3289
3290
3291
 
# File 'lib/tdlib/client_methods.rb', line 3288

def set_alarm(seconds)
  broadcast('@type'   => 'setAlarm',
            'seconds' => seconds)
end

#set_authentication_phone_number(phone_number, settings) ⇒ TD::Types::Ok

Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitCode or authorizationStateWaitPassword.

Parameters:

Returns:



3302
3303
3304
3305
3306
 
# File 'lib/tdlib/client_methods.rb', line 3302

def set_authentication_phone_number(phone_number, settings)
  broadcast('@type'        => 'setAuthenticationPhoneNumber',
            'phone_number' => phone_number,
            'settings'     => settings)
end

#set_auto_download_settings(settings, type) ⇒ TD::Types::Ok

Sets auto-download settings.

Parameters:

Returns:



3313
3314
3315
3316
3317
 
# File 'lib/tdlib/client_methods.rb', line 3313

def set_auto_download_settings(settings, type)
  broadcast('@type'    => 'setAutoDownloadSettings',
            'settings' => settings,
            'type'     => type)
end

#set_background(background, type, for_dark_theme) ⇒ TD::Types::Background

Changes the background selected by the user; adds background to the list of installed backgrounds.

Parameters:

  • background (TD::Types::InputBackground) —

    The input background to use, null for solid backgrounds.

  • type (TD::Types::BackgroundType) —

    Background type; null for default background. The method will return error 404 if type is null.

  • for_dark_theme (Boolean) —

    True, if the background is chosen for dark theme.

Returns:



3326
3327
3328
3329
3330
3331
 
# File 'lib/tdlib/client_methods.rb', line 3326

def set_background(background, type, for_dark_theme)
  broadcast('@type'          => 'setBackground',
            'background'     => background,
            'type'           => type,
            'for_dark_theme' => for_dark_theme)
end

#set_bio(bio) ⇒ TD::Types::Ok

Changes the bio of the current user.

Parameters:

  • bio (String) —

    The new value of the user bio; 0-70 characters without line feeds.

Returns:



3337
3338
3339
3340
 
# File 'lib/tdlib/client_methods.rb', line 3337

def set_bio(bio)
  broadcast('@type' => 'setBio',
            'bio'   => bio)
end

#set_bot_updates_status(pending_update_count, error_message) ⇒ TD::Types::Ok

Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only.

Parameters:

  • pending_update_count (Integer) —

    The number of pending updates.

  • error_message (String) —

    The last error message.

Returns:



3348
3349
3350
3351
3352
 
# File 'lib/tdlib/client_methods.rb', line 3348

def set_bot_updates_status(pending_update_count, error_message)
  broadcast('@type'                => 'setBotUpdatesStatus',
            'pending_update_count' => pending_update_count,
            'error_message'        => error_message)
end

#set_chat_client_data(chat_id, client_data) ⇒ TD::Types::Ok

Changes client data associated with a chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • client_data (String) —

    New value of client_data.

Returns:



3359
3360
3361
3362
3363
 
# File 'lib/tdlib/client_methods.rb', line 3359

def set_chat_client_data(chat_id, client_data)
  broadcast('@type'       => 'setChatClientData',
            'chat_id'     => chat_id,
            'client_data' => client_data)
end

#set_chat_description(chat_id, description) ⇒ TD::Types::Ok

Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info rights.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat.

  • description (String) —

    New chat description; 0-255 characters.

Returns:



3372
3373
3374
3375
3376
 
# File 'lib/tdlib/client_methods.rb', line 3372

def set_chat_description(chat_id, description)
  broadcast('@type'       => 'setChatDescription',
            'chat_id'     => chat_id,
            'description' => description)
end

#set_chat_draft_message(chat_id, draft_message = nil) ⇒ TD::Types::Ok

Changes the draft message in a chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • draft_message (TD::Types::DraftMessage, nil) (defaults to: nil) —

    New draft message; may be null.

Returns:



3383
3384
3385
3386
3387
 
# File 'lib/tdlib/client_methods.rb', line 3383

def set_chat_draft_message(chat_id, draft_message = nil)
  broadcast('@type'         => 'setChatDraftMessage',
            'chat_id'       => chat_id,
            'draft_message' => draft_message)
end

#set_chat_member_status(chat_id, user_id, status) ⇒ TD::Types::Ok

Changes the status of a chat member, needs appropriate privileges. This function is currently not suitable for adding new members to the chat; instead, use addChatMember. The chat member status will not be changed until it has been synchronized with the server.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • user_id (Integer) —

    User identifier.

  • status (TD::Types::ChatMemberStatus) —

    The new status of the member in the chat.

Returns:



3397
3398
3399
3400
3401
3402
 
# File 'lib/tdlib/client_methods.rb', line 3397

def set_chat_member_status(chat_id, user_id, status)
  broadcast('@type'   => 'setChatMemberStatus',
            'chat_id' => chat_id,
            'user_id' => user_id,
            'status'  => status)
end

#set_chat_notification_settings(chat_id, notification_settings) ⇒ TD::Types::Ok

Changes the notification settings of a chat.

Parameters:

Returns:



3409
3410
3411
3412
3413
 
# File 'lib/tdlib/client_methods.rb', line 3409

def set_chat_notification_settings(chat_id, notification_settings)
  broadcast('@type'                 => 'setChatNotificationSettings',
            'chat_id'               => chat_id,
            'notification_settings' => notification_settings)
end

#set_chat_permissions(chat_id, permissions) ⇒ TD::Types::Ok

Changes the chat members permissions. Supported only for basic groups and supergroups. Requires can_restrict_members administrator right.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • permissions (TD::Types::ChatPermissions) —

    New non-administrator members permissions in the chat.

Returns:



3422
3423
3424
3425
3426
 
# File 'lib/tdlib/client_methods.rb', line 3422

def set_chat_permissions(chat_id, permissions)
  broadcast('@type'       => 'setChatPermissions',
            'chat_id'     => chat_id,
            'permissions' => permissions)
end

#set_chat_photo(chat_id, photo) ⇒ TD::Types::Ok

Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info rights. The photo will not be changed before request to the server has been completed.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • photo (TD::Types::InputFile) —

    New chat photo. You can use a zero InputFileId to delete the chat photo. Files that are accessible only by HTTP URL are not acceptable.

Returns:



3438
3439
3440
3441
3442
 
# File 'lib/tdlib/client_methods.rb', line 3438

def set_chat_photo(chat_id, photo)
  broadcast('@type'   => 'setChatPhoto',
            'chat_id' => chat_id,
            'photo'   => photo)
end

#set_chat_title(chat_id, title) ⇒ TD::Types::Ok

Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info rights. The title will not be changed until the request to the server has been completed.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • title (String) —

    New title of the chat; 1-128 characters.

Returns:



3452
3453
3454
3455
3456
 
# File 'lib/tdlib/client_methods.rb', line 3452

def set_chat_title(chat_id, title)
  broadcast('@type'   => 'setChatTitle',
            'chat_id' => chat_id,
            'title'   => title)
end

#set_custom_language_pack(info, strings) ⇒ TD::Types::Ok

Adds or changes a custom local language pack to the current localization target.

Parameters:

  • info (TD::Types::LanguagePackInfo) —

    Information about the language pack. Language pack ID must start with 'X', consist only of English letters, digits and hyphens, and must not exceed 64 characters. Can be called before authorization.

  • strings (Array<TD::Types::LanguagePackString>) —

    Strings of the new language pack.

Returns:



3466
3467
3468
3469
3470
 
# File 'lib/tdlib/client_methods.rb', line 3466

def set_custom_language_pack(info, strings)
  broadcast('@type'   => 'setCustomLanguagePack',
            'info'    => info,
            'strings' => strings)
end

#set_custom_language_pack_string(language_pack_id, new_string) ⇒ TD::Types::Ok

Adds, edits or deletes a string in a custom local language pack. Can be called before authorization.

Parameters:

  • language_pack_id (String) —

    Identifier of a previously added custom local language pack in the current localization target.

  • new_string (TD::Types::LanguagePackString) —

    New language pack string.

Returns:



3479
3480
3481
3482
3483
 
# File 'lib/tdlib/client_methods.rb', line 3479

def set_custom_language_pack_string(language_pack_id, new_string)
  broadcast('@type'            => 'setCustomLanguagePackString',
            'language_pack_id' => language_pack_id,
            'new_string'       => new_string)
end

#set_database_encryption_key(new_encryption_key) ⇒ TD::Types::Ok

Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain.

Parameters:

  • new_encryption_key (String) —

    New encryption key.

Returns:



3490
3491
3492
3493
 
# File 'lib/tdlib/client_methods.rb', line 3490

def set_database_encryption_key(new_encryption_key)
  broadcast('@type'              => 'setDatabaseEncryptionKey',
            'new_encryption_key' => new_encryption_key)
end

#set_file_generation_progress(generation_id, expected_size, local_prefix_size) ⇒ TD::Types::Ok

Informs TDLib on a file generation prograss.

Parameters:

  • generation_id (Integer) —

    The identifier of the generation process.

  • expected_size (Integer) —

    Expected size of the generated file, in bytes; 0 if unknown.

  • local_prefix_size (Integer) —

    The number of bytes already generated.

Returns:



3501
3502
3503
3504
3505
3506
 
# File 'lib/tdlib/client_methods.rb', line 3501

def set_file_generation_progress(generation_id, expected_size, local_prefix_size)
  broadcast('@type'             => 'setFileGenerationProgress',
            'generation_id'     => generation_id,
            'expected_size'     => expected_size,
            'local_prefix_size' => local_prefix_size)
end

#set_game_score(chat_id, message_id, edit_message, user_id, score, force) ⇒ TD::Types::Message

Updates the game score of the specified user in the game; for bots only.

Parameters:

  • chat_id (Integer) —

    The chat to which the message with the game belongs.

  • message_id (Integer) —

    Identifier of the message.

  • edit_message (Boolean) —

    True, if the message should be edited.

  • user_id (Integer) —

    User identifier.

  • score (Integer) —

    The new score.

  • force (Boolean) —

    Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table.

Returns:



3518
3519
3520
3521
3522
3523
3524
3525
3526
 
# File 'lib/tdlib/client_methods.rb', line 3518

def set_game_score(chat_id, message_id, edit_message, user_id, score, force)
  broadcast('@type'        => 'setGameScore',
            'chat_id'      => chat_id,
            'message_id'   => message_id,
            'edit_message' => edit_message,
            'user_id'      => user_id,
            'score'        => score,
            'force'        => force)
end

#set_inline_game_score(inline_message_id, edit_message, user_id, score, force) ⇒ TD::Types::Ok

Updates the game score of the specified user in a game; for bots only.

Parameters:

  • inline_message_id (String) —

    Inline message identifier.

  • edit_message (Boolean) —

    True, if the message should be edited.

  • user_id (Integer) —

    User identifier.

  • score (Integer) —

    The new score.

  • force (Boolean) —

    Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table.

Returns:



3537
3538
3539
3540
3541
3542
3543
3544
 
# File 'lib/tdlib/client_methods.rb', line 3537

def set_inline_game_score(inline_message_id, edit_message, user_id, score, force)
  broadcast('@type'             => 'setInlineGameScore',
            'inline_message_id' => inline_message_id,
            'edit_message'      => edit_message,
            'user_id'           => user_id,
            'score'             => score,
            'force'             => force)
end

#set_log_stream(log_stream) ⇒ TD::Types::Ok

Sets new log stream for internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

Returns:



3553
3554
3555
3556
 
# File 'lib/tdlib/client_methods.rb', line 3553

def set_log_stream(log_stream)
  broadcast('@type'      => 'setLogStream',
            'log_stream' => log_stream)
end

#set_log_tag_verbosity_level(tag, new_verbosity_level) ⇒ TD::Types::Ok

Sets the verbosity level for a specified TDLib internal log tag. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • tag (String) —

    Logging tag to change verbosity level.

  • new_verbosity_level (Integer) —

    New verbosity level; 1-1024.

Returns:



3566
3567
3568
3569
3570
 
# File 'lib/tdlib/client_methods.rb', line 3566

def set_log_tag_verbosity_level(tag, new_verbosity_level)
  broadcast('@type'               => 'setLogTagVerbosityLevel',
            'tag'                 => tag,
            'new_verbosity_level' => new_verbosity_level)
end

#set_log_verbosity_level(new_verbosity_level) ⇒ TD::Types::Ok

Sets the verbosity level of the internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously.

Parameters:

  • new_verbosity_level (Integer) —

    New value of the verbosity level for logging. Value 0 corresponds to fatal errors, value 1 corresponds to errors, value 2 corresponds to warnings and debug warnings, value 3 corresponds to informational, value 4 corresponds to debug, value 5 corresponds to verbose debug, value greater than 5 and up to 1023 can be used to enable even more logging.

Returns:



3582
3583
3584
3585
 
# File 'lib/tdlib/client_methods.rb', line 3582

def set_log_verbosity_level(new_verbosity_level)
  broadcast('@type'               => 'setLogVerbosityLevel',
            'new_verbosity_level' => new_verbosity_level)
end

#set_name(first_name, last_name) ⇒ TD::Types::Ok

Changes the first and last name of the current user. If something changes, updateUser will be sent.

Parameters:

  • first_name (String) —

    The new value of the first name for the user; 1-64 characters.

  • last_name (String) —

    The new value of the optional last name for the user; 0-64 characters.

Returns:



3593
3594
3595
3596
3597
 
# File 'lib/tdlib/client_methods.rb', line 3593

def set_name(first_name, last_name)
  broadcast('@type'      => 'setName',
            'first_name' => first_name,
            'last_name'  => last_name)
end

#set_network_type(type) ⇒ TD::Types::Ok

Sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it should be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics.

Parameters:

Returns:



3609
3610
3611
3612
 
# File 'lib/tdlib/client_methods.rb', line 3609

def set_network_type(type)
  broadcast('@type' => 'setNetworkType',
            'type'  => type)
end

#set_option(name, value) ⇒ TD::Types::Ok

Sets the value of an option. (Check the list of available options on https://core.telegram.org/tdlib/options.) Only writable options can be set. Can be called before authorization.

Parameters:

Returns:



3621
3622
3623
3624
3625
 
# File 'lib/tdlib/client_methods.rb', line 3621

def set_option(name, value)
  broadcast('@type' => 'setOption',
            'name'  => name,
            'value' => value)
end

#set_passport_element(element, password) ⇒ TD::Types::PassportElement

Adds an element to the user's Telegram Passport. May return an error with a message "PHONE_VERIFICATION_NEEDED" or "EMAIL_VERIFICATION_NEEDED" if the chosen phone number or the chosen email address must be verified first.

Parameters:

Returns:



3634
3635
3636
3637
3638
 
# File 'lib/tdlib/client_methods.rb', line 3634

def set_passport_element(element, password)
  broadcast('@type'    => 'setPassportElement',
            'element'  => element,
            'password' => password)
end

#set_passport_element_errors(user_id, errors) ⇒ TD::Types::Ok

Informs the user that some of the elements in their Telegram Passport contain errors; for bots only. The user will not be able to resend the elements, until the errors are fixed.

Parameters:

Returns:



3646
3647
3648
3649
3650
 
# File 'lib/tdlib/client_methods.rb', line 3646

def set_passport_element_errors(user_id, errors)
  broadcast('@type'   => 'setPassportElementErrors',
            'user_id' => user_id,
            'errors'  => errors)
end

#set_password(old_password, new_password: nil, new_hint: nil, set_recovery_email_address: false, new_recovery_email_address: nil) ⇒ TD::Types::PasswordState

Changes the password for the user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed.

Parameters:

  • old_password (String) —

    Previous password of the user.

  • new_password (String, nil) (defaults to: nil) —

    New password of the user; may be empty to remove the password.

  • new_hint (String, nil) (defaults to: nil) —

    New password hint; may be empty.

  • set_recovery_email_address (Boolean) (defaults to: false) —

    Pass true if the recovery email address should be changed.

  • new_recovery_email_address (String, nil) (defaults to: nil) —

    New recovery email address; may be empty.

Returns:



3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/tdlib/client_methods.rb', line 3662

def set_password(old_password, new_password: nil, new_hint: nil, set_recovery_email_address: false,
                 new_recovery_email_address: nil)
  broadcast('@type'                      => 'setPassword',
            'old_password'               => old_password,
            'new_password'               => new_password,
            'new_hint'                   => new_hint,
            'set_recovery_email_address' => set_recovery_email_address,
            'new_recovery_email_address' => new_recovery_email_address)
end

#set_pinned_chats(chat_ids) ⇒ TD::Types::Ok

Changes the order of pinned chats.

Parameters:

  • chat_ids (Array<Integer>) —

    The new list of pinned chats.

Returns:



3676
3677
3678
3679
 
# File 'lib/tdlib/client_methods.rb', line 3676

def set_pinned_chats(chat_ids)
  broadcast('@type'    => 'setPinnedChats',
            'chat_ids' => chat_ids)
end

#set_poll_answer(chat_id, message_id, option_ids) ⇒ TD::Types::Ok

Changes user answer to a poll.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to which the poll belongs.

  • message_id (Integer) —

    Identifier of the message containing the poll.

  • option_ids (Array<Integer>) —

    0-based identifiers of options, chosen by the user. Currently user can't choose more than 1 option.

Returns:



3688
3689
3690
3691
3692
3693
 
# File 'lib/tdlib/client_methods.rb', line 3688

def set_poll_answer(chat_id, message_id, option_ids)
  broadcast('@type'      => 'setPollAnswer',
            'chat_id'    => chat_id,
            'message_id' => message_id,
            'option_ids' => option_ids)
end

#set_profile_photo(photo) ⇒ TD::Types::Ok

Uploads a new profile photo for the current user. If something changes, updateUser will be sent.

Parameters:

Returns:



3701
3702
3703
3704
 
# File 'lib/tdlib/client_methods.rb', line 3701

def set_profile_photo(photo)
  broadcast('@type' => 'setProfilePhoto',
            'photo' => photo)
end

#set_recovery_email_address(password, new_recovery_email_address) ⇒ TD::Types::PasswordState

Changes the 2-step verification recovery email address of the user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed. If new_recovery_email_address is the same as the email address that is currently set up, this call succeeds immediately and aborts all other requests waiting for an email confirmation.

Parameters:

  • password (String) —

    Password of the current user.

  • new_recovery_email_address (String) —

    New recovery email address.

Returns:



3715
3716
3717
3718
3719
 
# File 'lib/tdlib/client_methods.rb', line 3715

def set_recovery_email_address(password, new_recovery_email_address)
  broadcast('@type'                      => 'setRecoveryEmailAddress',
            'password'                   => password,
            'new_recovery_email_address' => new_recovery_email_address)
end

#set_scope_notification_settings(scope, notification_settings) ⇒ TD::Types::Ok

Changes notification settings for chats of a given type.

Parameters:

Returns:



3727
3728
3729
3730
3731
 
# File 'lib/tdlib/client_methods.rb', line 3727

def set_scope_notification_settings(scope, notification_settings)
  broadcast('@type'                 => 'setScopeNotificationSettings',
            'scope'                 => scope,
            'notification_settings' => notification_settings)
end

#set_sticker_position_in_set(sticker, position) ⇒ TD::Types::Ok

Changes the position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot.

Parameters:

  • sticker (TD::Types::InputFile) —

    Sticker.

  • position (Integer) —

    New position of the sticker in the set, zero-based.

Returns:



3739
3740
3741
3742
3743
 
# File 'lib/tdlib/client_methods.rb', line 3739

def set_sticker_position_in_set(sticker, position)
  broadcast('@type'    => 'setStickerPositionInSet',
            'sticker'  => sticker,
            'position' => position)
end

#set_supergroup_sticker_set(supergroup_id, sticker_set_id) ⇒ TD::Types::Ok

Changes the sticker set of a supergroup; requires can_change_info rights.

Parameters:

  • supergroup_id (Integer) —

    Identifier of the supergroup.

  • sticker_set_id (Integer) —

    New value of the supergroup sticker set identifier. Use 0 to remove the supergroup sticker set.

Returns:



3751
3752
3753
3754
3755
 
# File 'lib/tdlib/client_methods.rb', line 3751

def set_supergroup_sticker_set(supergroup_id, sticker_set_id)
  broadcast('@type'          => 'setSupergroupStickerSet',
            'supergroup_id'  => supergroup_id,
            'sticker_set_id' => sticker_set_id)
end

#set_supergroup_username(supergroup_id, username) ⇒ TD::Types::Ok

Changes the username of a supergroup or channel, requires creator privileges in the supergroup or channel.

Parameters:

  • supergroup_id (Integer) —

    Identifier of the supergroup or channel.

  • username (String) —

    New value of the username. Use an empty string to remove the username.

Returns:



3763
3764
3765
3766
3767
 
# File 'lib/tdlib/client_methods.rb', line 3763

def set_supergroup_username(supergroup_id, username)
  broadcast('@type'         => 'setSupergroupUsername',
            'supergroup_id' => supergroup_id,
            'username'      => username)
end

#set_tdlib_parameters(parameters) ⇒ TD::Types::Ok

Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters.

Parameters:

Returns:



3774
3775
3776
3777
 
# File 'lib/tdlib/client_methods.rb', line 3774

def set_tdlib_parameters(parameters)
  broadcast('@type'      => 'setTdlibParameters',
            'parameters' => parameters)
end

#set_user_privacy_setting_rules(setting, rules) ⇒ TD::Types::Ok

Changes user privacy settings.

Parameters:

Returns:



3784
3785
3786
3787
3788
 
# File 'lib/tdlib/client_methods.rb', line 3784

def set_user_privacy_setting_rules(setting, rules)
  broadcast('@type'   => 'setUserPrivacySettingRules',
            'setting' => setting,
            'rules'   => rules)
end

#set_username(username) ⇒ TD::Types::Ok

Changes the username of the current user. If something changes, updateUser will be sent.

Parameters:

  • username (String) —

    The new value of the username. Use an empty string to remove the username.

Returns:



3796
3797
3798
3799
 
# File 'lib/tdlib/client_methods.rb', line 3796

def set_username(username)
  broadcast('@type'    => 'setUsername',
            'username' => username)
end

#stop_poll(chat_id, message_id, reply_markup) ⇒ TD::Types::Ok

Stops a poll. A poll in a message can be stopped when the message has can_be_edited flag set.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to which the poll belongs.

  • message_id (Integer) —

    Identifier of the message containing the poll.

  • reply_markup (TD::Types::ReplyMarkup) —

    The new message reply markup; for bots only.

Returns:



3808
3809
3810
3811
3812
3813
 
# File 'lib/tdlib/client_methods.rb', line 3808

def stop_poll(chat_id, message_id, reply_markup)
  broadcast('@type'        => 'stopPoll',
            'chat_id'      => chat_id,
            'message_id'   => message_id,
            'reply_markup' => reply_markup)
end

#synchronize_language_pack(language_pack_id) ⇒ TD::Types::Ok

Fetches the latest versions of all strings from a language pack in the current localization target from the server. This method doesn't need to be called explicitly for the current used/base language packs. Can be called before authorization.

Parameters:

  • language_pack_id (String) —

    Language pack identifier.

Returns:



3821
3822
3823
3824
 
# File 'lib/tdlib/client_methods.rb', line 3821

def synchronize_language_pack(language_pack_id)
  broadcast('@type'            => 'synchronizeLanguagePack',
            'language_pack_id' => language_pack_id)
end

#terminate_all_other_sessions ⇒ TD::Types::Ok

Terminates all other sessions of the current user.

Returns:



3829
3830
3831
 
# File 'lib/tdlib/client_methods.rb', line 3829

def terminate_all_other_sessions
  broadcast('@type' => 'terminateAllOtherSessions')
end

#terminate_session(session_id) ⇒ TD::Types::Ok

Terminates a session of the current user.

Parameters:

  • session_id (Integer) —

    Session identifier.

Returns:



3837
3838
3839
3840
 
# File 'lib/tdlib/client_methods.rb', line 3837

def terminate_session(session_id)
  broadcast('@type'      => 'terminateSession',
            'session_id' => session_id)
end

#toggle_chat_default_disable_notification(chat_id, default_disable_notification) ⇒ TD::Types::Ok

Changes the value of the default disable_notification parameter, used when a message is sent to a chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • default_disable_notification (Boolean) —

    New value of default_disable_notification.

Returns:



3847
3848
3849
3850
3851
 
# File 'lib/tdlib/client_methods.rb', line 3847

def toggle_chat_default_disable_notification(chat_id, default_disable_notification)
  broadcast('@type'                        => 'toggleChatDefaultDisableNotification',
            'chat_id'                      => chat_id,
            'default_disable_notification' => default_disable_notification)
end

#toggle_chat_is_marked_as_unread(chat_id, is_marked_as_unread) ⇒ TD::Types::Ok

Changes the marked as unread state of a chat.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • is_marked_as_unread (Boolean) —

    New value of is_marked_as_unread.

Returns:



3858
3859
3860
3861
3862
 
# File 'lib/tdlib/client_methods.rb', line 3858

def toggle_chat_is_marked_as_unread(chat_id, is_marked_as_unread)
  broadcast('@type'               => 'toggleChatIsMarkedAsUnread',
            'chat_id'             => chat_id,
            'is_marked_as_unread' => is_marked_as_unread)
end

#toggle_chat_is_pinned(chat_id, is_pinned) ⇒ TD::Types::Ok

Changes the pinned state of a chat. You can pin up to GetOption("pinned_chat_count_max") non-secret chats and the same number of secret chats.

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • is_pinned (Boolean) —

    New value of is_pinned.

Returns:



3870
3871
3872
3873
3874
 
# File 'lib/tdlib/client_methods.rb', line 3870

def toggle_chat_is_pinned(chat_id, is_pinned)
  broadcast('@type'     => 'toggleChatIsPinned',
            'chat_id'   => chat_id,
            'is_pinned' => is_pinned)
end

#toggle_supergroup_is_all_history_available(supergroup_id, is_all_history_available) ⇒ TD::Types::Ok

Toggles whether the message history of a supergroup is available to new members; requires can_change_info rights.

Parameters:

  • supergroup_id (Integer) —

    The identifier of the supergroup.

  • is_all_history_available (Boolean) —

    The new value of is_all_history_available.

Returns:



3881
3882
3883
3884
3885
 
# File 'lib/tdlib/client_methods.rb', line 3881

def toggle_supergroup_is_all_history_available(supergroup_id, is_all_history_available)
  broadcast('@type'                    => 'toggleSupergroupIsAllHistoryAvailable',
            'supergroup_id'            => supergroup_id,
            'is_all_history_available' => is_all_history_available)
end

#toggle_supergroup_sign_messages(supergroup_id, sign_messages) ⇒ TD::Types::Ok

Toggles sender signatures messages sent in a channel; requires can_change_info rights.

Parameters:

  • supergroup_id (Integer) —

    Identifier of the channel.

  • sign_messages (Boolean) —

    New value of sign_messages.

Returns:



3892
3893
3894
3895
3896
 
# File 'lib/tdlib/client_methods.rb', line 3892

def toggle_supergroup_sign_messages(supergroup_id, sign_messages)
  broadcast('@type'         => 'toggleSupergroupSignMessages',
            'supergroup_id' => supergroup_id,
            'sign_messages' => sign_messages)
end

#unblock_user(user_id) ⇒ TD::Types::Ok

Removes a user from the blacklist.

Parameters:

  • user_id (Integer) —

    User identifier.

Returns:



3902
3903
3904
3905
 
# File 'lib/tdlib/client_methods.rb', line 3902

def unblock_user(user_id)
  broadcast('@type'   => 'unblockUser',
            'user_id' => user_id)
end

#unpin_chat_message(chat_id) ⇒ TD::Types::Ok

Removes the pinned message from a chat; requires can_pin_messages rights in the group or channel.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat.

Returns:



3911
3912
3913
3914
 
# File 'lib/tdlib/client_methods.rb', line 3911

def unpin_chat_message(chat_id)
  broadcast('@type'   => 'unpinChatMessage',
            'chat_id' => chat_id)
end

#upgrade_basic_group_chat_to_supergroup_chat(chat_id) ⇒ TD::Types::Chat

Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and messageChatUpgradeFrom; requires creator privileges. Deactivates the original basic group.

Parameters:

  • chat_id (Integer) —

    Identifier of the chat to upgrade.

Returns:



3922
3923
3924
3925
 
# File 'lib/tdlib/client_methods.rb', line 3922

def upgrade_basic_group_chat_to_supergroup_chat(chat_id)
  broadcast('@type'   => 'upgradeBasicGroupChatToSupergroupChat',
            'chat_id' => chat_id)
end

#upload_file(file, file_type, priority) ⇒ TD::Types::File

Asynchronously uploads a file to the cloud without sending it in a message. updateFile will be used to notify about upload progress and successful completion of the upload. The file will not have a persistent remote identifier until it will be sent in a message.

Parameters:

  • file (TD::Types::InputFile) —

    File to upload.

  • file_type (TD::Types::FileType) —

    File type.

  • priority (Integer) —

    Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which uploadFile was called will be uploaded first.

Returns:



3938
3939
3940
3941
3942
3943
 
# File 'lib/tdlib/client_methods.rb', line 3938

def upload_file(file, file_type, priority)
  broadcast('@type'     => 'uploadFile',
            'file'      => file,
            'file_type' => file_type,
            'priority'  => priority)
end

#upload_sticker_file(user_id, png_sticker) ⇒ TD::Types::File

Uploads a PNG image with a sticker; for bots only; returns the uploaded file.

Parameters:

  • user_id (Integer) —

    Sticker file owner.

  • png_sticker (TD::Types::InputFile) —

    PNG image with the sticker; must be up to 512 kB in size and fit in 512x512 square.

Returns:



3951
3952
3953
3954
3955
 
# File 'lib/tdlib/client_methods.rb', line 3951

def upload_sticker_file(user_id, png_sticker)
  broadcast('@type'       => 'uploadStickerFile',
            'user_id'     => user_id,
            'png_sticker' => png_sticker)
end

#validate_order_info(chat_id, message_id, order_info, allow_save) ⇒ TD::Types::ValidatedOrderInfo

Validates the order information provided by a user and returns the available shipping options for a flexible invoice.

Parameters:

  • chat_id (Integer) —

    Chat identifier of the Invoice message.

  • message_id (Integer) —

    Message identifier.

  • order_info (TD::Types::OrderInfo) —

    The order information, provided by the user.

  • allow_save (Boolean) —

    True, if the order information can be saved.

Returns:



3965
3966
3967
3968
3969
3970
3971
 
# File 'lib/tdlib/client_methods.rb', line 3965

def validate_order_info(chat_id, message_id, order_info, allow_save)
  broadcast('@type'      => 'validateOrderInfo',
            'chat_id'    => chat_id,
            'message_id' => message_id,
            'order_info' => order_info,
            'allow_save' => allow_save)
end

#view_messages(chat_id, message_ids, force_read) ⇒ TD::Types::Ok

Informs TDLib that messages are being viewed by the user. Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels).

Parameters:

  • chat_id (Integer) —

    Chat identifier.

  • message_ids (Array<Integer>) —

    The identifiers of the messages being viewed.

  • force_read (Boolean) —

    True, if messages in closed chats should be marked as read.

Returns:



3981
3982
3983
3984
3985
3986
 
# File 'lib/tdlib/client_methods.rb', line 3981

def view_messages(chat_id, message_ids, force_read)
  broadcast('@type'       => 'viewMessages',
            'chat_id'     => chat_id,
            'message_ids' => message_ids,
            'force_read'  => force_read)
end

#view_trending_sticker_sets(sticker_set_ids) ⇒ TD::Types::Ok

Informs the server that some trending sticker sets have been viewed by the user.

Parameters:

  • sticker_set_ids (Array<Integer>) —

    Identifiers of viewed trending sticker sets.

Returns:



3992
3993
3994
3995
 
# File 'lib/tdlib/client_methods.rb', line 3992

def view_trending_sticker_sets(sticker_set_ids)
  broadcast('@type'           => 'viewTrendingStickerSets',
            'sticker_set_ids' => sticker_set_ids)
end

#write_generated_file_part(generation_id, offset, data) ⇒ TD::Types::Ok

Writes a part of a generated file. This method is intended to be used only if the client has no direct access to TDLib's file system, because it is usually slower than a direct write to the destination file.

Parameters:

  • generation_id (Integer) —

    The identifier of the generation process.

  • offset (Integer) —

    The offset from which to write the data to the file.

  • data (String) —

    The data to write.

Returns:



4005
4006
4007
4008
4009
4010
 
# File 'lib/tdlib/client_methods.rb', line 4005

def write_generated_file_part(generation_id, offset, data)
  broadcast('@type'         => 'writeGeneratedFilePart',
            'generation_id' => generation_id,
            'offset'        => offset,
            'data'          => data)
end