| Package | Description |
|---|---|
| edu.ksu.canvas.impl |
Default implementations for Canvas API calls.
|
| edu.ksu.canvas.interfaces |
Interfaces defining Canvas API functionality
|
| edu.ksu.canvas.model |
POJOs to parse Canvas API data into
|
| Modifier and Type | Method and Description |
|---|---|
Optional<Enrollment> |
EnrollmentImpl.dropUser(String courseId,
String enrollmentId) |
Optional<Enrollment> |
EnrollmentImpl.dropUser(String courseId,
String enrollmentId,
UnEnrollOptions unEnrollOption) |
Optional<Enrollment> |
EnrollmentImpl.enrollUser(Enrollment enrollment)
Deprecated.
|
Optional<Enrollment> |
EnrollmentImpl.enrollUserInCourse(Enrollment enrollment) |
Optional<Enrollment> |
EnrollmentImpl.enrollUserInSection(Enrollment enrollment) |
List<Enrollment> |
EnrollmentImpl.getCourseEnrollments(GetEnrollmentOptions options) |
List<Enrollment> |
EnrollmentImpl.getSectionEnrollments(GetEnrollmentOptions options) |
List<Enrollment> |
EnrollmentImpl.getUserEnrollments(GetEnrollmentOptions options) |
protected Class<Enrollment> |
EnrollmentImpl.objectType() |
| Modifier and Type | Method and Description |
|---|---|
Optional<Enrollment> |
EnrollmentImpl.enrollUser(Enrollment enrollment)
Deprecated.
|
Optional<Enrollment> |
EnrollmentImpl.enrollUserInCourse(Enrollment enrollment) |
Optional<Enrollment> |
EnrollmentImpl.enrollUserInSection(Enrollment enrollment) |
| Modifier and Type | Method and Description |
|---|---|
Optional<Enrollment> |
EnrollmentWriter.dropUser(String courseId,
String enrollmentId)
Drop a user enrolled in a course using the Unenrollment option of DELETE.
|
Optional<Enrollment> |
EnrollmentWriter.dropUser(String courseId,
String enrollmentId,
UnEnrollOptions unEnrollOption)
Drop a user enrolled in a course passing the UnEnrollOptions string in the task param.
|
Optional<Enrollment> |
EnrollmentWriter.enrollUser(Enrollment enrollment)
Deprecated.
Use the
enrollUserInCourse or enrollUserInSection methods instead. |
Optional<Enrollment> |
EnrollmentWriter.enrollUserInCourse(Enrollment enrollment)
Enrolls a user in a course
|
Optional<Enrollment> |
EnrollmentWriter.enrollUserInSection(Enrollment enrollment)
Enrolls a user in a section.
|
List<Enrollment> |
EnrollmentReader.getCourseEnrollments(GetEnrollmentOptions options)
Retrieve enrollments in a given course.
|
List<Enrollment> |
EnrollmentReader.getSectionEnrollments(GetEnrollmentOptions options)
Retrieve enrollments in a given section.
|
List<Enrollment> |
EnrollmentReader.getUserEnrollments(GetEnrollmentOptions options)
Retrieve a user's enrollments.
|
| Modifier and Type | Method and Description |
|---|---|
Optional<Enrollment> |
EnrollmentWriter.enrollUser(Enrollment enrollment)
Deprecated.
Use the
enrollUserInCourse or enrollUserInSection methods instead. |
Optional<Enrollment> |
EnrollmentWriter.enrollUserInCourse(Enrollment enrollment)
Enrolls a user in a course
|
Optional<Enrollment> |
EnrollmentWriter.enrollUserInSection(Enrollment enrollment)
Enrolls a user in a section.
|
| Modifier and Type | Method and Description |
|---|---|
List<Enrollment> |
Course.getEnrollments() |
List<Enrollment> |
User.getEnrollments() |
| Modifier and Type | Method and Description |
|---|---|
void |
Course.setEnrollments(List<Enrollment> enrollments) |
void |
User.setEnrollments(List<Enrollment> enrollments) |
Copyright © 2021 Kansas State University, Office of Mediated Education. All rights reserved.