com.vaadin.collaborationengine.

Class SystemUserInfo

java.lang.Object
com.vaadin.collaborationengine.UserInfo
com.vaadin.collaborationengine.SystemUserInfo

All Implemented Interfaces:

Serializable

public class SystemUserInfo extends UserInfo

A UserInfo for non-interaction thread. A system user is immutable. Its color index is always 0 and not registered to users' color index map in Collaboration Engine.

Since:

1.0

Author:

Vaadin Ltd

See Also:

  • Method Details

    • getInstance

      public static SystemUserInfo getInstance()

      Gets the unique instance of system user info.

      Returns:

      the system user info instance, not null

      Since:

      1.0

    • setName

      public void setName(String name)

      Description copied from class: UserInfo

      Sets the user's name.

      Overrides:

      setName in class UserInfo

      Parameters:

      name - the name to set

    • setAbbreviation

      public void setAbbreviation(String abbreviation)

      Description copied from class: UserInfo

      Sets the user's abbreviation.

      Overrides:

      setAbbreviation in class UserInfo

      Parameters:

      abbreviation - the abbreviation to set

    • setImage

      public void setImage(String imageUrl)

      Description copied from class: UserInfo

      Sets the url of the user's image.

      If this user info is given to a CollaborationAvatarGroup, the image URL is used to load the user's avatar. Alternatively, the user images can be loaded from a backend to the avatar group with CollaborationAvatarGroup.setImageProvider(ImageProvider).

      Overrides:

      setImage in class UserInfo

      Parameters:

      imageUrl - the image URL to set

    • setColorIndex

      public void setColorIndex(int colorIndex)

      Description copied from class: UserInfo

      Sets the user's color index.

      Setting it to -1 (which is the default value) indicates that the user color can be automatically assigned by Collaboration Engine.

      Overrides:

      setColorIndex in class UserInfo

      Parameters:

      colorIndex - the color index to set

      See Also: