stream-chat-android-core/io.getstream.chat.android.models/Member

Member

@Immutable

data class Member(val user: User, val createdAt: Date? = null, val updatedAt: Date? = null, val isInvited: Boolean? = null, val inviteAcceptedAt: Date? = null, val inviteRejectedAt: Date? = null, val shadowBanned: Boolean = false, val banned: Boolean = false, val channelRole: String? = null, val notificationsMuted: Boolean? = null, val status: String? = null, val banExpires: Date? = null, val pinnedAt: Date? = null, val archivedAt: Date? = null, val extraData: Map<String, Any> = emptyMap()) : UserEntity, CustomObject, ComparableFieldProvider

Represents a channel member.

Constructors

constructor(user: User, createdAt: Date? = null, updatedAt: Date? = null, isInvited: Boolean? = null, inviteAcceptedAt: Date? = null, inviteRejectedAt: Date? = null, shadowBanned: Boolean = false, banned: Boolean = false, channelRole: String? = null, notificationsMuted: Boolean? = null, status: String? = null, banExpires: Date? = null, pinnedAt: Date? = null, archivedAt: Date? = null, extraData: Map<String, Any> = emptyMap())

Properties

val archivedAt: Date?

The date when this channel was archived.

val banExpires: Date?

The date the ban expires.

val banned: Boolean

If channel member is banned.

val channelRole: String?

The user's channel-level role.

val createdAt: Date?

When the user became a member.

open override val extraData: Map<String, Any>

A map of custom fields for the member.

inviteAcceptedAt

val inviteAcceptedAt: Date?

The date the invite was accepted.

inviteRejectedAt

val inviteRejectedAt: Date?

The date the invite was rejected.

val isInvited: Boolean?

If the user is invited.

notificationsMuted

val notificationsMuted: Boolean?

If notifications are muted for the user in the channel.

val pinnedAt: Date?

The date when this channel was pinned.

val shadowBanned: Boolean

If channel member is shadow banned.

val status: String?

The status of the user in the channel.

val updatedAt: Date?

When the membership data was last updated.

open override val user: User

The user who is a member of the channel.

Functions

getComparableField

open override fun getComparableField(fieldName: String): Comparable<*>?

Gets a comparable fields from a name.

open fun <T> getExtraValue(key: String, default: T): T

Returns the value associated with the given key, or default if the key is not present in the extraData.

open fun getUserId(): String

Returns the user ID.