Xmtp.Installations (xmtp_elixir_sdk v0.1.2)

Copy Markdown

Product-safe installation status and repair helpers.

Summary

Types

status()

Functions

recommend_cleanup(client_or_state, opts \\ [])
revoke_old_installation(client, installation_id, signer)
status(client_or_state, opts \\ [])

Types

status()

@type status() :: %{
  status: :ok | :too_many_devices,
  installation_count: non_neg_integer(),
  device_limit: pos_integer(),
  installation_ids: [String.t()],
  user_copy: String.t()
}

Functions

recommend_cleanup(client_or_state, opts \\ [])

@spec recommend_cleanup(
  XmtpElixirSdk.Client.t() | XmtpElixirSdk.Types.InboxState.t(),
  keyword()
) ::
  {:ok, %{installation_ids: [String.t()], user_copy: String.t()}}
  | {:error, term()}

revoke_old_installation(client, installation_id, signer)

@spec revoke_old_installation(XmtpElixirSdk.Client.t(), String.t(), map()) ::
  :ok | {:error, term()}

status(client_or_state, opts \\ [])

@spec status(
  XmtpElixirSdk.Client.t() | XmtpElixirSdk.Types.InboxState.t(),
  keyword()
) :: {:ok, status()} | {:error, term()}