UVACanvasAccess
Loading...
Searching...
No Matches
Public Member Functions | List of all members
UVACanvasAccess.Structures.Quizzes.QuizBuilder Class Reference

Builder for quiz creation and updates. More...

Public Member Functions

QuizBuilder WithTitle ([NotNull] string title)
 The quiz title.
 
QuizBuilder WithDescription ([CanBeNull] string description)
 The quiz description (HTML).
 
QuizBuilder WithQuizType (QuizType quizType)
 The quiz type.
 
QuizBuilder WithAssignmentGroupId (ulong assignmentGroupId)
 The assignment group id.
 
QuizBuilder WithTimeLimit (int timeLimit)
 The quiz time limit, in minutes.
 
QuizBuilder WithShuffleAnswers (bool shuffleAnswers=true)
 Whether to shuffle answers.
 
QuizBuilder WithHideResults (HideResults? hideResults)
 Whether to hide student results.
 
QuizBuilder WithShowCorrectAnswers (bool showCorrectAnswers=true)
 Whether to show correct answers in results.
 
QuizBuilder WithShowCorrectAnswersLastAttempt (bool showCorrectAnswersLastAttempt=true)
 Whether to show correct answers only after the last attempt.
 
QuizBuilder WithShowCorrectAnswersAt (DateTime showCorrectAnswersAt)
 When to begin showing correct answers.
 
QuizBuilder WithHideCorrectAnswersAt (DateTime hideCorrectAnswersAt)
 When to stop showing correct answers.
 
QuizBuilder WithAllowedAttempts (int allowedAttempts)
 The number of allowed attempts. A value of -1 indicates unlimited attempts.
 
QuizBuilder WithScoringPolicy (ScoringPolicy scoringPolicy)
 The scoring policy to use if multiple attempts are allowed.
 
QuizBuilder WithOneTimeResults (bool oneTimeResults=true)
 If true, results will only be shown to students right after they submit their answers.
 
QuizBuilder WithOneQuestionAtATime (bool oneQuestionAtATime=true)
 Whether one question should be shown at a time.
 
QuizBuilder WithCantGoBack (bool cantGoBack=true)
 Whether students can go back to previous questions when WithOneQuestionAtATime is enabled.
 
QuizBuilder WithAccessCode ([CanBeNull] string accessCode)
 The access code required to take the quiz.
 
QuizBuilder WithIpFilter ([CanBeNull] string ipFilter)
 The IP address or range the quiz must be accessed from.
 
QuizBuilder WithDueAt (DateTime dueAt)
 The quiz due date.
 
QuizBuilder WithLockAt (DateTime lockAt)
 When the quiz locks.
 
QuizBuilder WithUnlockAt (DateTime unlockAt)
 When the quiz unlocks.
 
QuizBuilder WithPublished (bool published=true)
 Whether the quiz is published.
 
QuizBuilder WithOnlyVisibleToOverrides (bool onlyVisibleToOverrides=true)
 Whether the quiz is only visible to overrides.
 
QuizBuilder WithNotifyOfUpdate (bool notifyOfUpdate=true)
 Whether to notify users that the quiz has changed.
 
Task< QuizPost ()
 Performs the operation using the fields in this builder.
 

Detailed Description

Builder for quiz creation and updates.

Member Function Documentation

◆ Post()

Task< Quiz > UVACanvasAccess.Structures.Quizzes.QuizBuilder.Post ( )
inline

Performs the operation using the fields in this builder.

Returns
The created or updated quiz.

◆ WithHideResults()

QuizBuilder UVACanvasAccess.Structures.Quizzes.QuizBuilder.WithHideResults ( HideResults hideResults)
inline

Whether to hide student results.

A null value omits the parameter, which indicates that results should not be hidden.

◆ WithNotifyOfUpdate()

QuizBuilder UVACanvasAccess.Structures.Quizzes.QuizBuilder.WithNotifyOfUpdate ( bool  notifyOfUpdate = true)
inline

Whether to notify users that the quiz has changed.

Only applicable when updating an existing quiz.


The documentation for this class was generated from the following file: