Skip to main content
Module

x/gesso/types/params.ts>ListCalendarEventsParams

A TypeScript API client for Canvas LMS
Latest
interface ListCalendarEventsParams
import { type ListCalendarEventsParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
type: string

Allowed values: event, assignment

optional
startdate: Date

Only return events since the start_date (inclusive). Defaults to today. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

optional
enddate: Date

Only return events before the end_date (inclusive). Defaults to start_date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. If end_date is the same as start_date, then only events on that day are returned.

optional
undated: boolean

Defaults to false (dated events only). If true, only return undated events and ignore start_date and end_date.

optional
allevents: boolean

Defaults to false (uses start_date, end_date, and undated criteria). If true, all events are returned, ignoring start_date, end_date, and undated criteria.

optional
context_codes: string[]

List of context codes of courses/groups/users whose events you want to see. If not specified, defaults to the current user (i.e personal calendar, no course/group events). Limited to 10 context codes, additional ones are ignored. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42

optional
excludes: unknown[][]

Array of attributes to exclude. Possible values are “description”, “child_events” and “assignment”

optional
includes: unknown[][]

Array of optional attributes to include. Possible values are “web_conferenes” and “series_natural_language”

optional
importantdates: boolean

Defaults to false. If true, only events with important dates set to true will be returned.

optional
blackoutdate: boolean

Defaults to false. If true, only events with blackout date set to true will be returned.