Uses of Class
edu.ksu.canvas.requestOptions.GetUsersInCourseOptions

Packages that use GetUsersInCourseOptions

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.

Uses of GetUsersInCourseOptions in edu.ksu.canvas.impl

Methods in edu.ksu.canvas.impl with parameters of type GetUsersInCourseOptions

Modifier and Type	Method and Description
List<User>	UserImpl.getUsersInCourse(GetUsersInCourseOptions options)

Uses of GetUsersInCourseOptions in edu.ksu.canvas.interfaces

Methods in edu.ksu.canvas.interfaces with parameters of type GetUsersInCourseOptions

Modifier and Type	Method and Description
List<User>	UserReader.getUsersInCourse(GetUsersInCourseOptions options) Retrieve a list of users in a course

Uses of GetUsersInCourseOptions in edu.ksu.canvas.requestOptions

Methods in edu.ksu.canvas.requestOptions that return GetUsersInCourseOptions

Modifier and Type	Method and Description
GetUsersInCourseOptions	GetUsersInCourseOptions.enrollmentRoleId(Integer roleId) Filter users by course-level role ID.
GetUsersInCourseOptions	GetUsersInCourseOptions.enrollmentState(List<GetUsersInCourseOptions.EnrollmentState> enrollmentStates) Filter users by enrollment state
GetUsersInCourseOptions	GetUsersInCourseOptions.enrollmentType(List<GetUsersInCourseOptions.EnrollmentType> enrollmentTypes) Only return users who match the given enrollment type.
GetUsersInCourseOptions	GetUsersInCourseOptions.include(List<GetUsersInCourseOptions.Include> includes) Optional sub-items to include in the user response
GetUsersInCourseOptions	GetUsersInCourseOptions.searchTerm(String searchTerm) Only return users who match search term.
GetUsersInCourseOptions	GetUsersInCourseOptions.userId(String userId) If the given user ID exists in a course, the page parameter will be modified to return the page containing the given user.
GetUsersInCourseOptions	GetUsersInCourseOptions.userIds(List<String> userIds) Only return the users in the given list of user IDs