edu.ksu.canvas.requestOptions

Class ListCalendarEventsOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListCalendarEventsOptions

public class ListCalendarEventsOptions
extends BaseOptions

These are the options for listing calendar events. The same options are used for both the current user and a specific user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListCalendarEventsOptions.Exclude
static class	ListCalendarEventsOptions.Type

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListCalendarEventsOptions()

Method Summary

Modifier and Type	Method and Description
ListCalendarEventsOptions	contextCodes(List<String> contextCodes)
ListCalendarEventsOptions	endDate(LocalDate endDate)
ListCalendarEventsOptions	endDate(TemporalAccessor endDate)
ListCalendarEventsOptions	excludes(List<ListCalendarEventsOptions.Exclude> excludes)
ListCalendarEventsOptions	includeAllEvents(boolean all)
ListCalendarEventsOptions	includeUndated(boolean include)
ListCalendarEventsOptions	startDate(LocalDate startDate)
ListCalendarEventsOptions	startDate(TemporalAccessor startDate)
ListCalendarEventsOptions	type(ListCalendarEventsOptions.Type eventType)

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

ListCalendarEventsOptions

public ListCalendarEventsOptions()

Method Detail

type

public ListCalendarEventsOptions type(ListCalendarEventsOptions.Type eventType)

startDate

public ListCalendarEventsOptions startDate(LocalDate startDate)

startDate

public ListCalendarEventsOptions startDate(TemporalAccessor startDate)

endDate

public ListCalendarEventsOptions endDate(LocalDate endDate)

endDate

public ListCalendarEventsOptions endDate(TemporalAccessor endDate)

includeUndated

public ListCalendarEventsOptions includeUndated(boolean include)

includeAllEvents

public ListCalendarEventsOptions includeAllEvents(boolean all)

contextCodes

public ListCalendarEventsOptions contextCodes(List<String> contextCodes)

excludes

public ListCalendarEventsOptions excludes(List<ListCalendarEventsOptions.Exclude> excludes)