User

All Implemented Interfaces:

io.getstream.chat.android.client.models.CustomObject
```
public final class User
 implements CustomObject
                    
```
The only required field on the User data class is the user id.
You can also store custom data as you'd like.

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`id`
`private String`	`role`
`private Boolean`	`invisible`
`private Boolean`	`banned`
`private List<Device>`	`devices`
`private Boolean`	`online`
`private Date`	`createdAt`
`private Date`	`updatedAt`
`private Date`	`lastActive`
`private Integer`	`totalUnreadCount`
`private Integer`	`unreadChannels`
`private Integer`	`unreadCount`
`private List<Mute>`	`mutes`
`private final List<String>`	`teams`
`private final List<ChannelMute>`	`channelMutes`
`private Map<String, Object>`	`extraData`

Constructor Summary

Constructors
Constructor	Description
`User(String id, String role, Boolean invisible, Boolean banned, List<Device> devices, Boolean online, Date createdAt, Date updatedAt, Date lastActive, Integer totalUnreadCount, Integer unreadChannels, Integer unreadCount, List<Mute> mutes, List<String> teams, List<ChannelMute> channelMutes, Map<String, Object> extraData)`

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`	the user id, this field is the only required field
`final Unit`	`setId(String id)`	the user id, this field is the only required field
`final String`	`getRole()`
`final Unit`	`setRole(String role)`
`final Boolean`	`getInvisible()`
`final Unit`	`setInvisible(Boolean invisible)`
`final Boolean`	`getBanned()`
`final Unit`	`setBanned(Boolean banned)`
`final List<Device>`	`getDevices()`
`final Unit`	`setDevices(List<Device> devices)`
`final Boolean`	`getOnline()`
`final Unit`	`setOnline(Boolean online)`
`final Date`	`getCreatedAt()`
`final Unit`	`setCreatedAt(@SerializedName(value = created_at) Date createdAt)`
`final Date`	`getUpdatedAt()`
`final Unit`	`setUpdatedAt(@SerializedName(value = updated_at) Date updatedAt)`
`final Date`	`getLastActive()`
`final Unit`	`setLastActive(@SerializedName(value = last_active) Date lastActive)`
`final Integer`	`getTotalUnreadCount()`
`final Unit`	`setTotalUnreadCount(@SerializedName(value = total_unread_count) Integer totalUnreadCount)`
`final Integer`	`getUnreadChannels()`
`final Unit`	`setUnreadChannels(@SerializedName(value = unread_channels) Integer unreadChannels)`
`final Integer`	`getUnreadCount()`
`final Unit`	`setUnreadCount(@Deprecated(message = This property is deprecated, it value could be wrong and will be removed in a future version, replaceWith = @ReplaceWith(imports = {}, expression = this.totalUnreadCount)) @SerializedName(value = unread_count) Integer unreadCount)`
`final List<Mute>`	`getMutes()`
`final Unit`	`setMutes(@SerializedName(value = mutes) List<Mute> mutes)`
`final List<String>`	`getTeams()`
`final List<ChannelMute>`	`getChannelMutes()`
`Map<String, Object>`	`getExtraData()`
`Unit`	`setExtraData(Map<String, Object> extraData)`
`final String`	`component1()`
`final String`	`component2()`
`final Boolean`	`component3()`
`final Boolean`	`component4()`
`final List<Device>`	`component5()`
`final Boolean`	`component6()`
`final Date`	`component7()`
`final Date`	`component8()`
`final Date`	`component9()`
`final Integer`	`component10()`
`final Integer`	`component11()`
`final Integer`	`component12()`
`final List<Mute>`	`component13()`
`final List<String>`	`component14()`
`final List<ChannelMute>`	`component15()`
`final Map<String, Object>`	`component16()`
`final User`	`copy(String id, String role, Boolean invisible, Boolean banned, List<Device> devices, Boolean online, Date createdAt, Date updatedAt, Date lastActive, Integer totalUnreadCount, Integer unreadChannels, Integer unreadCount, List<Mute> mutes, List<String> teams, List<ChannelMute> channelMutes, Map<String, Object> extraData)`

Methods inherited from class io.getstream.chat.android.client.models.User
getExtraValue, putExtraValue
Methods inherited from class io.getstream.chat.android.client.models.CustomObject
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

User(String id, String role, Boolean invisible, Boolean banned, List<Device> devices, Boolean online, Date createdAt, Date updatedAt, Date lastActive, Integer totalUnreadCount, Integer unreadChannels, Integer unreadCount, List<Mute> mutes, List<String> teams, List<ChannelMute> channelMutes, Map<String, Object> extraData)

Method Detail

getId
```
 final String getId()
