Documentation

Conference extends AbstractBaseApi

in package

• CanvasLMS
• Api
• Conferences

Conference API class for managing web conferences in Canvas LMS.

Tags

see

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

phpstan-consistent-constructor

Table of Contents

Properties

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

$conferenceType  : string|null

$contextId  : int|null

$contextType  : string|null

$createdAt  : DateTime|null

$description  : string|null

$duration  : int|null

$endedAt  : DateTime|null

$hasAdvancedSettings  : bool|null

$id  : int|null

$joinUrl  : string|null

$longRunning  : bool|null

$recordings  : array<string|int, ConferenceRecording>|null

$settings  : array<string, mixed>|null

$startedAt  : DateTime|null

$status  : string|null

$title  : string|null

$updatedAt  : DateTime|null

$url  : string|null

$users  : array<string|int, int>|null

$methodAliases  : array<string, array<string|int, string>>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Constructor to initialize conference from array data.

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

Get all pages of results

createForCourse()  : self

Create a new conference for a course.

createForGroup()  : self

Create a new conference for a group.

delete()  : self

Delete the conference.

fetchByCourse()  : array<string|int, Conference>

Fetch all conferences for a course.

fetchByGroup()  : array<string|int, Conference>

Fetch all conferences for a group.

find()  : static

Find a specific conference by ID.

get()  : array<string|int, Conference>

Fetch all conferences (not implemented - conferences require context).

getRecordings()  : array<string|int, ConferenceRecording>

Get conference recordings.

join()  : array<string, mixed>

Join the conference.

overrideApiClient()  : void

Set an API client for this class only, leaving other resources on the shared default.

paginate()  : PaginationResult

Get paginated results with metadata

resetApiClients()  : void

Clear the shared default client and all per-class overrides.

setApiClient()  : void

Set the shared default API client used by ALL resource classes.

stream()  : Generator<int, static>

Stream all items across all pages one at a time.

update()  : self

Update the conference.

castValue()  : DateTime|mixed

Cast a value to the correct type

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

getAliasMap()  : array<string, string>

Build a flat alias-to-method lookup from $methodAliases.

getApiClient()  : HttpClientInterface

Get the API client, initializing if necessary

getApiEndpoint()  : string

Get the API endpoint for conferences.

getClassName()  : string

Get the class name for API responses.

getEndpoint()  : string

Get the API endpoint for this resource Note: Conference endpoints are context-specific and this should not be used directly

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

hydrate()  : void

Assign API response data to properties with type coercion.

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

Parse JSON response from API safely handling StreamInterface

populate()  : void

Populate the object with new data

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

Convert the object to an array

validateContext()  : void

Validate a context type path segment against an allowlist.

processRecordings()  : void

Process recordings from API response data.

foreach (User::stream(['per_page' => 100]) as $user) {
    processUser($user);
}