API Reference xmtp_elixir_sdk v#0.1.2
Copy MarkdownModules
Shared XMTP identity setup for product apps.
Product-safe installation status and repair helpers.
Regent group appData codec.
Regent profile metadata codec for silent profile updates and room display.
Shared wallet and inbox resolver with bounded caching.
Product-safe room state for Phoenix UIs.
Canonical room action facade for product apps.
Describes the optional host-owned XMTP room mirror storage shape.
Phoenix/Postgres-friendly sync helpers for room mirrors.
The main entrypoint for the XMTP Elixir SDK.
Browser-shim contracts for browser-only SDK work.
Typed message envelopes for the browser-only bridge.
An error response sent back from the browser shim.
A request sent from Elixir to the browser shim.
A successful response sent back from the browser shim.
A streamed error emitted by the browser shim.
A streamed event emitted by the browser shim.
Small async stream primitive for browser-shim boundaries.
Request builders for browser-managed storage operations.
Plain XMTP client data.
Client lifecycle and identity operations.
Behaviour for custom content codecs.
Registry of custom content codecs keyed by canonical content type.
Public URL constants and metadata helpers for the SDK surface.
Core content helpers used by messages and conversations.
Action list content.
Inline attachment.
Group update content.
Intent content.
Markdown content.
Multiple remote attachments.
Reaction content.
Read receipt marker.
Remote attachment.
Reply content.
Plain text content.
Transaction reference content.
Unknown content payload.
Wallet call.
Wallet send calls content.
Plain XMTP conversation data.
Find, create, and list conversations.
Public conversion helpers for stable SDK-facing shapes.
Stable conversation shape for public utility helpers.
Public timestamp helpers for the SDK's nanosecond-based time values.
Debug and statistics operations.
Message surface with custom content decoded through a codec registry.
Structured SDK error used throughout the core modules.
Runtime-scoped event subscriptions and delivery.
Consent records emitted after Preferences.set_consent_states/2.
Preference updates emitted by Preferences.sync/1 and consent changes.
Group membership, roles, permissions, and metadata.
Public inbox ID helpers for generating and resolving inbox IDs.
Public inbox state helpers for lookups and common state checks.
Public helpers for working with installations and revocation flows.
Send, list, count, publish, and decode messages.
Public metadata helpers for field names and group update inspection.
Native-backed XMTP operations.
Consent, inbox-state, and preference-sync operations.
Named supervised XMTP runtime.
Canonical signer payload helpers for signature-request flows.
Canonical externally owned account signer payload.
Canonical smart-contract wallet signer payload.
Local storage helper used by the SDK core.
Archive, restore, and device-sync operations.
Core SDK value objects and enum helpers.
Single action option.
Action list content.
API call statistics.
Archive metadata.
Archive options.
Available archive info.
Consent update from a preference stream.
Content type identifier.
Conversation snapshot.
Conversation debug data.
Conversation metadata.
DM creation options.
Group creation options.
Conversation cursor.
Message disappearing settings.
Group member snapshot.
Device sync summary.
Group update content.
HMAC key material.
Conversation HMAC key entry.
Account identifier.
Identity call statistics.
Inbox state snapshot.
Installation snapshot.
Intent content.
Key package status.
Per-inbox last-read timestamp.
Conversation listing options.
Message listing options.
Stored message.
Conversation metadata field change.
Multiple remote attachments.
Per-action permission policies.
Conversation permissions.
Preference update from a preference stream.
Message send options.
Sync result.
Transaction reference content.
Wallet call.
Wallet send calls content.