|
|
CommonOccupant
Common Structure
Occupant
Several API methods return documents describing room occupants. The description of each occupant contains the following fields:
id
- The unique id of the occupant
user_id
- The user id of the occupant. This element is only present if this occupant logged in.
nickname
- The nickname of the occupant, if any. For anonymous observers, this element is omitted.
description
- The description of the occupant, if any. For anonymous observers, this element is omitted.
icon_url
- The url of the avatar icon for this occupant. This url has the structure described here. For anonymous observers, this element is omitted.
source
- How this occupant is interacting with the chatroom. A value of browser means that the occupant is using the Lingr website at www.lingr.com, A value of api means that the occupant is using some Lingr API application.
client_type
- The type of this occupant’s client application- either human or automaton. A client of type human is operated by a human being. A client of type automaton speaks in chatrooms without human intervention. For more information, see the client_type page.