Client

Swift

public let inboxID: InboxId

Swift

public let libXMTPVersion: String

Swift

public let dbPath: String

Swift

public let installationID: String

Swift

public let publicIdentity: PublicIdentity

Swift

public let environment: XMTPEnvironment

Swift

public lazy var conversations: Conversations { get set }

Swift

public lazy var preferences: PrivatePreferences { get set }

Swift

public lazy var debugInformation: XMTPDebugInformation { get set }

Swift

public static func register(codec: any ContentCodec)

Swift

public static func create(
	account: SigningKey, options: ClientOptions
)
	async throws -> Client

Swift

public static func build(
	publicIdentity: PublicIdentity, options: ClientOptions,
	inboxId: InboxId? = nil
)
	async throws -> Client

Swift

public static func ffiCreateClient(
	identity: PublicIdentity, clientOptions: ClientOptions
) async throws -> Client

Swift

public static func connectToApiBackend(api: ClientOptions.Api) async throws
	-> XmtpApiClient

Swift

public static func connectToSyncApiBackend(api: ClientOptions.Api)
	async throws
	-> XmtpApiClient

Swift

public static func getOrCreateInboxId(
	api: ClientOptions.Api, publicIdentity: PublicIdentity
) async throws -> InboxId

Swift

public static func revokeInstallations(
	api: ClientOptions.Api,
	signingKey: SigningKey,
	inboxId: InboxId,
	installationIds: [String]
) async throws

Swift

public static func ffiApplySignatureRequest(
	api: ClientOptions.Api,
	signatureRequest: SignatureRequest
)
	async throws

Swift

public static func ffiRevokeInstallations(
	api: ClientOptions.Api,
	publicIdentity: PublicIdentity,
	inboxId: InboxId,
	installationIds: [String]
) async throws
	-> SignatureRequest

Swift

public static func canMessage(
	accountIdentities: [PublicIdentity], api: ClientOptions.Api
) async throws -> [String: Bool]

Swift

public static func inboxStatesForInboxIds(
	inboxIds: [InboxId],
	api: ClientOptions.Api
) async throws -> [InboxState]

Swift

public static func keyPackageStatusesForInstallationIds(
	installationIds: [String],
	api: ClientOptions.Api
) async throws -> [String: FfiKeyPackageStatus]

Swift

public func addAccount(
	newAccount: SigningKey, allowReassignInboxId: Bool = false
)
	async throws

Swift

public func removeAccount(
	recoveryAccount: SigningKey, identityToRemove: PublicIdentity
) async throws

Swift

public func revokeAllOtherInstallations(signingKey: SigningKey) async throws

Swift

public func revokeInstallations(
	signingKey: SigningKey, installationIds: [String]
) async throws

Swift

public func canMessage(identity: PublicIdentity) async throws -> Bool

Swift

public func canMessage(identities: [PublicIdentity]) async throws
	-> [String: Bool]

Swift

public func deleteLocalDatabase() throws

Swift

public func dropLocalDatabaseConnection() throws

Swift

public func reconnectLocalDatabase() async throws

Swift

public func inboxIdFromIdentity(identity: PublicIdentity) async throws
	-> InboxId?

Swift

public func signWithInstallationKey(message: String) throws -> Data

Swift

public func verifySignature(message: String, signature: Data) throws -> Bool

Swift

public func verifySignatureWithInstallationId(
	message: String, signature: Data, installationId: String
) throws -> Bool

Swift

public func inboxState(refreshFromNetwork: Bool) async throws -> InboxState

Swift

public func inboxStatesForInboxIds(
	refreshFromNetwork: Bool, inboxIds: [InboxId]
) async throws -> [InboxState]

Swift

public func createArchive(
	path: String,
	encryptionKey: Data,
	opts: ArchiveOptions = ArchiveOptions()
) async throws

Swift

public func importArchive(path: String, encryptionKey: Data) async throws

Swift

public func archiveMetadata(path: String, encryptionKey: Data) async throws
	-> ArchiveMetadata

Swift

public func ffiApplySignatureRequest(signatureRequest: SignatureRequest)
	async throws

Swift

public func ffiRevokeInstallations(ids: [Data]) async throws
	-> SignatureRequest

Swift

public func ffiRevokeAllOtherInstallations() async throws
	-> SignatureRequest

Swift

public func ffiRevokeIdentity(identityToRemove: PublicIdentity) async throws
	-> SignatureRequest

Swift

public func ffiAddIdentity(
	identityToAdd: PublicIdentity, allowReassignInboxId: Bool = false
) async throws
	-> SignatureRequest

Swift

public func ffiSignatureRequest() -> SignatureRequest?

Swift

public func ffiRegisterIdentity(signatureRequest: SignatureRequest)
	async throws

Swift

enum LogLevel

Swift

static func activatePersistentLibXMTPLogWriter(
	logLevel: LogLevel,
	rotationSchedule: FfiLogRotation,
	maxFiles: Int,
	customLogDirectory: URL? = nil
)

Swift

static func deactivatePersistentLibXMTPLogWriter()

Swift

static func getXMTPLogFilePaths(customLogDirectory: URL? = nil)
	-> [String]

Swift

@discardableResult
static func clearXMTPLogs(customLogDirectory: URL? = nil) -> Int