.user. self

Source:
Functions for interacting with enrollment terms

Methods

getProfile(configopt) → {Promise.<CanvasUserProfile>}

Source:
Author:
  • Gabe Abrams
Gets info on the current user
Parameters:
Name Type Attributes Description
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Canvas user profile object https://canvas.instructure.com/doc/api/users.html#Profile
Type
Promise.<CanvasUserProfile>

listCourses(opts, configopt) → {Promise.<Array.<CanvasCourse>>}

Source:
Author:
  • Gabe Abrams
Gets the list of courses associated with the current user
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Description
includeTerm boolean <optional>
 if truthy, term is included
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of Canvas courses https://canvas.instructure.com/doc/api/courses.html#Course
Type
Promise.<Array.<CanvasCourse>>