api/user

api/user

Classes

AdvisorProfileCollection
BaseProfileCollection
FacultyProfileCollection
MentorProfileCollection
StudentProfileCollection
UserCollection

Members

(static, constant) exports.AdvisorProfiles :api/user.AdvisorProfileCollection

Source:

Provides the singleton instance of this class to all other entities.

Type:

(static, constant) exports.FacultyProfiles :api/user.FacultyProfileCollection

Source:

Provides the singleton instance.

Type:

(static, constant) exports.MentorProfiles :api/user.MentorProfileCollection

Source:

Provides the singleton instance.

Type:

(static, constant) exports.StudentProfiles :api/user.StudentProfileCollection

Source:

Provides the singleton instance this collection to all other entities.

Type:

(static, constant) exports.updateAcademicPlanMethod

Source:

Allows students to update their academic plans.

(static, constant) exports.Users :api/user.UserCollection

Source:

Provides the singleton instance of this class to other entities.

Type:

(static) module.exports

Source:

The BaseProfileCollection used by all Profile classes.

(static, constant) rolesToCollectionNames

Source:

Set up the object to be used to map role names to their corresponding collections.

Methods

(static) exports.makeSampleUser() → {String}

Source:

Creates a User based upon the specified role.
If role is not supplied, it defaults to ROLE.STUDENT.

Returns:

The docID of the newly generated User.

Type
String