Conversation Enumeration Reference


                    
                    
                    v1(_:)

Undocumented

Declaration

Swift

case v1(ConversationV1)


                    
                    
                    v2(_:)

Undocumented

Declaration

Swift

case v2(ConversationV2)


                    
                    
                    Version

Undocumented

Declaration

Swift

public enum Version


                    
                    
                    consentState()

Asynchronous

Undocumented

Declaration

Swift

public func consentState() async -> ConsentState


                    
                    
                    version

Undocumented

Declaration

Swift

public var version: Version { get }


                    
                    
                    createdAt

Undocumented

Declaration

Swift

public var createdAt: Date { get }


                    
                    
                    encodedContainer

Undocumented

Declaration

Swift

public var encodedContainer: ConversationContainer { get }


                    
                    
                    peerAddress

The wallet address of the other person in this conversation.

Declaration

Swift

public var peerAddress: String { get }


                    
                    
                    conversationID

An optional string that can specify a different context for a conversation with another account address.

Note

conversationID is only available for ConversationV2 conversations.

Declaration

Swift

public var conversationID: String? { get }


                    
                    
                    toTopicData()

Exports the serializable topic data required for later import. See Conversations.importTopicData()

Declaration

Swift

public func toTopicData() -> Xmtp_KeystoreApi_V1_TopicMap.TopicData


                    
                    
                    decode(_:)

Undocumented

Declaration

Swift

public func decode(_ envelope: Envelope) throws -> DecodedMessage


                    
                    
                    decrypt(_:)

Undocumented

Declaration

Swift

public func decrypt(_ envelope: Envelope) throws -> DecryptedMessage


                    
                    
                    encode(codec:content:)

Asynchronous

Undocumented

Declaration

Swift

public func encode<Codec, T>(codec: Codec, content: T) async throws -> Data where Codec : ContentCodec, T == Codec.T


                    
                    
                    prepareMessage(encodedContent:options:)

Asynchronous

Undocumented

Declaration

Swift

public func prepareMessage(encodedContent: EncodedContent, options: SendOptions? = nil) async throws -> PreparedMessage


                    
                    
                    prepareMessage(content:options:)

Asynchronous

Undocumented

Declaration

Swift

public func prepareMessage<T>(content: T, options: SendOptions? = nil) async throws -> PreparedMessage


                    
                    
                    send(prepared:)

Asynchronous

Undocumented

Declaration

Swift

@discardableResult
public func send(prepared: PreparedMessage) async throws -> String


                    
                    
                    send(content:options:fallback:)

Asynchronous

Undocumented

Declaration

Swift

@discardableResult
public func send<T>(content: T, options: SendOptions? = nil, fallback _: String? = nil) async throws -> String


                    
                    
                    send(encodedContent:options:)

Asynchronous

Undocumented

Declaration

Swift

@discardableResult
public func send(encodedContent: EncodedContent, options: SendOptions? = nil) async throws -> String


                    
                    
                    send(text:options:)

Asynchronous

Send a message to the conversation

Declaration

Swift

public func send(text: String, options: SendOptions? = nil) async throws -> String


                    
                    
                    clientAddress

Undocumented

Declaration

Swift

public var clientAddress: String { get }


                    
                    
                    topic

The topic identifier for this conversation

Declaration

Swift

public var topic: String { get }


                    
                    
                    streamEphemeral()

Undocumented

Declaration

Swift

public func streamEphemeral() -> AsyncThrowingStream<Envelope, Error>?


                    
                    
                    streamMessages()

Returns a stream you can iterate through to receive new messages in this conversation.

Note

All messages in the conversation are returned by this stream. If you want to filter out messages by a sender, you can check the Client address against the message’s peerAddress.

Declaration

Swift

public func streamMessages() -> AsyncThrowingStream<DecodedMessage, Error>


                    
                    
                    streamDecryptedMessages()

Undocumented

Declaration

Swift

public func streamDecryptedMessages() -> AsyncThrowingStream<DecryptedMessage, Error>


                    
                    
                    messages(limit:before:after:direction:)

Asynchronous

List messages in the conversation

Declaration

Swift

public func messages(limit: Int? = nil, before: Date? = nil, after: Date? = nil, direction: PagingInfoSortDirection? = .descending) async throws -> [DecodedMessage]


                    
                    
                    decryptedMessages(limit:before:after:direction:)

Asynchronous

Undocumented

Declaration

Swift

public func decryptedMessages(limit: Int? = nil, before: Date? = nil, after: Date? = nil, direction: PagingInfoSortDirection? = .descending) async throws -> [DecryptedMessage]


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (lhs: Conversation, rhs: Conversation) -> Bool


                    
                    
                    hash(into:)

Declaration

Swift

public func hash(into hasher: inout Hasher)