classroom

Documentation

Index

• type AcceptedAssignment
  • func GetAssignmentList(client api.RESTClient, assignmentID int, page int, perPage int) ([]AcceptedAssignment, error)
  • func (a AcceptedAssignment) RepositoryUrl() string
• type AcceptedAssignmentList
  • func NewAcceptedAssignmentList(assignments []AcceptedAssignment) AcceptedAssignmentList
• type Assignment
  • func GetAssignment(client api.RESTClient, assignmentID int) (Assignment, error)
  • func (a Assignment) IsGroupAssignment() bool
  • func (a Assignment) Url() string
• type AssignmentGrade
  • func GetAssignmentGrades(client api.RESTClient, assignmentID int) ([]AssignmentGrade, error)
• type AssignmentList
  • func ListAssignments(client api.RESTClient, classroomID int, page int, perPage int) (AssignmentList, error)
  • func NewAssignmentList(assignments []Assignment) AssignmentList
  • func (a AssignmentList) Url() string
• type Classroom
  • func GetClassroom(client api.RESTClient, classroomID int) (Classroom, error)
  • func ListClassrooms(client api.RESTClient, page int, perPage int) ([]Classroom, error)
• type GitHubOrganization
• type GithubRepository
• type Student

Types

type AcceptedAssignment

type AcceptedAssignment struct {
	Id                     int              `json:"id"`
	Submitted              bool             `json:"submitted"`
	Passing                bool             `json:"passing"`
	CommitCount            int              `json:"commit_count"`
	Grade                  string           `json:"grade"`
	FeedbackPullRequestUrl string           `json:"feedback_pull_request_url"`
	Students               []Student        `json:"students"`
	Repository             GithubRepository `json:"repository"`
	Assignment             Assignment       `json:"assignment"`
}

func GetAssignmentList

func GetAssignmentList(client api.RESTClient, assignmentID int, page int, perPage int) ([]AcceptedAssignment, error)

func (AcceptedAssignment) RepositoryUrl

func (a AcceptedAssignment) RepositoryUrl() string

type AcceptedAssignmentList

type AcceptedAssignmentList struct {
	AcceptedAssignments []AcceptedAssignment
	Classroom           Classroom
	Assignment          Assignment
	Count               int
}

func NewAcceptedAssignmentList

func NewAcceptedAssignmentList(assignments []AcceptedAssignment) AcceptedAssignmentList

type Assignment

type Assignment struct {
	Id                          int              `json:"id"`
	PublicRepo                  bool             `json:"public_repo"`
	Title                       string           `json:"title"`
	AssignmentType              string           `json:"type"`
	InviteLink                  string           `json:"invite_link"`
	InvitationsEnabled          bool             `json:"invitations_enabled"`
	Slug                        string           `json:"slug"`
	StudentsAreRepoAdmins       bool             `json:"students_are_repo_admins"`
	FeedbackPullRequestsEnabled bool             `json:"feedback_pull_requests_enabled"`
	MaxTeams                    int              `json:"max_teams"`
	MaxMembers                  int              `json:"max_members"`
	Editor                      string           `json:"editor"`
	Accepted                    int              `json:"accepted"`
	Submissions                 int              `json:"submissions"`
	Passing                     int              `json:"passing"`
	Language                    string           `json:"language"`
	Deadline                    string           `json:"deadline"`
	Classroom                   Classroom        `json:"classroom"`
	StarterCodeRepository       GithubRepository `json:"starter_code_repository"`
}

func GetAssignment

func GetAssignment(client api.RESTClient, assignmentID int) (Assignment, error)

func (Assignment) IsGroupAssignment

func (a Assignment) IsGroupAssignment() bool

func (Assignment) Url

func (a Assignment) Url() string

type AssignmentGrade

type AssignmentGrade struct {
	AssignmentName        string `json:"assignment_name"`
	AssignmentURL         string `json:"assignment_url"`
	StarterCodeURL        string `json:"starter_code_url"`
	GithubUsername        string `json:"github_username"`
	RosterIdentifier      string `json:"roster_identifier"`
	StudentRepositoryName string `json:"student_repository_name"`
	StudentRepositoryURL  string `json:"student_repository_url"`
	SubmissionTimestamp   string `json:"submission_timestamp"`
	PointsAwarded         string `json:"points_awarded"`
	PointsAvailable       string `json:"points_available"`
	GroupName             string `json:"group_name"`
}

func GetAssignmentGrades

func GetAssignmentGrades(client api.RESTClient, assignmentID int) ([]AssignmentGrade, error)

type AssignmentList

type AssignmentList struct {
	Assignments []Assignment
	Classroom   Classroom
	Count       int
}

func ListAssignments

func ListAssignments(client api.RESTClient, classroomID int, page int, perPage int) (AssignmentList, error)

func NewAssignmentList

func NewAssignmentList(assignments []Assignment) AssignmentList

func (AssignmentList) Url

func (a AssignmentList) Url() string

type Classroom

type Classroom struct {
	Id           int                `json:"id"`
	Name         string             `json:"name"`
	Archived     bool               `json:"archived"`
	Url          string             `json:"url"`
	Organization GitHubOrganization `json:"organization"`
}

func GetClassroom

func GetClassroom(client api.RESTClient, classroomID int) (Classroom, error)

func ListClassrooms

func ListClassrooms(client api.RESTClient, page int, perPage int) ([]Classroom, error)

type GitHubOrganization

type GitHubOrganization struct {
	Id        int    `json:"id"`
	Login     string `json:"login"`
	NodeID    string `json:"node_id"`
	HtmlUrl   string `json:"html_url"`
	Name      string `json:"name"`
	AvatarUrl string `json:"avatar_url"`
}

type GithubRepository

type GithubRepository struct {
	Id            int    `json:"id"`
	Name          string `json:"name"`
	FullName      string `json:"full_name"`
	HtmlUrl       string `json:"html_url"`
	NodeId        string `json:"node_id"`
	Private       bool   `json:"private"`
	DefaultBranch string `json:"default_branch"`
}

type Student

type Student struct {
	Id        int    `json:"id"`
	Login     string `json:"login"`
	AvatarUrl string `json:"avatar_url"`
	HtmlUrl   string `json:"html_url"`
}