Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/gesso/types/params.ts>CreateNewDiscussionTopicParams

A TypeScript API client for Canvas LMS
Latest
interface CreateNewDiscussionTopicParams
import { type CreateNewDiscussionTopicParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
title: string

no description

optional
message: string

no description

optional
discussiontype: string

Allowed values: side_comment, threaded

optional
published: boolean

Whether this topic is published (true) or draft state (false). Only teachers and TAs have the ability to create draft state topics.

optional
delayedpostat: Date

If a timestamp is given, the topic will not be published until that time.

optional
allowrating: boolean

Whether or not users can rate entries in this topic.

optional
lockat: Date

If a timestamp is given, the topic will be scheduled to lock at the provided timestamp. If the timestamp is in the past, the topic will be locked.

optional
podcastenabled: boolean

If true, the topic will have an associated podcast feed.

optional
podcasthasstudentposts: boolean

If true, the podcast will include posts from students as well. Implies podcast_enabled.

optional
requireinitialpost: boolean

If true then a user may not respond to other replies until that user has made an initial reply. Defaults to false.

optional
assignment: Assignment

To create an assignment discussion, pass the assignment parameters as a sub- object. See the Create an Assignment API for the available parameters. The name parameter will be ignored, as it's taken from the discussion title. If you want to make a discussion that was an assignment NOT an assignment, pass set_assignment = false as part of the assignment object

optional
isannouncement: boolean

If true, this topic is an announcement. It will appear in the announcement's section rather than the discussions section. This requires announcment-posting permissions.

optional
pinned: boolean

If true, this topic will be listed in the “Pinned Discussion” section

optional
positionafter: string

By default, discussions are sorted chronologically by creation date, you can pass the id of another topic to have this one show up after the other when they are listed.

optional
groupcategoryid: number

If present, the topic will become a group discussion assigned to the group.

optional
onlygraderscanrate: boolean

If true, only graders will be allowed to rate entries.

optional
sortbyrating: boolean

If true, entries will be sorted by rating.

optional
attachment: unknown

A multipart/form-data form-field-style attachment. Attachments larger than 1 kilobyte are subject to quota restrictions.

optional
specificsections: string

A comma-separated list of sections ids to which the discussion topic should be made specific to. If it is not desired to make the discussion topic specific to sections, then this parameter may be omitted or set to “all”. Can only be present only on announcements and only those that are for a course (as opposed to a group).