.unwatch()
Unenroll the requesting client socket from this model's "class room" for this model, meaning it will no longer receive broadcasts every time publishCreate() is called on this model, and also no longer be subscribed to those new records.
Something.unwatch(req);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | req |
The incoming socket request (req). |
See
.watch()for more information.
Example
Let's say we have a mobile app or single-page web app where new public pictures of cute animals are displayd in real time when you are viewing the dashboard. Since there is no page refresh, the client-side socket remains connected; so when you view your user settings, as an optimization our app might hit a special endpoint that uses .unwatch() to temporarily stop receiving new animal pictures:
// We can only do this for socket requests.
// (to accomplish the same functionality using raw socket ids, see `sails.sockets.leave()`)
if (!req.isSocket) {
return res.badRequest('Only a socket request can use this endpoint!');
}
// Temporarily disable the cute animal picture firehose.
Photo.unwatch(req);
return res.ok();
Notes
- Be sure and check
req.isSocket === truebefore passing inreqto refer to the requesting socket. The providedreqmust be from a socket request, not just any old HTTP request.unwatch()will only work when the request is made over a socket connection (e.g. usingio.socket.get()), not over HTTP (e.g. usingjQuery.get()).
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command Line Interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.connections
- sails.config.cors
- sails.config.csrf
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req.accepted
- req.acceptedCharsets
- req.acceptedLanguages
- req.body
- req.cookies
- req.fresh
- req.headers
- req.host
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharset()
- req.acceptsLanguage()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is maintained by a web & mobile studio in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2018 The Sails Company.
The Sails framework is free and open-source under the MIT License.