Documentation

UpdateAppointmentGroupDTO extends AbstractBaseDto

in package

• CanvasLMS
• Dto
• AppointmentGroups

UpdateAppointmentGroupDTO

Table of Contents

Properties

$allowObserverSignup  : bool|null

Whether observer users can sign-up for an appointment

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

Array of context codes (courses, e.g. course_1) this group should be linked to Users in the course(s) with appropriate permissions will be able to sign up

$description  : string|null

Longer text description of the appointment group

$locationAddress  : string|null

Location address

$locationName  : string|null

Location name of the appointment group

$maxAppointmentsPerParticipant  : int|null

Maximum number of time slots a user may register for

$minAppointmentsPerParticipant  : int|null

Minimum number of time slots a user must register for If not set, users do not need to sign up for any time slots

$newAppointments  : array<int, array{start_at?: string, end_at?: string}>|null

Nested array of start time/end time pairs indicating time slots Format: [['start_at' => '2012-07-19T21:00:00Z', 'end_at' => '2012-07-19T22:00:00Z'], ...]

$participantsPerAppointment  : int|null

Maximum number of participants that may register for each time slot Defaults to null (no limit)

$participantVisibility  : string|null

'private' - participants cannot see who has signed up for a particular time slot 'protected' - participants can see who has signed up

$publish  : bool|null

Whether this appointment group should be published (made available for signup) Once published, an appointment group cannot be unpublished

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

Array of sub context codes (course sections or a single group category) Used to limit the appointment group to particular sections

$title  : string|null

Short title for the appointment group

$apiPropertyName  : string

The name of the property in the API

Methods

__construct()  : mixed

BaseDto constructor.

toApiArray()  : array<int, array{name: string, contents: string}>

Convert DTO to API-compatible array format

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

Convert the DTO to an array