MatrixAppService v0.3.0

MatrixAppService.ClientBehaviour behaviour (MatrixAppService v0.3.0) View Source

Behaviour defining callbacks implemented in MatrixAppService.Client. Can be used to mock the client, for instance with mox:

TODO: example

Link to this section Summary

Types

client_options()
create_options()
data_format()

Callbacks

client()
client(list)
create_alias(t, t, client_options)
create_attachment_message(t, data_format, t)
create_room(t)
create_room(t, client_options)
get_alias(t)
get_alias(t, client_options)
get_data(t, t)
get_data(t, t, client_options)
get_profile(t)
get_profile(t, client_options)
join(t)
join(t, client_options)
put_avatar_url(t, t)
put_avatar_url(t, t, client_options)
put_data(t, t, map)
put_data(t, t, map, client_options)
put_displayname(t, t)
put_displayname(t, t, client_options)
redact_message(t, t, t)
redact_message(t, t, t, client_options)
register()
register(list)
register(list, client_options)
search_user(t, integer)
search_user(t, integer, client_options)
send_message(t, t)
send_message(t, t, client_options)
upload(binary, t)
upload(binary, t, client_options)

Link to this section Types

Link to this type

client_options()

View Source

Specs

client_options() :: {:base_url, String.t()} | create_options()
Link to this type

create_options()

View Source

Specs

create_options() :: [
  access_token: String.t() | nil,
  user_id: String.t() | nil,
  device_id: String.t() | nil,
  storage: Polyjuice.Client.Storage.t() | nil
]
Link to this type

data_format()

View Source

Specs

data_format() ::
  {:data, binary(), String.t()}
  | {:file, String.t()}
  | {:url, String.t() | URI.t()}

Link to this section Callbacks

Link to this callback

client()

View Source

Specs

client() :: Polyjuice.Client.LowLevel.t()
Link to this callback

client(list)

View Source

Specs

client([client_options()]) :: Polyjuice.Client.LowLevel.t()
Link to this callback

create_alias(t, t, client_options)

View Source

Specs

create_alias(String.t(), String.t(), client_options()) ::
  {:ok, String.t()} | Any
Link to this callback

create_attachment_message(t, data_format, t)

View Source

Specs

create_attachment_message(
  Polyjuice.Client.LowLevel.t(),
  data_format(),
  Keyword.t()
) ::
  {:ok, Polyjuice.Client.Attachment.attachment()} | Any
Link to this callback

create_room(t)

View Source

Specs

create_room(Keyword.t()) :: {:ok, map()} | Any
Link to this callback

create_room(t, client_options)

View Source

Specs

create_room(Keyword.t(), client_options()) :: {:ok, map()} | Any
Link to this callback

get_alias(t)

View Source

Specs

get_alias(String.t()) :: {:ok, String.t()} | Any
Link to this callback

get_alias(t, client_options)

View Source

Specs

get_alias(String.t(), client_options()) :: {:ok, String.t()} | Any
Link to this callback

get_data(t, t)

View Source

Specs

get_data(String.t(), String.t()) :: {:ok, map()} | any()
Link to this callback

get_data(t, t, client_options)

View Source

Specs

get_data(String.t(), String.t(), client_options()) :: {:ok, map()} | any()
Link to this callback

get_profile(t)

View Source

Specs

get_profile(String.t()) :: {:ok, map()} | any()
Link to this callback

get_profile(t, client_options)

View Source

Specs

get_profile(String.t(), client_options()) :: {:ok, map()} | any()
Link to this callback

join(t)

View Source

Specs

join(String.t()) :: :ok | any()
Link to this callback

join(t, client_options)

View Source

Specs

join(String.t(), client_options()) :: :ok | any()
Link to this callback

put_avatar_url(t, t)

View Source

Specs

put_avatar_url(String.t(), String.t()) :: :ok | any()
Link to this callback

put_avatar_url(t, t, client_options)

View Source

Specs

put_avatar_url(String.t(), String.t(), client_options()) :: :ok | any()
Link to this callback

put_data(t, t, map)

View Source

Specs

put_data(String.t(), String.t(), map()) :: {:ok, map()} | any()
Link to this callback

put_data(t, t, map, client_options)

View Source

Specs

put_data(String.t(), String.t(), map(), client_options()) ::
  {:ok, map()} | any()
Link to this callback

put_displayname(t, t)

View Source

Specs

put_displayname(String.t(), String.t()) :: :ok | any()
Link to this callback

put_displayname(t, t, client_options)

View Source

Specs

put_displayname(String.t(), String.t(), client_options()) :: :ok | any()
Link to this callback

redact_message(t, t, t)

View Source

Specs

redact_message(String.t(), String.t(), String.t()) :: {:ok, String.t()} | Any
Link to this callback

redact_message(t, t, t, client_options)

View Source

Specs

redact_message(String.t(), String.t(), String.t(), client_options()) ::
  {:ok, String.t()} | Any
Link to this callback

register()

View Source

Specs

register() :: {:ok, String.t()} | Any
Link to this callback

register(list)

View Source

Specs

register(list()) :: {:ok, String.t()} | Any
Link to this callback

register(list, client_options)

View Source

Specs

register(list(), client_options()) :: {:ok, String.t()} | Any
Link to this callback

search_user(t, integer)

View Source

Specs

search_user(String.t(), integer()) :: {:ok, String.t()} | Any
Link to this callback

search_user(t, integer, client_options)

View Source

Specs

search_user(String.t(), integer(), client_options()) :: {:ok, String.t()} | Any
Link to this callback

send_message(t, t)

View Source

Specs

send_message(String.t(), String.t()) :: {:ok, String.t()} | Any
Link to this callback

send_message(t, t, client_options)

View Source

Specs

send_message(String.t(), String.t(), client_options()) ::
  {:ok, String.t()} | Any
Link to this callback

upload(binary, t)

View Source

Specs

upload(binary(), Keyword.t()) :: {:ok, String.t()} | Any
Link to this callback

upload(binary, t, client_options)

View Source

Specs

upload(binary(), Keyword.t(), client_options()) :: {:ok, String.t()} | Any