VIConversationParticipant
Class that represents a participant of a conversation.
In order to apply changes made by setters, you have to call one of the following methods:
- [VIMessenger createConversation:completion:]
- [VIConversation addParticipants:completion:]
- [VIConversation editParticipants:completion:]
The default permissions for all participants are: write / edit / remove their own messages.
The creator of any conversation by default:
- is the owner ([VIConversationParticipant owner] is YES)
- can edit / remove other participants' messages
- can manage other participants
Props
canEditAllMessages
canEditAllMessages: Whether the conversation participant can edit messages other than its own.
It could be changed only if the user has the [VIConversationParticipant canManageParticipants] permission.
If the user that calls this method has both canManageParticipants and isOwner permissions, it can edit other owners.
Note that a value change does not apply changes by itself; there are appropriate methods for applying:
- [VIConversation editParticipants:completion:] for an existing conversation
- [VIMessenger createConversation:completion:] for a new conversation
Returns
type:
BOOL
canEditMessages
canEditMessages: Whether the conversation participant can edit its own messages.
Once a participant is created, the default value is YES.
It could be changed only if the user has the [VIConversationParticipant canManageParticipants] permission.
If the user that calls this method has both canManageParticipants and isOwner permissions, it can edit other owners.
Note that a value change does not apply changes by itself; there are appropriate methods for applying:
- [VIConversation editParticipants:completion:] for an existing conversation
- [VIMessenger createConversation:completion:] for a new conversation
Returns
type:
BOOL
canManageParticipants
canManageParticipants: Whether the conversation participant can manage other participants in the conversation:
- add / remove / edit permissions
- add / remove participants
If YES and isOwner is YES, the participant can manage other owners.
It could be changed only if the user has the [VIConversationParticipant canManageParticipants] permission.
If the user that calls this method has both canManageParticipants and isOwner permissions, it can edit other owners.
Note that a value change does not apply changes by itself; there are appropriate methods for applying:
- [VIConversation editParticipants:completion:] for an existing conversation
- [VIMessenger createConversation:completion:] for a new conversation
Returns
type:
BOOL
canRemoveAllMessages
canRemoveAllMessages: Whether the conversation participant can remove messages other than its own.
It could be changed only if the user has the [VIConversationParticipant canManageParticipants] permission.
If the user that calls this method has both canManageParticipants and isOwner permissions, it can edit other owners.
Note that a value change does not apply changes by itself; there are appropriate methods for applying:
- [VIConversation editParticipants:completion:] for an existing conversation
- [VIMessenger createConversation:completion:] for a new conversation
Returns
type:
BOOL
canRemoveMessages
canRemoveMessages: Whether the conversation participant can remove its own messages.
Once a participant is created, the default value is YES.
It could be changed only if the user has the [VIConversationParticipant canManageParticipants] permission.
If the user that calls this method has both canManageParticipants and isOwner permissions, it can edit other owners.
Note that a value change does not apply changes by itself; there are appropriate methods for applying:
- [VIConversation editParticipants:completion:] for an existing conversation
- [VIMessenger createConversation:completion:] for a new conversation
Returns
type:
BOOL
canWrite
canWrite: Whether the conversation participant can send messages to the conversation.
Once a participant is created, the default value is YES.
It could be changed only if the user has the [VIConversationParticipant canManageParticipants] permission.
Note that a value change does not apply changes by itself; there are appropriate methods for applying:
- [VIConversation editParticipants:completion:] for an existing conversation
- [VIMessenger createConversation:completion:] for a new conversation
Returns
type:
BOOL
imUserId
imUserId: IM user's ID.
Returns
type:
NSNumber *
lastReadEventSequence
lastReadEventSequence: Sequence of the event that is last marked as read or 0 if the participant does not mark events as read.
Participants mark events as read via [VIConversation markAsRead:completion:].
Returns
type:
SInt64
owner
owner: Whether the conversation participant is the owner.
There could be more than one owner in the conversation.
If YES, the participant can edit the conversation. If YES and canManageParticipants is YES, the participant can manage other owners.
It could be changed only if the user has the [VIConversationParticipant canManageParticipants] and [VIConversationParticipant owner] permissions.
Note that a value change does not apply changes by itself; there are appropriate methods for applying:
- [VIConversation editParticipants:completion:] for an existing conversation
- [VIMessenger createConversation:completion:] for a new conversation
Returns
type:
BOOL
Methods
forIMUserId:
forIMUserId:(imUserId: NSNumber *
): instancetype
Creates a new participant with default permissions.
Use [VIConversationConfig participants] or [VIConversation addParticipants:completion:] to add participants to the conversation.
Parameters
imUserId:
NSNumber *
IM User ID. Can be retrieved from [VIUser imId]
Returns
type:
instancetype
initWithIMUserId:
initWithIMUserId:(imUserId: NSNumber *
): instancetype
Creates a new participant with default permissions.
Use [VIConversationConfig participants] or [VIConversation addParticipants:completion:] to add participants to the conversation.
Parameters
imUserId:
NSNumber *
IM User ID. Can be retrieved from [VIUser imId]
Returns
type:
instancetype