Nadia.Behaviour behaviour (nadia v0.9.0)

View Source

Summary

Callbacks

Callbacks

add_sticker_to_set(t, integer, binary, binary, binary, list)

(optional)
@callback add_sticker_to_set(Nadia.Client.t(), integer(), binary(), binary(), binary(), [
  {atom(), any()}
]) ::
  :ok | {:error, Nadia.Model.Error.t()}

answer_callback_query(binary, list)

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

answer_callback_query(t, binary, list)

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

answer_inline_query(binary, list, list)

@callback answer_inline_query(binary(), [Nadia.Model.InlineQueryResult.t()], [
  {atom(), any()}
]) ::
  :ok | {:error, Nadia.Model.Error.t()}

answer_inline_query(t, binary, list, list)

(optional)
@callback answer_inline_query(
  Nadia.Client.t(),
  binary(),
  [Nadia.Model.InlineQueryResult.t()],
  [
    {atom(), any()}
  ]
) :: :ok | {:error, Nadia.Model.Error.t()}

create_new_sticker_set(t, integer, binary, binary, binary, binary, list)

(optional)
@callback create_new_sticker_set(
  Nadia.Client.t(),
  integer(),
  binary(),
  binary(),
  binary(),
  binary(),
  [
    {atom(), any()}
  ]
) :: :ok | {:error, Nadia.Model.Error.t()}

delete_sticker_from_set(t, binary)

(optional)
@callback delete_sticker_from_set(Nadia.Client.t(), binary()) ::
  :ok | {:error, Nadia.Model.Error.t()}

delete_webhook(t)

(optional)
@callback delete_webhook(Nadia.Client.t()) :: :ok | {:error, Nadia.Model.Error.t()}

edit_message_caption(arg1, integer, binary, list)

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

edit_message_caption(t, arg2, integer, binary, list)

