API Documentation

Class

BaseProfileCollection

api/user.BaseProfileCollection()

BaseProfileCollection is an abstract superclass of all profile collections.

Constructor

# new BaseProfileCollection()

View Source api/user/BaseProfileCollection.ts, line 35

Extends

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 268

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 258

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 280

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

Meteor.Error

# checkIntegrity() → {array}

Define the default integrity checker for all applications. Returns an array with a string indicating that this method is not overridden.

Overrides:

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

An array containing a string indicating the use of the default integrity checker.

array

# checkIntegrityCommonFields(doc) → {Array}

Internal method for use by subclasses.

Parameters:
Name Type Description
doc

The profile document.

View Source api/user/BaseProfileCollection.ts, line 193

An array of problems

Array

# count() → {Number}

Returns the number of documents in this collection.

Overrides:

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

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 78

The number of non-retired elements in this collection.

Number

# define(obj)

Define documents for the collection.

Parameters:
Name Type Description
obj Object

the document.
Overrides:

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

Meteor.Error since shouldn't call this method on the base class.

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

An object representing the contents of this collection.

Object

# dumpOne(docID) → {Object}

Returns an object representing the definition of docID in a format appropriate to the restoreOne function. Must be overridden by each collection.

Parameters:
Name Type Description
docID

A docID from this collection.
Overrides:

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

An object representing this document.

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 132

Mongo.Cursor

# findByUsername(username)

Returns the profile document associated with username, or null if none was found.

Parameters:
Name Type Description
username

A username, such as 'johnson@hawaii.edu'.

View Source api/user/BaseProfileCollection.ts, line 129

The profile document, or null.

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

If the document cannot be found.

Meteor.Error

The document associated with name.

Object

# findDocBySlug(slug) → {Object}

Returns the instance associated with the passed slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).
Overrides:

View Source api/base/BaseSlugCollection.ts, line 143

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

The document representing the instance.

Object

# findIdBySlug(slug) → {String}

Return the docID of the instance associated with this slug.

Parameters:
Name Type Description
slug String

The slug (string or docID).
Overrides:

View Source api/base/BaseSlugCollection.ts, line 124

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

The docID.

String

# findIdsBySlugs(slugs) → {Array}

Returns a list of docIDs associated with the instances associated with the list of slugs.

Parameters:
Name Type Description
slugs Array

A list or collection of slugs.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 134

If the slug cannot be found, or is not associated with an instance in this collection.

Meteor.Error

A list of docIDs.

Array

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

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 154

Mongo.Cursor

# findSlugByID(docID) → {String}

Returns the slug name associated with this docID.

Parameters:
Name Type Description
docID

The docID
Overrides:

View Source api/base/BaseSlugCollection.ts, line 152

If docID is not associated with this entity.

Meteor.Error

The slug name

String

# getCollection() → {Mongo.Collection}

Returns the Mongo collection.

Overrides:

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

The collection.

Mongo.Collection

# getCollectionName() → {string}

Returns the collection name.

Overrides:

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

The collection name as a string.

string

# getCollectionNameForProfile(profile) → {String}

Returns the name of the collection associated with the given profile.

Parameters:
Name Type Description
profile

A Profile object.

View Source api/user/BaseProfileCollection.ts, line 71

The name of a profile collection.

String

# getCollectionSchema() → {SimpleSchema}

Returns the schema applied to the collection.

Overrides:

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

.

SimpleSchema

# getDefineSchema() → {SimpleSchema}

Returns a schema for the define method's parameter.

Overrides:

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

the define method's parameter.

SimpleSchema

# getFakeUserId() → {string}

The subclass methods need a way to create a profile with a valid, though fake, userId.

View Source api/user/BaseProfileCollection.ts, line 63

string

# getID(instance) → {String}

Returns the Profile's docID associated with instance, or throws an error if it cannot be found. If instance is a docID, then it is returned unchanged. If instance is a slug, its corresponding docID is returned. If instance is the value for the username field in this collection, then return that document's ID. If instance is the userID for the profile, then return the Profile's ID. If instance is an object with an _id field, then that value is checked to see if it's in the collection.

