Modules§
- content_
types - group_
updated - Nested message and enum types in
GroupUpdated. - membership_
policy - Nested message and enum types in
MembershipPolicy. - metadata_
policy - Nested message and enum types in
MetadataPolicy. - oneshot_
message - Nested message and enum types in
OneshotMessage. - permissions_
update_ policy - Nested message and enum types in
PermissionsUpdatePolicy. - plaintext_
envelope - Nested message and enum types in
PlaintextEnvelope. - welcome_
pointer - Nested message and enum types in
WelcomePointer.
Structs§
- Commit
LogEntry - Content
Type Id - ContentTypeId is used to identify the type of content stored in a Message.
- DmMembers
- Ordering does not matter here
- Encoded
Content - EncodedContent bundles the content with metadata identifying its type and parameters required for correct decoding and presentation of the content.
- Group
Membership - Contains a mapping of
inbox_id->sequence_idfor all members of a group. Designed to be stored in the group context extension of the MLS group - Group
Membership Changes - The group membership change proto
- Group
Metadata V1 - Parent message for group metadata
- Group
Mutable Metadata V1 - Message for group mutable metadata
- Group
Mutable Permissions V1 - Message for group mutable metadata
- Group
Updated - A summary of the changes in a commit. Includes added/removed inboxes and changes to metadata
- Inbox
- Wrapper around an Inbox Id
- Inboxes
- Wrapper around a list of repeated Inbox Ids
- Membership
Change - A group member and affected installation IDs
- Membership
Policy - A policy that governs adding/removing members or installations
- Metadata
Policy - A policy that governs updating metadata
- Oneshot
Message - Permissions
Update Policy - A policy that governs updating permissions
- Plaintext
Commit LogEntry - PlaintextCommitLogEntry indicates whether a commit was successful or not,
when applied on top of the indicated
last_epoch_authenticator. - Plaintext
Envelope - A PlaintextEnvelope is the outermost payload that gets encrypted by MLS
- Policy
Set - The set of policies that govern the group
- Readd
Request - A request sent by an installation to recover from a fork. Other members may remove and readd that installation from the group. XIP: https://community.xmtp.org/t/xip-68-draft-automated-fork-recovery/951
- Welcome
Pointee Encryption Aead Types Extension - Extension message that indicates the types of encryption supported by a client
- Welcome
Pointer - A WelcomePointer is used to point to the welcome message for several installations at once to save overhead
- Welcome
Wrapper Encryption - The KeyPackageExtension that stores the PubKey and the WelcomeWrapperEncryption
Enums§
- Commit
Result - Compression
- Recognized compression algorithms protolint:disable ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH
- Conversation
Type - Defines the type of conversation
- Welcome
Pointee Encryption Aead Type - Welcome
Pointer Wrapper Algorithm - MUST match the WelcomeWrapperAlgorithm enum values without 25519 so that the i32 transformations are compatible
- Welcome
Wrapper Algorithm - Describes the algorithm used to encrypt the Welcome Wrapper