Class

PageInterestsDailySnapshotCollection

PageInterestsDailySnapshotCollection()

Represents a snapshot of the aggregated student interest views for the different categories for a particular day

  • The different topic categories that are tracked an counted towards student interest views are Career Goal, Course, Interest, and Opportunity See PageInteressCollection to see the definition of a page interest view. This collection is populated automatically on the server-side.
Constructor

# new PageInterestsDailySnapshotCollection()

Creates the PageInterestsDailySnapshot collection.

View Source api/page-tracking/PageInterestsDailySnapshotCollection.ts, line 14

Extends

Members

# getDateOffset

Gets the correct timestamp date that the daily snapshot represents The cron job that autopopulates this collection runs at 00:00:00 (morning of next day) Since a daily snapshot represents the page interest views for the day BEFORE, we need to subtract one day from .toDate() when the define() method is called. i.e., A cron job runs at June 18,2020 00:00:00 AM Therefore, the timestamp for the daily snapshot that it creates should represent the page interest views that were defined between June 17,2020 00:00:00 AM and June 17,2020 23:59:59 PM Thus, the timestamp of the daily snapshot created on June 18,2020 00:00:00 AM should be June 17, 2020 23:59:59 PM

View Source api/page-tracking/PageInterestsDailySnapshotCollection.ts, line 51

Methods

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

Default implementation of assertValidRoleForMethod. Asserts that userId is logged in as an Admin or Advisor. This is used in the define, update, and removeIt Meteor methods associated with each class.

Parameters:
Name Type Description
userId

The userId of the logged in user. Can be null or undefined

Overrides:

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

If there is no logged in user, or the user is not an Admin or Advisor.

Meteor.Error

# 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 each object in the careerGoals, courses, interests, and opportunities arrays. For each object, check the name if it is a valid slug and validate the views to be a positive integer.

Overrides:

View Source api/page-tracking/PageInterestsDailySnapshotCollection.ts, line 106

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(careerGoals, courses, interests, opportunities, timestamp, retired) → {String}

Defines a snapshot of the aggregated student interest views for the different categories for the particular timestamp. This should never be called manually as it is handled by a cron job.

Parameters:
Name Type Description
careerGoals

Array of objects that describe the name and views for all career goals

courses

Array of objects that describe the name and views for all courses

interests

Array of objects that describe the name and views for all interests

opportunities

Array of objects that describe the name and views for all opportunities

timestamp

the timestamp that represents the page interests it aggregated by default, this is the day before .toDate(). This is because the cron job that autopopulates this collection runs on 00:00:00 time (the day after), so we need to subtract one day

retired

boolean optional defaults to false.

Overrides:

View Source api/page-tracking/PageInterestsDailySnapshotCollection.ts, line 66

the id of the document created

String

# 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 PageInterestsDailySnapshot docID in a format acceptable to define().

Parameters:
Name Type Description
docID

The docID of a PageInterestsDailySnapshot

Overrides:

View Source api/page-tracking/PageInterestsDailySnapshotCollection.ts, line 149

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()

Default publication method for entities. It publishes the entire collection.

Overrides:

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

# 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(docID)

Remove the Page Interests Daily Snapshot

Parameters:
Name Type Description
docID

The docID of the Page Interests Daily Snapshot

Overrides:

View Source api/page-tracking/PageInterestsDailySnapshotCollection.ts, line 95

# 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