Join a user to a room
The roomId to join
Leave empty to act as the bot user.
The request entry for logging context
Should the request retry if it fails
Optional ttl: numberHow long should this request remain queued in milliseconds
before it's discarded. Defaults to opts.defaultTtlMs
A promise that resolves when the membership has completed
Leave OR kick a user from a room
The roomId to leave
Leave empty to act as the bot user.
The request entry for logging context
Should the request retry if it fails
Optional reason: stringReason for leaving/kicking
Optional kickUser: stringThe user to be kicked. If left blank, this will be a leave.
Optional ttl: numberHow long should this request remain queued in milliseconds
before it's discarded. Defaults to opts.defaultTtlMs
A promise that resolves when the membership has completed
Generated using TypeDoc
This class sends membership changes for rooms in a linearized queue. The queue is lineaized based upon the hash value of the roomId, so that two operations for the same roomId may never happen concurrently.