XmtpElixirSdk.Events (xmtp_elixir_sdk v0.1.2)

Copy Markdown

Runtime-scoped event subscriptions and delivery.

Summary

Types

topic()

Functions

emit(runtime_or_subject, topic, event)
subscribe(runtime_or_subject, topic, subscriber \\ self())
unsubscribe(runtime_or_subject, topic, subscriber \\ self())

Types

topic()

@type topic() ::
  {:conversations, String.t()}
  | {:conversation, String.t()}
  | {:messages, String.t()}
  | {:deleted_messages, String.t()}
  | {:preferences, String.t()}
  | {:consent, String.t()}

Functions

emit(runtime_or_subject, topic, event)

@spec emit(
  XmtpElixirSdk.Runtime.t()
  | XmtpElixirSdk.Client.t()
  | XmtpElixirSdk.Conversation.t()
  | atom(),
  topic(),
  struct()
) :: :ok

subscribe(runtime_or_subject, topic, subscriber \\ self())

@spec subscribe(
  XmtpElixirSdk.Runtime.t()
  | XmtpElixirSdk.Client.t()
  | XmtpElixirSdk.Conversation.t()
  | atom(),
  topic(),
  pid()
) :: :ok

unsubscribe(runtime_or_subject, topic, subscriber \\ self())

@spec unsubscribe(
  XmtpElixirSdk.Runtime.t()
  | XmtpElixirSdk.Client.t()
  | XmtpElixirSdk.Conversation.t()
  | atom(),
  topic(),
  pid()
) :: :ok