Edit Page
.getRoomName()
Retrieve the name of the PubSub “room” for a given record.
Something.getRoomName(id);
Usage
| Argument | Type | Details | |
|---|---|---|---|
| 1 | id | or |
The ID (primary key value) of the record to get the PubSub room name for. |
Example
// On the server:
subscribeAllBobWatchersToKaren: function (req, res) {
// Look up all users named "bob" or "karen".
User.find({name: ['bob', 'karen']}, function(err, users) {
if (err) {return res.serverError(err);}
// Get Bob's ID. We'll assume there is only one Bob.
var bobId = _.find(users, { name: 'bob' }).id;
// Get Karen's ID. We'll assume there is only one Karen.
var karenId = _.find(users, { name: 'karen' }).id;
// Subscribe all of Bob's sockets to Karen.
sails.sockets.addRoomMembersToRooms(User.getRoomName(bobId), User.getRoomName(karenId));
return res.send();
});
}
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.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- 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.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Reference
Built with Love
The Sails framework is built by a web & mobile shop 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-2025 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.