Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #180

Merged
merged 2 commits into from
Feb 21, 2024
Merged

Documentation #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a474a2c
Merge pull request #1 from Meteor-Community-Packages/master
ridersshare Jan 19, 2024
184f3e1
Updated README.md
ridersshare Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,20 @@ The `UserStatus.connections` (in-memory) collection contains information for all
- `loginTime`: if authenticated, when the user logged in with this connection.
- `idle`: `true` if idle monitoring is enabled on this connection and the client has gone idle.

#### startupQuerySelector (Optional)

On startup `meteor-user-status` automatically resets all users to `offline` and then marks each `online` as connections are reestablished.

To customize this functionality you can use the `startupQuerySelector` [Meteor package option](https://docs.meteor.com/api/packagejs.html#options) like this:
```javascript
"packages": {
"mizzao:user-status": {
"startupQuerySelector": { "$or": [{ "status.online": true }, { "status.idle": { "$exists": true } }, { "status.lastActivity": { "$exists": true } }] }
}
}
```
The above example reduces server/database load during startup if you have a large number of users.

#### Usage with collection2

If your project is using `aldeed:collection2` with a schema attached to `Meteor.users`, you need to add the following items to the schema to allow modifications of the status:
Expand Down