Home / @sym20/core-conversations / IConversationStore / updateMember

IConversationStore.updateMember() method

Update a member of a conversation

Signature
updateMember(conversationId: ConversationId, userId: UserId, update: Partial<IMemberUpdate>): Promise<void>;

Remarks

This can be used for example to promote a member to an owner, or to demote an owner to a regular member.

Parameters

ParameterTypeDescription
conversationIdConversationId

The conversation where a member should be updated

userIdUserId

The member to update

updatePartial<IMemberUpdate>

Settings to update for the member. Any setting that is not included will keep the existing value.

Throws

Error

ConversationNotFound

UserNotEntitled

ConversationInactive

NotARoom

NoOwnerInConversation