KUMobile

API Docs for: 0.0.2

KUMobile.Student

Module: KUMobile

Contains all student related functions for loading and controlling the student driven.

addPlannerCourse

(
  • courseId
  • courseTitle
)
Void

Adds a planner course to the set of courses

Parameters:

Name Type Description
courseId String
  • id of course
courseTitle String
  • title of course

Example:

KUMobile.Student.addPlannerCourse("CS-101", "Computing & Algorithms I");

generatePermutations

() Array

Generates the permutations of schedules based on a give course list. Returns an array of schedules html.

generateScheduleTable

(
  • courses
)
JQuery Div

Generates and returns a div with a table and corresponding popups based on courses

Parameters:

Name Type Description
courses Array
  • the course data returned by KetteringJS retrieveSchedule

guessTerm

() String

Tries to guess which term it is based on today's current date (e.g 201501)

Example:

var term = KUMobile.Student.guessTerm();

nextWorkingSchedule

() Void

Populates the schedule planner results page with the next working schedule

parseTime

(
  • timeStr
)
Object

Parses time from a pattern like 8:00 AM-9:05 AM. Returns an object with "start" and "end" properties representing the minutes past midnight rounded to the nearest 15 minute interval.

Parameters:

Name Type Description
timeStr String
  • the time range to parse from

previousWorkingSchedule

() Void

Populates the schedule planner results page with the previous working schedule

showSchedulePopup

(
  • crn
  • id
  • section
  • title
  • time
  • location
  • professor
)
Void

Makes and displays a schedule popup for a course. Deletes itself after close!

Parameters:

Name Type Description
crn String
  • course crn
id String
  • course identifier
section String
  • course section
title String
  • course title
time String
  • course time
location String
  • course location
professor String
  • course professor

testCourses

(
  • courses
  • course
)
Boolean

Tests courses to see if a course list works with the provided course

Parameters:

Name Type Description
courses Array
  • the course list which is known to work, type KetteringJS.Student.JWEB.CatalogEntry[]
course Object
  • the course to be tested with, type KetteringJS.Student.JWEB.CatalogEntry

toggleTermType

(
  • input
)
String

Toggles the term type between plain text (Winter 2015) and integer (201501)

Parameters:

Name Type Description
input String
  • text to be toggled, both formats accepted

Example:

var termInt = KUMobile.Student.toggleTermType("Winter 2015");
var termWord = KUMobile.Student.toggleTermType("201501");

bbCourses

Array

Latest courses downloaded from blackboard.

Default: null

evalLocked

boolean

Evaluation load locked?

Default: false

jwebCatalog

Array

Latest jweb catalog (containing all offered courses and their times)

Default: null

jwebCourses

Array

Latest courses downloaded from JWEB.

Default: null

loading

boolean

Are the student services loading something?

Default: false

schedulePlannerIndex

int

Index for the latest working schedule drawn

Default: null

workingSchedules

Array

Latest working schedules for schedule planner

Default: null

degreeEvaluationChange

Triggered when a new evaluation is selected to be loaded from the drop down

degreeEvaluationGenerate

Triggered when a new evaluation generate button is clicked

failure

Failure for generic errors on the student page

finalGradesTermChange

Triggered when a term for final grades is selected from drop down

login

Triggered when the sign in button is pressed and we attempt to login to all student services!

logout

Triggered when the logout button is pressed and we attempt to logout of all student services!

openFile

Attempts to open a file. Triggered after an attached file link is clicked.

pageCreate

Triggered when the student page is first created based on jQuery Mobile pagecreate event. This is called after the page itself is created but before any jQuery Mobile styling is applied.

pageInit

Triggered when the student page is first initialized based on jQuery Mobile pageinit event.

pageInitAccountSummary

Triggered when account summary page is initialized based on jQuery Mobile pageinit event.

pageInitBooks

Triggered when any course books page is initialized based on jQuery Mobile pageinit event.

pageInitCourses

Triggered when courses page is initialized based on jQuery Mobile pageinit event.

pageInitCurrentHolds

Triggered when current holds page is initialized based on jQuery Mobile pageinit event.

pageInitDegreeEvaluation

Triggered when degree evaluation page is initialized based on jQuery Mobile pageinit event.

pageInitFinalGrades

Triggered when final grades page is initialized based on jQuery Mobile pageinit event.

pageInitFinancialAid

Triggered when financial aid page is initialized based on jQuery Mobile pageinit event.

pageInitFolder

Triggered when any course folder page is initialized based on jQuery Mobile pageinit event.

pageInitGrades

Triggered when any course grades page is initialized based on jQuery Mobile pageinit event.

pageInitInformation

Triggered when information page is initialized based on jQuery Mobile pageinit event.

pageInitRoster

Triggered when any course roster page is initialized based on jQuery Mobile pageinit event.

pageInitSchedule

Triggered when schedule page is initialized based on jQuery Mobile pageinit event.

pageInitSchedulePlanner

Triggered when schedule planner page is initialized based on jQuery Mobile pageinit event.

pageInitSingleCourse

Triggered when any single course page is initialized based on jQuery Mobile pageinit event.

populateAccountSummary

Populates account summary page based on returned information.

populateCoursePage

Populates course page based on initial content tree.

populateCourses

Populates courses into the student page based on gathered information from KetteringJS after downloading courses.

populateCurrentHolds

Populates current holds page with given information

populateDegreeEvaluation

Populates degree evaluation page based on returned information.

populateFinalGrades

Populates final grades page based on returned information.

populateFinancialAid

Populates financial aid page based on returned information.

populateFolderPage

Populates course folder page based on a given content tree.

populateInformation

Populates information page based on initial content tree.

populateSchedule

Populates schedule page based on returned information.

populateSchedulePlanner

Populates schedule page based on returned information.

schedulePlannerTermChange

Triggered when a term for schedule planner page is selected from drop down

scheduleTermChange

Triggered when a term for schedule page is selected from drop down