Documentation

CalendarLink
in package

CalendarLink Object

Represents a calendar link for a course in Canvas LMS. This is a read-only object that provides the ICS format URL for course calendars.

Table of Contents

Properties

$ics  : string|null
The URL of the calendar in ICS format

Methods

__construct()  : mixed
Constructor
getIcs()  : string|null
Get the ICS URL
isAvailable()  : bool
Check if calendar link is available
setIcs()  : void
Set the ICS URL
toArray()  : array<string|int, mixed>
Convert to array

Properties

$ics

The URL of the calendar in ICS format

public string|null $ics = null

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

getIcs()

Get the ICS URL

public getIcs() : string|null
Return values
string|null

isAvailable()

Check if calendar link is available

public isAvailable() : bool
Return values
bool

setIcs()

Set the ICS URL

public setIcs(string|null $ics) : void
Parameters
$ics : string|null

toArray()

Convert to array

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results