View Source Teiserver.Communication (Teiserver v0.0.4)

The contextual module for:

Summary

Room messages

change_room_message(room_message, attrs \\ %{})

See Teiserver.Communication.RoomMessageLib.change_room_message/2.

create_room_message(attrs \\ %{})

See Teiserver.Communication.RoomMessageLib.create_room_message/1.

delete_room_message(room_message)

See Teiserver.Communication.RoomMessageLib.delete_room_message/1.

get_room_message(room_message_id, query_args \\ [])

See Teiserver.Communication.RoomMessageLib.get_room_message/2.

get_room_message!(room_message_id, query_args \\ [])

See Teiserver.Communication.RoomMessageLib.get_room_message!/2.

list_recent_room_messages(room_name_or_id, limit \\ 50)

See Teiserver.Communication.RoomMessageLib.list_recent_room_messages/2.

list_room_messages(args)

See Teiserver.Communication.RoomMessageLib.list_room_messages/1.

send_room_message(sender_id, room_id, content, attrs \\ %{})

See Teiserver.Communication.RoomMessageLib.send_room_message/4.

subscribe_to_room_messages(room_or_room_id)

See Teiserver.Communication.RoomMessageLib.subscribe_to_room_messages/1.

unsubscribe_from_room_messages(room_or_room_id)

See Teiserver.Communication.RoomMessageLib.unsubscribe_from_room_messages/1.

update_room_message(room_message, attrs)

See Teiserver.Communication.RoomMessageLib.update_room_message/2.

Match messages

change_match_message(match_message, attrs \\ %{})

See Teiserver.Communication.MatchMessageLib.change_match_message/2.

create_match_message(attrs \\ %{})

See Teiserver.Communication.MatchMessageLib.create_match_message/1.

delete_match_message(match_message)

See Teiserver.Communication.MatchMessageLib.delete_match_message/1.

get_match_message(match_message_id, query_args \\ [])

See Teiserver.Communication.MatchMessageLib.get_match_message/2.

get_match_message!(match_message_id, query_args \\ [])

See Teiserver.Communication.MatchMessageLib.get_match_message!/2.

list_match_messages(args)

See Teiserver.Communication.MatchMessageLib.list_match_messages/1.

list_recent_match_messages(match_name_or_id, limit \\ 50)

See Teiserver.Communication.MatchMessageLib.list_recent_match_messages/2.

send_lobby_message(sender_id, lobby_id, content)

See Teiserver.Communication.MatchMessageLib.send_lobby_message/3.

send_match_message(sender_id, match_id, content, attrs \\ %{})

See Teiserver.Communication.MatchMessageLib.send_match_message/4.

subscribe_to_match_messages(match_or_match_id)

See Teiserver.Communication.MatchMessageLib.subscribe_to_match_messages/1.

unsubscribe_from_match_messages(match_or_match_id)

See Teiserver.Communication.MatchMessageLib.unsubscribe_from_match_messages/1.

update_match_message(match_message, attrs)

See Teiserver.Communication.MatchMessageLib.update_match_message/2.

Direct messages

change_direct_message(direct_message, attrs \\ %{})

See Teiserver.Communication.DirectMessageLib.change_direct_message/2.

create_direct_message(attrs \\ %{})

See Teiserver.Communication.DirectMessageLib.create_direct_message/1.

delete_direct_message(direct_message)

See Teiserver.Communication.DirectMessageLib.delete_direct_message/1.

get_direct_message(direct_message_id, query_args \\ [])

See Teiserver.Communication.DirectMessageLib.get_direct_message/2.

get_direct_message!(direct_message_id, query_args \\ [])

See Teiserver.Communication.DirectMessageLib.get_direct_message!/2.

list_direct_messages(args)

See Teiserver.Communication.DirectMessageLib.list_direct_messages/1.

list_direct_messages_for_user(user_id, query_args \\ [])

See Teiserver.Communication.DirectMessageLib.list_direct_messages_for_user/2.

