Class

PageInterestCollection

api/analytic.PageInterestCollection()

Represents a student's interest view for a specific topic category page The different topic categories that a page could be are Career Goal, Course, Interest, and Opportunity Definition of a student's interest view when they visit a page

  1. When they Favorite that page and don't unfavorite it before leaving the page
  2. They play the Teaser video at that page or open it as an external link
  3. They click an external link in the DESCRIPTION of that page
    • Profile Pictures and the interests tags do not count
  4. They spend a minimum of 5 seconds viewing that page
    • They have to be "focused" on that page in the browser sense
Constructor

# new PageInterestCollection()

Creates the PageInterestCollection

View Source api/page-tracking/PageInterestCollection.ts, line 24

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.

View Source api/page-tracking/PageInterestCollection.ts, line 77

# 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:

View Source api/base/BaseCollection.ts, line 248

If instances is not an array, or if any instance is not in this collection.

Meteor.Error

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 238

If not defined.

Meteor.Error

# 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.

Overrides:

View Source api/page-tracking/PageInterestCollection.ts, line 84

# 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. Checks username, category, and name

Overrides:

View Source api/page-tracking/PageInterestCollection.ts, line 93

A (possibly empty) array of strings indicating integrity issues.

Array

# count() → {Number}

Returns the number of documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 41

The number of elements in this collection.

Number

# countNonRetired() → {Number}

Returns the number of non-retired documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 48

The number of non-retired elements in this collection.

Number

# define(termID, category, name, timestamp, retired)

Defines a snapshot of a page's student interest views

Parameters:
Name Type Description
termID

The ID of the academic term that this snapshot represents

category

The topic category that this snapshot represents

name

The name that the page represents

timestamp

Timestamp of when this snapshot was recorded

retired

boolean optional defaults to false.

Overrides:

View Source api/page-tracking/PageInterestCollection.ts, line 48

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 277

An object representing the contents of this collection.

Object

# dumpOne(docID) → {Object}

Returns an object representing the PageInterest docID in a format acceptable to define().

Parameters:
Name Type Description
docID

The docID of a PageInterest

Overrides:

View Source api/page-tracking/PageInterestCollection.ts, line 114

An object representing the definition of docID.

Object

# 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:

View Source api/base/BaseCollection.ts, line 101

Mongo.Cursor

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 76

If the document cannot be found.

Meteor.Error

The document associated with name.

Object

# 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:

View Source api/base/BaseCollection.ts, line 112

non-retired documents.

Array

# 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:

View Source api/base/BaseCollection.ts, line 123

Mongo.Cursor

# getCollection() → {Mongo.Collection}

Returns the Mongo collection.

Overrides:

View Source api/base/BaseCollection.ts, line 223

The collection.

Mongo.Collection

# getCollectionName() → {string}

Returns the collection name.

Overrides:

View Source api/base/BaseCollection.ts, line 216

The collection name as a string.

string

# getCollectionSchema() → {SimpleSchema}

Returns the schema applied to the collection.

Overrides:

View Source api/base/BaseCollection.ts, line 188

.

SimpleSchema

# getDefineSchema() → {SimpleSchema}

Returns a schema for the define method's parameter.

Overrides:

View Source api/base/BaseCollection.ts, line 195

the define method's parameter.

SimpleSchema

# getPublicationName() → {String}

Return the publication name.

Overrides:

View Source api/base/BaseCollection.ts, line 209

The publication name, as a string.

String

# getType() → {String}

Return the type of this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 181

The type, as a string.

String

# getUpdateSchema() → {SimpleSchema}

Returns a schema for the update method's second parameter.

Overrides:

View Source api/base/BaseCollection.ts, line 202

.

SimpleSchema

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 144

True if name exists in this collection.

boolean

# publish()

Publish an empty cursor to PageInterests. Since method calls are used to find interactions, we do not need to publish any records, but would still like this to be on the list of collections for integrity check, etc.

Overrides:

View Source api/page-tracking/PageInterestCollection.ts, line 128

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 170

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.

Overrides:

View Source api/base/BaseCollection.ts, line 157

true

# removeUser(username)

Removes all page interest documents from referenced user.

Parameters:
Name Type Description
username

The username of user to be removed.

View Source api/page-tracking/PageInterestCollection.ts, line 70

If user is not an ID or username.

Meteor.Error

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 315

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 305

The docID of the newly created document.

String

# subscribe()

Default subscription method for entities. It subscribes to the entire collection.

Overrides:

View Source api/base/BaseCollection.ts, line 64

# toString() → {String}

Returns a string representing all of the documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 230

String