edu.ksu.canvas.enums.package-info Maven / Gradle / Ivy
Show all versions of canvas-api Show documentation
/**
* Shared enums
*
* The hope was to consolidate enums, especially in the API options classes into
* one place. The problem is that even when two different API calls accept (for
* example) an enrollment_type parameter, they may either accept
* different values or require different string literals for the same logical
* value.
*
* Example: the List your courses API call takes an
* enrollment_type parameter which accepts the values: teacher,
* student, ta, observer, designer. The Get users in course API
* call also has an enrollment_type parameter and accepts all the
* previously listed ones plus student_view. The List enrollments
* API call also has the same parameter but it requires the strings
* StudentEnrollment, TeacherEnrollment, TaEnrollment, DesignerEnrollment, and
* ObserverEnrollment.
*
* So all the enums ended up getting sucked into the options classes where they
* could reflect the actual values that Canvas allows and is expecting.
*/
package edu.ksu.canvas.enums;