Documentation

CreateQuizDTO extends AbstractBaseDto

in package

• CanvasLMS
• Dto
• Quizzes

implements DTOInterface

Data Transfer Object for creating quizzes in Canvas LMS

Table of Contents

Interfaces

DTOInterface

Properties

$accessCode  : string|null

Access code/password for the quiz

$allowedAttempts  : int|null

Number of allowed attempts (-1 for unlimited)

$assignmentGroupId  : int|null

Assignment group ID for graded quizzes

$description  : string|null

Quiz description (HTML content)

$dueAt  : string|null

Quiz due date (ISO 8601 format)

$hideResults  : string|null

When to hide quiz results (null, always, until_after_last_attempt)

$ipFilter  : string|null

IP address filter/restriction

$lockAt  : string|null

Quiz lock date (ISO 8601 format)

$lockdownBrowserMonitorData  : string|null

Lockdown browser monitor data

$oneQuestionAtATime  : bool|null

Whether to display one question at a time

$pointsPossible  : float|null

Maximum points possible for this quiz

$published  : bool|null

Whether the quiz is published

$quizType  : string|null

Quiz type (assignment, practice_quiz, survey, graded_survey)

$requireLockdownBrowser  : bool|null

Whether the quiz requires lockdown browser

$requireLockdownBrowserForResults  : bool|null

Whether the quiz requires lockdown browser for results

$requireLockdownBrowserMonitor  : bool|null

Whether the quiz requires lockdown browser monitor

$showCorrectAnswers  : bool|null

Whether to show correct answers after submission

$shuffleAnswers  : bool|null

Whether to shuffle answers

$timeLimit  : int|null

Time limit in minutes

$title  : string|null

Quiz title (required)

$unlockAt  : string|null

Quiz unlock date (ISO 8601 format)

$apiPropertyName  : string

The API property name for multipart requests

Methods

__construct()  : mixed

BaseDto constructor.

getAccessCode()  : string|null

Get access code

getAllowedAttempts()  : int|null

Get allowed attempts

getAssignmentGroupId()  : int|null

Get assignment group ID

getDescription()  : string|null

Get quiz description

getDueAt()  : string|null

Get due date

getHideResults()  : string|null

Get hide results setting

getIpFilter()  : string|null

Get IP filter

getLockAt()  : string|null

Get lock date

getLockdownBrowserMonitorData()  : string|null

Get lockdown browser monitor data

getOneQuestionAtATime()  : bool|null

Get one question at a time status

getPointsPossible()  : float|null

Get points possible

getPublished()  : bool|null

Get published status

getQuizType()  : string|null

Get quiz type

getRequireLockdownBrowser()  : bool|null

Get require lockdown browser status

getRequireLockdownBrowserForResults()  : bool|null

Get require lockdown browser for results status

getRequireLockdownBrowserMonitor()  : bool|null

Get require lockdown browser monitor status

getShowCorrectAnswers()  : bool|null

Get show correct answers status

getShuffleAnswers()  : bool|null

Get shuffle answers status

getTimeLimit()  : int|null

Get time limit

getTitle()  : string|null

Get quiz title

getUnlockAt()  : string|null

Get unlock date

setAccessCode()  : void

Set access code

setAllowedAttempts()  : void

Set allowed attempts

setAssignmentGroupId()  : void

Set assignment group ID

setDescription()  : void

Set quiz description

setDueAt()  : void

Set due date

setHideResults()  : void

Set hide results setting

setIpFilter()  : void

Set IP filter

setLockAt()  : void

Set lock date

setLockdownBrowserMonitorData()  : void

Set lockdown browser monitor data

setOneQuestionAtATime()  : void

Set one question at a time status

setPointsPossible()  : void

Set points possible

setPublished()  : void

Set published status

setQuizType()  : void

Set quiz type

setRequireLockdownBrowser()  : void

Set require lockdown browser status

setRequireLockdownBrowserForResults()  : void

Set require lockdown browser for results status

setRequireLockdownBrowserMonitor()  : void

Set require lockdown browser monitor status

setShowCorrectAnswers()  : void

Set show correct answers status

setShuffleAnswers()  : void

Set shuffle answers status

setTimeLimit()  : void

Set time limit

setTitle()  : void

Set quiz title

setUnlockAt()  : void

Set unlock date

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

Convert the DTO to an array for API requests

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

Convert the DTO to an array