- Publicity: Public Only All
whos-online-procs.tcl
Provides support for registering which users are online.
- Location:
- packages/acs-tcl/tcl/whos-online-procs.tcl
- Created:
- 03 October 2003
- Authors:
- Bjoern Kiesbye
- Peter Marklund
- Lars Pind
- CVS Identification:
$Id: whos-online-procs.tcl,v 1.11 2024/09/11 06:15:48 gustafn Exp $
Procedures in this file
- whos_online::all_invisible_user_ids (public)
- whos_online::interval (public)
- whos_online::num_anonymous (public)
- whos_online::num_users (public)
- whos_online::seconds_since_first_request (public)
- whos_online::seconds_since_last_request (public)
- whos_online::set_invisible (public)
- whos_online::unset_invisible (public)
- whos_online::user_ids (public)
- whos_online::user_invisible_p (public)
Detailed information
whos_online::all_invisible_user_ids (public)
whos_online::all_invisible_user_ids
This function returns a list with all user_ids which are set to invisible
- Author:
- Bjoern Kiesbye
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- whos_online__check_online_visibility
whos_online::interval (public)
whos_online::interval
Returns the last number of seconds within a user must have requested a page to be considered online. Based on the LastVisitUpdateInterval parameter of the main site and defaults to 600 seconds = 10 minutes.
- Author:
- Peter Marklund
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
whos_online::num_anonymous (public)
whos_online::num_anonymous
Get the number of anonymous users currently online, and not invisible
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
whos_online::num_users (public)
whos_online::num_users
Get the number of registered users currently online, and not invisible
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- whos_online__check_online_visibility
whos_online::seconds_since_first_request (public)
whos_online::seconds_since_first_request user_id
Returns the number of seconds since the user with given id first requested a page. Returns the empty string if the user is not currently online.
- Parameters:
- user_id (required)
- Author:
- Peter Marklund
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
whos_online::seconds_since_last_request (public)
whos_online::seconds_since_last_request user_id
Returns the number of seconds since the user with given id requested a page. Returns the empty string if the user is not currently online.
- Parameters:
- user_id (required)
- Author:
- Peter Marklund
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
whos_online::set_invisible (public)
whos_online::set_invisible user_id
This procedure sets the user user_id to invisible, his user_id will not be returned by user_ids. The invisible state will only last as long as the user is online.
- Parameters:
- user_id (required)
- Author:
- Bjoern Kiesbye
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- whos_online__check_online_visibility
whos_online::unset_invisible (public)
whos_online::unset_invisible user_id
This procedure unsets the invisible state of user_id.
- Parameters:
- user_id (required)
- Author:
- Bjoern Kiesbye
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- whos_online__check_online_visibility
whos_online::user_ids (public)
whos_online::user_ids [ -all ]
This function returns a list of user_ids from users which have requested a page from this Server in the last 10 min and aren't set to invisible.
- Switches:
- -all (optional, boolean)
- Set this flag if you want to include invisible users.
- Author:
- Bjoern Kiesbye
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- whos_online__check_online_visibility
whos_online::user_invisible_p (public)
whos_online::user_invisible_p user_id
This function checks if the user user_id is set to invisible. Returns a Tcl boolean.
- Parameters:
- user_id (required)
- Author:
- Bjoern Kiesbye
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- whos_online__check_online_visibility
