View Source GitHub.Classroom (GitHub REST API Client v0.3.0)

Provides API endpoints related to classroom

Link to this section Summary

Link to this section Types

@type simple() :: %GitHub.Classroom{
  __info__: map(),
  archived: boolean(),
  id: integer(),
  name: String.t(),
  organization: term(),
  url: String.t()
}
@type t() :: %GitHub.Classroom{
  __info__: map(),
  archived: boolean(),
  id: integer(),
  name: String.t(),
  organization: GitHub.Classroom.Organization.simple(),
  url: String.t()
}

Link to this section Functions

Link to this function

get_a_classroom(classroom_id, opts \\ [])

View Source
@spec get_a_classroom(
  integer(),
  keyword()
) :: {:ok, t()} | {:error, GitHub.Error.t()}

Get a classroom

Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.

resources

Resources

Link to this function

get_an_assignment(assignment_id, opts \\ [])

View Source
@spec get_an_assignment(
  integer(),
  keyword()
) :: {:ok, GitHub.Classroom.Assignment.t()} | {:error, GitHub.Error.t()}

Get an assignment

Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.

resources

Resources

Link to this function

get_assignment_grades(assignment_id, opts \\ [])

View Source
@spec get_assignment_grades(
  integer(),
  keyword()
) :: {:ok, [GitHub.Classroom.AssignmentGrade.t()]} | {:error, GitHub.Error.t()}

Get assignment grades

Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.

resources

Resources

Link to this function

list_accepted_assigments_for_an_assignment(assignment_id, opts \\ [])

View Source
@spec list_accepted_assigments_for_an_assignment(
  integer(),
  keyword()
) ::
  {:ok, [GitHub.Classroom.AcceptedAssignment.t()]} | {:error, GitHub.Error.t()}

List accepted assignments for an assignment

Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.

options

Options

resources

Resources

Link to this function

list_assignments_for_a_classroom(classroom_id, opts \\ [])

View Source
@spec list_assignments_for_a_classroom(
  integer(),
  keyword()
) :: {:ok, [GitHub.Classroom.Assignment.simple()]} | {:error, GitHub.Error.t()}

List assignments for a classroom

Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.

options

Options

resources

Resources

Link to this function

list_classrooms(opts \\ [])

View Source
@spec list_classrooms(keyword()) :: {:ok, [simple()]} | {:error, GitHub.Error.t()}

List classrooms

Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.

options

Options

resources

Resources