(optional)
@callback edit_message_caption(
  Nadia.Client.t(),
  integer() | binary(),
  integer(),
  binary(),
  [
    {atom(), any()}
  ]
) :: {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

edit_message_reply_markup(arg1, integer, binary, list)

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

edit_message_reply_markup(t, arg2, integer, binary, list)

(optional)
@callback edit_message_reply_markup(
  Nadia.Client.t(),
  integer() | binary(),
  integer(),
  binary(),
  [
    {atom(), any()}
  ]
) :: {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

edit_message_text(arg1, integer, binary, binary, list)

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

edit_message_text(t, arg2, integer, binary, binary, list)

(optional)
@callback edit_message_text(
  Nadia.Client.t(),
  integer() | binary(),
  integer(),
  binary(),
  binary(),
  [
    {atom(), any()}
  ]
) :: {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

forward_message(integer, integer, integer)

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

forward_message(t, arg2, arg3, integer)

(optional)
@callback forward_message(
  Nadia.Client.t(),
  integer() | binary(),
  integer() | binary(),
  integer()
) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

get_chat(arg1)

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

get_chat(t, arg2)

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

get_chat_administrators(arg1)

@callback get_chat_administrators(integer() | binary()) ::
  {:ok, [Nadia.Model.ChatMember.t()]} | {:error, Nadia.Model.Error.t()}

get_chat_administrators(t, arg2)

(optional)
@callback get_chat_administrators(Nadia.Client.t(), integer() | binary()) ::
  {:ok, [Nadia.Model.ChatMember.t()]} | {:error, Nadia.Model.Error.t()}

get_chat_member(arg1, integer)

@callback get_chat_member(integer() | binary(), integer()) ::
  {:ok, Nadia.Model.ChatMember.t()} | {:error, Nadia.Model.Error.t()}

get_chat_member(t, arg2, integer)

(optional)
@callback get_chat_member(Nadia.Client.t(), integer() | binary(), integer()) ::
  {:ok, Nadia.Model.ChatMember.t()} | {:error, Nadia.Model.Error.t()}

get_chat_members_count(arg1)

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

get_chat_members_count(t, arg2)

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

get_file(binary)

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

get_file(t, binary)

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

get_file_link(t)

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

get_file_link(t, t)

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

get_me()

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

get_me(t)

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

get_sticker_set(t, binary)

(optional)
@callback get_sticker_set(Nadia.Client.t(), binary()) ::
  {:ok, Nadia.Model.StickerSet.t()} | {:error, Nadia.Model.Error.t()}

get_updates(list)

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

get_updates(t, list)

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

get_user_profile_photos(integer, list)

@callback get_user_profile_photos(integer(), [{atom(), any()}]) ::
  {:ok, Nadia.Model.UserProfilePhotos.t()} | {:error, Nadia.Model.Error.t()}

get_user_profile_photos(t, integer, list)

(optional)
@callback get_user_profile_photos(Nadia.Client.t(), integer(), [{atom(), any()}]) ::
  {:ok, Nadia.Model.UserProfilePhotos.t()} | {:error, Nadia.Model.Error.t()}

get_webhook_info(t)

(optional)
@callback get_webhook_info(Nadia.Client.t()) ::
  {:ok, Nadia.Model.WebhookInfo.t()} | {:error, Nadia.Model.Error.t()}

kick_chat_member(arg1, integer)

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

kick_chat_member(t, arg2, integer)

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

leave_chat(arg1)

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

leave_chat(t, arg2)

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

pin_chat_message(t, arg2, arg3, list)

(optional)
@callback pin_chat_message(Nadia.Client.t(), integer() | binary(), integer() | binary(), [
  {atom(), any()}
]) ::
  :ok | {:error, Nadia.Model.Error.t()}

send_animation(integer, binary, list)

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

send_animation(t, arg2, binary, list)

(optional)
@callback send_animation(Nadia.Client.t(), integer() | binary(), binary(), [
  {atom(), any()}
]) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_audio(integer, binary, list)

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

send_audio(t, arg2, binary, list)

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

send_chat_action(integer, binary)

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

send_chat_action(t, arg2, binary)

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

send_contact(integer, binary, binary, list)

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

send_contact(t, arg2, binary, binary, list)

(optional)
@callback send_contact(Nadia.Client.t(), integer() | binary(), binary(), binary(), [
  {atom(), any()}
]) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_document(integer, binary, list)

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

send_document(t, arg2, binary, list)

(optional)
@callback send_document(Nadia.Client.t(), integer() | binary(), binary(), [
  {atom(), any()}
]) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_location(integer, float, float, list)

@callback send_location(integer(), float(), float(), [{atom(), any()}]) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_location(t, arg2, float, float, list)

(optional)
@callback send_location(Nadia.Client.t(), integer() | binary(), float(), float(), [
  {atom(), any()}
]) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_message(integer, binary, list)

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

send_message(t, arg2, binary, list)

(optional)
@callback send_message(Nadia.Client.t(), integer() | binary(), binary(), [{atom(), any()}]) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_photo(integer, binary, list)

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

send_photo(t, arg2, binary, list)

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

send_sticker(integer, binary, list)

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

send_sticker(t, arg2, binary, list)

(optional)
@callback send_sticker(Nadia.Client.t(), integer() | binary(), binary(), [{atom(), any()}]) ::
  {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_venue(integer, float, float, binary, binary, list)

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

send_venue(t, arg2, float, float, binary, binary, list)

(optional)
@callback send_venue(
  Nadia.Client.t(),
  integer() | binary(),
  float(),
  float(),
  binary(),
  binary(),
  [
    {atom(), any()}
  ]
) :: {:ok, Nadia.Model.Message.t()} | {:error, Nadia.Model.Error.t()}

send_video(integer, binary, list)

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

send_video(t, arg2, binary, list)

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

send_voice(integer, binary, list)

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

send_voice(t, arg2, binary, list)

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

set_sticker_position_in_set(t, binary, integer)

(optional)
@callback set_sticker_position_in_set(Nadia.Client.t(), binary(), integer()) ::
  :ok | {:error, Nadia.Model.Error.t()}

set_webhook(list)

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

set_webhook(t, list)

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

unban_chat_member(arg1, integer)

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

unban_chat_member(t, arg2, integer)

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

unpin_chat_message(t, arg2)

(optional)
@callback unpin_chat_message(Nadia.Client.t(), integer() | binary()) ::
  :ok | {:error, Nadia.Model.Error.t()}

upload_sticker_file(t, integer, binary)

(optional)
@callback upload_sticker_file(Nadia.Client.t(), integer(), binary()) ::
  {:ok, Nadia.Model.File.t()} | {:error, Nadia.Model.Error.t()}