---

Class Relations

• class: ::nx::EnsembleObject

::nx::EnsembleObject create ::canvas::API::slot::__course

Methods (to be applied on the object)

• activities (scripted)

  #
  # Returns the paginated Returns the current user's
  # course-specific activity stream, paginated.
  #
  # Details: https://canvas.instructure.com/doc/api/courses.html
  #
  # @param page Return the nth page of the result set
  # @param per_page Return this number of entries per page
  # @param max_entries perform potentially multiple requests
  # until the requested number of entries can be returned.
  #
  set r [:request -method GET -token ${:token}  -url /courses/${course_id}/activity_stream?[:params {page per_page}]]
  return [:paginated_result_list -max_entries $max_entries $r 200]

• todo (scripted)

  #
  # Returns a paginated list of the current user's
  # course-specific todo items.
  #
  # Details: https://canvas.instructure.com/doc/api/courses.html
  #
  # @param page Return the nth page of the result set
  # @param per_page Return this number of entries per page
  # @param max_entries perform potentially multiple requests
  # until the requested number of entries can be returned.
  #
  set r [:request -method GET -token ${:token}  -url /courses/${course_id}/todo?[:params {page per_page}]]
  return [:paginated_result_list -max_entries $max_entries $r 200]

• users (scripted)

  #
  # Returns the paginated list of users in this course. And
  # optionally the user's enrollments in the course.
  #
  # Details: https://canvas.instructure.com/doc/api/courses.html
  #
  # @param search_term The partial name or full ID of the
  # users to match and return in the results list.
  #
  # @param sort When set, sort the results of the search
  # based on the given Allowed values: username, last_login,
  # email, sis_id
  #
  # @param enrollment_type When set, only return users where
  # the user is enrolled as this type. “student_view”
  # implies include[]=test_student. This argument is ignored
  # if enrollment_role is given. Allowed values: teacher,
  # student, student_view, ta, observer, designer
  #
  # @param enrollment_role_id When set, only return courses
  # where the user is enrolled with the specified
  # course-level role. This can be a role created with the
  # Add Role API or a built_in role id with type
  # 'StudentEnrollment', 'TeacherEnrollment',
  # 'TaEnrollment', 'ObserverEnrollment', or
  # 'DesignerEnrollment'.
  #
  # @param include Optionally included content.  Allowed
  # values: enrollments, locked, avatar_url, test_student,
  # bio, custom_links, current_grading_period_scores, uuid
  #
  # @param include Optionally included content.  Allowed
  # values: enrollments, locked, avatar_url, test_student,
  # bio, custom_links, current_grading_period_scores, uuid
  #
  # @param user_ids If included, the course users set will
  # only include users with IDs specified by the
  # param.
  #
  # @param enrollment_state When set, only return users
  # where the enrollment workflow state is of one of the
  # given types. “active” and “invited” enrollments are
  # returned by default.  Allowed values: active, invited,
  # rejected, completed, inactive
  #
  # @param page Return the nth page of the result set
  # @param per_page Return this number of entries per page
  # @param max_entries perform potentially multiple requests
  # until the requested number of entries can be returned.
  #
  set r [:request -method GET -token ${:token}  -url /courses/${course_id}/users?[:params {page per_page
                 search_term sort enrollment_type:array enrollment_role_id
                 include:array user_ids:array enrollment_state:array
             }]]
  return [:paginated_result_list -max_entries $max_entries $r 200]

---