Title

Global

Members

# COMPONENTIDS

Define IDs to identify components in the system. This is used for testing.

View Source ui/utilities/ComponentIDs.ts, line 3

# constant docToShortDescription

Return the first sentence of the description field of the passed document, or the passed description if we get a sentence.

View Source ui/components/shared/utilities/data-model.ts, line 59

# constant ensureFutureAcademicTerms

Ensures that there are AcademicTerms for the next 4 years.

View Source api/academic-term/AcademicTermUtilities.ts, line 33

# EXPLORER_FILTER_KEYS

Define Sort keys used to sort the cards in the explorer pages. It is used in Interests, Career Goals, Opportunities and Courses component

View Source ui/utilities/ExplorerUtils.ts, line 31

# EXPLORER_SORT_KEYS

Define Sort keys used to sort the cards in the explorer pages. It is used in Interests, Career Goals, Opportunities and Courses component

View Source ui/utilities/ExplorerUtils.ts, line 3

# EXPLORER_TYPE

Define each ExplorerType in the system, this is different from the EXPLORER_TYPE defined in route-constants.ts. This is used for Interests, CareerGoals, Opportunities and Courses pages and components

View Source ui/utilities/ExplorerUtils.ts, line 13

# EXPLORER_TYPE_ICON

Define icon names for each explorer type

View Source ui/utilities/ExplorerUtils.ts, line 22

# constant getCourseNumber

Returns the number portion of the getCourseSlug.

View Source api/course/CourseUtilities.ts, line 130

# constant getMostPopular

Calculates and returns the number of users associated with Interests, Career Goals, Courses, and Opportunities.

View Source api/utilities/MostPopular.methods.ts, line 33

# constant getPlanCount

Returns the count of the given planChoice.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 22

# constant getPublicProfileData

Meteor method used to retrieve public data for a student profile card. Returns an object with fields containing the visible profile data.

View Source api/user/StudentProfileCollection.methods.ts, line 78

# constant getRandomCourseSlug

Returns a random course slug for a random department.

View Source api/course/SampleCourses.ts, line 38

# constant getRandomCourseSlugForDept

Returns a random course slug for the given department.

View Source api/course/SampleCourses.ts, line 27

# constant getRandomDepartment

Returns a random department string.

View Source api/course/SampleCourses.ts, line 13

# constant getSimpleChoiceNumber

Returns the number portion of the getCourseSlug.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 170

# constant getTermsAndConditions

Meteor method used to retrieve the terms and conditions string from a file and return it to the client.

View Source api/utilities/TermsAndConditions.methods.ts, line 7

# constant getWhatsNew

Meteor method used to retrieve the terms and conditions string from a file and return it to the client.

View Source api/whats-new/WhatsNew.methods.ts, line 8

# constant makeSampleCareerGoal

Defines a sample CareerGoal.

View Source api/career/SampleCareerGoals.ts, line 11

# constant makeSampleCareerGoalArray

Returns an array of defined CareerGoal ids.

View Source api/career/SampleCareerGoals.ts, line 23

# constant makeSampleCareerGoalSlugArray

Returns an array of defined CareerGoal slugs.

View Source api/career/SampleCareerGoals.ts, line 35

# constant makeSampleCourseSlugArray

Creates an array of defined course slugs.

View Source api/course/SampleCourses.ts, line 69

# constant makeSampleInterestArray

Returns an array of interestIDs.

View Source api/interest/SampleInterests.ts, line 38

# constant makeSampleInterestSlugArray

Returns an array of defined Interest slugs.

View Source api/interest/SampleInterests.ts, line 50

# constant makeSampleOpportunitySlugArray

Creates an array of defined opportunity slugs.

View Source api/opportunity/SampleOpportunities.ts, line 44

# constant makeSampleUserArray

Returns an array of defined usernames.

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

# PAGEIDS

Define IDs to identify each page in the system. This is used for lastVisited, UserInteractions, and Testing.

View Source ui/utilities/PageIDs.ts, line 3

# constant processBulkStarCsvData

Processes STAR CSV data.

Deprecated:
  • Yes

View Source api/star/StarProcessor.ts, line 181

RadGradForecastsClass

# constant RadGradForecasts

Singleton instance of the RadGradForecasts.

View Source startup/both/RadGradForecasts.ts, line 90

# constant routes

Here are the routes for RadGrad2. The keys are the Roles, the values are an array of route information. Route information consists of a path, the path to the component, a Component to render.

