Class: Member

Member

Members are the users who have access to the project.


new Member(impl)

Parameters:
Name Type Description
impl MemberImpl

An object that implements member data storage and server requests.

Members


<readonly> data :Object

Raw member data received from the server.

Type:
  • Object

<readonly> id :string

Unique member ID.

Type:
  • string

role :string

Member role. See Project.getRoles() for more details.

Type:
  • string

<readonly> type :string

Member type. Can be owner or user.

Type:
  • string

<readonly> user :Object

User information.

Type:
  • Object
Properties:
Name Type Description
userId string

User ID.

userName string

User name.

name string

First name.

lastName string

Last name.

email string

User email.

avatarUrl string

User avatar image URL.

Methods


<async> checkout()

Refresh member data.

Returns:
Type
Promise.<Member>

<async> delete()

Remove a member from a project.

Returns:
  • Returns the raw data of a deleted member.
Type
Promise.<Object>

<async> save()

Save member data changes to the server. Call this method to update member data on the server after any changes.

Returns:
Type
Promise.<Member>

<async> update(data)

Update member data on the server.

Parameters:
Name Type Description
data Object

Raw member data.

Returns:
Type
Promise.<Member>