MemberProperties¶
Interface MemberProperties
interface MemberProperties {
name?: string;
profile?: MemberProfile;
role?: MemberRole;
state?: MemberState;
}
name?: string;
profile?: MemberProfile;
role?: MemberRole;
state?: MemberState;
}
Properties
Optionalname
name?: string
The name of the member.
Use MemberAPI.setMemberName to change the name.
Optionalprofile
Custom data associated with the member.
See
MemberAPI.setMemberProfileEntry and MemberAPI.deleteMemberProfileEntry for modifying profile entries.
Optionalrole
The role of the member in the space.
See
MemberAction.PROMOTE and MemberAction.DEMOTE for changing the role of a member.
Optionalstate
The state of the member.
Data associated with a member.
Can be requested via MemberAPI.requestMemberProperties.