ExGram (ex_gram v0.24.0) View Source

ExGram main supervisor that starts the bot's registry.

All the API calls are in this module. The API method's and models are auto generated and uses macros to build them.

Link to this section Summary

Functions

Unsafe version of add_sticker_to_set. It will return the response or raise in case of error.

Unsafe version of answer_callback_query. It will return the response or raise in case of error.

Unsafe version of answer_inline_query. It will return the response or raise in case of error.

Unsafe version of answer_pre_checkout_query. It will return the response or raise in case of error.

Unsafe version of answer_shipping_query. It will return the response or raise in case of error.

Unsafe version of ban_chat_member. It will return the response or raise in case of error.

Returns a specification to start this module under a supervisor.

Unsafe version of close. It will return the response or raise in case of error.

Unsafe version of copy_message. It will return the response or raise in case of error.

Unsafe version of create_chat_invite_link. It will return the response or raise in case of error.

Unsafe version of create_new_sticker_set. It will return the response or raise in case of error.

Unsafe version of delete_chat_photo. It will return the response or raise in case of error.

Unsafe version of delete_chat_sticker_set. It will return the response or raise in case of error.

Unsafe version of delete_message. It will return the response or raise in case of error.

Unsafe version of delete_my_commands. It will return the response or raise in case of error.

Unsafe version of delete_sticker_from_set. It will return the response or raise in case of error.

Unsafe version of delete_webhook. It will return the response or raise in case of error.

Unsafe version of edit_chat_invite_link. It will return the response or raise in case of error.

Unsafe version of edit_message_caption. It will return the response or raise in case of error.

Unsafe version of edit_message_live_location. It will return the response or raise in case of error.

Unsafe version of edit_message_media. It will return the response or raise in case of error.

Unsafe version of edit_message_reply_markup. It will return the response or raise in case of error.

Unsafe version of edit_message_text. It will return the response or raise in case of error.

Unsafe version of export_chat_invite_link. It will return the response or raise in case of error.

Unsafe version of forward_message. It will return the response or raise in case of error.

Unsafe version of get_chat. It will return the response or raise in case of error.

Unsafe version of get_chat_administrators. It will return the response or raise in case of error.

Unsafe version of get_chat_member. It will return the response or raise in case of error.

Unsafe version of get_chat_member_count. It will return the response or raise in case of error.

Unsafe version of get_file. It will return the response or raise in case of error.

Unsafe version of get_game_high_scores. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getme

Unsafe version of get_me. It will return the response or raise in case of error.

Unsafe version of get_my_commands. It will return the response or raise in case of error.

Unsafe version of get_sticker_set. It will return the response or raise in case of error.

Unsafe version of get_updates. It will return the response or raise in case of error.

Unsafe version of get_user_profile_photos. It will return the response or raise in case of error.

Unsafe version of get_webhook_info. It will return the response or raise in case of error.

Callback implementation for Supervisor.init/1.

Unsafe version of leave_chat. It will return the response or raise in case of error.

Unsafe version of log_out. It will return the response or raise in case of error.

Unsafe version of pin_chat_message. It will return the response or raise in case of error.

Unsafe version of promote_chat_member. It will return the response or raise in case of error.

Unsafe version of restrict_chat_member. It will return the response or raise in case of error.

Unsafe version of revoke_chat_invite_link. It will return the response or raise in case of error.

Unsafe version of send_animation. It will return the response or raise in case of error.

Unsafe version of send_audio. It will return the response or raise in case of error.

Unsafe version of send_chat_action. It will return the response or raise in case of error.

Unsafe version of send_contact. It will return the response or raise in case of error.

Unsafe version of send_dice. It will return the response or raise in case of error.

Unsafe version of send_document. It will return the response or raise in case of error.

Unsafe version of send_game. It will return the response or raise in case of error.

Unsafe version of send_invoice. It will return the response or raise in case of error.

Unsafe version of send_location. It will return the response or raise in case of error.

Unsafe version of send_media_group. It will return the response or raise in case of error.

Unsafe version of send_message. It will return the response or raise in case of error.

Unsafe version of send_photo. It will return the response or raise in case of error.

Unsafe version of send_poll. It will return the response or raise in case of error.

Unsafe version of send_sticker. It will return the response or raise in case of error.

Unsafe version of send_venue. It will return the response or raise in case of error.

Unsafe version of send_video. It will return the response or raise in case of error.

Unsafe version of send_video_note. It will return the response or raise in case of error.

Unsafe version of send_voice. It will return the response or raise in case of error.

Unsafe version of set_chat_administrator_custom_title. It will return the response or raise in case of error.

Unsafe version of set_chat_description. It will return the response or raise in case of error.

Unsafe version of set_chat_permissions. It will return the response or raise in case of error.

Unsafe version of set_chat_photo. It will return the response or raise in case of error.

Unsafe version of set_chat_sticker_set. It will return the response or raise in case of error.

Unsafe version of set_chat_title. It will return the response or raise in case of error.

Unsafe version of set_game_score. It will return the response or raise in case of error.

Unsafe version of set_my_commands. It will return the response or raise in case of error.

Unsafe version of set_passport_data_errors. It will return the response or raise in case of error.

Unsafe version of set_sticker_position_in_set. It will return the response or raise in case of error.

Unsafe version of set_sticker_set_thumb. It will return the response or raise in case of error.

