Interface UserProfile

A user's public profile.

Returned by user.getProfile() for the current user, and carried on RemoteUser.profile for other users in the room.

import { getProfile } from "@urth/metatell-sdk/user";

const profile = getProfile();
console.log(profile?.displayName);

interface UserProfile {
    avatarId?: string;
    displayName: string;
    roles?: string[];
}

Properties

avatarId?: string

Id of the avatar the user currently wears, if known.

displayName: string

Human-readable display name shown to other users.

roles?: string[]

Role identifiers granted to the user (e.g. "admin"), if any.