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

User

@Immutable

data class User(val id: String = "", val role: String = "", val name: String = "", val image: String = "", val invisible: Boolean? = null, val language: String = "", val banned: Boolean? = null, val devices: List<Device> = listOf(), val online: Boolean = false, val createdAt: Date? = null, val updatedAt: Date? = null, val lastActive: Date? = null, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0, val mutes: List<Mute> = listOf(), val teams: List<String> = listOf(), val channelMutes: List<ChannelMute> = emptyList(), val extraData: Map<String, Any> = mapOf(), val deactivatedAt: Date? = null) : CustomObject, ComparableFieldProvider

Represents a person who uses a chat and can perform chat operations like viewing channels or sending messages.

Parameters

The unique id of the user. This field if required.

role

Determines the set of user permissions.

name

User's name.

image

User's image.

invisible

Determines if the user should share its online status. Can only be changed while connecting the user.

banned

Whether a user is banned or not.

devices

The list of devices for the current user.

online

Whether a is user online or not.

createdAt

Date/time of creation.

updatedAt

Date/time of the last update.

lastActive

Date of last activity.

totalUnreadCount

The total unread messages count for the current user.

unreadChannels

The total unread channels count for the current user.

mutes

A list of users muted by the current user.

teams

List of teams user is a part of.

channelMutes

A list of channels muted by the current user.

extraData

A map of custom fields for the user.

deactivatedAt

Date/time of deactivation.

Constructors

User

constructor(id: String = "", role: String = "", name: String = "", image: String = "", invisible: Boolean? = null, language: String = "", banned: Boolean? = null, devices: List<Device> = listOf(), online: Boolean = false, createdAt: Date? = null, updatedAt: Date? = null, lastActive: Date? = null, totalUnreadCount: Int = 0, unreadChannels: Int = 0, mutes: List<Mute> = listOf(), teams: List<String> = listOf(), channelMutes: List<ChannelMute> = emptyList(), extraData: Map<String, Any> = mapOf(), deactivatedAt: Date? = null)