Skip to main content
Module

x/gesso/types/params.ts>CreateCalendarEventParams

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

Properties

optional
calendareventcontextcode: string

Context code of the course/group/user whose calendar this event should be added to.

optional
calendareventtitle: string

Short title for the calendar event.

optional
calendareventdescription: string

Longer HTML description of the event.

optional
calendareventstartat: Date

Start date/time of the event.

optional
calendareventendat: Date

End date/time of the event.

optional
calendareventlocationname: string

Location name of the event.

optional
calendareventlocationaddress: string

Location address

optional
calendareventtimezoneedited: string

Time zone of the user editing the event. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

optional
calendareventallday: boolean

When true event is considered to span the whole day and times are ignored.

optional
calendareventchildeventdataXstartat: Date

Section-level start time(s) if this is a course event. X can be any identifier, provided that it is consistent across the start_at, end_at and context_code

optional
calendareventchildeventdataXendat: Date

Section-level end time(s) if this is a course event.

optional
calendareventchildeventdataXcontextcode: string

Context code(s) corresponding to the section-level start and end time(s).

optional
calendareventduplicatecount: number

Number of times to copy/duplicate the event. Count cannot exceed 200.

optional
calendareventduplicateinterval: number

Defaults to 1 if duplicate count is set. The interval between the duplicated events.

optional
calendareventduplicatefrequency: string

Allowed values: daily, weekly, monthly

optional
calendareventduplicateappenditerator: boolean

Defaults to false. If set to true, an increasing counter number will be appended to the event title when the event is duplicated. (e.g. Event 1, Event 2, Event 3, etc)

optional
calendareventrrule: string

If the calendar_series flag is enabled, this parameter replaces the calendar_event's duplicate parameter to create a series of recurring events. Its value is the iCalendar RRULE defining how the event repeats, though unending series not supported.

optional
calendareventblackoutdate: boolean

If the blackout_date is true, this event represents a holiday or some other special day that does not count in course pacing.