XmtpElixirSdk.InboxState (xmtp_elixir_sdk v0.1.2)

Copy Markdown

Public inbox state helpers for lookups and common state checks.

Summary

Functions

account_identifiers(inbox_state)
fetch(runtime, inbox_ids, refresh_from_network \\ true)
fetch_for_client(client, inbox_ids, refresh_from_network \\ false)
includes_identifier?(inbox_state, identifier)
includes_installation?(state, installation_id)
installation_ids(inbox_state)
installations(inbox_state)

Functions

account_identifiers(inbox_state)

@spec account_identifiers(XmtpElixirSdk.Types.InboxState.t()) :: [
  XmtpElixirSdk.Types.Identifier.t()
]

fetch(runtime, inbox_ids, refresh_from_network \\ true)

@spec fetch(XmtpElixirSdk.Runtime.t() | atom(), [String.t()], boolean()) ::
  {:ok, [XmtpElixirSdk.Types.InboxState.t()]}
  | {:error, XmtpElixirSdk.Error.t()}

fetch_for_client(client, inbox_ids, refresh_from_network \\ false)

@spec fetch_for_client(XmtpElixirSdk.Client.t(), [String.t()], boolean()) ::
  {:ok, [XmtpElixirSdk.Types.InboxState.t()]}
  | {:error, XmtpElixirSdk.Error.t()}

includes_identifier?(inbox_state, identifier)

@spec includes_identifier?(
  XmtpElixirSdk.Types.InboxState.t(),
  XmtpElixirSdk.Types.Identifier.t()
) ::
  boolean()

includes_installation?(state, installation_id)

@spec includes_installation?(XmtpElixirSdk.Types.InboxState.t(), String.t()) ::
  boolean()

installation_ids(inbox_state)

@spec installation_ids(XmtpElixirSdk.Types.InboxState.t()) :: [String.t()]

installations(inbox_state)

@spec installations(XmtpElixirSdk.Types.InboxState.t()) :: [
  XmtpElixirSdk.Types.Installation.t()
]