Rate this page:

ConversationParticipant

This API is in beta and subject to change.

Participant of a Conversation.

In order to apply changes made by setters, call one of the following methods:

The default permissions for all participants are: write / edit / remove their own messages.

The creator of any conversation by default:

Note that changing these properties does not send the changes to the cloud. Use Conversation.editParticipants or Messenger.createConversation to submit all changes at once.

Props

canWrite

Copy URL
var canWrite: 

Boolean

This API is in beta and subject to change.

Whether the participant can write in the conversation. The default value is true.

It could be changed only if the user that calls this method has the ConversationParticipant.canManageParticipants permission.

Returns

  • type:

    Boolean

canEditMessages

Copy URL
var canEditMessages: 

Boolean

This API is in beta and subject to change.

Whether the participant can edit its own messages in the conversation. The default value is true.

It could be changed only if the user that calls this method has the ConversationParticipant.canManageParticipants permission.

Returns

  • type:

    Boolean

canRemoveMessages

Copy URL
var canRemoveMessages: 

Boolean

This API is in beta and subject to change.

Whether the participant can remove its own messages in the conversation. The default value is true.

The permission is given by default.

It could be changed only if the user that calls this method has the ConversationParticipant.canManageParticipants permission.

Returns

  • type:

    Boolean

canEditAllMessages

Copy URL
var canEditAllMessages: 

Boolean

This API is in beta and subject to change.

Whether the participant can edit messages other than its own. The default value is false.

It could be set only if the user that calls this method has the ConversationParticipant.canManageParticipants permission.

Returns

  • type:

    Boolean

canRemoveAllMessages

Copy URL
var canRemoveAllMessages: 

Boolean

This API is in beta and subject to change.

Whether the participant can remove messages other than its own. The default value is false.

It could be set only if the user that calls this method has the ConversationParticipant.canManageParticipants permission.

Returns

  • type:

    Boolean

canManageParticipants

Copy URL
var canManageParticipants: 

Boolean

This API is in beta and subject to change.

Whether the conversation participant can manage other participants in the conversation:

  • add, remove and edit permissions
  • add and remove participants

The default value is false.

It could be set only if the user that calls this method has the ConversationParticipant.canManageParticipants permission.

Returns

  • type:

    Boolean

isOwner

Copy URL
var isOwner: 

Boolean

This API is in beta and subject to change.

Whether the participant is the owner of the conversation. The default value is false.

There could be more than one owner in the conversation.

It could be set only if the user that calls this method has the ConversationParticipant.canManageParticipants permission and ConversationParticipant.isOwner permissions.

Returns

  • type:

    Boolean

imUserId

Copy URL
val imUserId: 

Long

IM user id. Can be retrieved from User.imId

Returns

  • type:

    Long

lastReadEventSequence

Copy URL
val lastReadEventSequence: 

Long

The sequence of the last read event in a conversation. Participants mark events as read via Conversation.markAsRead.

Returns

  • type:

    Long