.addRoomMembersToRooms()Subscribe all members of a room to one or more additional rooms.
sails.sockets.addRoomMembersToRooms(sourceRoom, destRooms, cb);
| Argument | Type | Details | |
|---|---|---|---|
| 1 | sourceRoom | The room from which to retrieve members. | |
| 2 | destRooms | The room or rooms to which to subscribe the members of sourceRoom. |
|
| 3 | cb | An optional callback, which will be called when the operation is complete on the current server (see notes below for more information) or if fatal errors were encountered. In the case of errors, it will be called with a single argument (err). |
In a controller action:
subscribeFunRoomMembersToFunnerRooms: function(req, res) {
sails.sockets.addRoomMembersToRooms('funRoom', ['greatRoom', 'awesomeRoom'], function(err) {
if (err) {return res.serverError(err);}
res.json({
message: 'Subscribed all members of `funRoom` to `greatRoom` and `awesomeRoom`!'
});
});
}
- In a multi-server environment, the callback function (
cb) will be executed when the.addRoomMembersToRooms()call completes on the current server. This does not guarantee that other servers in the cluster have already finished running the operation.
If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the sails repo. Once we merge it, the changes will be reflected on the website the next time it is deployed.