Interface ICollaborator

Interface for an object representing a single collaborator on a realtime model.

interface ICollaborator {
    color: string;
    displayName: string;
    sessionId: string;
    shortName: string;
    userId: string;
    [key: string]: JSONValue;
}

Hierarchy

Indexable

Properties

color displayName sessionId shortName userId

Properties

Readonlycolor

color: string

A color to be used to identify the collaborator in UI elements.

ReadonlydisplayName

displayName: string

A human-readable display name for a collaborator.

ReadonlysessionId

sessionId: string

A session id, which should be unique to a particular view on a collaborative model.

ReadonlyshortName

shortName: string

A human-readable short name for a collaborator, for use in places where the full displayName would take too much space.

ReadonlyuserId

userId: string

A user id for the collaborator. This might not be unique, if the user has more than one editing session at a time.

Settings

Member Visibility

On This Page

Properties