| Package | Description |
|---|---|
| edu.ksu.canvas.impl |
Default implementations for Canvas API calls.
|
| edu.ksu.canvas.interfaces |
Interfaces defining Canvas API functionality
|
| edu.ksu.canvas.requestOptions |
Classes to encapsulate parameters that get passed to API calls.
|
| Modifier and Type | Method and Description |
|---|---|
List<Course> |
CourseImpl.listActiveCoursesInAccount(ListActiveCoursesInAccountOptions options) |
| Modifier and Type | Method and Description |
|---|---|
List<Course> |
CourseReader.listActiveCoursesInAccount(ListActiveCoursesInAccountOptions options)
Retrieve a list of all courses on a given account
|
| Modifier and Type | Method and Description |
|---|---|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.addEnrollmentTermId(String enrollmentTermId)
Only include courses in the specified enrollment term
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.includes(List<ListActiveCoursesInAccountOptions.Include> includes)
Optional elements to include in the returned courses.
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.inState(List<ListActiveCoursesInAccountOptions.State> stateList)
Only include courses that are in the given list of states.
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.inSubaccount(List<String> accountList)
Only include courses in sub-accounts identified by the given list of account IDs
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.onlyBlueprint(Boolean blueprint)
If true, include only blueprint courses.
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.onlyBlueprintAssociated(Boolean blueprintAssociated)
If true, include only courses that inherit content from a blueprint course.
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.onlyCompleted(Boolean completed)
If true, include only completed courses (these may be in state 'completed', or their enrollment term may have ended).
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.onlyPublished(Boolean published)
If true, include only published courses.
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.searchBy(ListActiveCoursesInAccountOptions.SearchBy searchType) |
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.searchTerm(String searchTerm)
Filter on a search term.
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.taughtByTeachers(List<String> teacherList)
Only include courses taught by the given list of teacher user IDs
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.withEnrollments(Boolean enrollments)
If true, include only courses with at least one enrollment.
|
ListActiveCoursesInAccountOptions |
ListActiveCoursesInAccountOptions.withEnrollmentTypes(List<ListActiveCoursesInAccountOptions.EnrollmentType> enrollmentTypes)
If set, only return courses that have at least one user enrolled in in
the course with one of the specified enrollment types.
|
Copyright © 2021 Kansas State University, Office of Mediated Education. All rights reserved.