Parameters:
Name Type Description
instance String

Either a valid docID, valid userID or a valid slug string.
Overrides:

View Source api/user/BaseProfileCollection.ts, line 84

If instance is not a docID or a slug.

Meteor.Error

The docID associated with instance.

String

# getIDs(instances) → {Array.<String>}

Returns the docIDs associated with instances, or throws an error if any cannot be found. If an instance is a docID, then it is returned unchanged. If a slug, its corresponding docID is returned. If nothing is passed, then an empty array is returned.

Parameters:
Name Type Description
instances Array.<String>

An array of valid docIDs, slugs, or a combination.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 58

If any instance is not a docID or a slug.

Meteor.Error

The docIDs associated with instances.

Array.<String>

# getProfile(user)

Returns the profile associated with the specified user.

Parameters:
Name Type Description
user

The user (either their username (email) or their userID).

View Source api/user/BaseProfileCollection.ts, line 116

If user is not a valid user, or profile is not found.

Meteor.Error

The profile document.

# getPublicationName() → {String}

Return the publication name.

Overrides:

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

The publication name, as a string.

String

# getType() → {String}

Return the type of this collection.

Overrides:

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

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 222

.

SimpleSchema

# getUserID(profileID)

Returns the userID associated with the given profile.

Parameters:
Name Type Description
profileID

The ID of the profile.

View Source api/user/BaseProfileCollection.ts, line 185

The associated userID.

# hasProfile(user)

Returns non-null if the user has a profile in this collection.

Parameters:
Name Type Description
user

The user (either their username (email) or their userID).

View Source api/user/BaseProfileCollection.ts, line 138

If user is not a valid user.

Meteor.Error

The profile document if the profile exists, or null if not found.

# hasSetPicture(user) → {boolean}

Returns true if the user has set their picture.

Parameters:
Name Type Description
user

The user (either their username (email) or their userID).

View Source api/user/BaseProfileCollection.ts, line 147

boolean

# hasSlug(slug) → {boolean}

Returns true if the passed slug is associated with an entity of this type.

Parameters:
Name Type Description
slug String

Either the name of a slug or a slugID.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 115

True if the slug is in this collection.

boolean

# isDefined(instance) → {boolean}

Return true if instance is a docID or a slug for this entity.

Parameters:
Name Type Description
instance String

A docID or a slug.
Overrides:

View Source api/base/BaseSlugCollection.ts, line 106

True if instance is a docID or slug for this entity.

boolean

# publish()

Override the BaseCollection.publish. We only publish profiles if the user is logged in.

Overrides:

View Source api/user/BaseProfileCollection.ts, line 221

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

true

# removeIt(profileID)

Removes this profile, given its profile ID. Also removes this user from Meteor Accounts.

Parameters:
Name Type Description
profileID

The ID for this profile object.
Overrides:

View Source api/user/BaseProfileCollection.ts, line 205

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

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

The docID of the newly created document.

String

# sort()

Returns the instances sorted by slug string. Instances could be instanceIDs or slug names. Only tested so far with instances being slug names. Hopefully this.findDocBySlug resolves 'this' to the subcollection.

Overrides:

View Source api/base/BaseSlugCollection.ts, line 92

# subscribe()

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

Overrides:

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

# toString() → {String}

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

Overrides:

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

String

# updateCommonFields()

Internal method for use by subclasses. Destructively modifies updateData with the values of the passed fields. Call this function for side-effect only.

View Source api/user/BaseProfileCollection.ts, line 236

# updateLastVisitedEntry(user, page)

Updates an entry in lastVisited for this profile with a new (or updated) timestamp for the given page.

Parameters:
Name Type Description
user

user The user (either their username (email) or their userID).
page

The page. Should be one of PAGEIDS.

View Source api/user/BaseProfileCollection.ts, line 161