Returns the value of the specified client attribute.
The attribute's name.
The attribute's scope. For global client attributes, specify scope null. For attributes scoped to a room, specify the room's id.
The attribute value.
Returns an object whose variables represent the names and values of the shared attributes for this snapshot's client. The object is a map of fully qualified attribute name/value pairs. For details and examples, see the Client.getAttributes method, which returns an object of the same format.
Returns the clientID for this client snapshot object.
A string clientID.
Returns a list of the rooms observed by the client represented by this snapshot. Each item in the list a fully qualified string roomID.
Returns a list of the rooms containing the client represented by this snapshot. Each item in the list a fully qualified string roomID.
Returns the status of the most recent snapshot load-operation. If a load operation is currently in progress, getStatus() returns null. The possible return values of getStatus() depend on the snapshot type.
If the client represented by this snapshot object is logged in under a user account, getUserID() returns that account; otherwise, getUserID() returns null.
A string userID.
Indicates whether the snapshot is currently loading data. While an update is in progress, further requests to update the snapshot are ignored.
The ClientSnapshot class is used to load a "snapshot" of a client on the server. The snapshot includes all of the client's attributes, a list of the rooms the client is in, and a list of rooms the client is observing. If the client is currently logged in under a user account, the snapshot also includes the userID for that account.