Structures
The following structures are available globally.
-
Undocumented
See moreDeclaration
Swift
public struct Attachment : Codable
-
Undocumented
See moreDeclaration
Swift
public struct AttachmentCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct EncryptedEncodedContent
-
Undocumented
See moreDeclaration
Swift
public struct GroupUpdatedCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct MultiRemoteAttachment
-
Undocumented
See moreDeclaration
Swift
public struct MultiRemoteAttachmentCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct Reaction : Codable
-
Undocumented
See moreDeclaration
Swift
public struct ReactionCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct ReactionV2Codec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct ReadReceipt
-
Undocumented
See moreDeclaration
Swift
public struct ReadReceiptCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct RemoteAttachment
-
Undocumented
See moreDeclaration
Swift
public struct RemoteAttachmentCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct Reply
-
Undocumented
See moreDeclaration
Swift
public struct ReplyCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct TextCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct TransactionReference
-
Undocumented
See moreDeclaration
Swift
public struct TransactionReferenceCodec : ContentCodec
-
Undocumented
See moreDeclaration
Swift
public struct Dm : Identifiable, Equatable, Hashable
-
Undocumented
See moreDeclaration
Swift
public struct Group : Identifiable, Equatable, Hashable
-
Undocumented
See moreDeclaration
Swift
public struct ArchiveOptions
-
Undocumented
See moreDeclaration
Swift
public struct ArchiveMetadata
-
Undocumented
See moreDeclaration
Swift
public struct ConversationDebugInfo
-
Undocumented
See moreDeclaration
Swift
public struct DecodedMessage : Identifiable
-
Undocumented
See moreDeclaration
Swift
public struct DisappearingMessageSettings
-
Undocumented
See moreDeclaration
Swift
public struct GroupMembershipResult
-
Undocumented
See moreDeclaration
Swift
public struct InboxState
-
Undocumented
See moreDeclaration
Swift
public struct Installation
-
Undocumented
See moreDeclaration
Swift
public struct Member
-
Undocumented
See moreDeclaration
Swift
public struct PublicIdentity
-
Undocumented
See moreDeclaration
Swift
public struct SignatureRequest
-
Undocumented
See moreDeclaration
Swift
public struct ConsentRecord : Codable, Hashable
-
Wrapper class for errors from the Keystore API
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_KeystoreError
extension Xmtp_KeystoreApi_V1_KeystoreError: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_KeystoreError: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Decrypt a batch of messages using X3DH key agreement
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_DecryptV1Request
extension Xmtp_KeystoreApi_V1_DecryptV1Request: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_DecryptV1Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response type for both V1 and V2 decryption requests
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_DecryptResponse
extension Xmtp_KeystoreApi_V1_DecryptResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_DecryptResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Decrypt a batch of messages using the appropriate topic keys
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_DecryptV2Request
extension Xmtp_KeystoreApi_V1_DecryptV2Request: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_DecryptV2Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Encrypt a batch of messages using X3DH key agreement
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_EncryptV1Request
extension Xmtp_KeystoreApi_V1_EncryptV1Request: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_EncryptV1Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response type for both V1 and V2 encryption requests
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_EncryptResponse
extension Xmtp_KeystoreApi_V1_EncryptResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_EncryptResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Encrypt a batch of messages using the appropriate topic keys
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_EncryptV2Request
extension Xmtp_KeystoreApi_V1_EncryptV2Request: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_EncryptV2Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Encrypt a message for yourself
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SelfEncryptRequest
extension Xmtp_KeystoreApi_V1_SelfEncryptRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SelfEncryptRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response type for SelfEncryptRequest
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SelfEncryptResponse
extension Xmtp_KeystoreApi_V1_SelfEncryptResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SelfEncryptResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SelfDecryptRequest
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SelfDecryptRequest
extension Xmtp_KeystoreApi_V1_SelfDecryptRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SelfDecryptRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Get the private preferences topic identifier
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetPrivatePreferencesTopicIdentifierResponse
extension Xmtp_KeystoreApi_V1_GetPrivatePreferencesTopicIdentifierResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetPrivatePreferencesTopicIdentifierResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Request to create an invite payload, and store the topic keys in the Keystore
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_CreateInviteRequest
extension Xmtp_KeystoreApi_V1_CreateInviteRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_CreateInviteRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response to a CreateInviteRequest
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_CreateInviteResponse
extension Xmtp_KeystoreApi_V1_CreateInviteResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_CreateInviteResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Request to save a batch of invite messages to the Keystore
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SaveInvitesRequest
extension Xmtp_KeystoreApi_V1_SaveInvitesRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SaveInvitesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response to a SaveInvitesRequest
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SaveInvitesResponse
extension Xmtp_KeystoreApi_V1_SaveInvitesResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SaveInvitesResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
CreateAuthTokenRequest is used to create an auth token for the XMTP API
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_CreateAuthTokenRequest
extension Xmtp_KeystoreApi_V1_CreateAuthTokenRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_CreateAuthTokenRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SaveV1ConversationsRequest is used to save a batch of conversations to the built in persistence
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SaveV1ConversationsRequest
extension Xmtp_KeystoreApi_V1_SaveV1ConversationsRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SaveV1ConversationsRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Placeholder response type for SaveV1Conversations
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SaveV1ConversationsResponse
extension Xmtp_KeystoreApi_V1_SaveV1ConversationsResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SaveV1ConversationsResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response for GetV2Conversations
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetConversationsResponse
extension Xmtp_KeystoreApi_V1_GetConversationsResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetConversationsResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Used to check if the Keystore implementation has been setup for the given wallet address Only used for MM Snap Keystore currently
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetKeystoreStatusRequest
extension Xmtp_KeystoreApi_V1_GetKeystoreStatusRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetKeystoreStatusRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response to GetKeystoreStatusRequest
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetKeystoreStatusResponse
extension Xmtp_KeystoreApi_V1_GetKeystoreStatusResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetKeystoreStatusResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Used to initialize the Keystore with a private key bundle retrieved from the client
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_InitKeystoreRequest
extension Xmtp_KeystoreApi_V1_InitKeystoreRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_InitKeystoreRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response to the request to initialize the Keystore
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_InitKeystoreResponse
extension Xmtp_KeystoreApi_V1_InitKeystoreResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_InitKeystoreResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SignDigestRequest is used to sign a digest with either the identity key or a prekey
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SignDigestRequest
extension Xmtp_KeystoreApi_V1_SignDigestRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SignDigestRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
GetRefreshJobRequest is used to get the last run time of a refresh job
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetRefreshJobRequest
extension Xmtp_KeystoreApi_V1_GetRefreshJobRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetRefreshJobRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
GetRefreshJobResponse is used to return the last run time of a refresh job
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetRefreshJobResponse
extension Xmtp_KeystoreApi_V1_GetRefreshJobResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetRefreshJobResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SetRefreshJobRequest is used to set the last run time of a refresh job
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SetRefeshJobRequest
extension Xmtp_KeystoreApi_V1_SetRefeshJobRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SetRefeshJobRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SetRefreshJobResponse is an empty response type
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_SetRefreshJobResponse
extension Xmtp_KeystoreApi_V1_SetRefreshJobResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_SetRefreshJobResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A mapping of topics to their decrypted invitations
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_TopicMap
extension Xmtp_KeystoreApi_V1_TopicMap: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_TopicMap: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Used to get a mapping of conversation topics to their HMAC keys
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetConversationHmacKeysRequest
extension Xmtp_KeystoreApi_V1_GetConversationHmacKeysRequest: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetConversationHmacKeysRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A mapping of topics to their HMAC keys
See moreDeclaration
Swift
public struct Xmtp_KeystoreApi_V1_GetConversationHmacKeysResponse
extension Xmtp_KeystoreApi_V1_GetConversationHmacKeysResponse: @unchecked Sendable
extension Xmtp_KeystoreApi_V1_GetConversationHmacKeysResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Token is used by clients to prove to the nodes that they are serving a specific wallet.
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_Token
extension Xmtp_MessageApi_V1_Token: @unchecked Sendable
extension Xmtp_MessageApi_V1_Token: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
AuthData carries token parameters that are authenticated by the identity key signature. It is embedded in the Token structure as bytes so that the bytes don’t need to be reconstructed to verify the token signature.
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_AuthData
extension Xmtp_MessageApi_V1_AuthData: @unchecked Sendable
extension Xmtp_MessageApi_V1_AuthData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
This is based off of the go-waku Index type, but with the receiverTime and pubsubTopic removed for simplicity. Both removed fields are optional
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_IndexCursor
extension Xmtp_MessageApi_V1_IndexCursor: @unchecked Sendable
extension Xmtp_MessageApi_V1_IndexCursor: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Wrapper for potentially multiple types of cursor
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_Cursor
extension Xmtp_MessageApi_V1_Cursor: @unchecked Sendable
extension Xmtp_MessageApi_V1_Cursor: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
This is based off of the go-waku PagingInfo struct, but with the direction changed to our SortDirection enum format
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_PagingInfo
extension Xmtp_MessageApi_V1_PagingInfo: @unchecked Sendable
extension Xmtp_MessageApi_V1_PagingInfo: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Envelope encapsulates a message while in transit.
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_Envelope
extension Xmtp_MessageApi_V1_Envelope: @unchecked Sendable
extension Xmtp_MessageApi_V1_Envelope: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Publish
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_PublishRequest
extension Xmtp_MessageApi_V1_PublishRequest: @unchecked Sendable
extension Xmtp_MessageApi_V1_PublishRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Empty message as a response for Publish
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_PublishResponse
extension Xmtp_MessageApi_V1_PublishResponse: @unchecked Sendable
extension Xmtp_MessageApi_V1_PublishResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Subscribe
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_SubscribeRequest
extension Xmtp_MessageApi_V1_SubscribeRequest: @unchecked Sendable
extension Xmtp_MessageApi_V1_SubscribeRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SubscribeAll
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_SubscribeAllRequest
extension Xmtp_MessageApi_V1_SubscribeAllRequest: @unchecked Sendable
extension Xmtp_MessageApi_V1_SubscribeAllRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Query
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_QueryRequest
extension Xmtp_MessageApi_V1_QueryRequest: @unchecked Sendable
extension Xmtp_MessageApi_V1_QueryRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The response, containing envelopes, for a query
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_QueryResponse
extension Xmtp_MessageApi_V1_QueryResponse: @unchecked Sendable
extension Xmtp_MessageApi_V1_QueryResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
BatchQuery
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_BatchQueryRequest
extension Xmtp_MessageApi_V1_BatchQueryRequest: @unchecked Sendable
extension Xmtp_MessageApi_V1_BatchQueryRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response containing a list of QueryResponse messages
See moreDeclaration
Swift
public struct Xmtp_MessageApi_V1_BatchQueryResponse
extension Xmtp_MessageApi_V1_BatchQueryResponse: @unchecked Sendable
extension Xmtp_MessageApi_V1_BatchQueryResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Ciphertext represents encrypted payload. It is definited as a union to support cryptographic algorithm agility. The payload is accompanied by the cryptographic parameters required by the chosen encryption scheme.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_Ciphertext
extension Xmtp_MessageContents_Ciphertext: @unchecked Sendable
extension Xmtp_MessageContents_Ciphertext: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SignedEciesCiphertext represents an ECIES encrypted payload and a signature
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SignedEciesCiphertext
extension Xmtp_MessageContents_SignedEciesCiphertext: @unchecked Sendable
extension Xmtp_MessageContents_SignedEciesCiphertext: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Composite is used to implement xmtp.org/composite content type
See moreDeclaration
Swift
public struct Xmtp_MessageContents_Composite
extension Xmtp_MessageContents_Composite: @unchecked Sendable
extension Xmtp_MessageContents_Composite: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
LEGACY: User key bundle V1 using PublicKeys. The PublicKeys MUST be signed.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_ContactBundleV1
extension Xmtp_MessageContents_ContactBundleV1: @unchecked Sendable
extension Xmtp_MessageContents_ContactBundleV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
User key bundle V2 using SignedPublicKeys.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_ContactBundleV2
extension Xmtp_MessageContents_ContactBundleV2: @unchecked Sendable
extension Xmtp_MessageContents_ContactBundleV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Versioned ContactBundle
See moreDeclaration
Swift
public struct Xmtp_MessageContents_ContactBundle
extension Xmtp_MessageContents_ContactBundle: @unchecked Sendable
extension Xmtp_MessageContents_ContactBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
ContentTypeId is used to identify the type of content stored in a Message.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_ContentTypeId
extension Xmtp_MessageContents_ContentTypeId: @unchecked Sendable
extension Xmtp_MessageContents_ContentTypeId: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
EncodedContent bundles the content with metadata identifying its type and parameters required for correct decoding and presentation of the content.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_EncodedContent
extension Xmtp_MessageContents_EncodedContent: @unchecked Sendable
extension Xmtp_MessageContents_EncodedContent: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SignedContent attaches a signature to EncodedContent.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SignedContent
extension Xmtp_MessageContents_SignedContent: @unchecked Sendable
extension Xmtp_MessageContents_SignedContent: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A light pointer for a conversation that contains no decryption keys
See moreDeclaration
Swift
public struct Xmtp_MessageContents_ConversationReference
extension Xmtp_MessageContents_ConversationReference: @unchecked Sendable
extension Xmtp_MessageContents_ConversationReference: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
EciesMessage is a wrapper for ECIES encrypted payloads
See moreDeclaration
Swift
public struct Xmtp_MessageContents_EciesMessage
extension Xmtp_MessageContents_EciesMessage: @unchecked Sendable
extension Xmtp_MessageContents_EciesMessage: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The message that will be signed by the Client and returned inside the
See moreaction_body
field of the FrameAction messageDeclaration
Swift
public struct Xmtp_MessageContents_FrameActionBody : Sendable
extension Xmtp_MessageContents_FrameActionBody: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The outer payload that will be sent as the
See moremessageBytes
in thetrusted_data
part of the Frames messageDeclaration
Swift
public struct Xmtp_MessageContents_FrameAction : @unchecked Sendable
extension Xmtp_MessageContents_FrameAction: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Unsealed invitation V1
See moreDeclaration
Swift
public struct Xmtp_MessageContents_InvitationV1
extension Xmtp_MessageContents_InvitationV1: @unchecked Sendable
extension Xmtp_MessageContents_InvitationV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Sealed Invitation V1 Header Header carries information that is unencrypted, thus readable by the network it is however authenticated as associated data with the AEAD scheme used to encrypt the invitation body, thus providing tamper evidence.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SealedInvitationHeaderV1
extension Xmtp_MessageContents_SealedInvitationHeaderV1: @unchecked Sendable
extension Xmtp_MessageContents_SealedInvitationHeaderV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Sealed Invitation V1 Invitation encrypted with key material derived from the sender’s and recipient’s public key bundles using simplified X3DH where the sender’s ephemeral key is replaced with sender’s pre-key.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SealedInvitationV1
extension Xmtp_MessageContents_SealedInvitationV1: @unchecked Sendable
extension Xmtp_MessageContents_SealedInvitationV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Versioned Sealed Invitation
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SealedInvitation
extension Xmtp_MessageContents_SealedInvitation: @unchecked Sendable
extension Xmtp_MessageContents_SealedInvitation: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Payload for user’s consent proof to be set in the invitation Signifying the conversation should be preapproved for the user on receipt
See moreDeclaration
Swift
public struct Xmtp_MessageContents_ConsentProofPayload
extension Xmtp_MessageContents_ConsentProofPayload: @unchecked Sendable
extension Xmtp_MessageContents_ConsentProofPayload: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Message header is encoded separately as the bytes are also used as associated data for authenticated encryption
See moreDeclaration
Swift
public struct Xmtp_MessageContents_MessageHeaderV1
extension Xmtp_MessageContents_MessageHeaderV1: @unchecked Sendable
extension Xmtp_MessageContents_MessageHeaderV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Message is the top level protocol element
See moreDeclaration
Swift
public struct Xmtp_MessageContents_MessageV1
extension Xmtp_MessageContents_MessageV1: @unchecked Sendable
extension Xmtp_MessageContents_MessageV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Message header carries information that is not encrypted, and is therefore observable by the network. It is however authenticated as associated data of the AEAD encryption used to protect the message, thus providing tamper evidence.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_MessageHeaderV2
extension Xmtp_MessageContents_MessageHeaderV2: @unchecked Sendable
extension Xmtp_MessageContents_MessageHeaderV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Message combines the encoded header with the encrypted payload.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_MessageV2
extension Xmtp_MessageContents_MessageV2: @unchecked Sendable
extension Xmtp_MessageContents_MessageV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Versioned Message
See moreDeclaration
Swift
public struct Xmtp_MessageContents_Message
extension Xmtp_MessageContents_Message: @unchecked Sendable
extension Xmtp_MessageContents_Message: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
DecodedMessage represents the decrypted message contents. DecodedMessage instances are not stored on the network, but may be serialized and stored by clients
See moreDeclaration
Swift
public struct Xmtp_MessageContents_DecodedMessage
extension Xmtp_MessageContents_DecodedMessage: @unchecked Sendable
extension Xmtp_MessageContents_DecodedMessage: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
PrivateKey generalized to support different key types
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SignedPrivateKey
extension Xmtp_MessageContents_SignedPrivateKey: @unchecked Sendable
extension Xmtp_MessageContents_SignedPrivateKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
PrivateKeyBundle wraps the identityKey and the preKeys, enforces usage of signed keys.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PrivateKeyBundleV2
extension Xmtp_MessageContents_PrivateKeyBundleV2: @unchecked Sendable
extension Xmtp_MessageContents_PrivateKeyBundleV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
LEGACY: PrivateKey generalized to support different key types
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PrivateKey
extension Xmtp_MessageContents_PrivateKey: @unchecked Sendable
extension Xmtp_MessageContents_PrivateKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
LEGACY: PrivateKeyBundleV1 wraps the identityKey and the preKeys
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PrivateKeyBundleV1
extension Xmtp_MessageContents_PrivateKeyBundleV1: @unchecked Sendable
extension Xmtp_MessageContents_PrivateKeyBundleV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Versioned PrivateKeyBundle
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PrivateKeyBundle
extension Xmtp_MessageContents_PrivateKeyBundle: @unchecked Sendable
extension Xmtp_MessageContents_PrivateKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
PrivateKeyBundle encrypted with key material generated by signing a randomly generated “pre-key” with the user’s wallet, i.e. EIP-191 signature of a “storage signature” message with the pre-key embedded in it. (see xmtp-js::PrivateKeyBundle.toEncryptedBytes for details)
See moreDeclaration
Swift
public struct Xmtp_MessageContents_EncryptedPrivateKeyBundleV1
extension Xmtp_MessageContents_EncryptedPrivateKeyBundleV1: @unchecked Sendable
extension Xmtp_MessageContents_EncryptedPrivateKeyBundleV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Versioned encrypted PrivateKeyBundle
See moreDeclaration
Swift
public struct Xmtp_MessageContents_EncryptedPrivateKeyBundle
extension Xmtp_MessageContents_EncryptedPrivateKeyBundle: @unchecked Sendable
extension Xmtp_MessageContents_EncryptedPrivateKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
PrivatePreferencesAction is a message used to update the client’s preference store.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PrivatePreferencesAction
extension Xmtp_MessageContents_PrivatePreferencesAction: @unchecked Sendable
extension Xmtp_MessageContents_PrivatePreferencesAction: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The payload that goes over the wire
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PrivatePreferencesPayload
extension Xmtp_MessageContents_PrivatePreferencesPayload: @unchecked Sendable
extension Xmtp_MessageContents_PrivatePreferencesPayload: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
UnsignedPublicKey represents a generalized public key, defined as a union to support cryptographic algorithm agility.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_UnsignedPublicKey
extension Xmtp_MessageContents_UnsignedPublicKey: @unchecked Sendable
extension Xmtp_MessageContents_UnsignedPublicKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SignedPublicKey
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SignedPublicKey
extension Xmtp_MessageContents_SignedPublicKey: @unchecked Sendable
extension Xmtp_MessageContents_SignedPublicKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
PublicKeyBundle packages the cryptographic keys associated with a wallet.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SignedPublicKeyBundle
extension Xmtp_MessageContents_SignedPublicKeyBundle: @unchecked Sendable
extension Xmtp_MessageContents_SignedPublicKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
PublicKey represents a generalized public key, defined as a union to support cryptographic algorithm agility.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PublicKey
extension Xmtp_MessageContents_PublicKey: @unchecked Sendable
extension Xmtp_MessageContents_PublicKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
PublicKeyBundle packages the cryptographic keys associated with a wallet, both senders and recipients are identified by their key bundles.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_PublicKeyBundle
extension Xmtp_MessageContents_PublicKeyBundle: @unchecked Sendable
extension Xmtp_MessageContents_PublicKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Signature represents a generalized public key signature, defined as a union to support cryptographic algorithm agility.
See moreDeclaration
Swift
public struct Xmtp_MessageContents_Signature
extension Xmtp_MessageContents_Signature: @unchecked Sendable
extension Xmtp_MessageContents_Signature: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
SignedPayload is a wrapper for a signature and a payload
See moreDeclaration
Swift
public struct Xmtp_MessageContents_SignedPayload
extension Xmtp_MessageContents_SignedPayload: @unchecked Sendable
extension Xmtp_MessageContents_SignedPayload: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Full representation of a welcome message
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_WelcomeMessage
extension Xmtp_Mls_Api_V1_WelcomeMessage: @unchecked Sendable
extension Xmtp_Mls_Api_V1_WelcomeMessage: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Input type for a welcome message
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_WelcomeMessageInput
extension Xmtp_Mls_Api_V1_WelcomeMessageInput: @unchecked Sendable
extension Xmtp_Mls_Api_V1_WelcomeMessageInput: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Full representation of a group message
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_GroupMessage
extension Xmtp_Mls_Api_V1_GroupMessage: @unchecked Sendable
extension Xmtp_Mls_Api_V1_GroupMessage: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Input type for a group message
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_GroupMessageInput
extension Xmtp_Mls_Api_V1_GroupMessageInput: @unchecked Sendable
extension Xmtp_Mls_Api_V1_GroupMessageInput: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Send a batch of MLS messages
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_SendGroupMessagesRequest
extension Xmtp_Mls_Api_V1_SendGroupMessagesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_SendGroupMessagesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Send a batch of welcome messages
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_SendWelcomeMessagesRequest
extension Xmtp_Mls_Api_V1_SendWelcomeMessagesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_SendWelcomeMessagesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A wrapper around the Key Package bytes
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_KeyPackageUpload
extension Xmtp_Mls_Api_V1_KeyPackageUpload: @unchecked Sendable
extension Xmtp_Mls_Api_V1_KeyPackageUpload: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Register a new installation
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_RegisterInstallationRequest
extension Xmtp_Mls_Api_V1_RegisterInstallationRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_RegisterInstallationRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The response to a RegisterInstallationRequest
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_RegisterInstallationResponse
extension Xmtp_Mls_Api_V1_RegisterInstallationResponse: @unchecked Sendable
extension Xmtp_Mls_Api_V1_RegisterInstallationResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Upload a new key packages
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_UploadKeyPackageRequest
extension Xmtp_Mls_Api_V1_UploadKeyPackageRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_UploadKeyPackageRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Fetch one or more key packages
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_FetchKeyPackagesRequest
extension Xmtp_Mls_Api_V1_FetchKeyPackagesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_FetchKeyPackagesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The response to a FetchKeyPackagesRequest
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_FetchKeyPackagesResponse
extension Xmtp_Mls_Api_V1_FetchKeyPackagesResponse: @unchecked Sendable
extension Xmtp_Mls_Api_V1_FetchKeyPackagesResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Revoke an installation
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_RevokeInstallationRequest
extension Xmtp_Mls_Api_V1_RevokeInstallationRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_RevokeInstallationRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Get all updates for an identity since the specified time
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_GetIdentityUpdatesRequest
extension Xmtp_Mls_Api_V1_GetIdentityUpdatesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_GetIdentityUpdatesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Used to get any new or revoked installations for a list of wallet addresses
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_GetIdentityUpdatesResponse
extension Xmtp_Mls_Api_V1_GetIdentityUpdatesResponse: @unchecked Sendable
extension Xmtp_Mls_Api_V1_GetIdentityUpdatesResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Pagination config for queries
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_PagingInfo
extension Xmtp_Mls_Api_V1_PagingInfo: @unchecked Sendable
extension Xmtp_Mls_Api_V1_PagingInfo: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Request for group message queries
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_QueryGroupMessagesRequest
extension Xmtp_Mls_Api_V1_QueryGroupMessagesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_QueryGroupMessagesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response for group message queries
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_QueryGroupMessagesResponse
extension Xmtp_Mls_Api_V1_QueryGroupMessagesResponse: @unchecked Sendable
extension Xmtp_Mls_Api_V1_QueryGroupMessagesResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Request for welcome message queries
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_QueryWelcomeMessagesRequest
extension Xmtp_Mls_Api_V1_QueryWelcomeMessagesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_QueryWelcomeMessagesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response for welcome message queries
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_QueryWelcomeMessagesResponse
extension Xmtp_Mls_Api_V1_QueryWelcomeMessagesResponse: @unchecked Sendable
extension Xmtp_Mls_Api_V1_QueryWelcomeMessagesResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Request for subscribing to group messages
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_SubscribeGroupMessagesRequest
extension Xmtp_Mls_Api_V1_SubscribeGroupMessagesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_SubscribeGroupMessagesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Request for subscribing to welcome messages
See moreDeclaration
Swift
public struct Xmtp_Mls_Api_V1_SubscribeWelcomeMessagesRequest
extension Xmtp_Mls_Api_V1_SubscribeWelcomeMessagesRequest: @unchecked Sendable
extension Xmtp_Mls_Api_V1_SubscribeWelcomeMessagesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The data required to publish a message
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_SendMessageData
extension Xmtp_Mls_Database_SendMessageData: @unchecked Sendable
extension Xmtp_Mls_Database_SendMessageData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Wrapper around a list af repeated EVM Account Addresses
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_AccountAddresses
extension Xmtp_Mls_Database_AccountAddresses: @unchecked Sendable
extension Xmtp_Mls_Database_AccountAddresses: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Wrapper around a list of repeated Installation IDs
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_InstallationIds
extension Xmtp_Mls_Database_InstallationIds: @unchecked Sendable
extension Xmtp_Mls_Database_InstallationIds: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
One of an EVM account address or Installation ID
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_AddressesOrInstallationIds
extension Xmtp_Mls_Database_AddressesOrInstallationIds: @unchecked Sendable
extension Xmtp_Mls_Database_AddressesOrInstallationIds: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The data required to add members to a group
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_AddMembersData
extension Xmtp_Mls_Database_AddMembersData: @unchecked Sendable
extension Xmtp_Mls_Database_AddMembersData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The data required to remove members from a group
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_RemoveMembersData
extension Xmtp_Mls_Database_RemoveMembersData: @unchecked Sendable
extension Xmtp_Mls_Database_RemoveMembersData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The data required to make a commit that updates group membership Handles both Add and Remove actions
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_UpdateGroupMembershipData
extension Xmtp_Mls_Database_UpdateGroupMembershipData: @unchecked Sendable
extension Xmtp_Mls_Database_UpdateGroupMembershipData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The data required to update group metadata
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_UpdateMetadataData
extension Xmtp_Mls_Database_UpdateMetadataData: @unchecked Sendable
extension Xmtp_Mls_Database_UpdateMetadataData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The data required to update group admin/super admin lists
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_UpdateAdminListsData
extension Xmtp_Mls_Database_UpdateAdminListsData: @unchecked Sendable
extension Xmtp_Mls_Database_UpdateAdminListsData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The data required to update permissions
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_UpdatePermissionData
extension Xmtp_Mls_Database_UpdatePermissionData: @unchecked Sendable
extension Xmtp_Mls_Database_UpdatePermissionData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Generic data-type for all post-commit actions
See moreDeclaration
Swift
public struct Xmtp_Mls_Database_PostCommitAction
extension Xmtp_Mls_Database_PostCommitAction: @unchecked Sendable
extension Xmtp_Mls_Database_PostCommitAction: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Used for “Grant Messaging Access” associations
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_GrantMessagingAccessAssociation
extension Xmtp_Mls_MessageContents_GrantMessagingAccessAssociation: @unchecked Sendable
extension Xmtp_Mls_MessageContents_GrantMessagingAccessAssociation: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Used for “Revoke Messaging Access” associations
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_RevokeMessagingAccessAssociation
extension Xmtp_Mls_MessageContents_RevokeMessagingAccessAssociation: @unchecked Sendable
extension Xmtp_Mls_MessageContents_RevokeMessagingAccessAssociation: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
LegacyCreateIdentityAssociation is used when a v3 installation key is signed by a v2 identity key, which in turn is signed via a ‘CreateIdentity’ wallet signature
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_LegacyCreateIdentityAssociation
extension Xmtp_Mls_MessageContents_LegacyCreateIdentityAssociation: @unchecked Sendable
extension Xmtp_Mls_MessageContents_LegacyCreateIdentityAssociation: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
RecoverableEcdsaSignature
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_RecoverableEcdsaSignature
extension Xmtp_Mls_MessageContents_RecoverableEcdsaSignature: @unchecked Sendable
extension Xmtp_Mls_MessageContents_RecoverableEcdsaSignature: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
EdDSA signature bytes matching RFC 8032
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_EdDsaSignature
extension Xmtp_Mls_MessageContents_EdDsaSignature: @unchecked Sendable
extension Xmtp_Mls_MessageContents_EdDsaSignature: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A credential that can be used in MLS leaf nodes
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_MlsCredential
extension Xmtp_Mls_MessageContents_MlsCredential: @unchecked Sendable
extension Xmtp_Mls_MessageContents_MlsCredential: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A declaration and proof that a credential is no longer valid
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_CredentialRevocation
extension Xmtp_Mls_MessageContents_CredentialRevocation: @unchecked Sendable
extension Xmtp_Mls_MessageContents_CredentialRevocation: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Contains a mapping of
See moreinbox_id
->sequence_id
for all members of a group. Designed to be stored in the group context extension of the MLS groupDeclaration
Swift
public struct Xmtp_Mls_MessageContents_GroupMembership
extension Xmtp_Mls_MessageContents_GroupMembership: @unchecked Sendable
extension Xmtp_Mls_MessageContents_GroupMembership: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Parent message for group metadata
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_GroupMetadataV1
extension Xmtp_Mls_MessageContents_GroupMetadataV1: @unchecked Sendable
extension Xmtp_Mls_MessageContents_GroupMetadataV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Message for group mutable metadata
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_GroupMutableMetadataV1
extension Xmtp_Mls_MessageContents_GroupMutableMetadataV1: @unchecked Sendable
extension Xmtp_Mls_MessageContents_GroupMutableMetadataV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Wrapper around a list of repeated Inbox Ids
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_Inboxes
extension Xmtp_Mls_MessageContents_Inboxes: @unchecked Sendable
extension Xmtp_Mls_MessageContents_Inboxes: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Message for group mutable metadata
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_GroupMutablePermissionsV1
extension Xmtp_Mls_MessageContents_GroupMutablePermissionsV1: @unchecked Sendable
extension Xmtp_Mls_MessageContents_GroupMutablePermissionsV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The set of policies that govern the group
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_PolicySet
extension Xmtp_Mls_MessageContents_PolicySet: @unchecked Sendable
extension Xmtp_Mls_MessageContents_PolicySet: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A policy that governs adding/removing members or installations
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_MembershipPolicy
extension Xmtp_Mls_MessageContents_MembershipPolicy: @unchecked Sendable
extension Xmtp_Mls_MessageContents_MembershipPolicy: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A policy that governs updating metadata
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_MetadataPolicy
extension Xmtp_Mls_MessageContents_MetadataPolicy: @unchecked Sendable
extension Xmtp_Mls_MessageContents_MetadataPolicy: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A policy that governs updating permissions
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_PermissionsUpdatePolicy
extension Xmtp_Mls_MessageContents_PermissionsUpdatePolicy: @unchecked Sendable
extension Xmtp_Mls_MessageContents_PermissionsUpdatePolicy: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A group member and affected installation IDs
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_MembershipChange
extension Xmtp_Mls_MessageContents_MembershipChange: @unchecked Sendable
extension Xmtp_Mls_MessageContents_MembershipChange: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
The group membership change proto
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_GroupMembershipChanges
extension Xmtp_Mls_MessageContents_GroupMembershipChanges: @unchecked Sendable
extension Xmtp_Mls_MessageContents_GroupMembershipChanges: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A summary of the changes in a commit. Includes added/removed inboxes and changes to metadata
See moreDeclaration
Swift
public struct Xmtp_Mls_MessageContents_GroupUpdated
extension Xmtp_Mls_MessageContents_GroupUpdated: @unchecked Sendable
extension Xmtp_Mls_MessageContents_GroupUpdated: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Undocumented
See moreDeclaration
Swift
public struct XMTPPush
-
An union of possible delibery mechanisms
See moreDeclaration
Swift
public struct Notifications_V1_DeliveryMechanism
extension Notifications_V1_DeliveryMechanism: @unchecked Sendable
extension Notifications_V1_DeliveryMechanism: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A request to register an installation with the service
See moreDeclaration
Swift
public struct Notifications_V1_RegisterInstallationRequest
extension Notifications_V1_RegisterInstallationRequest: @unchecked Sendable
extension Notifications_V1_RegisterInstallationRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Response to RegisterInstallationRequest
See moreDeclaration
Swift
public struct Notifications_V1_RegisterInstallationResponse
extension Notifications_V1_RegisterInstallationResponse: @unchecked Sendable
extension Notifications_V1_RegisterInstallationResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Delete an installation from the service
See moreDeclaration
Swift
public struct Notifications_V1_DeleteInstallationRequest
extension Notifications_V1_DeleteInstallationRequest: @unchecked Sendable
extension Notifications_V1_DeleteInstallationRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A subscription with associated metadata
See moreDeclaration
Swift
public struct Notifications_V1_Subscription
extension Notifications_V1_Subscription: @unchecked Sendable
extension Notifications_V1_Subscription: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
A request to subscribe to a list of topics and update the associated metadata
See moreDeclaration
Swift
public struct Notifications_V1_SubscribeWithMetadataRequest
extension Notifications_V1_SubscribeWithMetadataRequest: @unchecked Sendable
extension Notifications_V1_SubscribeWithMetadataRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Subscribe to a list of topics
See moreDeclaration
Swift
public struct Notifications_V1_SubscribeRequest
extension Notifications_V1_SubscribeRequest: @unchecked Sendable
extension Notifications_V1_SubscribeRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Unsubscribe from a list of topics
See moreDeclaration
Swift
public struct Notifications_V1_UnsubscribeRequest
extension Notifications_V1_UnsubscribeRequest: @unchecked Sendable
extension Notifications_V1_UnsubscribeRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
-
Undocumented
See moreDeclaration
Swift
public struct SendOptions
-
Undocumented
See moreDeclaration
Swift
public struct SignedData