matrix-sdk-android/org.matrix.android.sdk.api.session.profile/ProfileService

ProfileService

interface ProfileService
Content copied to clipboard

This interface defines methods to handling profile information. It's implemented at the session level.

Types

Link copied to clipboard
object Constants
Content copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun addThreePid(threePid: ThreePid)
Content copied to clipboard

Add a 3Pids. This is the first step to add a ThreePid to an account. Then the threePid will be added to the pending threePid list.

Link copied to clipboard
abstract suspend fun cancelAddingThreePid(threePid: ThreePid)
Content copied to clipboard

Cancel adding a threepid. It will remove locally stored data about this ThreePid.

Link copied to clipboard
abstract suspend fun deleteThreePid(threePid: ThreePid)
Content copied to clipboard

Remove a 3Pid from the Matrix account.

Link copied to clipboard
abstract suspend fun finalizeAddingThreePid(threePid: ThreePid, userInteractiveAuthInterceptor: UserInteractiveAuthInterceptor)
Content copied to clipboard

Finalize adding a 3Pids. Call this method once the user has validated that he owns the ThreePid.

Link copied to clipboard
abstract suspend fun getAvatarUrl(userId: String): Optional<String>
Content copied to clipboard

Return the current avatarUrl for this user.

Link copied to clipboard
abstract suspend fun getDisplayName(userId: String): Optional<String>
Content copied to clipboard

Return the current display name for this user.

Link copied to clipboard
abstract fun getPendingThreePids(): List<ThreePid>
Content copied to clipboard

Get the pending 3Pids, i.e. ThreePids that have requested a token, but not yet validated by the user.

Link copied to clipboard
abstract fun getPendingThreePidsLive(): LiveData<List<ThreePid>>
Content copied to clipboard

Get the pending 3Pids Live.

Link copied to clipboard
abstract suspend fun getProfile(userId: String): JsonDict
Content copied to clipboard

Get the combined profile information for this user. This may return keys which are not limited to displayname or avatar_url. If server is configured as limit_profile_requests_to_users_who_share_rooms: true then response can be HTTP 403.

Link copied to clipboard
open suspend fun getProfileAsUser(userId: String): User
Content copied to clipboard

Return a User object from a userId.

Link copied to clipboard
abstract fun getThreePids(): List<ThreePid>
Content copied to clipboard

Get the current user 3Pids.

Link copied to clipboard
abstract fun getThreePidsLive(refreshData: Boolean): LiveData<List<ThreePid>>
Content copied to clipboard

Get the current user 3Pids Live.

Link copied to clipboard
abstract suspend fun setDisplayName(userId: String, newDisplayName: String)
Content copied to clipboard

Update the display name for this user.

Link copied to clipboard
abstract suspend fun submitSmsCode(threePid: ThreePid.Msisdn, code: String)
Content copied to clipboard

Validate a code received by text message.

Link copied to clipboard
abstract suspend fun updateAvatar(    userId: String,     newAvatarUri: Uri,     fileName: String)
Content copied to clipboard

Update the avatar for this user.