enigma-bbs/docs/_docs/modding/whos-online.md

---
layout: page
title: Who's Online
---
## The Who's Online Module
The built in `whos_online` module provides a basic who's online mod.

### Theming
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
* `userId`: User ID.
* `authenticated`: boolean if the client has a logged in user or not.
* `userName`: Login username.
* `node`: Node ID the user is connected to.
* `timeOn`: A human friendly amount of time the user has been online.
* `realName`: User's real name.
* `location`: User's location.
* `affiliation` or `affils`: Users affiliations.
* `action`: Current action/view in the system taken from the `desc` field of the current MenuModule they are interacting with. For example, "Playing L.O.R.D".
* `isSecure`: Is the client securely connected?
* `serverName`: Name of connected server such as "Telnet" or "SSH".

:information_source: These properties are available via the `client_connections.js` `getActiveConnectionList()` API.
Add Who's online docs, minor doc updates to last callers, and code cleanup 2018-07-22 16:55:39 +00:00			`---`
			`layout: page`
			`title: Who's Online`
			`---`
Update message conf list with standardized + custom formats 2018-07-22 21:59:00 +00:00			`## The Who's Online Module`
Add Who's online docs, minor doc updates to last callers, and code cleanup 2018-07-22 16:55:39 +00:00			The built in `whos_online` module provides a basic who's online mod.

			`### Theming`
			The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
			* `userId`: User ID.
WFC documentation updates 2022-05-07 23:13:10 +00:00			* `authenticated`: boolean if the client has a logged in user or not.
Standardization work on built in user list module plus docs & code cleanup * More docs, fix some info * Code cleanup 2018-07-22 18:56:56 +00:00			* `userName`: Login username.
Add Who's online docs, minor doc updates to last callers, and code cleanup 2018-07-22 16:55:39 +00:00			* `node`: Node ID the user is connected to.
			* `timeOn`: A human friendly amount of time the user has been online.
			* `realName`: User's real name.
			* `location`: User's location.
			* `affiliation` or `affils`: Users affiliations.
			* `action`: Current action/view in the system taken from the `desc` field of the current MenuModule they are interacting with. For example, "Playing L.O.R.D".
WFC documentation updates 2022-05-07 23:13:10 +00:00			* `isSecure`: Is the client securely connected?
			* `serverName`: Name of connected server such as "Telnet" or "SSH".

			:information_source: These properties are available via the `client_connections.js` `getActiveConnectionList()` API.
Add Who's online docs, minor doc updates to last callers, and code cleanup 2018-07-22 16:55:39 +00:00