Online User List

This plugin displays users who are currently logged into BPC.

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

Required Permissions

To retrieve logged-in users, the role COLLABORATION_ADMIN or the permission COLLABORATION_LIST_USERS is required. It is therefore recommended to restrict the plugin’s visibility to this role and this permission.

Configuration

The configuration parameters are described below:

Parameter Type Description

Parameter	Type	Description
`includeOwnAvatar`	bool	Displays an avatar for the current user.
`maxUsersVisible`	int	Limits the number of user avatars displayed. Additional users are grouped into a single avatar icon displaying the number of additional users. If the value is set to `0`, no limit is applied.
`useColoring`	bool	If this option is set, the avatars are colored.
`applyHoverHighlighting`	bool	If this option is set, avatars are highlighted in color when the mouse cursor hovers over them.
`hideInactiveUsers`	bool	If this option is set, inactive users are not displayed. If this option is not set, inactive users are displayed without color. A user is considered inactive if there is no WebSocket connection but the user is still logged in. This usually happens when all BPC tabs and windows are closed without logging out.

includeOwnAvatar

bool

Displays an avatar for the current user.

maxUsersVisible

int

Limits the number of user avatars displayed. Additional users are grouped into a single avatar icon displaying the number of additional users.

If the value is set to 0, no limit is applied.

useColoring

bool

If this option is set, the avatars are colored.

applyHoverHighlighting

bool

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

hideInactiveUsers

bool

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

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