.course. section

Source:
Functions for interacting with sections within courses

Methods

get(opts, configopt) → {Promise.<CanvasSection>}

Source:
Author:
  • Gabe Abrams
Gets info on a specific section
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
sectionId number Section Id to retrieve
courseId number <optional>
 default course id Canvas course Id to query
includeStudents boolean <optional>
 if true, the list of students in the section are included
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Canvas Section https://canvas.instructure.com/doc/api/sections.html#Section
Type
Promise.<CanvasSection>

list(optsopt, configopt) → {Promise.<Array.<CanvasSection>>}

Source:
Author:
  • Gabe Abrams
Gets the list of sections in a course
Parameters:
Name Type Attributes Description
opts object <optional>
 object containing all arguments
Properties
Name Type Attributes Default Description
courseId number <optional>
 default course id Canvas course Id to query
includeStudents boolean <optional>
 if true, the list of students from each section are included
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of Canvas Sections https://canvas.instructure.com/doc/api/sections.html#Section
Type
Promise.<Array.<CanvasSection>>