Group

Swift

public var id: String { get }

Swift

public var topic: String { get }

Swift

public var disappearingMessageSettings: DisappearingMessageSettings? { get }

Swift

public func isDisappearingMessagesEnabled() throws -> Bool

Swift

public func sync() async throws

Swift

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

Swift

public func hash(into hasher: inout Hasher)

Swift

public func isActive() throws -> Bool

Swift

public func isCreator() async throws -> Bool

Swift

public func isAdmin(inboxId: InboxId) throws -> Bool

Swift

public func isSuperAdmin(inboxId: InboxId) throws -> Bool

Swift

public func addAdmin(inboxId: InboxId) async throws

Swift

public func removeAdmin(inboxId: InboxId) async throws

Swift

public func addSuperAdmin(inboxId: InboxId) async throws

Swift

public func removeSuperAdmin(inboxId: InboxId) async throws

Swift

public func listAdmins() throws -> [InboxId]

Swift

public func listSuperAdmins() throws -> [InboxId]

Swift

public func permissionPolicySet() throws -> PermissionPolicySet

Swift

public func creatorInboxId() async throws -> InboxId

Swift

public func addedByInboxId() throws -> InboxId

Swift

public var members: [Member] { get async throws }

Swift

public var peerInboxIds: [InboxId] { get async throws }

Swift

public var createdAt: Date { get }

Swift

public var createdAtNs: Int64 { get }

Swift

public var lastActivityAtNs: Int64 { get }

Swift

public func addMembers(inboxIds: [InboxId]) async throws
	-> GroupMembershipResult

Swift

public func removeMembers(inboxIds: [InboxId]) async throws

Swift

public func addMembersByIdentity(identities: [PublicIdentity]) async throws
	-> GroupMembershipResult

Swift

public func removeMembersByIdentity(identities: [PublicIdentity])
	async throws

Swift

public func name() throws -> String

Swift

public func imageUrl() throws -> String

Swift

public func description() throws -> String

Swift

public func updateName(name: String) async throws

Swift

public func updateImageUrl(imageUrl: String) async throws

Swift

public func updateDescription(description: String) async throws

Swift

public func updateAddMemberPermission(newPermissionOption: PermissionOption)
	async throws

Swift

public func updateRemoveMemberPermission(
	newPermissionOption: PermissionOption
) async throws

Swift

public func updateAddAdminPermission(newPermissionOption: PermissionOption)
	async throws

Swift

public func updateRemoveAdminPermission(
	newPermissionOption: PermissionOption
) async throws

Swift

public func updateNamePermission(newPermissionOption: PermissionOption)
	async throws

Swift

public func updateDescriptionPermission(
	newPermissionOption: PermissionOption
) async throws

Swift

public func updateImageUrlPermission(
	newPermissionOption: PermissionOption
) async throws

Swift

public func updateDisappearingMessageSettings(
	_ disappearingMessageSettings: DisappearingMessageSettings?
) async throws

Swift

public func clearDisappearingMessageSettings() async throws

Swift

public func pausedForVersion() throws -> String?

Swift

public func updateConsentState(state: ConsentState) async throws

Swift

public func consentState() throws -> ConsentState

Swift

public func processMessage(messageBytes: Data) async throws
	-> DecodedMessage?

Swift

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

Swift

public func send(
	encodedContent: EncodedContent, visibilityOptions: MessageVisibilityOptions? = nil
) async throws -> String

Swift

public func encodeContent<T>(content: T, options: SendOptions?) async throws
	-> (EncodedContent, MessageVisibilityOptions)

Swift

public func prepareMessage(
	encodedContent: EncodedContent, visibilityOptions: MessageVisibilityOptions? = nil
) async throws
	-> String

Swift

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

Swift

public func publishMessages() async throws

Swift

public func endStream()

Swift

public func streamMessages(onClose: (() -> Void)? = nil)
	-> AsyncThrowingStream<DecodedMessage, Error>

Swift

public func lastMessage() async throws -> DecodedMessage?

Swift

public func commitLogForkStatus() -> CommitLogForkStatus

Swift

public func messages(
	beforeNs: Int64? = nil,
	afterNs: Int64? = nil,
	limit: Int? = nil,
	direction: SortDirection? = .descending,
	deliveryStatus: MessageDeliveryStatus = .all,
	excludeContentTypes: [StandardContentType]? = nil,
	excludeSenderInboxIds: [String]? = nil
) async throws -> [DecodedMessage]

Swift

public func messagesWithReactions(
	beforeNs: Int64? = nil,
	afterNs: Int64? = nil,
	limit: Int? = nil,
	direction: SortDirection? = .descending,
	deliveryStatus: MessageDeliveryStatus = .all,
	excludeContentTypes: [StandardContentType]? = nil,
	excludeSenderInboxIds: [String]? = nil
) async throws -> [DecodedMessage]

Swift

public func enrichedMessages(
	beforeNs: Int64? = nil,
	afterNs: Int64? = nil,
	limit: Int? = nil,
	direction: SortDirection? = .descending,
	deliveryStatus: MessageDeliveryStatus = .all,
	excludeContentTypes: [StandardContentType]? = nil,
	excludeSenderInboxIds: [String]? = nil
) async throws -> [DecodedMessageV2]

Swift

public func countMessages(
	beforeNs: Int64? = nil, afterNs: Int64? = nil, deliveryStatus: MessageDeliveryStatus = .all,
	excludeContentTypes: [StandardContentType]? = nil,
	excludeSenderInboxIds: [String]? = nil
) throws -> Int64

Swift

public func getHmacKeys() throws
	-> Xmtp_KeystoreApi_V1_GetConversationHmacKeysResponse

Swift

public func getPushTopics() throws -> [String]

Swift

public func getDebugInformation() async throws -> ConversationDebugInfo

Swift

public func getLastReadTimes() throws -> [String : Int64]