Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Latest commit

 

History

History
57 lines (43 loc) · 1.8 KB

stream-notify-logged.md

File metadata and controls

57 lines (43 loc) · 1.8 KB

stream-notify-logged

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 id of the
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.