trixnity-clientserverapi-client/de.connect2x.trixnity.clientserverapi.client/UserApiClient

UserApiClient

interface UserApiClient

Inheritors

Properties

Link copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun deleteProfileField(userId: UserId, key: ProfileField.Key<*>): Result<Unit>
Link copied to clipboard
abstract suspend fun getAccountData(type: String, userId: UserId, key: String = ""): Result<GlobalAccountDataEventContent>
Link copied to clipboard
inline suspend fun <C : GlobalAccountDataEventContent> UserApiClient.getAccountData(userId: UserId, key: String = ""): Result<C>
Link copied to clipboard
abstract suspend fun getFilter(userId: UserId, filterId: String): Result<Filters>
Link copied to clipboard
abstract suspend fun getPresence(userId: UserId): Result<PresenceEventContent>
Link copied to clipboard
abstract suspend fun getProfile(userId: UserId): Result<Profile>
Link copied to clipboard
abstract suspend fun <T : ProfileField> getProfileField(userId: UserId, key: ProfileField.Key<T>): Result<T>
Link copied to clipboard
abstract suspend fun reportUser(userId: UserId, reason: String): Result<Unit>
Link copied to clipboard
abstract suspend fun searchUsers(searchTerm: String, acceptLanguage: String, limit: Long? = 10): Result<SearchUsers.Response>
Link copied to clipboard
abstract suspend fun sendToDevice(events: Map<UserId, Map<String, ToDeviceEventContent>>): Result<Unit>

This splits events into multiple requests, when they have a different type (for example a mix of encrypted and unencrypted events).

Link copied to clipboard
abstract suspend fun <C : ToDeviceEventContent> sendToDeviceUnsafe(events: Map<UserId, Map<String, C>>, transactionId: String = Random.nextString(22)): Result<Unit>
abstract suspend fun sendToDeviceUnsafe(type: String, events: Map<UserId, Map<String, ToDeviceEventContent>>, transactionId: String = Random.nextString(22)): Result<Unit>
Link copied to clipboard
abstract suspend fun setAccountData(content: GlobalAccountDataEventContent, userId: UserId, key: String = ""): Result<Unit>
Link copied to clipboard
abstract suspend fun setFilter(userId: UserId, filters: Filters): Result<String>
Link copied to clipboard
abstract suspend fun setPresence(userId: UserId, presence: Presence, statusMessage: String? = null): Result<Unit>
Link copied to clipboard
abstract suspend fun setProfileField(userId: UserId, field: ProfileField): Result<Unit>
Generated by Dokka
© 2026 connect2x GmbH