SendbirdChat/com.sendbird.android.user/Participant

Participant

class Participant : User

Represents a participant of an open channel.

Since

4.3.0

See also

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
var friendDiscoveryKey: String?

Represents friend discovery key.

Link copied to clipboard
var friendName: String?

The friend name.

Link copied to clipboard
var isActive: Boolean

Whether the user is active.

Link copied to clipboard
var isMuted: Boolean

Whether the Participant is muted or not.

Link copied to clipboard
var lastSeenAt: Long

The time this User has been last seen at. Zero if this User is online.

Link copied to clipboard
val metaData: Map<String, String>

All meta data of the user.

Link copied to clipboard
var nickname: String

The nickname of the user.

Link copied to clipboard
val originalProfileUrl: String

The User original profile URL.

Link copied to clipboard
var plainProfileImageUrl: String

The plain profile image URL, which does not contain SendbirdChat.eKey as a parameter. If the file encryption feature is enabled, accessing this plainProfileImageUrl will be denied.

Link copied to clipboard
var preferredLanguages: List<String>?

The preferred languages of the user.

Link copied to clipboard
val profileUrl: String

The profile image URL. If the file encryption feature is enabled, this will have SendbirdChat.eKey combined with the plainProfileImageUrl so the file can be accessed. For caching the file, it is recommended to use plainProfileImageUrl as the key of the file cache.

Link copied to clipboard
val userId: String

The ID of the user.

Functions

Link copied to clipboard
fun createMetaData(metaDataMap: Map<String, String>, handler: MetaDataHandler?)

Creates meta data. This can be used to customize the user.

Link copied to clipboard
fun deleteAllMetaData(handler: CompletionHandler?)

Deletes all meta data.

Link copied to clipboard
fun deleteMetaData(key: String, handler: CompletionHandler?)

Deletes a meta data.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
fun getMetaData(key: String): String?

Gets meta data.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun serialize(): ByteArray

Serializes the Participant instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
fun updateMetaData(metaDataMap: Map<String, String>, handler: MetaDataHandler?)

Updates meta data.