Skip to content
This repository has been archived by the owner on Jul 3, 2021. It is now read-only.

[actions] getUsers

Sunciits edited this page Jun 19, 2016 · 2 revisions

getUsers()

Get a list of all users in the room.


Returns

List of user object of all users in the room.


Example

bot.getUsers();
/*
[
    {
        avatarID: 'hiphop-s01',
        badge: 'winter-s02',
        blurb: undefined,
        gRole: 0,
        grab: false,
        id: 5587691,
        ignores: undefined,
        joined: 'xxxx-xx-xx xx:xx:xx.xxxxx',
        language: null,
        level: 10,
        notifications: undefined,
        pp: undefined,
        pw: undefined,
        role: 0,
        slug: null,
        status: 1,
        sub: 0,
        username: 'xxxxxxxxx',
        vote: 1,
        xp: undefined 
  }, {
        avatarID: 'rave01',
        badge: 'raveset-g',
        blurb: undefined,
        gRole: 0,
        grab: false,
        id: 3675243,
        ignores: undefined,
        joined: 'xxxx-xx-xx xx:xx:xx.xxxxx',
        language: null,
        level: 16,
        notifications: undefined,
        pp: undefined,
        pw: undefined,
        role: 1,
        slug: null,
        status: 1,
        sub: 0,
        username: 'xxxxxxxxxx',
        vote: 1,
        xp: undefined 
   }
]
*/
Clone this wiki locally