Documentation

CalendarEvent extends AbstractBaseApi

in package

• CanvasLMS
• Api
• CalendarEvents

CalendarEvent Class

// Creating a calendar event directly
$dto = new CreateCalendarEventDTO();
$dto->contextCode = 'course_123';
$dto->title = 'Midterm Exam';
$dto->startAt = new DateTime('2025-03-15 10:00:00');
$dto->endAt = new DateTime('2025-03-15 12:00:00');
$event = CalendarEvent::create($dto);

// Finding a calendar event
$event = CalendarEvent::find(456);

// Listing all calendar events with filters
$events = CalendarEvent::get([
    'start_date' => '2025-03-01',
    'end_date' => '2025-03-31',
    'context_codes' => ['course_123', 'user_456']
]);

// Updating an event
$updateDto = new UpdateCalendarEventDTO();
$updateDto->title = 'Midterm Exam - Room Changed';
$updateDto->locationName = 'Room 301';
$event = CalendarEvent::update(456, $updateDto);

// Working with recurring events
$dto->rrule = 'FREQ=WEEKLY;COUNT=10';
$recurringEvent = CalendarEvent::create($dto);

// Updating a series
$recurringEvent->updateSeries($updateDto, 'following');

// Making a reservation
$reservation = new CreateReservationDTO();
$reservation->participantId = 789;
$reservation->comments = 'Looking forward to the meeting';
$event->reserve($reservation);

Tags

see

https://canvas.instructure.com/doc/api/calendar_events.html

Table of Contents

Properties

$allContextCodes  : string|null

A comma-separated list of all calendar contexts this event is part of

$allDay  : bool|null

Boolean indicating whether this is an all-day event (midnight to midnight)

$allDayDate  : string|null

The date of this event (YYYY-MM-DD format)

$appointmentGroupId  : int|null

The id of the appointment group

$appointmentGroupUrl  : string|null

The API URL of the appointment group

$availableSlots  : int|null

If the event is a time slot with a limit, how many slots are available

$blackoutDate  : bool|null

Boolean indicating whether this has blackout date

$childEvents  : array<int, array<string, mixed>>|null

If this is a time slot, this will be a list of any reservations If this is a course-level event, this will be a list of section-level events

$childEventsCount  : int|null

The number of child_events

$contextCode  : string|null

The context code of the calendar this event belongs to Format: {type}_{id} (e.g., course_123, user_456, group_789, account_1)

$contextName  : string|null

The context name of the calendar this event belongs to

$createdAt  : DateTime|null

When the calendar event was created

$description  : string|null

The HTML description of the event

$effectiveContextCode  : string|null

If specified, indicates which calendar this event should be displayed on (e.g., a section-level event would have the course's context code here)

$endAt  : DateTime|null

The end timestamp of the event

$group  : array<string, mixed>|null

If the event is a group-level reservation, contains the group participant

$hidden  : bool|null

Whether this event should be displayed on the calendar Only true for course-level events with section-level child events

$htmlUrl  : string|null

URL for a user to view this event

$id  : int|null

The ID of the calendar event

$importantDates  : bool|null

Boolean indicating whether this has important dates

$locationAddress  : string|null

The address where the event is taking place

$locationName  : string|null

The location name of the event

$ownReservation  : bool|null

If the event is a reservation, whether it is the current user's reservation

$parentEventId  : int|null

If this is a reservation, the id will indicate the time slot it is for If this is a section-level event, this will be the course-level parent event

$participantsPerAppointment  : int|null

If the event is a time slot, this is the participant limit

$participantType  : string|null

The type of participant to sign up for a slot: 'User' or 'Group'

$reserved  : bool|null

If the event is a time slot, whether the user has already made a reservation

$reserveUrl  : string|null

If the event is a time slot, the API URL for reserving it

$rrule  : string|null

An iCalendar RRULE for defining how events in a recurring event series repeat

$seriesHead  : bool|null

Boolean indicating if this is the first event in the series of recurring events

$seriesNaturalLanguage  : string|null

A natural language expression of how events occur in the series

$seriesUuid  : string|null

Identifies the recurring event series this event may belong to

$startAt  : DateTime|null

The start timestamp of the event

$title  : string|null

The title of the calendar event

$updatedAt  : DateTime|null

When the calendar event was last updated

$url  : string|null

URL for this calendar event (to update, delete, etc.)

$user  : array<string, mixed>|null

If the event is a user-level reservation, contains the user participant

$workflowState  : string|null

Current state of the event ('active', 'locked' or 'deleted') 'locked' indicates that start_at/end_at cannot be changed

$apiClient  : HttpClientInterface

$contextId  : int|null

Context ID extracted from context code

$contextType  : string|null

Context type extracted from context code

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Constructor

__set()  : void

Magic setter to handle property casting

all()  : array<int, self>

Get all calendar events from all pages

create()  : self

Create a new calendar event

delete()  : self

Delete a calendar event

deleteSeries()  : self

Delete a series of recurring events

fetchByContext()  : array<int, self>

Fetch calendar events by context

find()  : self

Find a calendar event by ID

get()  : array<int, self>

List calendar events

getContextId()  : int|null

Get the context ID

getContextType()  : string|null

Get the context type

getNextAvailableAppointment()  : self|null

Get next available appointment

paginate()  : PaginationResult

Get paginated calendar events

parseContextCode()  : array{type: string, id: int}

Parse a context code into type and ID

reserve()  : self

Reserve a time slot

reserveSlot()  : self

Reserve a time slot (static method)

save()  : self

Save the calendar event (create or update)

saveEnabledAccountCalendars()  : array<string, mixed>

Save enabled account calendars

setApiClient()  : void

Set the API client

update()  : self

Update a calendar event

updateSeries()  : self

Update a series of recurring events

castValue()  : mixed

Cast value to appropriate type based on property

checkApiClient()  : void

Check if the API client is set, if not, instantiate a new one

convertPaginatedResponseToModels()  : array<string|int, static>

Helper method to convert paginated response data to model instances

createConfiguredHttpClient()  : HttpClient

Create an HttpClient with configured middleware

createPaginationResult()  : PaginationResult

Helper method to create PaginationResult from paginated response

getEndpoint()  : string

Get the API endpoint for this resource

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

populate()  : void

Populate the object with new data

toDtoArray()  : array<string|int, mixed>

Convert the object to an array