edu.ksu.canvas.requestOptions

Class ListCurrentUserCoursesOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListCurrentUserCoursesOptions

public class ListCurrentUserCoursesOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListCurrentUserCoursesOptions.EnrollmentType
static class	ListCurrentUserCoursesOptions.Include
static class	ListCurrentUserCoursesOptions.State

Field Summary

Fields inherited from class edu.ksu.canvas.requestOptions.BaseOptions

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListCurrentUserCoursesOptions()

Method Summary

Modifier and Type	Method and Description
ListCurrentUserCoursesOptions	includes(List<ListCurrentUserCoursesOptions.Include> includes) Include additional optional fields in the course objects
ListCurrentUserCoursesOptions	states(List<ListCurrentUserCoursesOptions.State> states) If set, only return courses that are in the given state(s)
ListCurrentUserCoursesOptions	withEnrollmentRoleId(Integer roleId) When set, only return courses where the user is enrolled with the specified course-level role
ListCurrentUserCoursesOptions	withEnrollmentType(ListCurrentUserCoursesOptions.EnrollmentType enrollmentType) When given, only return courses where the user is enrolled as the given type(s)

Methods inherited from class edu.ksu.canvas.requestOptions.BaseOptions

addEnumList, addNumberList, addSingleItem, addStringList, getOptionsMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListCurrentUserCoursesOptions

public ListCurrentUserCoursesOptions()

Method Detail

withEnrollmentType

public ListCurrentUserCoursesOptions withEnrollmentType(ListCurrentUserCoursesOptions.EnrollmentType enrollmentType)

When given, only return courses where the user is enrolled as the given type(s)

Parameters:

enrollmentType - Enrollment type to restrict the list to

Returns:

This object to allow adding more options

withEnrollmentRoleId

public ListCurrentUserCoursesOptions withEnrollmentRoleId(Integer roleId)

When set, only return courses where the user is enrolled with the specified course-level role

Parameters:

roleId - The ID of the role to restrict the list to

Returns:

This object to allow adding more options

includes

public ListCurrentUserCoursesOptions includes(List<ListCurrentUserCoursesOptions.Include> includes)

Include additional optional fields in the course objects

Parameters:

includes - List of additional fields to include

Returns:

This object to allow adding more options

states

public ListCurrentUserCoursesOptions states(List<ListCurrentUserCoursesOptions.State> states)

If set, only return courses that are in the given state(s)

Parameters:

states - A list of states to filter on

Returns:

This object to allow adding more options