list_direct_messages_from_user(user_id, query_args \\ [])

See Teiserver.Communication.DirectMessageLib.list_direct_messages_from_user/2.

list_direct_messages_from_user_to_user(sender_id, to_id, query_args \\ [])

See Teiserver.Communication.DirectMessageLib.list_direct_messages_from_user_to_user/3.

list_direct_messages_to_user(user_id, query_args \\ [])

See Teiserver.Communication.DirectMessageLib.list_direct_messages_to_user/2.

send_direct_message(sender_id, to_id, content, attrs \\ %{})

See Teiserver.Communication.DirectMessageLib.send_direct_message/4.

subscribe_to_user_messaging(user_or_user_id)

See Teiserver.Communication.DirectMessageLib.subscribe_to_user_messaging/1.

unsubscribe_from_user_messaging(user_or_user_id)

See Teiserver.Communication.DirectMessageLib.unsubscribe_from_user_messaging/1.

update_direct_message(direct_message, attrs)

See Teiserver.Communication.DirectMessageLib.update_direct_message/2.

Functions

change_room(room, attrs \\ %{})

See Teiserver.Communication.RoomLib.change_room/2.

create_room(attrs \\ %{})

See Teiserver.Communication.RoomLib.create_room/1.

delete_room(room)

See Teiserver.Communication.RoomLib.delete_room/1.

get_or_create_room(room_name)

See Teiserver.Communication.RoomLib.get_or_create_room/1.

get_room(room_id, query_args \\ [])

See Teiserver.Communication.RoomLib.get_room/2.

get_room!(room_id, query_args \\ [])

See Teiserver.Communication.RoomLib.get_room!/2.

get_room_by_name_or_id(room_name_or_id)

See Teiserver.Communication.RoomLib.get_room_by_name_or_id/1.

list_direct_messages_between_users(user_id1, user_id2, query_args \\ [])

See Teiserver.Communication.DirectMessageLib.list_direct_messages_between_users/3.

list_rooms(args)

See Teiserver.Communication.RoomLib.list_rooms/1.

update_room(room, attrs)

See Teiserver.Communication.RoomLib.update_room/2.

Room messages

Link to this function

change_room_message(room_message, attrs \\ %{})

View Source 
@spec change_room_message(Teiserver.Communication.RoomMessage.t(), map()) ::
  Ecto.Changeset.t()

See Teiserver.Communication.RoomMessageLib.change_room_message/2.

Link to this function

create_room_message(attrs \\ %{})

