docs/reference/websockets/resourceful-pubsub/unsubscribe.md
.unsubscribe()Unsubscribe the requesting client socket from one or more database records.
Something.unsubscribe(req, ids);
| Argument | Type | Details | |
|---|---|---|---|
| 1 | req | ((req)) | The incoming socket request (req) containing the socket to unsubscribe. |
| 2 | ids | ((array)) | An array of record ids (primary key values). |
On the server:
unsubscribeFromUsersNamedLenny: function (req, res) {
if (!req.isSocket) {
return res.badRequest();
}
User.find({name: 'Lenny'}).exec(function(err, lennies) {
if (err) { return res.serverError(err); }
var lennyIds = _.pluck(lennies, 'id');
User.unsubscribe(req, lennyIds);
return res.ok();
});
},
<docmeta name="displayName" value=".unsubscribe()"> <docmeta name="pageType" value="method">
- Be sure to check that
req.isSocket === truebefore passing inreqto refer to the requesting socket. The providedreqmust be from a socket request, not just any old HTTP request.unsubscribewill only work when the request is made over a socket connection (e.g. usingio.socket.get()), not over HTTP (e.g. usingjQuery.get()).