Notify Room Stream (Realtime)

Prev Next

Notify a room about some specific events.

Events

  • Typing

  • user-activity

Example call

{
    "msg": "method",
    "method": "stream-notify-room",
    "id": "42",
    "params": [
        ... // params varies
    ]
}

Typing

You can notify a room about a user typing on the keyboard.

Payload parameters

Argument

Example

Required

Description

room-id/typing

64a1f373376181965ab77f54/typing

Required

The room ID followed by /typing.

username

testrc

Required

The username.

flag

true

Required

A boolean indicating if the user is typing (true) or it's not typing (false).

Example call

{
    "msg": "method",
    "method": "stream-notify-room",
    "id": "42",
    "params": [
        "room-id/typing",
        "username",
        true
    ]
}

user-activity

You can notify a room about user activity like typing on the keyboard.

Payload parameters

Argument

Example

Required

Description

room-id/user-activity

64a1f373376181965ab77f54/typing

Required

The room is followed by /user-activity

username

testrc

Required

The username.

events

["user-typing"]

Required

A boolean indicating if the user is typing (true) or it's not typing (false).

args

{}

Example call

{
    "msg": "method",
    "method": "stream-notify-room",
    "id": "42",
    "params": [
        "room-id/user-activity",
        "username",
        ["user-typing"],
        {}
    ]
}