Title

Global

Members

# constant getCourseNumber

Returns the number portion of the getCourseSlug.

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

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

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

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

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

# constant schema

Schema for the form that controls sending email.

View Source ui/components/admin/analytics/newsletter/AdminAnalyticsNewsletterWidget.tsx, line 22

# constant sendEmail

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

View Source api/analytic/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 78

# constant sleep

Sleeps for ms milliseconds.

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

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

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 54

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

# CompletedVerificationsWidget(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/CompletedVerificationsWidget.tsx, line 46

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 16

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

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

# 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 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/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 29

# 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 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/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 25

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

# 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 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/AdminDataModelVerificationRequestsPage.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/shared/ManageOpportunitiesPage.tsx, line 50

# EventVerificationsWidget(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/EventVerificationsWidget.tsx, line 14

Segment

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

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 16

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

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

# 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 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/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 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/AdminDataModelOpportunityInstancesPage.tsx, line 55

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

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

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

# 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 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/shared/ManageOpportunitiesPage.tsx, line 68

# 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 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/AdminDataModelCoursesPage.tsx, line 38

# 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 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/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 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/AdminDataModelOpportunityInstancesPage.tsx, line 44

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

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

# 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 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/AdminDataModelVerificationRequestsPage.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/shared/ManageOpportunitiesPage.tsx, line 63

# LandingNavBar()

LandingNavBar rendered on each of the landing pages.

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

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

# PendingVerificationsWidget(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/PendingVerificationsWidget.tsx, line 12

Segment

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

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

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