Notify Logged-In Users (Realtime)

Prev Next

Stream for logged-in users.

Events

  • Users:NameChanged

  • Users:Deleted

  • updateAvatar

  • updateEmojiCustom

  • deleteEmojiCustom

  • roles-change

  • user-status

Example call

{
    "msg": "sub",
    "id": "7489",
    "name": "stream-notify-logged",
    "params":[
        "user-status",
        false
    ]
}

Example response

user-status

Event about user status changes.

{
    "msg": "changed",
    "collection": "stream-notify-logged",
    "id": "id",
    "fields": {
        "eventName": "user-status",
        "args": [["uNqJeFuag2344i62k", "rocket.cat", 1]]
    }
}

The args property will always be an array with the following values:

Argument

Example

Description

user_id

uNqJeFuag2344i62k

The user ID.

username

rocket.cat

The username.

status

1

The indicator of the user status. The integers represent the following: 0 - offline, 1-online, 2 - away, 3 - busy.