Using Communication Components > FCPeopleList object

FCPeopleList object

The FCPeopleList API provides the client-side and server-side functionality for connecting your objects to the server and cleaning up. It also allows you to set the lurker mode programmatically.

 
Variables

Name	Variable	Description
Lurkers	lurkers	Integer; this variable updates whenever a new user connects or disconnects. It has a value that is equal to the number of users who are connected to the application but have not supplied a user name. This variable should only be read and not set.
Users	users	Integer; this variable is similar to lurkers. It has a value that is equal to the number of users who are connected to the application and have supplied a user name. This variable should only be read and not set.

 
Method summary for the FCPeopleList object

Method	Description
FCPeopleList.connect	Sets up all the assets needed by the component (on the client side and the server side), and calls the setUsername function with the name that the server provides.
FCPeopleList.setUsername	Sets the user name that appears in the list of active users.
FCPeopleList.close	Cleans up after itself.