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
Check the documentation of this method in https://core.telegram.org/bots/api#addstickertoset
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#answercallbackquery
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#answerinlinequery
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#answerprecheckoutquery
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#answershippingquery
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#banchatmember
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.
Check the documentation of this method in https://core.telegram.org/bots/api#close
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#copymessage
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#createchatinvitelink
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#createnewstickerset
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#deletechatphoto
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#deletechatstickerset
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#deletemessage
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#deletemycommands
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#deletestickerfromset
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#deletewebhook
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#editchatinvitelink
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#editmessagecaption
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#editmessagelivelocation
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#editmessagemedia
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#editmessagereplymarkup
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#editmessagetext
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#exportchatinvitelink
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#forwardmessage
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#getchat
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#getchatadministrators
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#getchatmember
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#getchatmembercount
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#getfile
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#getgamehighscores
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.
Check the documentation of this method in https://core.telegram.org/bots/api#getmycommands
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#getstickerset
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#getupdates
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#getuserprofilephotos
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#getwebhookinfo
Unsafe version of get_webhook_info. It will return the response or raise in case of error.
Callback implementation for Supervisor.init/1
.
Check the documentation of this method in https://core.telegram.org/bots/api#leavechat
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#logout
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#pinchatmessage
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#promotechatmember
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#restrictchatmember
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#revokechatinvitelink
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#sendanimation
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#sendaudio
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#sendchataction
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#sendcontact
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#senddice
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#senddocument
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#sendgame
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#sendinvoice
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#sendlocation
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#sendmediagroup
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#sendmessage
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#sendphoto
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#sendpoll
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#sendsticker
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#sendvenue
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#sendvideo
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#sendvideonote
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#sendvoice
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#setchatadministratorcustomtitle
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#setchatdescription
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#setchatpermissions
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#setchatphoto
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#setchatstickerset
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#setchattitle
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#setgamescore
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#setmycommands
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#setpassportdataerrors
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#setstickerpositioninset
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#setstickersetthumb
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#setwebhook
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#stopmessagelivelocation
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#stoppoll
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#unbanchatmember
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#unpinallchatmessages
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#unpinchatmessage
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#uploadstickerfile
Unsafe version of upload_sticker_file. It will return the response or raise in case of error.
Link to this section Functions
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
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
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
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
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
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
answer_pre_checkout_query(pre_checkout_query_id, ok, options \\ [])
View SourceSpecs
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
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
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
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
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
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
.
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
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
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
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
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
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
create_new_sticker_set(user_id, name, title, emojis, options \\ [])
View SourceSpecs
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
.
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
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
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
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
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
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
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
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
restrict_chat_member(chat_id, user_id, permissions, options \\ [])
View SourceSpecs
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
send_invoice(chat_id, title, description, payload, provider_token, currency, prices, options \\ [])
View SourceSpecs
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
send_invoice!(chat_id, title, description, payload, provider_token, currency, prices, ops \\ [])
View SourceSpecs
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
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
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
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
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
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
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
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
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
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
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
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
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
send_venue(chat_id, latitude, longitude, title, address, options \\ [])
View SourceSpecs
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
send_venue!(chat_id, latitude, longitude, title, address, ops \\ [])
View SourceSpecs
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
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
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
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
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
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
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
set_chat_administrator_custom_title(chat_id, user_id, custom_title, options \\ [])
View SourceSpecs
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
set_chat_administrator_custom_title!(chat_id, user_id, custom_title, ops \\ [])
View SourceSpecs
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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