Spatio.Api.NativeDM (spatio_sdk v0.0.2)

API calls for all endpoints tagged NativeDM.

Summary

Functions

add_native_dm_reaction(connection, message_id, request_body, opts \\ [])

Add a reaction to a DM message.

attach_to_native_dm_message(connection, message_id, request_body, opts \\ [])

Attach a file to a DM message.

delete_native_dm_message(connection, dm_id, message_id, opts \\ [])

Delete a DM message.

forward_native_dm_message(connection, message_id, request_body, opts \\ [])

Forward a DM message to another conversation.

list_native_dm_channels(connection, opts \\ [])

List the caller's DM channels.

list_native_dm_conversations(connection, opts \\ [])

List DM conversations with metadata (last message, unread count, etc.).

list_native_dm_messages(connection, dm_id, opts \\ [])

List messages in a DM.

list_native_dm_pinned_messages(connection, dm_id, opts \\ [])

List pinned messages in a DM.

list_native_dm_thread_replies(connection, dm_id, message_id, opts \\ [])

List threaded replies on a message.

mark_native_dm_read(connection, dm_id, opts \\ [])

Mark a DM as read.

mute_native_dm(connection, dm_id, opts \\ [])

Mute a DM.

pin_native_dm_conversation(connection, dm_id, opts \\ [])

Pin a DM conversation in the sidebar.

pin_native_dm_message(connection, message_id, opts \\ [])

Pin a DM message.

post_native_dm_message(connection, request_body, opts \\ [])

Post a DM message (top-level entry).

post_native_dm_thread_reply(connection, dm_id, message_id, request_body, opts \\ [])

Post a threaded reply.

remove_native_dm_reaction(connection, message_id, emoji, opts \\ [])

Remove a reaction.

search_native_dm_messages(connection, opts \\ [])

Search DM messages.

set_native_dm_draft(connection, dm_id, request_body, opts \\ [])

Save a draft on a DM conversation.

unpin_native_dm_conversation(connection, dm_id, opts \\ [])

Unpin a DM conversation.

unpin_native_dm_message(connection, message_id, opts \\ [])

Unpin a DM message.

update_native_dm_message(connection, dm_id, message_id, request_body, opts \\ [])

Update a DM message body.

Functions

add_native_dm_reaction(connection, message_id, request_body, opts \\ [])

@spec add_native_dm_reaction(
  Tesla.Env.client(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Add a reaction to a DM message.

Parameters

  • connection (Spatio.Connection): Connection to server
  • message_id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

attach_to_native_dm_message(connection, message_id, request_body, opts \\ [])

@spec attach_to_native_dm_message(
  Tesla.Env.client(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Attach a file to a DM message.

Parameters

  • connection (Spatio.Connection): Connection to server
  • message_id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

delete_native_dm_message(connection, dm_id, message_id, opts \\ [])

@spec delete_native_dm_message(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Delete a DM message.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • message_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

forward_native_dm_message(connection, message_id, request_body, opts \\ [])

@spec forward_native_dm_message(
  Tesla.Env.client(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Forward a DM message to another conversation.

Parameters

  • connection (Spatio.Connection): Connection to server
  • message_id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

list_native_dm_channels(connection, opts \\ [])

@spec list_native_dm_channels(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List the caller's DM channels.

Parameters

  • connection (Spatio.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

list_native_dm_conversations(connection, opts \\ [])

@spec list_native_dm_conversations(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List DM conversations with metadata (last message, unread count, etc.).

Parameters

  • connection (Spatio.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

list_native_dm_messages(connection, dm_id, opts \\ [])

@spec list_native_dm_messages(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List messages in a DM.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

list_native_dm_pinned_messages(connection, dm_id, opts \\ [])

@spec list_native_dm_pinned_messages(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List pinned messages in a DM.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

list_native_dm_thread_replies(connection, dm_id, message_id, opts \\ [])

@spec list_native_dm_thread_replies(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

List threaded replies on a message.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • message_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

mark_native_dm_read(connection, dm_id, opts \\ [])

@spec mark_native_dm_read(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Mark a DM as read.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

mute_native_dm(connection, dm_id, opts \\ [])

@spec mute_native_dm(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Mute a DM.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • opts (keyword): Optional parameters
    • :body (%{optional(String.t) => any()}):

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

pin_native_dm_conversation(connection, dm_id, opts \\ [])

@spec pin_native_dm_conversation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Pin a DM conversation in the sidebar.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

pin_native_dm_message(connection, message_id, opts \\ [])

@spec pin_native_dm_message(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Pin a DM message.

Parameters

  • connection (Spatio.Connection): Connection to server
  • message_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

post_native_dm_message(connection, request_body, opts \\ [])

@spec post_native_dm_message(
  Tesla.Env.client(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Post a DM message (top-level entry).

Parameters

  • connection (Spatio.Connection): Connection to server
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

post_native_dm_thread_reply(connection, dm_id, message_id, request_body, opts \\ [])

@spec post_native_dm_thread_reply(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Post a threaded reply.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • message_id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

remove_native_dm_reaction(connection, message_id, emoji, opts \\ [])

@spec remove_native_dm_reaction(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Remove a reaction.

Parameters

  • connection (Spatio.Connection): Connection to server
  • message_id (String.t):
  • emoji (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

search_native_dm_messages(connection, opts \\ [])

@spec search_native_dm_messages(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Search DM messages.

Parameters

  • connection (Spatio.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :q (String.t):

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure

set_native_dm_draft(connection, dm_id, request_body, opts \\ [])

@spec set_native_dm_draft(
  Tesla.Env.client(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Save a draft on a DM conversation.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

unpin_native_dm_conversation(connection, dm_id, opts \\ [])

@spec unpin_native_dm_conversation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Unpin a DM conversation.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

unpin_native_dm_message(connection, message_id, opts \\ [])

@spec unpin_native_dm_message(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Unpin a DM message.

Parameters

  • connection (Spatio.Connection): Connection to server
  • message_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

update_native_dm_message(connection, dm_id, message_id, request_body, opts \\ [])

@spec update_native_dm_message(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  %{optional(String.t()) => any()},
  keyword()
) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Update a DM message body.

Parameters

  • connection (Spatio.Connection): Connection to server
  • dm_id (String.t):
  • message_id (String.t):
  • request_body (%{optional(String.t) => any()}):
  • opts (keyword): Optional parameters

Returns

  • {:ok, %{}} on success
  • {:error, Tesla.Env.t} on failure