Packages

telegraph

0.7.0
0.8.3 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.0.2 0.0.1

Modern Telegram Bot API framework based on Nadia project

HexDocs

Current section

Files

Jump to
Readme
8 Versions
2 Dependencies
Dependants
Files
Activity
telegraph lib telegraph behaviour.ex
Raw

lib/telegraph/behaviour.ex 

defmodule Telegraph.Behaviour do

  alias Telegraph.Model.{User, Message, Update, UserProfilePhotos, File, Error}



  @callback get_me :: {:ok, User.t()} | {:error, Error.t()}

  @callback send_message(integer, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback forward_message(integer, integer, integer) :: {:ok, Message.t()} | {:error, Error.t()}

  @callback send_photo(integer, binary, [{atom, any}]) :: {:ok, Message.t()} | {:error, Error.t()}

  @callback send_audio(integer, binary, [{atom, any}]) :: {:ok, Message.t()} | {:error, Error.t()}

  @callback send_document(integer, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback send_sticker(integer, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback send_video(integer, binary, [{atom, any}]) :: {:ok, Message.t()} | {:error, Error.t()}

  @callback send_voice(integer, binary, [{atom, any}]) :: {:ok, Message.t()} | {:error, Error.t()}

  @callback send_animation(integer, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback send_location(integer, float, float, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback send_venue(integer, float, float, binary, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback send_contact(integer, binary, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback send_chat_action(integer, binary) :: :ok | {:error, Error.t()}

  @callback get_user_profile_photos(integer, [{atom, any}]) ::

              {:ok, UserProfilePhotos.t()} | {:error, Error.t()}

  @callback get_updates([{atom, any}]) :: {:ok, [Update.t()]} | {:error, Error.t()}

  @callback set_webhook([{atom, any}]) :: :ok | {:error, Error.t()}

  @callback get_file(binary) :: {:ok, File.t()} | {:error, Error.t()}

  @callback get_file_link(File.t()) :: {:ok, binary} | {:error, Error.t()}

  @callback kick_chat_member(integer | binary, integer) :: :ok | {:error, Error.t()}

  @callback leave_chat(integer | binary) :: :ok | {:error, Error.t()}

  @callback unban_chat_member(integer | binary, integer) :: :ok | {:error, Error.t()}

  @callback get_chat(integer | binary) :: {:ok, Chat.t()} | {:error, Error.t()}

  @callback get_chat_administrators(integer | binary) ::

              {:ok, [ChatMember.t()]} | {:error, Error.t()}

  @callback get_chat_members_count(integer | binary) :: {:ok, integer} | {:error, Error.t()}

  @callback get_chat_member(integer | binary, integer) ::

              {:ok, ChatMember.t()} | {:error, Error.t()}

  @callback answer_callback_query(binary, [{atom, any}]) :: :ok | {:error, Error.t()}

  @callback edit_message_text(integer | binary, integer, binary, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback edit_message_caption(integer | binary, integer, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback edit_message_reply_markup(integer | binary, integer, binary, [{atom, any}]) ::

              {:ok, Message.t()} | {:error, Error.t()}

  @callback answer_inline_query(binary, [Telegraph.Model.InlineQueryResult.t()], [{atom, any}]) ::

              :ok | {:error, Error.t()}

end