View Source GitHub.Classroom (GitHub REST API Client v0.2.0)
Provides API endpoints related to classroom
Link to this section Summary
Functions
Get a classroom
Get an assignment
Get assignment grades
List accepted assignments for an assignment
List assignments for a classroom
List classrooms
Link to this section Types
Link to this section Functions
@spec get_a_classroom( integer(), keyword() ) :: {:ok, map()} | {: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
@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
@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
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
page
: Page number of the results to fetch.per_page
: The number of results per page (max 100).
resources
Resources
@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
page
: Page number of the results to fetch.per_page
: The number of results per page (max 100).
resources
Resources
@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
page
: Page number of the results to fetch.per_page
: The number of results per page (max 100).