View Source ui/layouts/utilities/routes-config.ts, line 65

# constant sendEmail

Email sender to distribute RadGrad newsletter. Utilizes SSR to compile and render HTML/CSS code within the email.

View Source api/email/Email.ts, line 14

# constant setPublicProfileData

Meteor method to set a Profile field (usually a "share" field). After setting the share value, generates and returns an object with fields containing the visible profile data.

View Source api/user/StudentProfileCollection.methods.ts, line 93

# constant sleep

Sleeps for ms milliseconds.

View Source api/test/test-utilities.ts, line 15

# constant USER_INTERACTION_DESCRIPTIONS

Provide short documentation string for each User Interaction behavior.

View Source api/user-interaction/UserInteractionCollection.ts, line 20

# constant validateCourseSlugFormat

Checks the format of the getCourseSlug. Does not check to see if the slug is defined. Valid course slugs have the format _.

View Source api/course/CourseUtilities.ts, line 112

# VISIBILITY

The boolean fields in a student's profile used to indicate what's visible.

View Source api/user-interaction/UserInteractionManager.ts, line 14

# WHATS_NEW_FIELDS

What's New is implemented via the following mechanisms:

  • This server-side class, which stores the current state of What's New along with updateData() and getData() methods.
  • The WhatsNew method, which is called by the client to obtain what's new data via the getData() method.
  • The WhatsNew server-side cron job, which updates what's new once a day via updateData().

View Source api/whats-new/WhatsNew.ts, line 18

Methods

# AdminProtectedRoute({)

AdminProtectedRoute (see React Router v4 sample) Checks for Meteor login and admin role before routing to the requested page, otherwise goes to signin page.

Parameters:
Name Type Description
{ any

component: Component, ...rest }

View Source ui/layouts/App.tsx, line 68

# CareerGoalLabel(slug, userID, size)

Returns a React Component representing a Career Goal label.

Parameters:
Name Type Description
slug

Required slug. Error if not found.

userID

Optional userID. If provided, then Label will colored if present in the user's profile.

size

Optional size. Defaults to 'Large'.

View Source ui/components/shared/label/CareerGoalLabel.tsx, line 15

# CompletedVerifications(completedVerifications, username) → {Segment}

Component that naively displays a supplied array of IVerificationRequests and the UI for users to handle them. The parent component is expected to handle permissions and filtering (role and status are not checked in this component).

Parameters:
Name Type Description
completedVerifications Array.<VerificationRequest>
username string

Current user's username. Used primarily for getting name of user when making changes to records.

View Source ui/components/shared/verification/CompletedVerifications.tsx, line 47

Segment

# CourseLabel(slug, userID, size)

Returns a React Component representing a Course label.

Parameters:
Name Type Description
slug

Required slug. Error if not found.

userID

Optional userID. If provided, then Label will colored if present in the user's profile.

size

Optional size. Defaults to 'Large'.

View Source ui/components/shared/label/CourseLabel.tsx, line 15

# defineAcademicTermsForYear(year)

Defines the academic terms for the given year.

Parameters:
Name Type Description
year number

the year.

View Source api/academic-term/AcademicTermUtilities.ts, line 10

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCourseInstancesPage.tsx, line 24

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCoursesPage.tsx, line 24

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestTypesPage.tsx, line 31

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestsPage.tsx, line 21

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunitiesPage.tsx, line 28

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityInstancesPage.tsx, line 27

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityTypesPage.tsx, line 32

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelReviewsPage.tsx, line 26

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelSlugsPage.tsx, line 15

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelTeasersPage.tsx, line 26

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelVerificationRequestsPage.tsx, line 23

# EventVerifications(eventOpportunities) → {Segment}

This component naively displays a supplied array of IEventOpportunities and a form to verify individual students. The parent component is expected to handle permissions and filtering (eventDate property is not checked in this component).

Parameters:
Name Type Description
eventOpportunities Array.<IEventOpportunity>

An array of IOpportunities where eventDate exists

View Source ui/components/shared/verification/EventVerifications.tsx, line 15

Segment

# filterByShareField()

Returns a function that is passed a userID and returns true if shareField in their profile is true.

View Source api/user/profile-entries/ProfileAssociatedUsers.methods.ts, line 17

# generatePublicProfileDataObject(username) → {PublicProfileData}

Helper function to create and return an object with fields for all the publicly shared profile data for username.

Parameters:
Name Type Description
username

The user who's public data is to be shared.

