Edit Page

.removeRoomMembersFromRooms()

Unsubscribe all members of a room from one or more other rooms.

sails.sockets.removeRoomMembersFromRooms(sourceRoom, destRooms, cb);

Usage

#
Argument Type Details
1 sourceRoom String The room from which to retrieve members.
2 destRooms String, Array The room or rooms from which to unsubscribe the members of sourceRoom.
3 cb Function? 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).

Example

#

In a controller action:

unsubscribeFunRoomMembersFromFunnerRooms: function(req, res) {
  sails.sockets.removeRoomMembersFromRooms('funRoom', ['greatRoom', 'awesomeRoom'], function(err) {
    if (err) {return res.serverError(err);}
    res.json({
      message: 'Unsubscribed all members of `funRoom` from `greatRoom` and `awesomeRoom`!'
    });
  });
}

Notes

#
  • In a multi-server environment, the callback function (cb) will be executed when the .removeRoomMembersFromRooms() call completes on the current server. This does not guarantee that other servers in the cluster have already finished running the operation.

Is something missing?

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.

Reference

Reference