xmtp library

*[<Null safety>](https://dart.dev/null-safety)*

Library containing the XMTP client SDK for Flutter applications written in dart.

Classes

Api

This is an instance of the xmtp.MessageApiClient with some metadata helpers (e.g. for setting the authorization token).

AuthData

Ciphertext

Ciphertext_Aes256gcmHkdfsha256

Client

This is the top-level entrypoint to the XMTP flutter SDK.

Codec<T extends Object>

This defines the interface for a content codec of a particular type T. It is responsible for knowing how to encode the content T. And it is responsible for knowing how to decode the EncodedContent.

CodecRegistry

This is a registry of codecs for particular types.

Composite

Composite_Part

Compression

ContactBundle

ContactBundleV1

ContactBundleV2

ContentTypeId

Conversation

This represents an ongoing conversation. It can be provided to Client to listMessages and sendMessage. The Client also allows you to streamMessages from this Conversation.

Cursor

DecodedContent

This represents the result of decoding content.

DecodedMessage

This represents a fully decoded message. It attempts to give uniform shape to v1 and v2 messages.

EncodedContent

EncryptedPrivateKeyBundle

EncryptedPrivateKeyBundleV1

Envelope

IndexCursor

InvitationV1

InvitationV1_Aes256gcmHkdfsha256

InvitationV1_Context

Message

MessageApiClient

MessageApiServiceBase

MessageHeaderV1

MessageHeaderV2

MessageV1

MessageV2

PagingInfo

PrivateKey

PrivateKey_Secp256k1

PrivateKeyBundle

PrivateKeyBundleV1

PrivateKeyBundleV2

PublicKey

PublicKey_Secp256k1Uncompressed

PublicKeyBundle

PublishRequest

PublishResponse

QueryRequest

QueryResponse

SealedInvitation

SealedInvitationHeaderV1

SealedInvitationV1

Signature

Signature_ECDSACompact

Signature_WalletECDSACompact

SignedContent

SignedPrivateKey

SignedPrivateKey_Secp256k1

SignedPublicKey

SignedPublicKeyBundle

Signer

Abstraction over a wallet with an address that can signPersonalMessages.

SortDirection

SubscribeRequest

TextCodec

This is a basic text Codec that supports UTF-8 encoding.

Token

UnsignedPublicKey

UnsignedPublicKey_Secp256k1Uncompressed

Extensions

CredentialsToSigner

This adds a helper to Credentials to treat it as a Signer.

Properties

contentTypeText → ContentTypeId

final

Enums

Ciphertext_Union

Composite_Part_Element

ContactBundle_Version

Cursor_Cursor

EncryptedPrivateKeyBundle_Version

InvitationV1_Encryption

Message_Version

PrivateKey_Union

PrivateKeyBundle_Version

PublicKey_Union

SealedInvitation_Version

Signature_Union

SignedPrivateKey_Union

UnsignedPublicKey_Union