View Source api/user/StudentProfileCollection.methods.ts, line 31

PublicProfileData

# InterestLabel(slug, userID, size)

Returns a React Component representing a Interest label.

Parameters:
Name Type Description
slug

Required slug. Error if not found.

userID

Optional userID. If provided, then Label will colored if present in the user's profile.

size

Optional size. Defaults to 'Large'.

View Source ui/components/shared/label/InterestLabel.tsx, line 15

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCourseInstancesPage.tsx, line 50

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCoursesPage.tsx, line 42

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestTypesPage.tsx, line 47

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestsPage.tsx, line 35

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunitiesPage.tsx, line 61

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityInstancesPage.tsx, line 59

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityTypesPage.tsx, line 48

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelReviewsPage.tsx, line 70

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelSlugsPage.tsx, line 29

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelTeasersPage.tsx, line 51

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelVerificationRequestsPage.tsx, line 49

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCourseInstancesPage.tsx, line 40

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCoursesPage.tsx, line 37

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestTypesPage.tsx, line 42

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestsPage.tsx, line 30

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunitiesPage.tsx, line 56

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityInstancesPage.tsx, line 45

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityTypesPage.tsx, line 43

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelReviewsPage.tsx, line 51

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelSlugsPage.tsx, line 24

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelTeasersPage.tsx, line 39

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelVerificationRequestsPage.tsx, line 38

# LandingNavBar()

LandingNavBar rendered on each of the landing pages.

View Source ui/components/landing/LandingNavBar.tsx, line 12

# normalInitialization()

Set up system for operation in a non-testing environment.

View Source startup/server/startup.ts, line 39

# NotAuthorizedPage()

Render a not authorized page if the user enters a URL that they are not allowed to see.

View Source ui/pages/NotAuthorizedPage.tsx, line 7

# NotFoundPage()

Render a Not Found page if the user enters a URL that doesn't match any route.

View Source ui/pages/NotFoundPage.tsx, line 7

# OpportunityLabel(slug, userID, size)

Returns a React Component representing an Opportunity label.

Parameters:
Name Type Description
slug

Required slug. Error if not found.

userID

Optional userID. If provided, then Label will colored if present in the user's profile.

size

Optional size. Defaults to 'Large'.

View Source ui/components/shared/label/OpportunityLabel.tsx, line 15

# PendingVerifications(pendingVerifications) → {Segment}

Component that naively displays a supplied array of IVerificationRequests and the UI for users to handle them. The parent component is expected to handle permissions and filtering (role and status are not checked in this component).

Parameters:
Name Type Description
pendingVerifications Array.<VerificationRequest>

View Source ui/components/shared/verification/PendingVerifications.tsx, line 13

Segment

# PictureField()

Augment the Uniforms TextField with an to support Cloudinary upload for pictures. Adapted from https://github.com/vazco/uniforms/blob/master/packages/uniforms-semantic/src/TextField.tsx

The MIT License (MIT)

Copyright (c) 2016-2019 Vazco

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View Source ui/components/form-fields/PictureField.tsx, line 33

# ProtectedRoute({)

ProtectedRoute (see React Router v4 sample) Checks for Meteor login before routing to the requested page, otherwise goes to signin page.

Parameters:
Name Type Description
{ any

component: Component, ...rest }

View Source ui/layouts/App.tsx, line 59

# ScrollToTop()

Scroll to top when navigating to non-Explorer pages.

View Source ui/layouts/App.tsx, line 28

# setupMailURL()

Define MAIL_URL appropriately.

View Source startup/server/startup.ts, line 18

# SigninPage()

SigninPage page overrides the form’s submit event and call Meteor’s loginWithPassword(). Authentication errors modify the component’s state to be displayed

View Source ui/pages/SigninPage.tsx, line 14

# SignoutDidntAgreeToTermsPage()

After the user clicks the "SignoutPage" link in the NavBar, log them out and display this page.

View Source ui/pages/SignoutDidntAgreeToTermsPage.tsx, line 7

# SignoutPage()

After the user clicks the "SignoutPage" link in the NavBar, log them out and display this page.

View Source ui/pages/SignoutPage.tsx, line 7

# TermsAndConditionsPage()

See https://www.radgrad.org/docs/developers/patterns/components-methods for documentation.

View Source ui/pages/shared/TermsAndConditionsPage.tsx, line 22

# testModeInitialization()

Set up entities and users appropriately for testing environment.

View Source startup/server/startup.ts, line 30