.course. groupSet

Source:
Functions for interacting with group sets/categories within courses

Methods

(async) create(opts, configopt) → {Promise.<CanvasGroupCategory>}

Source:
Author:
  • Gabe Abrams
Create a group set in a course
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
name string The name of the new group set
courseId number <optional>
 default course id Canvas course Id to create a group set in
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Canvas GroupCategory https://canvas.instructure.com/doc/api/group_categories.html#GroupCategory
Type
Promise.<CanvasGroupCategory>

(async) delete(opts, configopt) → {Promise.<CanvasGroupCategory>}

Source:
Author:
  • Gabe Abrams
Deletes a group set
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Description
groupSetId number Canvas group set Id
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Canvas GroupCategory https://canvas.instructure.com/doc/api/group_categories.html#GroupCategory
Type
Promise.<CanvasGroupCategory>

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

Source:
Author:
  • Gabe Abrams
Gets info on a specific group set
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Description
groupSetId number Canvas group set Id
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Canvas GroupCategory https://canvas.instructure.com/doc/api/group_categories.html#GroupCategory
Type
Promise.<CanvasGroupCategory>

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

Source:
Author:
  • Gabe Abrams
Lists the group sets in the 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
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of Canvas GroupCategories https://canvas.instructure.com/doc/api/group_categories.html#GroupCategory
Type
Promise.<Array.<CanvasGroupCategory>>

(async) listGroups(opts, configopt) → {Promise.<Array.<CanvasGroup>>}

Source:
Author:
  • Gabe Abrams
Gets the list of groups in a group set
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
groupSetId number Canvas group set Id to query
includeUsers boolean <optional>
 if true, after getting the list of groups, CACCL requests each group's member list individually and adds each array to the group as groups[i].users (an array of Canvas user objects)
parallelLimit number <optional>
 1 the number of group membership arrays to request in parallel (if 1 or undefined, memberships will be requested serially). Only relevant if including users
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of Canvas Groups https://canvas.instructure.com/doc/api/groups.html#Group
Type
Promise.<Array.<CanvasGroup>>