MemberProperties

Interface MemberProperties

Data associated with a member.

Can be requested via MemberAPI.requestMemberProperties.

interface MemberProperties {
    name?: string;
    profile?: MemberProfile;
    role: MemberRole;
}

Properties

name? profile? role

Properties

Optionalname

name?: string

The name of the member.

Use MemberAPI.setMemberName to change the name.

Optionalprofile

profile?: MemberProfile

Custom data associated with the member.

See

MemberAPI.setMemberProfileEntry and MemberAPI.deleteMemberProfileEntry for modifying profile entries.

role

role: MemberRole

The role of the member in the space.

See

MemberAction.PROMOTE and MemberAction.DEMOTE for changing the role of a member.