```
the user id, this field is the only required field

setId
```
 final Unit setId(String id)
```
the user id, this field is the only required field

getRole
```
 final String getRole()
```

setRole
```
 final Unit setRole(String role)
```

getInvisible
```
 final Boolean getInvisible()
```

setInvisible

 final Unit setInvisible(Boolean invisible)

getBanned
```
 final Boolean getBanned()
```

setBanned
```
 final Unit setBanned(Boolean banned)
```

getDevices
```
 final List<Device> getDevices()
```

setDevices

 final Unit setDevices(List<Device> devices)

getOnline
```
 final Boolean getOnline()
```

setOnline
```
 final Unit setOnline(Boolean online)
```

getCreatedAt
```
 final Date getCreatedAt()
```

setCreatedAt

 final Unit setCreatedAt(@SerializedName(value = created_at) Date createdAt)

getUpdatedAt
```
 final Date getUpdatedAt()
```

setUpdatedAt

 final Unit setUpdatedAt(@SerializedName(value = updated_at) Date updatedAt)

getLastActive
```
 final Date getLastActive()
```

setLastActive

 final Unit setLastActive(@SerializedName(value = last_active) Date lastActive)

getTotalUnreadCount
```
 final Integer getTotalUnreadCount()
```

setTotalUnreadCount

 final Unit setTotalUnreadCount(@SerializedName(value = total_unread_count) Integer totalUnreadCount)

getUnreadChannels
```
 final Integer getUnreadChannels()
```

setUnreadChannels

 final Unit setUnreadChannels(@SerializedName(value = unread_channels) Integer unreadChannels)

getUnreadCount
```
 final Integer getUnreadCount()
```

setUnreadCount

 final Unit setUnreadCount(@Deprecated(message = This property is deprecated, it value could be wrong and will be removed in a future version, replaceWith = @ReplaceWith(imports = {}, expression = this.totalUnreadCount)) @SerializedName(value = unread_count) Integer unreadCount)

getMutes
```
 final List<Mute> getMutes()
```

setMutes

 final Unit setMutes(@SerializedName(value = mutes) List<Mute> mutes)

getTeams
```
 final List<String> getTeams()
```

getChannelMutes

 final List<ChannelMute> getChannelMutes()

getExtraData
```
 Map<String, Object> getExtraData()
```

setExtraData

 Unit setExtraData(Map<String, Object> extraData)

component1
```
 final String component1()
```

component2
```
 final String component2()
```

component3
```
 final Boolean component3()
```

component4
```
 final Boolean component4()
```

component5
```
 final List<Device> component5()
```

component6
```
 final Boolean component6()
```

component7
```
 final Date component7()
```

component8
```
 final Date component8()
```

component9
```
 final Date component9()
```

component10
```
 final Integer component10()
```

component11
```
 final Integer component11()
```

component12
```
 final Integer component12()
```

component13
```
 final List<Mute> component13()
```

component14
```
 final List<String> component14()
```

component15
```
 final List<ChannelMute> component15()
```

component16

 final Map<String, Object> component16()

copy

 final User copy(String id, String role, Boolean invisible, Boolean banned, List<Device> devices, Boolean online, Date createdAt, Date updatedAt, Date lastActive, Integer totalUnreadCount, Integer unreadChannels, Integer unreadCount, List<Mute> mutes, List<String> teams, List<ChannelMute> channelMutes, Map<String, Object> extraData)

Class User

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.getstream.chat.android.client.models.User

Methods inherited from class io.getstream.chat.android.client.models.CustomObject

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

getId

setId

getRole

setRole

getInvisible

setInvisible

getBanned

setBanned

getDevices

setDevices

getOnline

setOnline

getCreatedAt

setCreatedAt

getUpdatedAt

setUpdatedAt

getLastActive

setLastActive

getTotalUnreadCount

setTotalUnreadCount

getUnreadChannels

setUnreadChannels

getUnreadCount

setUnreadCount

getMutes

setMutes

getTeams

getChannelMutes

getExtraData

setExtraData

component1

component2

component3

component4

component5

component6

component7

component8

component9

component10

component11

component12

component13

component14

component15

component16

copy