Unsafe version of set_webhook. It will return the response or raise in case of error.

Unsafe version of stop_message_live_location. It will return the response or raise in case of error.

Unsafe version of stop_poll. It will return the response or raise in case of error.

Unsafe version of unban_chat_member. It will return the response or raise in case of error.

Unsafe version of unpin_all_chat_messages. It will return the response or raise in case of error.

Unsafe version of unpin_chat_message. It will return the response or raise in case of error.

Unsafe version of upload_sticker_file. It will return the response or raise in case of error.

Link to this section Functions

Link to this function

add_sticker_to_set(user_id, name, emojis, options \\ [])

View Source

Specs

add_sticker_to_set(
  user_id :: integer(),
  name :: String.t(),
  emojis :: String.t(),
  options :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#addstickertoset

Link to this function

add_sticker_to_set!(user_id, name, emojis, ops \\ [])

View Source

Specs

add_sticker_to_set!(
  user_id :: integer(),
  name :: String.t(),
  emojis :: String.t(),
  ops :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of add_sticker_to_set. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#addstickertoset

Link to this function

answer_callback_query(callback_query_id, options \\ [])

View Source

Specs

answer_callback_query(
  callback_query_id :: String.t(),
  options :: [
    text: String.t(),
    show_alert: boolean(),
    url: String.t(),
    cache_time: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#answercallbackquery

Link to this function

answer_callback_query!(callback_query_id, ops \\ [])

View Source

Specs

answer_callback_query!(
  callback_query_id :: String.t(),
  ops :: [
    text: String.t(),
    show_alert: boolean(),
    url: String.t(),
    cache_time: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_callback_query. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#answercallbackquery

Link to this function

answer_inline_query(inline_query_id, results, options \\ [])

View Source

Specs

answer_inline_query(
  inline_query_id :: String.t(),
  results :: [ExGram.Model.InlineQueryResult.t()],
  options :: [
    cache_time: integer(),
    is_personal: boolean(),
    next_offset: String.t(),
    switch_pm_text: String.t(),
    switch_pm_parameter: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#answerinlinequery

Link to this function

answer_inline_query!(inline_query_id, results, ops \\ [])

View Source

Specs

answer_inline_query!(
  inline_query_id :: String.t(),
  results :: [ExGram.Model.InlineQueryResult.t()],
  ops :: [
    cache_time: integer(),
    is_personal: boolean(),
    next_offset: String.t(),
    switch_pm_text: String.t(),
    switch_pm_parameter: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_inline_query. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#answerinlinequery

Link to this function

answer_pre_checkout_query(pre_checkout_query_id, ok, options \\ [])

View Source

Specs

answer_pre_checkout_query(
  pre_checkout_query_id :: String.t(),
  ok :: boolean(),
  options :: [
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#answerprecheckoutquery

Link to this function

answer_pre_checkout_query!(pre_checkout_query_id, ok, ops \\ [])

View Source

Specs

answer_pre_checkout_query!(
  pre_checkout_query_id :: String.t(),
  ok :: boolean(),
  ops :: [
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_pre_checkout_query. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#answerprecheckoutquery

Link to this function

answer_shipping_query(shipping_query_id, ok, options \\ [])

View Source

Specs

answer_shipping_query(
  shipping_query_id :: String.t(),
  ok :: boolean(),
  options :: [
    shipping_options: [ExGram.Model.ShippingOption.t()],
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#answershippingquery

Link to this function

answer_shipping_query!(shipping_query_id, ok, ops \\ [])

View Source

Specs

answer_shipping_query!(
  shipping_query_id :: String.t(),
  ok :: boolean(),
  ops :: [
    shipping_options: [ExGram.Model.ShippingOption.t()],
    error_message: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of answer_shipping_query. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#answershippingquery

Link to this function

ban_chat_member(chat_id, user_id, options \\ [])

View Source

Specs

ban_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    until_date: integer(),
    revoke_messages: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#banchatmember

Link to this function

ban_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

ban_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    until_date: integer(),
    revoke_messages: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of ban_chat_member. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#banchatmember

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

close(chat_id, text, options \\ [])

View Source

Specs

close(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  options :: [
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#close

Link to this function

close!(chat_id, text, ops \\ [])

View Source

Specs

close!(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  ops :: [
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of close. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#close

Link to this function

copy_message(chat_id, from_chat_id, message_id, options \\ [])

View Source

Specs

copy_message(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.MessageId.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#copymessage

Link to this function

copy_message!(chat_id, from_chat_id, message_id, ops \\ [])

View Source

Specs

copy_message!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.MessageId.t()

Unsafe version of copy_message. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#copymessage

Link to this function

create_chat_invite_link(chat_id, options \\ [])

View Source

Specs

create_chat_invite_link(
  chat_id :: integer() | String.t(),
  options :: [
    expire_date: integer(),
    member_limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#createchatinvitelink

Link to this function

create_chat_invite_link!(chat_id, ops \\ [])

View Source

Specs

create_chat_invite_link!(
  chat_id :: integer() | String.t(),
  ops :: [
    expire_date: integer(),
    member_limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of create_chat_invite_link. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#createchatinvitelink

Link to this function

create_new_sticker_set(user_id, name, title, emojis, options \\ [])

View Source

Specs

create_new_sticker_set(
  user_id :: integer(),
  name :: String.t(),
  title :: String.t(),
  emojis :: String.t(),
  options :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    contains_masks: boolean(),
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#createnewstickerset

Link to this function

create_new_sticker_set!(user_id, name, title, emojis, ops \\ [])

View Source

Specs

create_new_sticker_set!(
  user_id :: integer(),
  name :: String.t(),
  title :: String.t(),
  emojis :: String.t(),
  ops :: [
    png_sticker:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    tgs_sticker:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    contains_masks: boolean(),
    mask_position: ExGram.Model.MaskPosition.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of create_new_sticker_set. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#createnewstickerset

Link to this function

delete_chat_photo(chat_id, options \\ [])

View Source

Specs

delete_chat_photo(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatphoto

Link to this function

delete_chat_photo!(chat_id, ops \\ [])

View Source

Specs

delete_chat_photo!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_chat_photo. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatphoto

Link to this function

delete_chat_sticker_set(chat_id, options \\ [])

View Source

Specs

delete_chat_sticker_set(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatstickerset

Link to this function

delete_chat_sticker_set!(chat_id, ops \\ [])

View Source

Specs

delete_chat_sticker_set!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_chat_sticker_set. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#deletechatstickerset

Link to this function

delete_message(chat_id, message_id, options \\ [])

View Source

Specs

delete_message(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#deletemessage

Link to this function

delete_message!(chat_id, message_id, ops \\ [])

View Source

Specs

delete_message!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_message. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#deletemessage

Link to this function

delete_my_commands(options \\ [])

View Source

Specs

delete_my_commands(
  options :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#deletemycommands

Link to this function

delete_my_commands!(ops \\ [])

View Source

Specs

delete_my_commands!(
  ops :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_my_commands. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#deletemycommands

Link to this function

delete_sticker_from_set(sticker, options \\ [])

View Source

Specs

delete_sticker_from_set(
  sticker :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#deletestickerfromset

Link to this function

delete_sticker_from_set!(sticker, ops \\ [])

View Source

Specs

delete_sticker_from_set!(
  sticker :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_sticker_from_set. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#deletestickerfromset

Link to this function

delete_webhook(options \\ [])

View Source

Specs

delete_webhook(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#deletewebhook

Link to this function

delete_webhook!(ops \\ [])

View Source

Specs

delete_webhook!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of delete_webhook. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#deletewebhook

Link to this function

edit_chat_invite_link(chat_id, invite_link, options \\ [])

View Source

Specs

edit_chat_invite_link(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  options :: [
    expire_date: integer(),
    member_limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#editchatinvitelink

Link to this function

edit_chat_invite_link!(chat_id, invite_link, ops \\ [])

View Source

Specs

edit_chat_invite_link!(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  ops :: [
    expire_date: integer(),
    member_limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of edit_chat_invite_link. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#editchatinvitelink

Link to this function

edit_message_caption(options \\ [])

View Source

Specs

edit_message_caption(
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagecaption

Link to this function

edit_message_caption!(ops \\ [])

View Source

Specs

edit_message_caption!(
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_caption. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagecaption

Link to this function

edit_message_live_location(latitude, longitude, options \\ [])

View Source

Specs

edit_message_live_location(
  latitude :: float(),
  longitude :: float(),
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    horizontal_accuracy: float(),
    heading: integer(),
    proximity_alert_radius: integer(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagelivelocation

Link to this function

edit_message_live_location!(latitude, longitude, ops \\ [])

View Source

Specs

edit_message_live_location!(
  latitude :: float(),
  longitude :: float(),
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    horizontal_accuracy: float(),
    heading: integer(),
    proximity_alert_radius: integer(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_live_location. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagelivelocation

Link to this function

edit_message_media(media, options \\ [])

View Source

Specs

edit_message_media(
  media :: ExGram.Model.InputMedia.t(),
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagemedia

Link to this function

edit_message_media!(media, ops \\ [])

View Source

Specs

edit_message_media!(
  media :: ExGram.Model.InputMedia.t(),
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_media. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagemedia

Link to this function

edit_message_reply_markup(options \\ [])

View Source

Specs

edit_message_reply_markup(
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagereplymarkup

Link to this function

edit_message_reply_markup!(ops \\ [])

View Source

Specs

edit_message_reply_markup!(
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_reply_markup. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagereplymarkup

Link to this function

edit_message_text(text, options \\ [])

View Source

Specs

edit_message_text(
  text :: String.t(),
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagetext

Link to this function

edit_message_text!(text, ops \\ [])

View Source

Specs

edit_message_text!(
  text :: String.t(),
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of edit_message_text. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#editmessagetext

Link to this function

export_chat_invite_link(chat_id, options \\ [])

View Source

Specs

export_chat_invite_link(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, String.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#exportchatinvitelink

Link to this function

export_chat_invite_link!(chat_id, ops \\ [])

View Source

Specs

export_chat_invite_link!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: String.t()

Unsafe version of export_chat_invite_link. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#exportchatinvitelink

Link to this function

forward_message(chat_id, from_chat_id, message_id, options \\ [])

View Source

Specs

forward_message(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    disable_notification: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#forwardmessage

Link to this function

forward_message!(chat_id, from_chat_id, message_id, ops \\ [])

View Source

Specs

forward_message!(
  chat_id :: integer() | String.t(),
  from_chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    disable_notification: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of forward_message. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#forwardmessage

Link to this function

get_chat(chat_id, options \\ [])

View Source

Specs

get_chat(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Chat.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getchat

Link to this function

get_chat!(chat_id, ops \\ [])

View Source

Specs

get_chat!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Chat.t()

Unsafe version of get_chat. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getchat

Link to this function

get_chat_administrators(chat_id, options \\ [])

View Source

Specs

get_chat_administrators(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatMember.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getchatadministrators

Link to this function

get_chat_administrators!(chat_id, ops \\ [])

View Source

Specs

get_chat_administrators!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatMember.t()

Unsafe version of get_chat_administrators. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatadministrators

Link to this function

get_chat_member(chat_id, user_id, options \\ [])

View Source

Specs

get_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatMember.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmember

Link to this function

get_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

get_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatMember.t()

Unsafe version of get_chat_member. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmember

Link to this function

get_chat_member_count(chat_id, options \\ [])

View Source

Specs

get_chat_member_count(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, integer()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmembercount

Link to this function

get_chat_member_count!(chat_id, ops \\ [])

View Source

Specs

get_chat_member_count!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: integer()

Unsafe version of get_chat_member_count. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getchatmembercount

Link to this function

get_file(file_id, options \\ [])

View Source

Specs

get_file(
  file_id :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.File.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getfile

Link to this function

get_file!(file_id, ops \\ [])

View Source

Specs

get_file!(
  file_id :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.File.t()

Unsafe version of get_file. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getfile

Link to this function

get_game_high_scores(user_id, options \\ [])

View Source

Specs

get_game_high_scores(
  user_id :: integer(),
  options :: [
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.GameHighScore.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getgamehighscores

Link to this function

get_game_high_scores!(user_id, ops \\ [])

View Source

Specs

get_game_high_scores!(
  user_id :: integer(),
  ops :: [
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.GameHighScore.t()

Unsafe version of get_game_high_scores. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getgamehighscores

Specs

get_me(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.User.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getme

Specs

get_me!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.User.t()

Unsafe version of get_me. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getme

Link to this function

get_my_commands(options \\ [])

View Source

Specs

get_my_commands(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.BotCommand.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getmycommands

Link to this function

get_my_commands!(ops \\ [])

View Source

Specs

get_my_commands!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.BotCommand.t()

Unsafe version of get_my_commands. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getmycommands

Link to this function

get_sticker_set(name, options \\ [])

View Source

Specs

get_sticker_set(
  name :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.StickerSet.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getstickerset

Link to this function

get_sticker_set!(name, ops \\ [])

View Source

Specs

get_sticker_set!(
  name :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.StickerSet.t()

Unsafe version of get_sticker_set. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getstickerset

Link to this function

get_updates(options \\ [])

View Source

Specs

get_updates(
  options :: [
    offset: integer(),
    limit: integer(),
    timeout: integer(),
    allowed_updates: [String.t()],
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Update.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getupdates

Specs

get_updates!(
  ops :: [
    offset: integer(),
    limit: integer(),
    timeout: integer(),
    allowed_updates: [String.t()],
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Update.t()

Unsafe version of get_updates. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getupdates

Link to this function

get_user_profile_photos(user_id, options \\ [])

View Source

Specs

get_user_profile_photos(
  user_id :: integer(),
  options :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.UserProfilePhotos.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getuserprofilephotos

Link to this function

get_user_profile_photos!(user_id, ops \\ [])

View Source

Specs

get_user_profile_photos!(
  user_id :: integer(),
  ops :: [
    offset: integer(),
    limit: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.UserProfilePhotos.t()

Unsafe version of get_user_profile_photos. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getuserprofilephotos

Link to this function

get_webhook_info(options \\ [])

View Source

Specs

get_webhook_info(
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.WebhookInfo.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#getwebhookinfo

Link to this function

get_webhook_info!(ops \\ [])

View Source

Specs

get_webhook_info!(
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.WebhookInfo.t()

Unsafe version of get_webhook_info. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#getwebhookinfo

Callback implementation for Supervisor.init/1.

Link to this function

leave_chat(chat_id, options \\ [])

View Source

Specs

leave_chat(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#leavechat

Link to this function

leave_chat!(chat_id, ops \\ [])

View Source

Specs

leave_chat!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of leave_chat. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#leavechat

Link to this function

log_out(chat_id, text, options \\ [])

View Source

Specs

log_out(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  options :: [
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#logout

Link to this function

log_out!(chat_id, text, ops \\ [])

View Source

Specs

log_out!(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  ops :: [
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of log_out. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#logout

Link to this function

pin_chat_message(chat_id, message_id, options \\ [])

View Source

Specs

pin_chat_message(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    disable_notification: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#pinchatmessage

Link to this function

pin_chat_message!(chat_id, message_id, ops \\ [])

View Source

Specs

pin_chat_message!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    disable_notification: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of pin_chat_message. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#pinchatmessage

Link to this function

promote_chat_member(chat_id, user_id, options \\ [])

View Source

Specs

promote_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    is_anonymous: boolean(),
    can_manage_chat: boolean(),
    can_post_messages: boolean(),
    can_edit_messages: boolean(),
    can_delete_messages: boolean(),
    can_manage_voice_chats: boolean(),
    can_restrict_members: boolean(),
    can_promote_members: boolean(),
    can_change_info: boolean(),
    can_invite_users: boolean(),
    can_pin_messages: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#promotechatmember

Link to this function

promote_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

promote_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    is_anonymous: boolean(),
    can_manage_chat: boolean(),
    can_post_messages: boolean(),
    can_edit_messages: boolean(),
    can_delete_messages: boolean(),
    can_manage_voice_chats: boolean(),
    can_restrict_members: boolean(),
    can_promote_members: boolean(),
    can_change_info: boolean(),
    can_invite_users: boolean(),
    can_pin_messages: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of promote_chat_member. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#promotechatmember

Link to this function

restrict_chat_member(chat_id, user_id, permissions, options \\ [])

View Source

Specs

restrict_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  options :: [
    until_date: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#restrictchatmember

Link to this function

restrict_chat_member!(chat_id, user_id, permissions, ops \\ [])

View Source

Specs

restrict_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  ops :: [
    until_date: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of restrict_chat_member. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#restrictchatmember

Link to this function

revoke_chat_invite_link(chat_id, invite_link, options \\ [])

View Source

Specs

revoke_chat_invite_link(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.ChatInviteLink.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#revokechatinvitelink

Link to this function

revoke_chat_invite_link!(chat_id, invite_link, ops \\ [])

View Source

Specs

revoke_chat_invite_link!(
  chat_id :: integer() | String.t(),
  invite_link :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.ChatInviteLink.t()

Unsafe version of revoke_chat_invite_link. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#revokechatinvitelink

Link to this function

send_animation(chat_id, animation, options \\ [])

View Source

Specs

send_animation(
  chat_id :: integer() | String.t(),
  animation ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendanimation

Link to this function

send_animation!(chat_id, animation, ops \\ [])

View Source

Specs

send_animation!(
  chat_id :: integer() | String.t(),
  animation ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_animation. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendanimation

Link to this function

send_audio(chat_id, audio, options \\ [])

View Source

Specs

send_audio(
  chat_id :: integer() | String.t(),
  audio ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    performer: String.t(),
    title: String.t(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendaudio

Link to this function

send_audio!(chat_id, audio, ops \\ [])

View Source

Specs

send_audio!(
  chat_id :: integer() | String.t(),
  audio ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    performer: String.t(),
    title: String.t(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_audio. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendaudio

Link to this function

send_chat_action(chat_id, action, options \\ [])

View Source

Specs

send_chat_action(
  chat_id :: integer() | String.t(),
  action :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendchataction

Link to this function

send_chat_action!(chat_id, action, ops \\ [])

View Source

Specs

send_chat_action!(
  chat_id :: integer() | String.t(),
  action :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of send_chat_action. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendchataction

Link to this function

send_contact(chat_id, phone_number, first_name, options \\ [])

View Source

Specs

send_contact(
  chat_id :: integer() | String.t(),
  phone_number :: String.t(),
  first_name :: String.t(),
  options :: [
    last_name: String.t(),
    vcard: String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendcontact

Link to this function

send_contact!(chat_id, phone_number, first_name, ops \\ [])

View Source

Specs

send_contact!(
  chat_id :: integer() | String.t(),
  phone_number :: String.t(),
  first_name :: String.t(),
  ops :: [
    last_name: String.t(),
    vcard: String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_contact. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendcontact

Link to this function

send_dice(chat_id, options \\ [])

View Source

Specs

send_dice(
  chat_id :: integer() | String.t(),
  options :: [
    emoji: String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#senddice

Link to this function

send_dice!(chat_id, ops \\ [])

View Source

Specs

send_dice!(
  chat_id :: integer() | String.t(),
  ops :: [
    emoji: String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_dice. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#senddice

Link to this function

send_document(chat_id, document, options \\ [])

View Source

Specs

send_document(
  chat_id :: integer() | String.t(),
  document ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_content_type_detection: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#senddocument

Link to this function

send_document!(chat_id, document, ops \\ [])

View Source

Specs

send_document!(
  chat_id :: integer() | String.t(),
  document ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_content_type_detection: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_document. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#senddocument

Link to this function

send_game(chat_id, game_short_name, options \\ [])

View Source

Specs

send_game(
  chat_id :: integer(),
  game_short_name :: String.t(),
  options :: [
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendgame

Link to this function

send_game!(chat_id, game_short_name, ops \\ [])

View Source

Specs

send_game!(
  chat_id :: integer(),
  game_short_name :: String.t(),
  ops :: [
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_game. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendgame

Link to this function

send_invoice(chat_id, title, description, payload, provider_token, currency, prices, options \\ [])

View Source

Specs

send_invoice(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  provider_token :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  options :: [
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    start_parameter: String.t(),
    provider_data: String.t(),
    photo_url: String.t(),
    photo_size: integer(),
    photo_width: integer(),
    photo_height: integer(),
    need_name: boolean(),
    need_phone_number: boolean(),
    need_email: boolean(),
    need_shipping_address: boolean(),
    send_phone_number_to_provider: boolean(),
    send_email_to_provider: boolean(),
    is_flexible: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendinvoice

Link to this function

send_invoice!(chat_id, title, description, payload, provider_token, currency, prices, ops \\ [])

View Source

Specs

send_invoice!(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  description :: String.t(),
  payload :: String.t(),
  provider_token :: String.t(),
  currency :: String.t(),
  prices :: [ExGram.Model.LabeledPrice.t()],
  ops :: [
    max_tip_amount: integer(),
    suggested_tip_amounts: [integer()],
    start_parameter: String.t(),
    provider_data: String.t(),
    photo_url: String.t(),
    photo_size: integer(),
    photo_width: integer(),
    photo_height: integer(),
    need_name: boolean(),
    need_phone_number: boolean(),
    need_email: boolean(),
    need_shipping_address: boolean(),
    send_phone_number_to_provider: boolean(),
    send_email_to_provider: boolean(),
    is_flexible: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_invoice. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendinvoice

Link to this function

send_location(chat_id, latitude, longitude, options \\ [])

View Source

Specs

send_location(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  options :: [
    horizontal_accuracy: float(),
    live_period: integer(),
    heading: integer(),
    proximity_alert_radius: integer(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendlocation

Link to this function

send_location!(chat_id, latitude, longitude, ops \\ [])

View Source

Specs

send_location!(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  ops :: [
    horizontal_accuracy: float(),
    live_period: integer(),
    heading: integer(),
    proximity_alert_radius: integer(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_location. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendlocation

Link to this function

send_media_group(chat_id, media, options \\ [])

View Source

Specs

send_media_group(
  chat_id :: integer() | String.t(),
  media :: [
    ExGram.Model.InputMediaAudio.t()
    | ExGram.Model.InputMediaDocument.t()
    | ExGram.Model.InputMediaPhoto.t()
    | ExGram.Model.InputMediaVideo.t()
  ],
  options :: [
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendmediagroup

Link to this function

send_media_group!(chat_id, media, ops \\ [])

View Source

Specs

send_media_group!(
  chat_id :: integer() | String.t(),
  media :: [
    ExGram.Model.InputMediaAudio.t()
    | ExGram.Model.InputMediaDocument.t()
    | ExGram.Model.InputMediaPhoto.t()
    | ExGram.Model.InputMediaVideo.t()
  ],
  ops :: [
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_media_group. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendmediagroup

Link to this function

send_message(chat_id, text, options \\ [])

View Source

Specs

send_message(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  options :: [
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendmessage

Link to this function

send_message!(chat_id, text, ops \\ [])

View Source

Specs

send_message!(
  chat_id :: integer() | String.t(),
  text :: String.t(),
  ops :: [
    parse_mode: String.t(),
    entities: [ExGram.Model.MessageEntity.t()],
    disable_web_page_preview: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_message. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendmessage

Link to this function

send_photo(chat_id, photo, options \\ [])

View Source

Specs

send_photo(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendphoto

Link to this function

send_photo!(chat_id, photo, ops \\ [])

View Source

Specs

send_photo!(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_photo. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendphoto

Link to this function

send_poll(chat_id, question, options, options \\ [])

View Source

Specs

send_poll(
  chat_id :: integer() | String.t(),
  question :: String.t(),
  options :: [String.t()],
  options :: [
    is_anonymous: boolean(),
    type: String.t(),
    allows_multiple_answers: boolean(),
    correct_option_id: integer(),
    explanation: String.t(),
    explanation_parse_mode: String.t(),
    explanation_entities: [ExGram.Model.MessageEntity.t()],
    open_period: integer(),
    close_date: integer(),
    is_closed: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendpoll

Link to this function

send_poll!(chat_id, question, options, ops \\ [])

View Source

Specs

send_poll!(
  chat_id :: integer() | String.t(),
  question :: String.t(),
  options :: [String.t()],
  ops :: [
    is_anonymous: boolean(),
    type: String.t(),
    allows_multiple_answers: boolean(),
    correct_option_id: integer(),
    explanation: String.t(),
    explanation_parse_mode: String.t(),
    explanation_entities: [ExGram.Model.MessageEntity.t()],
    open_period: integer(),
    close_date: integer(),
    is_closed: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_poll. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendpoll

Link to this function

send_sticker(chat_id, sticker, options \\ [])

View Source

Specs

send_sticker(
  chat_id :: integer() | String.t(),
  sticker ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendsticker

Link to this function

send_sticker!(chat_id, sticker, ops \\ [])

View Source

Specs

send_sticker!(
  chat_id :: integer() | String.t(),
  sticker ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_sticker. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendsticker

Link to this function

send_venue(chat_id, latitude, longitude, title, address, options \\ [])

View Source

Specs

send_venue(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  title :: String.t(),
  address :: String.t(),
  options :: [
    foursquare_id: String.t(),
    foursquare_type: String.t(),
    google_place_id: String.t(),
    google_place_type: String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendvenue

Link to this function

send_venue!(chat_id, latitude, longitude, title, address, ops \\ [])

View Source

Specs

send_venue!(
  chat_id :: integer() | String.t(),
  latitude :: float(),
  longitude :: float(),
  title :: String.t(),
  address :: String.t(),
  ops :: [
    foursquare_id: String.t(),
    foursquare_type: String.t(),
    google_place_id: String.t(),
    google_place_type: String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_venue. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvenue

Link to this function

send_video(chat_id, video, options \\ [])

View Source

Specs

send_video(
  chat_id :: integer() | String.t(),
  video ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    supports_streaming: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideo

Link to this function

send_video!(chat_id, video, ops \\ [])

View Source

Specs

send_video!(
  chat_id :: integer() | String.t(),
  video ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    duration: integer(),
    width: integer(),
    height: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    supports_streaming: boolean(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_video. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideo

Link to this function

send_video_note(chat_id, video_note, options \\ [])

View Source

Specs

send_video_note(
  chat_id :: integer() | String.t(),
  video_note ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    duration: integer(),
    length: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideonote

Link to this function

send_video_note!(chat_id, video_note, ops \\ [])

View Source

Specs

send_video_note!(
  chat_id :: integer() | String.t(),
  video_note ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    duration: integer(),
    length: integer(),
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_video_note. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvideonote

Link to this function

send_voice(chat_id, voice, options \\ [])

View Source

Specs

send_voice(
  chat_id :: integer() | String.t(),
  voice ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  options :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#sendvoice

Link to this function

send_voice!(chat_id, voice, ops \\ [])

View Source

Specs

send_voice!(
  chat_id :: integer() | String.t(),
  voice ::
    {:file, String.t()}
    | {:file_content, iodata() | Enum.t(), String.t()}
    | String.t(),
  ops :: [
    caption: String.t(),
    parse_mode: String.t(),
    caption_entities: [ExGram.Model.MessageEntity.t()],
    duration: integer(),
    disable_notification: boolean(),
    reply_to_message_id: integer(),
    allow_sending_without_reply: boolean(),
    reply_markup:
      ExGram.Model.InlineKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardMarkup.t()
      | ExGram.Model.ReplyKeyboardRemove.t()
      | ExGram.Model.ForceReply.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of send_voice. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#sendvoice

Link to this function

set_chat_administrator_custom_title(chat_id, user_id, custom_title, options \\ [])

View Source

Specs

set_chat_administrator_custom_title(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  custom_title :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setchatadministratorcustomtitle

Link to this function

set_chat_administrator_custom_title!(chat_id, user_id, custom_title, ops \\ [])

View Source

Specs

set_chat_administrator_custom_title!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  custom_title :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_administrator_custom_title. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatadministratorcustomtitle

Link to this function

set_chat_description(chat_id, options \\ [])

View Source

Specs

set_chat_description(
  chat_id :: integer() | String.t(),
  options :: [
    description: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setchatdescription

Link to this function

set_chat_description!(chat_id, ops \\ [])

View Source

Specs

set_chat_description!(
  chat_id :: integer() | String.t(),
  ops :: [
    description: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_description. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatdescription

Link to this function

set_chat_permissions(chat_id, permissions, options \\ [])

View Source

Specs

set_chat_permissions(
  chat_id :: integer() | String.t(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setchatpermissions

Link to this function

set_chat_permissions!(chat_id, permissions, ops \\ [])

View Source

Specs

set_chat_permissions!(
  chat_id :: integer() | String.t(),
  permissions :: ExGram.Model.ChatPermissions.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_permissions. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatpermissions

Link to this function

set_chat_photo(chat_id, photo, options \\ [])

View Source

Specs

set_chat_photo(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setchatphoto

Link to this function

set_chat_photo!(chat_id, photo, ops \\ [])

View Source

Specs

set_chat_photo!(
  chat_id :: integer() | String.t(),
  photo ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_photo. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatphoto

Link to this function

set_chat_sticker_set(chat_id, sticker_set_name, options \\ [])

View Source

Specs

set_chat_sticker_set(
  chat_id :: integer() | String.t(),
  sticker_set_name :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setchatstickerset

Link to this function

set_chat_sticker_set!(chat_id, sticker_set_name, ops \\ [])

View Source

Specs

set_chat_sticker_set!(
  chat_id :: integer() | String.t(),
  sticker_set_name :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_sticker_set. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setchatstickerset

Link to this function

set_chat_title(chat_id, title, options \\ [])

View Source

Specs

set_chat_title(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setchattitle

Link to this function

set_chat_title!(chat_id, title, ops \\ [])

View Source

Specs

set_chat_title!(
  chat_id :: integer() | String.t(),
  title :: String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_chat_title. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setchattitle

Link to this function

set_game_score(user_id, score, options \\ [])

View Source

Specs

set_game_score(
  user_id :: integer(),
  score :: integer(),
  options :: [
    force: boolean(),
    disable_edit_message: boolean(),
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setgamescore

Link to this function

set_game_score!(user_id, score, ops \\ [])

View Source

Specs

set_game_score!(
  user_id :: integer(),
  score :: integer(),
  ops :: [
    force: boolean(),
    disable_edit_message: boolean(),
    chat_id: integer(),
    message_id: integer(),
    inline_message_id: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of set_game_score. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setgamescore

Link to this function

set_my_commands(commands, options \\ [])

View Source

Specs

set_my_commands(
  commands :: [ExGram.Model.BotCommand.t()],
  options :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setmycommands

Link to this function

set_my_commands!(commands, ops \\ [])

View Source

Specs

set_my_commands!(
  commands :: [ExGram.Model.BotCommand.t()],
  ops :: [
    scope: ExGram.Model.BotCommandScope.t(),
    language_code: String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_my_commands. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setmycommands

Link to this function

set_passport_data_errors(user_id, errors, options \\ [])

View Source

Specs

set_passport_data_errors(
  user_id :: integer(),
  errors :: [ExGram.Model.PassportElementError.t()],
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setpassportdataerrors

Link to this function

set_passport_data_errors!(user_id, errors, ops \\ [])

View Source

Specs

set_passport_data_errors!(
  user_id :: integer(),
  errors :: [ExGram.Model.PassportElementError.t()],
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_passport_data_errors. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setpassportdataerrors

Link to this function

set_sticker_position_in_set(sticker, position, options \\ [])

View Source

Specs

set_sticker_position_in_set(
  sticker :: String.t(),
  position :: integer(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setstickerpositioninset

Link to this function

set_sticker_position_in_set!(sticker, position, ops \\ [])

View Source

Specs

set_sticker_position_in_set!(
  sticker :: String.t(),
  position :: integer(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_sticker_position_in_set. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setstickerpositioninset

Link to this function

set_sticker_set_thumb(name, user_id, options \\ [])

View Source

Specs

set_sticker_set_thumb(
  name :: String.t(),
  user_id :: integer(),
  options :: [
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setstickersetthumb

Link to this function

set_sticker_set_thumb!(name, user_id, ops \\ [])

View Source

Specs

set_sticker_set_thumb!(
  name :: String.t(),
  user_id :: integer(),
  ops :: [
    thumb:
      {:file, String.t()}
      | {:file_content, iodata() | Enum.t(), String.t()}
      | String.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_sticker_set_thumb. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setstickersetthumb

Link to this function

set_webhook(url, options \\ [])

View Source

Specs

set_webhook(
  url :: String.t(),
  options :: [
    certificate:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    ip_address: String.t(),
    max_connections: integer(),
    allowed_updates: [String.t()],
    drop_pending_updates: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#setwebhook

Link to this function

set_webhook!(url, ops \\ [])

View Source

Specs

set_webhook!(
  url :: String.t(),
  ops :: [
    certificate:
      {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
    ip_address: String.t(),
    max_connections: integer(),
    allowed_updates: [String.t()],
    drop_pending_updates: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of set_webhook. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#setwebhook

Link to this function

stop_message_live_location(options \\ [])

View Source

Specs

stop_message_live_location(
  options :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Message.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#stopmessagelivelocation

Link to this function

stop_message_live_location!(ops \\ [])

View Source

Specs

stop_message_live_location!(
  ops :: [
    chat_id: integer() | String.t(),
    message_id: integer(),
    inline_message_id: String.t(),
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Message.t()

Unsafe version of stop_message_live_location. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#stopmessagelivelocation

Link to this function

stop_poll(chat_id, message_id, options \\ [])

View Source

Specs

stop_poll(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  options :: [
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.Poll.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#stoppoll

Link to this function

stop_poll!(chat_id, message_id, ops \\ [])

View Source

Specs

stop_poll!(
  chat_id :: integer() | String.t(),
  message_id :: integer(),
  ops :: [
    reply_markup: ExGram.Model.InlineKeyboardMarkup.t(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.Poll.t()

Unsafe version of stop_poll. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#stoppoll

Link to this function

unban_chat_member(chat_id, user_id, options \\ [])

View Source

Specs

unban_chat_member(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  options :: [
    only_if_banned: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#unbanchatmember

Link to this function

unban_chat_member!(chat_id, user_id, ops \\ [])

View Source

Specs

unban_chat_member!(
  chat_id :: integer() | String.t(),
  user_id :: integer(),
  ops :: [
    only_if_banned: boolean(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unban_chat_member. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#unbanchatmember

Link to this function

unpin_all_chat_messages(chat_id, options \\ [])

View Source

Specs

unpin_all_chat_messages(
  chat_id :: integer() | String.t(),
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#unpinallchatmessages

Link to this function

unpin_all_chat_messages!(chat_id, ops \\ [])

View Source

Specs

unpin_all_chat_messages!(
  chat_id :: integer() | String.t(),
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unpin_all_chat_messages. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinallchatmessages

Link to this function

unpin_chat_message(chat_id, options \\ [])

View Source

Specs

unpin_chat_message(
  chat_id :: integer() | String.t(),
  options :: [
    message_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, true} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#unpinchatmessage

Link to this function

unpin_chat_message!(chat_id, ops \\ [])

View Source

Specs

unpin_chat_message!(
  chat_id :: integer() | String.t(),
  ops :: [
    message_id: integer(),
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: true

Unsafe version of unpin_chat_message. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#unpinchatmessage

Link to this function

upload_sticker_file(user_id, png_sticker, options \\ [])

View Source

Specs

upload_sticker_file(
  user_id :: integer(),
  png_sticker ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  options :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: {:ok, ExGram.Model.File.t()} | {:error, ExGram.Error.t()}

Check the documentation of this method in https://core.telegram.org/bots/api#uploadstickerfile

Link to this function

upload_sticker_file!(user_id, png_sticker, ops \\ [])

View Source

Specs

upload_sticker_file!(
  user_id :: integer(),
  png_sticker ::
    {:file, String.t()} | {:file_content, iodata() | Enum.t(), String.t()},
  ops :: [
    adapter: atom(),
    bot: atom(),
    token: String.t(),
    debug: boolean(),
    check_params: boolean()
  ]
) :: ExGram.Model.File.t()

Unsafe version of upload_sticker_file. It will return the response or raise in case of error.

Check the documentation of this method in https://core.telegram.org/bots/api#uploadstickerfile