gk::users

Keep track of information on conference users

Synopsis

gk::users get key
gk::users keys ?key?

Description

The gk::users command is used to retrieve information about the current users of a conference, or those currently connected to a GroupKit session manager.

Each user has subtree underneath the root of the environment, named after their unique user number. Typical information stored under that node would be "color", "username", and optionally information such as "title", "company", "email", and "www" as displayed by the business card widget.

Several "aliases" are available. If rather than a unique user number the toplevel node is specified as "local", it will be mapped to the local user's unique user number. In particular, you can retrieve this number via the key "local.usernum". Specifying "gk::users keys remote" is a shorthand for returning the list of all unique user numbers, except for that of the local process.

Supported environments commands include "get" and "keys". Despite looking like an environment, the gk::users command actually retrieves its information from the registry, a separate environment.


GroupKit Reference Manual. Last updated April 6, 1998 by Mark Roseman.