Livechat room stream documentation incorrect and errors unreported

Rocket.Chat v0.71.1

I found the docs and codebase are out of sync regarding expected arguments for subscribing to a livechat room stream via DDP.

Also, it doesn't throw an error to catch or debug the subscription attempt, seems to just silently return false.

See docs.

Code:

https://github.com/RocketChat/Rocket.Chat/blob/e6d9375fe28abf907577a1e66220d23b6d2027c1/packages/rocketchat-livechat/server/lib/Livechat.js#L877-L889

What's expected seems to be:

"ROOM_ID",
{
  "args":[{ "visitorToken":"TOKEN" }]
}

The documentation shows a token argument instead of visitorToken - I think that's what's usually required and seems to even be used for livechat notification streams, just not messages. It should be consistent, no? Also it's unclear if the documented useCollection attribute does anything.

Still, after resolving the proper attributes for the subscription, there seems to be no events emitted on the stream when messages are sent to the room. I was able to get the messages from a regular stream-room-messages though. Does this stream only emit events like agent assignment? That should also be cleared up in the docs.

Ping @renatobecker

Review the linked streamlivechatroom documentation alongside packages/rocketchat-livechat/server/lib/Livechat.js#L877-L889. Compare the documented token, visitorToken, useCollection, and event behavior with stream-room-messages and livechat notification streams. Done means the accepted arguments, errors, and emitted events are accurately explained in the documentation.