View Source 
@spec create_room_message(map()) ::
  {:ok, Teiserver.Communication.RoomMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.RoomMessageLib.create_room_message/1.

Link to this function

delete_room_message(room_message)

View Source 
@spec delete_room_message(Teiserver.Communication.RoomMessage.t()) ::
  {:ok, Teiserver.Communication.RoomMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.RoomMessageLib.delete_room_message/1.

Link to this function

get_room_message(room_message_id, query_args \\ [])

View Source 
@spec get_room_message(
  Teiserver.Communication.RoomMessage.id(),
  Teiserver.query_args()
) ::
  Teiserver.Communication.RoomMessage.t() | nil

See Teiserver.Communication.RoomMessageLib.get_room_message/2.

Link to this function

get_room_message!(room_message_id, query_args \\ [])

View Source 
@spec get_room_message!(
  Teiserver.Communication.RoomMessage.id(),
  Teiserver.query_args()
) ::
  Teiserver.Communication.RoomMessage.t()

See Teiserver.Communication.RoomMessageLib.get_room_message!/2.

Link to this function

list_recent_room_messages(room_name_or_id, limit \\ 50)

View Source 
@spec list_recent_room_messages(Teiserver.Communication.Room.id(), non_neg_integer()) ::
  [
    Teiserver.Communication.RoomMessage.t()
  ]

See Teiserver.Communication.RoomMessageLib.list_recent_room_messages/2.

Link to this function

list_room_messages(args)

View Source 
@spec list_room_messages(Teiserver.query_args()) :: [
  Teiserver.Communication.RoomMessage.t()
]

See Teiserver.Communication.RoomMessageLib.list_room_messages/1.

Link to this function

send_room_message(sender_id, room_id, content, attrs \\ %{})

View Source 
@spec send_room_message(
  Teiserver.user_id(),
  Teiserver.Communication.Room.id(),
  String.t(),
  map()
) ::
  {:ok, Teiserver.Communication.RoomMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.RoomMessageLib.send_room_message/4.

Link to this function

subscribe_to_room_messages(room_or_room_id)

View Source 
@spec subscribe_to_room_messages(
  Teiserver.Communication.Room.id()
  | Teiserver.Communication.Room.t()
) ::
  :ok

See Teiserver.Communication.RoomMessageLib.subscribe_to_room_messages/1.

Link to this function

unsubscribe_from_room_messages(room_or_room_id)

View Source 
@spec unsubscribe_from_room_messages(
  Teiserver.Communication.Room.id()
  | Teiserver.Communication.Room.t()
) :: :ok

See Teiserver.Communication.RoomMessageLib.unsubscribe_from_room_messages/1.

Link to this function

update_room_message(room_message, attrs)

View Source 
@spec update_room_message(Teiserver.Communication.RoomMessage, map()) ::
  {:ok, Teiserver.Communication.RoomMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.RoomMessageLib.update_room_message/2.

Match messages

Link to this function

change_match_message(match_message, attrs \\ %{})

View Source 
@spec change_match_message(Teiserver.Communication.MatchMessage.t(), map()) ::
  Ecto.Changeset.t()

See Teiserver.Communication.MatchMessageLib.change_match_message/2.

Link to this function

create_match_message(attrs \\ %{})

View Source 
@spec create_match_message(map()) ::
  {:ok, Teiserver.Communication.MatchMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.MatchMessageLib.create_match_message/1.

Link to this function

delete_match_message(match_message)

View Source 
@spec delete_match_message(Teiserver.Communication.MatchMessage.t()) ::
  {:ok, Teiserver.Communication.MatchMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.MatchMessageLib.delete_match_message/1.

Link to this function

get_match_message(match_message_id, query_args \\ [])

View Source 
@spec get_match_message(
  Teiserver.Communication.MatchMessage.id(),
  Teiserver.query_args()
) ::
  Teiserver.Communication.MatchMessage.t() | nil

See Teiserver.Communication.MatchMessageLib.get_match_message/2.

Link to this function

get_match_message!(match_message_id, query_args \\ [])

View Source 
@spec get_match_message!(
  Teiserver.Communication.MatchMessage.id(),
  Teiserver.query_args()
) ::
  Teiserver.Communication.MatchMessage.t()

See Teiserver.Communication.MatchMessageLib.get_match_message!/2.

Link to this function

list_match_messages(args)

View Source 
@spec list_match_messages(Teiserver.query_args()) :: [
  Teiserver.Communication.MatchMessage.t()
]

See Teiserver.Communication.MatchMessageLib.list_match_messages/1.

Link to this function

list_recent_match_messages(match_name_or_id, limit \\ 50)

View Source 
@spec list_recent_match_messages(Teiserver.Game.Match.id(), non_neg_integer()) :: [
  Teiserver.Communication.MatchMessage.t()
]

See Teiserver.Communication.MatchMessageLib.list_recent_match_messages/2.

Link to this function

send_lobby_message(sender_id, lobby_id, content)

View Source 
@spec send_lobby_message(Teiserver.user_id(), Lobby.id(), String.t()) ::
  {:ok, Teiserver.Communication.MatchMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.MatchMessageLib.send_lobby_message/3.

Link to this function

send_match_message(sender_id, match_id, content, attrs \\ %{})

View Source 
@spec send_match_message(
  Teiserver.user_id(),
  Teiserver.Game.Match.id(),
  String.t(),
  map()
) ::
  {:ok, Teiserver.Communication.MatchMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.MatchMessageLib.send_match_message/4.

Link to this function

subscribe_to_match_messages(match_or_match_id)

View Source 
@spec subscribe_to_match_messages(
  Teiserver.Game.Match.id()
  | Teiserver.Game.Match.t()
) :: :ok

See Teiserver.Communication.MatchMessageLib.subscribe_to_match_messages/1.

Link to this function

unsubscribe_from_match_messages(match_or_match_id)

View Source 
@spec unsubscribe_from_match_messages(
  Teiserver.Game.Match.id()
  | Teiserver.Game.Match.t()
) :: :ok

See Teiserver.Communication.MatchMessageLib.unsubscribe_from_match_messages/1.

Link to this function

update_match_message(match_message, attrs)

View Source 
@spec update_match_message(Teiserver.Communication.MatchMessage, map()) ::
  {:ok, Teiserver.Communication.MatchMessage.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.MatchMessageLib.update_match_message/2.

Direct messages

Link to this function

change_direct_message(direct_message, attrs \\ %{})

View Source 
@spec change_direct_message(Teiserver.Communication.DirectMessage.t(), map()) ::
  Ecto.Changeset.t()

See Teiserver.Communication.DirectMessageLib.change_direct_message/2.

Link to this function

create_direct_message(attrs \\ %{})

View Source 
@spec create_direct_message(map()) ::
  {:ok, Teiserver.Communication.DirectMessage.t()}
  | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.DirectMessageLib.create_direct_message/1.

Link to this function

delete_direct_message(direct_message)

View Source 
@spec delete_direct_message(Teiserver.Communication.DirectMessage.t()) ::
  {:ok, Teiserver.Communication.DirectMessage.t()}
  | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.DirectMessageLib.delete_direct_message/1.

Link to this function

get_direct_message(direct_message_id, query_args \\ [])

View Source 
@spec get_direct_message(
  Teiserver.Communication.DirectMessage.id(),
  Teiserver.query_args()
) ::
  Teiserver.Communication.DirectMessage.t() | nil

See Teiserver.Communication.DirectMessageLib.get_direct_message/2.

Link to this function

get_direct_message!(direct_message_id, query_args \\ [])

View Source 
@spec get_direct_message!(
  Teiserver.Communication.DirectMessage.id(),
  Teiserver.query_args()
) ::
  Teiserver.Communication.DirectMessage.t()

See Teiserver.Communication.DirectMessageLib.get_direct_message!/2.

Link to this function

list_direct_messages(args)

View Source 
@spec list_direct_messages(list()) :: [Teiserver.Communication.DirectMessage.t()]

See Teiserver.Communication.DirectMessageLib.list_direct_messages/1.

Link to this function

list_direct_messages_for_user(user_id, query_args \\ [])

View Source 
@spec list_direct_messages_for_user(Teiserver.user_id(), Teiserver.query_args()) :: [
  Teiserver.Communication.DirectMessage.t()
]

See Teiserver.Communication.DirectMessageLib.list_direct_messages_for_user/2.

Link to this function

list_direct_messages_from_user(user_id, query_args \\ [])

View Source 
@spec list_direct_messages_from_user(Teiserver.user_id(), Teiserver.query_args()) :: [
  Teiserver.Communication.DirectMessage.t()
]

See Teiserver.Communication.DirectMessageLib.list_direct_messages_from_user/2.

Link to this function

list_direct_messages_from_user_to_user(sender_id, to_id, query_args \\ [])

View Source 
@spec list_direct_messages_from_user_to_user(
  Teiserver.user_id(),
  Teiserver.user_id(),
  Teiserver.query_args()
) :: [Teiserver.Communication.DirectMessage.t()]

See Teiserver.Communication.DirectMessageLib.list_direct_messages_from_user_to_user/3.

Link to this function

list_direct_messages_to_user(user_id, query_args \\ [])

View Source 
@spec list_direct_messages_to_user(Teiserver.user_id(), Teiserver.query_args()) :: [
  Teiserver.Communication.DirectMessage.t()
]

See Teiserver.Communication.DirectMessageLib.list_direct_messages_to_user/2.

Link to this function

send_direct_message(sender_id, to_id, content, attrs \\ %{})

View Source 
@spec send_direct_message(
  sender_id :: Teiserver.user_id(),
  to_id :: Teiserver.user_id(),
  content :: String.t(),
  attrs :: map()
) ::
  {:ok, Teiserver.Communication.DirectMessage.t()}
  | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.DirectMessageLib.send_direct_message/4.

Link to this function

subscribe_to_user_messaging(user_or_user_id)

View Source 
@spec subscribe_to_user_messaging(
  Teiserver.Account.User.id()
  | Teiserver.Account.User.t()
) :: :ok

See Teiserver.Communication.DirectMessageLib.subscribe_to_user_messaging/1.

Link to this function

unsubscribe_from_user_messaging(user_or_user_id)

View Source 
@spec unsubscribe_from_user_messaging(
  Teiserver.Account.User.id()
  | Teiserver.Account.User.t()
) :: :ok

See Teiserver.Communication.DirectMessageLib.unsubscribe_from_user_messaging/1.

Link to this function

update_direct_message(direct_message, attrs)

View Source 
@spec update_direct_message(Teiserver.Communication.DirectMessage, map()) ::
  {:ok, Teiserver.Communication.DirectMessage.t()}
  | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.DirectMessageLib.update_direct_message/2.

Functions

Link to this function

change_room(room, attrs \\ %{})

View Source 
@spec change_room(Teiserver.Communication.Room.t(), map()) :: Ecto.Changeset.t()

See Teiserver.Communication.RoomLib.change_room/2.

Link to this function

create_room(attrs \\ %{})

View Source 
@spec create_room(map()) ::
  {:ok, Teiserver.Communication.Room.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.RoomLib.create_room/1.

Link to this function

delete_room(room)

View Source 
@spec delete_room(Teiserver.Communication.Room.t()) ::
  {:ok, Teiserver.Communication.Room.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.RoomLib.delete_room/1.

Link to this function

get_or_create_room(room_name)

View Source 
@spec get_or_create_room(Teiserver.Communication.Room.name()) ::
  Teiserver.Communication.Room.t()

See Teiserver.Communication.RoomLib.get_or_create_room/1.

Link to this function

get_room(room_id, query_args \\ [])

View Source 
@spec get_room(Teiserver.Communication.Room.id(), Teiserver.query_args()) ::
  Teiserver.Communication.Room.t() | nil

See Teiserver.Communication.RoomLib.get_room/2.

Link to this function

get_room!(room_id, query_args \\ [])

View Source 
@spec get_room!(Teiserver.Communication.Room.id(), Teiserver.query_args()) ::
  Teiserver.Communication.Room.t()

See Teiserver.Communication.RoomLib.get_room!/2.

Link to this function

get_room_by_name_or_id(room_name_or_id)

View Source 
@spec get_room_by_name_or_id(Teiserver.Communication.Room.name_or_id()) ::
  Teiserver.Communication.Room.t() | nil

See Teiserver.Communication.RoomLib.get_room_by_name_or_id/1.

Link to this function

list_direct_messages_between_users(user_id1, user_id2, query_args \\ [])

View Source 
@spec list_direct_messages_between_users(
  Teiserver.user_id(),
  Teiserver.user_id(),
  Teiserver.query_args()
) :: [Teiserver.Communication.DirectMessage.t()]

See Teiserver.Communication.DirectMessageLib.list_direct_messages_between_users/3.

Link to this function

list_rooms(args)

View Source 
@spec list_rooms(Teiserver.query_args()) :: [Teiserver.Communication.Room.t()]

See Teiserver.Communication.RoomLib.list_rooms/1.

Link to this function

update_room(room, attrs)

View Source 
@spec update_room(Teiserver.Communication.Room, map()) ::
  {:ok, Teiserver.Communication.Room.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Communication.RoomLib.update_room/2.