Extends
Methods
# assertAdminRoleForMethod(userId)
Asserts that the userID belongs to an admin role when running the find and removeUser method within this class.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
The userId of the logged in user. |
# assertAllDefined(names)
Verifies that the list of passed instances are all members of this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
names |
Should be a list of docs and/or docIDs. |
- Overrides:
If instances is not an array, or if any instance is not in this collection.
# assertDefined(name)
Verifies that the passed object is one of this collection's instances.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | List | Should be a defined ID or doc in this collection. |
If not defined.
# assertValidRoleForMethod(userId)
Asserts that the userID belongs to a valid role when running the define method within this class.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
The userId of the logged in user. |
# checkIntegrity() → {Array}
Returns an array of strings, each one representing an integrity problem with this collection. Returns an empty array if no problems were found.
A (possibly empty) array of strings indicating integrity issues.
# count() → {Number}
Returns the number of documents in this collection.
The number of elements in this collection.
# countNonRetired() → {Number}
Returns the number of non-retired documents in this collection.
The number of non-retired elements in this collection.
# define(username, type, typeData, timestamp)
Defines a user interaction record. Returns an existing one if the username, type, and timestamp all match exactly.
Parameters:
| Name | Type | Description |
|---|---|---|
username |
The username. |
|
type |
The interaction type. |
|
typeData |
Optional. Any data associated with the interaction type. Defaults to []. |
|
timestamp |
Optional. The time of interaction. Defaults to right now. |
# dumpAll() → {Object}
Returns an object with two fields: name and contents. Name is the name of this collection. Contents is an array of objects suitable for passing to the restore() method.
An object representing the contents of this collection.
# dumpOne(docID) → {Object}
Returns an object representing the UserInteraction docID in a format acceptable to define().
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of a UserInteraction. |
An object representing the definition of docID.
# find(selector, options) → {Mongo.Cursor}
Runs find on this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
options |
Object | MongoDB options. |
- Overrides:
- See:
# findDoc(name) → {Object}
A stricter form of findOne, in that it throws an exception if the entity isn't found in the collection.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | Object | Either the docID, or an object selector, or the 'name' field value. |
If the document cannot be found.
The document associated with name.
# findNonRetired(selector, options) → {Array}
Runs find on this collection and returns the non-retired documents.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
options |
Object | MongoDB options. |
- Overrides:
- See:
non-retired documents.
# findOne(selector, options) → {Mongo.Cursor}
Runs findOne on this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
options |
Object | MongoDB options. |
- Overrides:
- See:
# getCollection() → {Mongo.Collection}
Returns the Mongo collection.
The collection.
# getCollectionName() → {string}
Returns the collection name.
- Overrides:
The collection name as a string.
# getCollectionSchema() → {SimpleSchema}
Returns the schema applied to the collection.
- Overrides:
.
# getDefineSchema() → {SimpleSchema}
Returns a schema for the define method's parameter.
the define method's parameter.
# getPublicationName() → {String}
Return the publication name.
- Overrides:
The publication name, as a string.
# getUpdateSchema() → {SimpleSchema}
Returns a schema for the update method's second parameter.
.
# isDefined(name) → {boolean}
Returns true if the passed entity is in this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | Object | The docID, or an object specifying a documennt. |
True if name exists in this collection.
# publish()
Publish a cursor to UserInteractions. Method calls are used to find interactions and we do not subscribe to UserInteractions on the client. However, we would still like this to be on the list of collections for integrity check, etc.
# removeAll()
Removes all elements of this collection. This is implemented by mapping through all elements because mini-mongo does not implement the remove operation. So this approach can be used on both client and server side. removeAll should only used for testing purposes, so it doesn't need to be efficient.
true
# removeIt(name)
A stricter form of remove that throws an error if the document or docID could not be found in this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | Object | A document or docID in this collection. |
true
# removeUser(username)
Removes all interaction documents from referenced user.
Parameters:
| Name | Type | Description |
|---|---|---|
username |
The username of user to be removed. |
If user is not an ID or username.
# restoreAll(dumpObjects)
Defines all the entities in the passed array of objects.
Parameters:
| Name | Type | Description |
|---|---|---|
dumpObjects |
The array of objects representing the definition of a document in this collection. |
# restoreOne(dumpObject) → {String}
Defines the entity represented by dumpObject. Defaults to calling the define() method if it exists.
Parameters:
| Name | Type | Description |
|---|---|---|
dumpObject |
An object representing one document in this collection. |
The docID of the newly created document.
# subscribe()
Default subscription method for entities. It subscribes to the entire collection.
# toString() → {String}
Returns a string representing all of the documents in this collection.