Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/gesso/types/params.ts>CreatePlannerNoteParams

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

Properties

optional
title: string

The title of the planner note.

optional
details: string

Text of the planner note.

optional
tododate: Date

The date where this planner note should appear in the planner. The value should be formatted as: yyyy-mm-dd.

optional
courseid: number

The ID of the course to associate with the planner note. The caller must be able to view the course in order to associate it with a planner note.

optional
linkedobjecttype: string

The type of a learning object to link to this planner note. Must be used in conjunction wtih linked_object_id and course_id. Valid linked_object_type values are: 'announcement', 'assignment', 'discussion_topic', 'wiki_page', 'quiz'

optional
linkedobjectid: number

The id of a learning object to link to this planner note. Must be used in conjunction with linked_object_type and course_id. The object must be in the same course as specified by course_id. If the title argument is not provided, the planner note will use the learning object's title as its title. Only one planner note may be linked to a specific learning object.