ConversationParticipant
Represents a participant in a conversation.
By default, all participants have the following permissions:
- Write messages
- Edit their own messages
- Remove their own messages
The creator of a conversation is, by default:
- The owner (ConversationParticipant.isOwner is true)
- Can edit or remove messages of other participants
- Can manage other participants
Constructors
constructor
Creates a new participant with default permissions.
Parameters
imId:
number
IM user's ID. Can be retrieved from User.imId.
Returns
Props
canEditAllMessages
canEditAllMessages: boolean
Whether the participant can edit messages posted by other users in the conversation.
It can be modified only by a user with the ConversationParticipant.canManageParticipants or ConversationParticipant.isOwner permissions.
canEditMessages
canEditMessages: boolean
Whether the participant can edit their own messages in the conversation.
This permission is granted by default.
It can be modified only by a user with the ConversationParticipant.canManageParticipants or ConversationParticipant.isOwner permissions.
canManageParticipants
canManageParticipants: boolean
Whether the user can manage other participants: edit their permissions, or add/remove them from the conversation.
It can be modified only by a user with the ConversationParticipant.canManageParticipants or ConversationParticipant.isOwner permissions.
canRemoveAllMessages
canRemoveAllMessages: boolean
Whether the participant can delete messages posted by other users of the conversation.
It can be modified only by a user with the ConversationParticipant.canManageParticipants or ConversationParticipant.isOwner permissions.
canRemoveMessages
canRemoveMessages: boolean
Whether the participant can remove their own messages from the conversation.
This permission is granted by default.
It can be modified only by a user with the ConversationParticipant.canManageParticipants or ConversationParticipant.isOwner permissions.
canWrite
canWrite: boolean
Whether the participant can send messages to the conversation.
This permission is granted by default.
It can be modified only by a user with the ConversationParticipant.canManageParticipants or ConversationParticipant.isOwner permissions.
imUserId
imUserId: number
The IM user's ID.
isOwner
isOwner: boolean
Whether the participant is an owner of the conversation.
A conversation may have multiple owners. Owners can edit conversation settings and have all other permissions.
lastReadEventSequence
lastReadEventSequence: number
The sequence number of the event that has been last marked as read via Conversation.markAsRead.
Defaults to 0 if no events have been marked as read.