User

Summary

The User class represents a User in a room. Every User you interact with will have the data provided by this class, except yourself. For this one exception there is an extended User class available called Self

Model

{
   "avatarID": "",
   "badge": "",
   "gRole": -1,
   "guest": false,
   "id": -1,
   "joined": "Invalid Date",
   "language": "",
   "level": -1,
   "role": -1,
   "silver": false,
   "slug": "",
   "sub": -1,
   "username": ""
}

Detail

avatarID

Avatar used, i.e. “animals01”.

Type: String
Default Value: ""

badge

User’s badge, i.e. “bt-g”.

Type: String
Default Value: ""

gRole

Global wide role on plug.

Type: Number
Default Value: -1

guest

Indicates if user is a guest.

Type: Boolean
Default Value: false

id

Type: Number
Default Value: -1

joined

Date and time when user joined plug

Type: String
Default Value: "Invalid Date"

language

Language used, represented by ISO 639-1 encoding. See: Wikipedia

Type: String
Default Value: ""

level

Level gathered on plug.

Type: Number
Default Value: 0

role

Role in a room.

Note

This is not set when requesting users that are not connected to the room you are in.

Type: Number
Default Value: -1

silver

Indicates if user has silver subscription.

Type: Boolean
Default Value: false

slug

URL conform representation of the username. Used for the profile link.

Type: String
Default Value: ""

sub

Subscription status

Type: Number
Default Value: -1

username

Name of the user.

Type: String
Default Value: ""