collab_member

Collaboration Members

Get current Member

You can get the current member with the collaboration.getCurrentUser API.

Example

collaboration.getCurrentUser(): Promise<Member> 

This function resolves to member of Member.

Get Online Members

You can get collaboration online members with the collaboration.getOnlineMembers API. This function can get all the online members information under the current collaboration.

Example

collaboration.getOnlineMembers(): Promise<Member[]> 

This function resolves to an array of Member.

Get Members

You can get collaboration members with the collaboration.getMembers API. This function can get all the collaboration members information under the current collaboration.

Example

collaboration.getMembers(): Promise<Member[]> 

This function resolves to an array of Member.

Add Members

You can invite members to a collaboration with the collaboration.addMembers API.

If the collaboration session is shared by others and is not public, you will not have the permission to invite members.

Example

  collaboration.addMembers(members): Promise<boolean>;

• members is an array of emails or user IDs to invite.

Remove Members

You can remove collaboration members with the collaboration.removeMembers API. This function can remove specific members from the current collaboration.

Example

collaboration.removeMembers(members: Array<{ id: 'MemberId' }>): Promise<boolean>

tip

This action can only be executed by the creator of the collaboration, and other members do not have permissions.