User

class

The representation of a single user that is involved in document editing.

Properties

avatar : undefined | string

The URL pointing to the image with the avatar of the user.

If avatar is not set, default avatar is used.
color : CollaborationUserColor

CSS colors classes object for the user.
id : string

The ID of the user.
initials : string
readonly

module:collaboration-core/users~User#initials
The initials of the user.

By default, the initials are composed of the user name's first and last words ignoring non-characters parts:
- for Joe Doe, the initials are JD,
- for Joe Doe (admin), the initials are JD,
- for Anonymous the initials are A,
- for Katie John-Newman the initials are KJ,
- for Adam Daniel Smith the initials are AS.
The initials can be configured by UserConfig#getInitialsCallback.
isAnonymous : boolean
readonly

Is true for the anonymous user, false otherwise.

The anonymous user is used when there is no defined user for given resource.

The situations when the anonymous user is used will depend on your application. For example, it can be used when the editor can be used by "guest" users of your application, or when the original user's account was removed.
isMe : boolean
readonly

Is true for the local user.
name : string

The name of the user.