Online User List

This plugin displays users who are currently logged into the BPC.

Logged-in users are displayed with their profile picture, if one is available. Otherwise the initials are used.

Necessary authorizations

The role COLLABORATION_ADMIN or the right COLLABORATION_LIST_USERS is required to retrieve the logged-in users. It is therefore recommended to restrict the visibility of the plugin to this role and this right.

Configuration

The configuration parameters are described below:

Parameters Type Description

Parameters	Type	Description
`includeOwnAvatar`	bool	Displays an avatar for the own user.
`maxUsersVisible`	int	Limits the number of user avatars displayed. Additional users are summarized in an avatar icon with the number of additional users. No limitation takes place with a value of `0`.
`useColoring`	bool	If this option is set, the avatars are given a color.
`applyHoverHighlighting`	bool	If this option is set, the avatars are circled in color when the mouse cursor is positioned over them.
`hideInactiveUsers`	bool	If this option is set, inactive users are not displayed. If this option is not set, inactive users are displayed in a less colorful way. A user is inactive if there is no websocket connection but the user is still logged in. This usually happens when all tabs and windows of the BPC are closed without logging out.

includeOwnAvatar

bool

Displays an avatar for the own user.

maxUsersVisible

int

Limits the number of user avatars displayed. Additional users are summarized in an avatar icon with the number of additional users.

No limitation takes place with a value of 0.

useColoring

bool

If this option is set, the avatars are given a color.

applyHoverHighlighting

bool

If this option is set, the avatars are circled in color when the mouse cursor is positioned over them.

hideInactiveUsers

bool

If this option is set, inactive users are not displayed.

If this option is not set, inactive users are displayed in a less colorful way. A user is inactive if there is no websocket connection but the user is still logged in. This usually happens when all tabs and windows of the BPC are closed without logging out.