Documentation

CreateAnnouncementDTO extends CreateDiscussionTopicDTO

in package

• CanvasLMS
• Dto
• Announcements

Data Transfer Object for creating announcements in Canvas LMS

Table of Contents

Properties

$allowRating  : bool|null

Whether the discussion allows rating

$assignment  : array<string, mixed>|null

Assignment configuration for graded discussions

$assignmentId  : int|null

Assignment ID for graded discussions

$attachment  : array<string, mixed>|null

Attachment settings

$delayedPostAt  : string|null

Discussion delayed post date (ISO 8601 format)

$discussionType  : string|null

Discussion type (threaded, side_comment, flat)

$expanded  : bool|null

Whether threaded replies should be expanded by default

$expandedLocked  : bool|null

Whether users can choose their preferred thread expansion setting

$gradingType  : string|null

Grading type for graded discussions

$groupCategoryId  : int|null

Group category ID for group discussions

$isAnnouncement  : bool|null

Whether this is an announcement

$lockAt  : string|null

Discussion lock date (ISO 8601 format)

$lockComment  : bool|null

If is_announcement and lock_comment are true, disable participant comments

$locked  : bool|null

Whether the discussion is locked

$message  : string|null

Discussion topic message/description (HTML content)

$onlyGradersCanRate  : bool|null

Whether rating is only for graders

$pinned  : bool|null

Whether the discussion is pinned

$podcastEnabled  : bool|null

Whether to enable podcast feed

$podcastHasStudentPosts  : bool|null

Whether to include student posts in podcast

$podcastSettings  : array<string, mixed>|null

Podcast settings

$pointsPossible  : float|null

Points possible for graded discussions

$positionAfter  : string|null

Position after specified topic (for ordering)

$postedAt  : string|null

Discussion posting date (ISO 8601 format)

$published  : bool|null

Whether the discussion topic is published

$readOnly  : bool|null

Whether the discussion is read only

$requireInitialPost  : bool|null

Whether users must post before seeing replies

$sortOrder  : string|null

Default sort order of the discussion (asc or desc)

$sortOrderLocked  : bool|null

Whether users can choose their preferred sort order

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

Specific sections the topic is assigned to

$title  : string|null

Discussion topic title (required)

$apiPropertyName  : string

The API property name for multipart requests

Methods

__construct()  : mixed

Create a new announcement DTO with announcement-specific defaults

getAllowRating()  : bool|null

Get allow rating status

getAssignment()  : array<string, mixed>|null

Get assignment configuration

getAssignmentId()  : int|null

Get assignment ID

getAttachment()  : array<string, mixed>|null

Get attachment settings

getDelayedPostAt()  : string|null

Get delayed post at date

getDiscussionType()  : string|null

Get discussion type

getExpanded()  : bool|null

Get expanded status

getExpandedLocked()  : bool|null

Get expanded locked status

getGradingType()  : string|null

Get grading type

getGroupCategoryId()  : int|null

Get group category ID

getIsAnnouncement()  : bool|null

Get is announcement status

getLockAt()  : string|null

Get lock at date

getLockComment()  : bool|null

Get lock comment status

getLocked()  : bool|null

Get locked status

getMessage()  : string|null

Get discussion topic message

getOnlyGradersCanRate()  : bool|null

Get only graders can rate status

getPinned()  : bool|null

Get pinned status

getPodcastEnabled()  : bool|null

Get podcast enabled status

getPodcastHasStudentPosts()  : bool|null

Get podcast has student posts status

getPodcastSettings()  : array<string, mixed>|null

Get podcast settings

getPointsPossible()  : float|null

Get points possible

getPositionAfter()  : string|null

Get position after

getPostedAt()  : string|null

Get posted at date

getPublished()  : bool|null

Get published status

getReadOnly()  : bool|null

Get read only status

getRequireInitialPost()  : bool|null

Get require initial post status

getSortOrder()  : string|null

Get sort order

getSortOrderLocked()  : bool|null

Get sort order locked status

getSpecificSections()  : array<string|int, int>|null

Get specific sections

getTitle()  : string|null

Get discussion topic title

lockComments()  : self

Lock comments on the announcement This prevents students from commenting on the announcement

setAllowRating()  : void

Set allow rating status

setAssignment()  : void

Set assignment configuration

setAssignmentId()  : void

Set assignment ID

setAttachment()  : void

Set attachment settings

setDelayedPostAt()  : void

Set delayed post date for scheduled announcements

setDiscussionType()  : void

Set discussion type

setExpanded()  : void

Set expanded status

setExpandedLocked()  : void

Set expanded locked status

setGradingType()  : void

Set grading type

setGroupCategoryId()  : void

Set group category ID

setIsAnnouncement()  : void

Set is announcement status

setLockAt()  : void

Set lock at date

setLockComment()  : void

Set lock comment status

setLocked()  : void

Set locked status

setMessage()  : void

Set discussion topic message

setOnlyGradersCanRate()  : void

Set only graders can rate status

setPinned()  : void

Set pinned status

setPodcastEnabled()  : void

Set podcast enabled status

setPodcastHasStudentPosts()  : void

Set podcast has student posts status

setPodcastSettings()  : void

Set podcast settings

setPointsPossible()  : void

Set points possible

setPositionAfter()  : void

Set position after

setPostedAt()  : void

Set posted at date

setPublished()  : void

Set published status

setReadOnly()  : void

Set read only status

setRequireInitialPost()  : void

Set require initial post status

setSections()  : self

Set sections for targeted announcements Allows announcements to be sent to specific course sections only

setSortOrder()  : void

Set sort order

setSortOrderLocked()  : void

Set sort order locked status

setSpecificSections()  : void

Set specific sections

setTitle()  : void

Set discussion topic title

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