Package io.getstream.chat.android.models
Class Member
-
- All Implemented Interfaces:
-
io.getstream.chat.android.models.CustomObject,io.getstream.chat.android.models.UserEntity,io.getstream.chat.android.models.querysort.ComparableFieldProvider
@Immutable() public final class Member implements UserEntity, CustomObject, ComparableFieldProvider
Represents a channel member.
-
-
Field Summary
Fields Modifier and Type Field Description private final Useruserprivate final DatecreatedAtprivate final DateupdatedAtprivate final BooleanisInvitedprivate final DateinviteAcceptedAtprivate final DateinviteRejectedAtprivate final BooleanshadowBannedprivate final Booleanbannedprivate final StringchannelRoleprivate final BooleannotificationsMutedprivate final Stringstatusprivate final DatebanExpiresprivate final DatepinnedAtprivate final DatearchivedAtprivate final Map<String, Object>extraData
-
Constructor Summary
Constructors Constructor Description Member(User user, Date createdAt, Date updatedAt, Boolean isInvited, Date inviteAcceptedAt, Date inviteRejectedAt, Boolean shadowBanned, Boolean banned, String channelRole, Boolean notificationsMuted, String status, Date banExpires, Date pinnedAt, Date archivedAt, Map<String, Object> extraData)
-
Method Summary
Modifier and Type Method Description UsergetUser()The user who is a member of the channel. final DategetCreatedAt()When the user became a member. final DategetUpdatedAt()When the membership data was last updated. final BooleanisInvited()If the user is invited. final DategetInviteAcceptedAt()The date the invite was accepted. final DategetInviteRejectedAt()The date the invite was rejected. final BooleangetShadowBanned()If channel member is shadow banned. final BooleangetBanned()If channel member is banned. final StringgetChannelRole()The user's channel-level role. final BooleangetNotificationsMuted()If notifications are muted for the user in the channel. final StringgetStatus()The status of the user in the channel. final DategetBanExpires()The date the ban expires. final DategetPinnedAt()The date when this channel was pinned. final DategetArchivedAt()The date when this channel was archived. Map<String, Object>getExtraData()A map of custom fields for the member. Comparable<?>getComparableField(String fieldName)Gets a comparable fields from a name. -
Methods inherited from class io.getstream.chat.android.models.UserEntity
getUserId -
Methods inherited from class io.getstream.chat.android.models.CustomObject
getExtraValue -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
Member
Member(User user, Date createdAt, Date updatedAt, Boolean isInvited, Date inviteAcceptedAt, Date inviteRejectedAt, Boolean shadowBanned, Boolean banned, String channelRole, Boolean notificationsMuted, String status, Date banExpires, Date pinnedAt, Date archivedAt, Map<String, Object> extraData)
-
-
Method Detail
-
getCreatedAt
final Date getCreatedAt()
When the user became a member.
-
getUpdatedAt
final Date getUpdatedAt()
When the membership data was last updated.
-
getInviteAcceptedAt
final Date getInviteAcceptedAt()
The date the invite was accepted.
-
getInviteRejectedAt
final Date getInviteRejectedAt()
The date the invite was rejected.
-
getShadowBanned
final Boolean getShadowBanned()
If channel member is shadow banned.
-
getChannelRole
final String getChannelRole()
The user's channel-level role.
-
getNotificationsMuted
final Boolean getNotificationsMuted()
If notifications are muted for the user in the channel.
-
getBanExpires
final Date getBanExpires()
The date the ban expires.
-
getPinnedAt
final Date getPinnedAt()
The date when this channel was pinned.
-
getArchivedAt
final Date getArchivedAt()
The date when this channel was archived.
-
getExtraData
Map<String, Object> getExtraData()
A map of custom fields for the member.
-
getComparableField
Comparable<?> getComparableField(String fieldName)
Gets a comparable fields from a name.
- Parameters:
fieldName- The name of the field.
-
-
-
-