Namespace

api/user

api/user

Classes

AdminProfileCollection
AdvisorProfileCollection
BaseProfileCollection
FacultyProfileCollection
StudentProfileCollection
UserCollection

Members

api/user.AdminProfileCollection

# static constant exports.AdminProfiles

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

View Source api/user/AdminProfileCollection.ts, line 130

api/user.AdvisorProfileCollection

# static constant exports.AdvisorProfiles

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

View Source api/user/AdvisorProfileCollection.ts, line 133

api/user.FacultyProfileCollection

# static constant exports.FacultyProfiles

Provides the singleton instance.

View Source api/user/FacultyProfileCollection.ts, line 134

api/user.StudentProfileCollection

# static constant exports.StudentProfiles

Provides the singleton instance this collection to all other entities.

View Source api/user/StudentProfileCollection.ts, line 587

# static constant exports.updateAcademicPlanMethod

Allows students to update their academic plans.

View Source api/user/UserCollection.methods.ts, line 13

api/user.UserCollection

# static constant exports.Users

Provides the singleton instance of this class to other entities.

View Source api/user/UserCollection.ts, line 492

# static module.exports

The BaseProfileCollection used by all Profile classes.

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

# static constant rolesToCollectionNames

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

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

Methods

# static exports.makeSampleUser() → {String}

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

View Source api/user/SampleUsers.ts, line 53

The docID of the newly generated User.

String