sails/docs/reference/websockets/resourceful-pubsub/unsubscribe.md

API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)

# `.unsubscribe()`

Unsubscribe the requesting client socket from one or more database records.

```js
Something.unsubscribe(req, ids);
```

### Usage

|   | 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).



### Example

On the server:

```javascript
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();

  });
},
```


### Notes
> + Be sure to check that `req.isSocket === true` before passing in `req` to refer to the requesting socket.  The provided `req` must be from a socket request, not just any old HTTP request.
> + `unsubscribe` will only work when the request is made over a socket connection (e.g. using `io.socket.get()`), *not* over HTTP (e.g. using `jQuery.get()`).


<docmeta name="displayName" value=".unsubscribe()">
<docmeta name="pageType" value="method">