Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/gesso/types/params.ts>UpdateCalendarEventParams

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

Properties

optional
calendareventcontextcode: string

Context code of the course/group/user to move this event to. Scheduler appointments and events with section-specific times cannot be moved between calendars.

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
calendareventrrule: string

Valid if the calendar_series feature is enabled and the event whose ID is in the URL is part of a series. This defines the shape of the recurring event series after it's updated. Its value is the iCalendar RRULE, though unending series not supported.

optional
which: string

Allowed values: one, all, following

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.