Client
public final class Client
Undocumented
-
Undocumented
Declaration
Swift
public let inboxID: InboxId
-
Undocumented
Declaration
Swift
public let libXMTPVersion: String
-
Undocumented
Declaration
Swift
public let dbPath: String
-
Undocumented
Declaration
Swift
public let installationID: String
-
Undocumented
Declaration
Swift
public let publicIdentity: PublicIdentity
-
Undocumented
Declaration
Swift
public let environment: XMTPEnvironment
-
Undocumented
Declaration
Swift
public lazy var conversations: Conversations { get set }
-
Undocumented
Declaration
Swift
public lazy var preferences: PrivatePreferences { get set }
-
Undocumented
Declaration
Swift
public lazy var debugInformation: XMTPDebugInformation { get set }
-
Undocumented
Declaration
Swift
public static func register(codec: any ContentCodec)
-
create(account:
Asynchronousoptions: ) Undocumented
Declaration
Swift
public static func create( account: SigningKey, options: ClientOptions ) async throws -> Client
-
build(publicIdentity:
Asynchronousoptions: inboxId: ) Undocumented
Declaration
Swift
public static func build( publicIdentity: PublicIdentity, options: ClientOptions, inboxId: InboxId? = nil ) async throws -> Client
-
ffiCreateClient(identity:
AsynchronousclientOptions: ) Undocumented
Declaration
Swift
public static func ffiCreateClient( identity: PublicIdentity, clientOptions: ClientOptions ) async throws -> Client
-
connectToApiBackend(api:
Asynchronous) Undocumented
Declaration
Swift
public static func connectToApiBackend(api: ClientOptions.Api) async throws -> XmtpApiClient
-
getOrCreateInboxId(api:
AsynchronouspublicIdentity: ) Undocumented
Declaration
Swift
public static func getOrCreateInboxId( api: ClientOptions.Api, publicIdentity: PublicIdentity ) async throws -> InboxId
-
Undocumented
Declaration
Swift
public static func revokeInstallations( api: ClientOptions.Api, signingKey: SigningKey, inboxId: InboxId, installationIds: [String] ) async throws
-
ffiApplySignatureRequest(api:
AsynchronoussignatureRequest: ) Undocumented
Declaration
Swift
public static func ffiApplySignatureRequest( api: ClientOptions.Api, signatureRequest: SignatureRequest ) async throws
-
Undocumented
Declaration
Swift
public static func ffiRevokeInstallations( api: ClientOptions.Api, publicIdentity: PublicIdentity, inboxId: InboxId, installationIds: [String] ) async throws -> SignatureRequest
-
canMessage(accountIdentities:
Asynchronousapi: ) Undocumented
Declaration
Swift
public static func canMessage( accountIdentities: [PublicIdentity], api: ClientOptions.Api ) async throws -> [String: Bool]
-
inboxStatesForInboxIds(inboxIds:
Asynchronousapi: ) Undocumented
Declaration
Swift
public static func inboxStatesForInboxIds( inboxIds: [InboxId], api: ClientOptions.Api ) async throws -> [InboxState]
-
Undocumented
Declaration
Swift
public static func keyPackageStatusesForInstallationIds( installationIds: [String], api: ClientOptions.Api ) async throws -> [String: FfiKeyPackageStatus]
-
addAccount(newAccount:
AsynchronousallowReassignInboxId: ) Undocumented
Declaration
Swift
public func addAccount( newAccount: SigningKey, allowReassignInboxId: Bool = false ) async throws
-
removeAccount(recoveryAccount:
AsynchronousidentityToRemove: ) Undocumented
Declaration
Swift
public func removeAccount( recoveryAccount: SigningKey, identityToRemove: PublicIdentity ) async throws
-
revokeAllOtherInstallations(signingKey:
Asynchronous) Undocumented
Declaration
Swift
public func revokeAllOtherInstallations(signingKey: SigningKey) async throws
-
revokeInstallations(signingKey:
AsynchronousinstallationIds: ) Undocumented
Declaration
Swift
public func revokeInstallations( signingKey: SigningKey, installationIds: [String] ) async throws
-
canMessage(identity:
Asynchronous) Undocumented
Declaration
Swift
public func canMessage(identity: PublicIdentity) async throws -> Bool
-
canMessage(identities:
Asynchronous) Undocumented
Declaration
Swift
public func canMessage(identities: [PublicIdentity]) async throws -> [String: Bool]
-
Undocumented
Declaration
Swift
public func deleteLocalDatabase() throws
-
Undocumented
Declaration
Swift
public func dropLocalDatabaseConnection() throws
-
reconnectLocalDatabase()
AsynchronousUndocumented
Declaration
Swift
public func reconnectLocalDatabase() async throws
-
inboxIdFromIdentity(identity:
Asynchronous) Undocumented
Declaration
Swift
public func inboxIdFromIdentity(identity: PublicIdentity) async throws -> InboxId?
-
Undocumented
Declaration
Swift
public func signWithInstallationKey(message: String) throws -> Data
-
Undocumented
Declaration
Swift
public func verifySignature(message: String, signature: Data) throws -> Bool
-
Undocumented
Declaration
Swift
public func verifySignatureWithInstallationId( message: String, signature: Data, installationId: String ) throws -> Bool
-
inboxState(refreshFromNetwork:
Asynchronous) Undocumented
Declaration
Swift
public func inboxState(refreshFromNetwork: Bool) async throws -> InboxState
-
inboxStatesForInboxIds(refreshFromNetwork:
AsynchronousinboxIds: ) Undocumented
Declaration
Swift
public func inboxStatesForInboxIds( refreshFromNetwork: Bool, inboxIds: [InboxId] ) async throws -> [InboxState]
-
ffiApplySignatureRequest(signatureRequest:
Asynchronous) Undocumented
Declaration
Swift
public func ffiApplySignatureRequest(signatureRequest: SignatureRequest) async throws
-
ffiRevokeInstallations(ids:
Asynchronous) Undocumented
Declaration
Swift
public func ffiRevokeInstallations(ids: [Data]) async throws -> SignatureRequest
-
ffiRevokeAllOtherInstallations()
AsynchronousUndocumented
Declaration
Swift
public func ffiRevokeAllOtherInstallations() async throws -> SignatureRequest
-
ffiRevokeIdentity(identityToRemove:
Asynchronous) Undocumented
Declaration
Swift
public func ffiRevokeIdentity(identityToRemove: PublicIdentity) async throws -> SignatureRequest
-
ffiAddIdentity(identityToAdd:
AsynchronousallowReassignInboxId: ) Undocumented
Declaration
Swift
public func ffiAddIdentity( identityToAdd: PublicIdentity, allowReassignInboxId: Bool = false ) async throws -> SignatureRequest
-
Undocumented
Declaration
Swift
public func ffiSignatureRequest() -> SignatureRequest?
-
ffiRegisterIdentity(signatureRequest:
Asynchronous) Undocumented
Declaration
Swift
public func ffiRegisterIdentity(signatureRequest: SignatureRequest) async throws
-
Log level for XMTP logging
See moreDeclaration
Swift
public enum LogLevel
-
Activates persistent logging for LibXMTP
Declaration
Swift
public static func activatePersistentLibXMTPLogWriter( logLevel: LogLevel, rotationSchedule: FfiLogRotation, maxFiles: Int, customLogDirectory: URL? = nil )
Parameters
logLevel
The level of logging to capture
rotationSchedule
When log files should rotate
maxFiles
Maximum number of log files to keep
customLogDirectory
Optional custom directory path for logs
-
Deactivates the persistent log writer
Declaration
Swift
public static func deactivatePersistentLibXMTPLogWriter()
-
Returns paths to all XMTP log files
Declaration
Swift
public static func getXMTPLogFilePaths(customLogDirectory: URL? = nil) -> [String]
Parameters
customLogDirectory
Optional custom directory path for logs
Return Value
Array of file paths to log files
-
Clears all XMTP log files
Declaration
Swift
@discardableResult public static func clearXMTPLogs(customLogDirectory: URL? = nil) -> Int
Parameters
customLogDirectory
Optional custom directory path for logs
Return Value
Number of files deleted