nikolayh86 / meteor-presence

Meteor package to help track users' presence

Meteor Presence

A very simple presence package, to track who's online, etc.

Important

This version of presence has been re-written from the ground up to make use of the new Meteor connection API. If you're using a version of Meteor prior to 0.7.0, you should use the 0.3.0 version. Add to your smart.json:

"packages": {
  "presence": "0.3.0"
}

Installation

The Presence package can be installed with Meteorite. From inside a Meteorite-managed app:

$ mrt add presence

Usage

The user's online state can be tracked via the Presences collection, referenced by userId

NOTE: The package doesn't publish the presences by default, you'll need to do something like:

Meteor.publish('userPresence', function() {
  // Setup some filter to find the users your user
  // cares about. It's unlikely that you want to publish the 
  // presences of _all_ the users in the system.
  
  // If for example we wanted to publish only logged in users we could apply:
  // filter = { userId: { $exists: true }};
  var filter = {}; 
  
  return Presences.find(filter, {fields: {state: true, userId: true}});
});

To use that presence, you can inspect the Presences collection in the client.

Advanced Usage

State functions

If you want to track more than just users' online state, you can set a custom state function. (The default state function returns just 'online'):

// Setup the state function on the client
Presence.state = function() {
  return {
    online: true,
    currentRoomId: Session.get('currentRoomId')
  };
}

Now we can simply query the collection to find all other users that share the same currentRoomId

Presences.find({ state: { online: true, currentRoomId: Session.get('currentRoomId') } })

Of course presence will call your function reactively, so everyone will know as soon as things change.

Contributing

Please! The biggest thing right now is figuring how to write tests.

License

MIT