classroom

package
v0.0.0-...-375ceb8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2015 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package classroom provides access to the Google Classroom API.

Usage example: 

import "google.golang.org/api/classroom/v1"
...
classroomService, err := classroom.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// Manage your Google Classroom classes
	ClassroomCoursesScope = "https://www.googleapis.com/auth/classroom.courses"

	// View your Google Classroom classes
	ClassroomCoursesReadonlyScope = "https://www.googleapis.com/auth/classroom.courses.readonly"

	// View the email addresses of people in your classes
	ClassroomProfileEmailsScope = "https://www.googleapis.com/auth/classroom.profile.emails"

	// View the profile photos of people in your classes
	ClassroomProfilePhotosScope = "https://www.googleapis.com/auth/classroom.profile.photos"

	// Manage your Google Classroom class rosters
	ClassroomRostersScope = "https://www.googleapis.com/auth/classroom.rosters"

	// View your Google Classroom class rosters
	ClassroomRostersReadonlyScope = "https://www.googleapis.com/auth/classroom.rosters.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Course 

type Course struct {
	// AlternateLink: Absolute link to this course in the Classroom web UI.
	// Read-only.
	AlternateLink string `json:"alternateLink,omitempty"`

	// CourseState: State of the course. If unspecified, the default state
	// will be `PROVISIONED`.
	//
	// Possible values:
	//   "COURSE_STATE_UNSPECIFIED"
	//   "ACTIVE"
	//   "ARCHIVED"
	//   "PROVISIONED"
	//   "DECLINED"
	CourseState string `json:"courseState,omitempty"`

	// CreationTime: Creation time of the course. Specifying this field in a
	// course update mask will result in an error. Read-only.
	CreationTime string `json:"creationTime,omitempty"`

	// Description: Optional description. For example, "We'll be learning
	// about about the structure of living creatures from a combination of
	// textbooks, guest lectures, and lab work. Expect to be excited!" If
	// set, this field must be a valid UTF-8 string and no longer than
	// 30,000 characters.
	Description string `json:"description,omitempty"`

	// DescriptionHeading: Optional heading for the description. For
	// example, "Welcome to 10th Grade Biology" If set, this field must be a
	// valid UTF-8 string and no longer than 3600 characters.
	DescriptionHeading string `json:"descriptionHeading,omitempty"`

	// EnrollmentCode: Enrollment code to use when joining this course.
	// Specifying this field in a course update mask will result in an
	// error. Read-only.
	EnrollmentCode string `json:"enrollmentCode,omitempty"`

	// Id: Unique identifier for this course assigned by Classroom. You may
	// optionally set this to an [alias
	// string][google.classroom.v1.CourseAlias] as part of [creating a
	// course][google.classroom.v1.Courses.CreateCourse], creating a
	// corresponding alias. The `ID` cannot be updated after a course is
	// created. Specifying this field in a course update mask will result in
	// an error.
	Id string `json:"id,omitempty"`

	// Name: Name of the course. For example, "10th Grade Biology". This is
	// required and must be between 1 and 750 characters and a valid UTF-8
	// string.
	Name string `json:"name,omitempty"`

	// OwnerId: The identifier of the owner (and primary teacher) of a
	// course. When specified as a parameter of CreateCourseRequest, this
	// field is required. It may be the numeric identifier for the user, or
	// an alias that identifies the owner. The following aliases are
	// supported: * the e-mail address of the user * the string literal
	// "me", indicating that the requesting user This must be set in a
	// CreateRequest; specifying this field in a course update mask will
	// result in an error.
	OwnerId string `json:"ownerId,omitempty"`

	// Room: Optional room location. For example, "301" If set, this field
	// must be a valid UTF-8 string and no longer than 650 characters.
	Room string `json:"room,omitempty"`

	// Section: Section of the course For example, "Period 2". If set, this
	// field must be a valid UTF-8 string and no longer than 2800
	// characters.
	Section string `json:"section,omitempty"`

	// UpdateTime: Time of the most recent update to this course. Specifying
	// this field in a course update mask will result in an error.
	// Read-only.
	UpdateTime string `json:"updateTime,omitempty"`
}

Course: A Course in Classroom.

type CourseAlias 

type CourseAlias struct {
	// Alias: Alias string. The format of the string indicated the desired
	// alias scoping. * "d:" indicates a domain-scoped alias. Example:
	// d:math_101 * "p:" indicates a project-scoped alias. Example: p:abc123
	// This field has a maximum length of 256 characters.
	Alias string `json:"alias,omitempty"`
}

CourseAlias: Alternative identifier for a course. An alias uniquely identifies a course. It will be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and may only be created by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console Project ID that created the alias and may be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded.

type CoursesAliasesCreateCall 

type CoursesAliasesCreateCall struct {
	// contains filtered or unexported fields
}

func (*CoursesAliasesCreateCall) Do 

func (c *CoursesAliasesCreateCall) Do() (*CourseAlias, error)

func (*CoursesAliasesCreateCall) Fields 

func (c *CoursesAliasesCreateCall) Fields(s ...googleapi.Field) *CoursesAliasesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesAliasesDeleteCall 

type CoursesAliasesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*CoursesAliasesDeleteCall) Do 

func (c *CoursesAliasesDeleteCall) Do() (*Empty, error)

func (*CoursesAliasesDeleteCall) Fields 

func (c *CoursesAliasesDeleteCall) Fields(s ...googleapi.Field) *CoursesAliasesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesAliasesListCall 

type CoursesAliasesListCall struct {
	// contains filtered or unexported fields
}

func (*CoursesAliasesListCall) Do 

func (c *CoursesAliasesListCall) Do() (*ListCourseAliasesResponse, error)

func (*CoursesAliasesListCall) Fields 

func (c *CoursesAliasesListCall) Fields(s ...googleapi.Field) *CoursesAliasesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CoursesAliasesListCall) PageSize 

func (c *CoursesAliasesListCall) PageSize(pageSize int64) *CoursesAliasesListCall

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

func (*CoursesAliasesListCall) PageToken 

func (c *CoursesAliasesListCall) PageToken(pageToken string) *CoursesAliasesListCall

PageToken sets the optional parameter "pageToken": [nextPageToken][google.classroom.v1.ListCourseAliasesResponse.next_pag e_token] value returned from a previous [list][google.classroom.v1.Courses.ListCourseAliases] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Courses.ListCourseAliases] request must be identical to the one which resulted in this token.

type CoursesAliasesService 

type CoursesAliasesService struct {
	// contains filtered or unexported fields
}

func NewCoursesAliasesService 

func NewCoursesAliasesService(s *Service) *CoursesAliasesService

func (*CoursesAliasesService) Create 

func (r *CoursesAliasesService) Create(courseId string, coursealias *CourseAlias) *CoursesAliasesCreateCall

Create: Creates an alias to a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.

func (*CoursesAliasesService) Delete 

func (r *CoursesAliasesService) Delete(courseId string, aliasid string) *CoursesAliasesDeleteCall

Delete: Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias. * `NOT_FOUND` if the alias does not exist.

func (*CoursesAliasesService) List 

func (r *CoursesAliasesService) List(courseId string) *CoursesAliasesListCall

List: Lists the aliases of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course. * `NOT_FOUND` if the course does not exist.

type CoursesCreateCall 

type CoursesCreateCall struct {
	// contains filtered or unexported fields
}

func (*CoursesCreateCall) Do 

func (c *CoursesCreateCall) Do() (*Course, error)

func (*CoursesCreateCall) Fields 

func (c *CoursesCreateCall) Fields(s ...googleapi.Field) *CoursesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesDeleteCall 

type CoursesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*CoursesDeleteCall) Do 

func (c *CoursesDeleteCall) Do() (*Empty, error)

func (*CoursesDeleteCall) Fields 

func (c *CoursesDeleteCall) Fields(s ...googleapi.Field) *CoursesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesGetCall 

type CoursesGetCall struct {
	// contains filtered or unexported fields
}

func (*CoursesGetCall) Do 

func (c *CoursesGetCall) Do() (*Course, error)

func (*CoursesGetCall) Fields 

func (c *CoursesGetCall) Fields(s ...googleapi.Field) *CoursesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesListCall 

type CoursesListCall struct {
	// contains filtered or unexported fields
}

func (*CoursesListCall) Do 

func (c *CoursesListCall) Do() (*ListCoursesResponse, error)

func (*CoursesListCall) Fields 

func (c *CoursesListCall) Fields(s ...googleapi.Field) *CoursesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CoursesListCall) PageSize 

func (c *CoursesListCall) PageSize(pageSize int64) *CoursesListCall

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

func (*CoursesListCall) PageToken 

func (c *CoursesListCall) PageToken(pageToken string) *CoursesListCall

PageToken sets the optional parameter "pageToken": [nextPageToken][google.classroom.v1.ListCoursesResponse.next_page_toke n] value returned from a previous [list][google.classroom.v1.Courses.ListCourses] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Courses.ListCourses] request must be identical to the one which resulted in this token.

func (*CoursesListCall) StudentId 

func (c *CoursesListCall) StudentId(studentId string) *CoursesListCall

StudentId sets the optional parameter "studentId": Restricts returned courses to those having a student with the specified identifier, or an alias that identifies a student. The following aliases are supported: * the e-mail address of the user * the string literal "me", indicating that the requesting user

func (*CoursesListCall) TeacherId 

func (c *CoursesListCall) TeacherId(teacherId string) *CoursesListCall

TeacherId sets the optional parameter "teacherId": Restricts returned courses to those having a teacher with the specified identifier, or an alias that identifies a teacher. The following aliases are supported: * the e-mail address of the user * the string literal "me", indicating that the requesting user

type CoursesPatchCall 

type CoursesPatchCall struct {
	// contains filtered or unexported fields
}

func (*CoursesPatchCall) Do 

func (c *CoursesPatchCall) Do() (*Course, error)

func (*CoursesPatchCall) Fields 

func (c *CoursesPatchCall) Fields(s ...googleapi.Field) *CoursesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CoursesPatchCall) UpdateMask 

func (c *CoursesPatchCall) UpdateMask(updateMask string) *CoursesPatchCall

UpdateMask sets the optional parameter "updateMask": Mask which identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. Valid fields are listed below: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this should be specified as `updateMask=,,...`

type CoursesService 

type CoursesService struct {
	Aliases *CoursesAliasesService

	Students *CoursesStudentsService

	Teachers *CoursesTeachersService
	// contains filtered or unexported fields
}

func NewCoursesService 

func NewCoursesService(s *Service) *CoursesService

func (*CoursesService) Create 

func (r *CoursesService) Create(course *Course) *CoursesCreateCall

Create: Creates a course. The user specified as the primary teacher in `primary_teacher_id` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses. * `NOT_FOUND` if the primary teacher is not a valid user. * `ALREADY_EXISTS` if an alias was specified and already exists.

func (*CoursesService) Delete 

func (r *CoursesService) Delete(id string) *CoursesDeleteCall

Delete: Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesService) Get 

func (r *CoursesService) Get(id string) *CoursesGetCall

Get: Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesService) List 

func (r *CoursesService) List() *CoursesListCall

List: Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

func (*CoursesService) Patch 

func (r *CoursesService) Patch(id string, course *Course) *CoursesPatchCall

Patch: Updates one or more fields a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.

func (*CoursesService) Update 

func (r *CoursesService) Update(id string, course *Course) *CoursesUpdateCall

Update: Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course. * `NOT_FOUND` if no course exists with the requested ID.

type CoursesStudentsCreateCall 

type CoursesStudentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*CoursesStudentsCreateCall) Do 

func (c *CoursesStudentsCreateCall) Do() (*Student, error)

func (*CoursesStudentsCreateCall) EnrollmentCode 

func (c *CoursesStudentsCreateCall) EnrollmentCode(enrollmentCode string) *CoursesStudentsCreateCall

EnrollmentCode sets the optional parameter "enrollmentCode": Enrollment code of the course to create the student in. This is required if [userId][google.classroom.v1.Student.user_id] corresponds to the requesting user; this may be omitted if the requesting user has administrative permissions to create students for any user.

func (*CoursesStudentsCreateCall) Fields 

func (c *CoursesStudentsCreateCall) Fields(s ...googleapi.Field) *CoursesStudentsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesStudentsDeleteCall 

type CoursesStudentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*CoursesStudentsDeleteCall) Do 

func (c *CoursesStudentsDeleteCall) Do() (*Empty, error)

func (*CoursesStudentsDeleteCall) Fields 

func (c *CoursesStudentsDeleteCall) Fields(s ...googleapi.Field) *CoursesStudentsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesStudentsGetCall 

type CoursesStudentsGetCall struct {
	// contains filtered or unexported fields
}

func (*CoursesStudentsGetCall) Do 

func (c *CoursesStudentsGetCall) Do() (*Student, error)

func (*CoursesStudentsGetCall) Fields 

func (c *CoursesStudentsGetCall) Fields(s ...googleapi.Field) *CoursesStudentsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesStudentsListCall 

type CoursesStudentsListCall struct {
	// contains filtered or unexported fields
}

func (*CoursesStudentsListCall) Do 

func (c *CoursesStudentsListCall) Do() (*ListStudentsResponse, error)

func (*CoursesStudentsListCall) Fields 

func (c *CoursesStudentsListCall) Fields(s ...googleapi.Field) *CoursesStudentsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CoursesStudentsListCall) PageSize 

func (c *CoursesStudentsListCall) PageSize(pageSize int64) *CoursesStudentsListCall

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

func (*CoursesStudentsListCall) PageToken 

func (c *CoursesStudentsListCall) PageToken(pageToken string) *CoursesStudentsListCall

PageToken sets the optional parameter "pageToken": [nextPageToken][google.classroom.v1.ListStudentsResponse.next_page_tok en] value returned from a previous [list][google.classroom.v1.Users.ListStudents] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListStudents] request must be identical to the one which resulted in this token.

type CoursesStudentsService 

type CoursesStudentsService struct {
	// contains filtered or unexported fields
}

func NewCoursesStudentsService 

func NewCoursesStudentsService(s *Service) *CoursesStudentsService

func (*CoursesStudentsService) Create 

func (r *CoursesStudentsService) Create(courseId string, student *Student) *CoursesStudentsCreateCall

Create: Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a student or student in the course.

func (*CoursesStudentsService) Delete 

func (r *CoursesStudentsService) Delete(courseId string, userId string) *CoursesStudentsDeleteCall

Delete: Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

func (*CoursesStudentsService) Get 

func (r *CoursesStudentsService) Get(courseId string, userId string) *CoursesStudentsGetCall

Get: Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

func (*CoursesStudentsService) List 

func (r *CoursesStudentsService) List(courseId string) *CoursesStudentsListCall

List: Returns a list of students of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.

type CoursesTeachersCreateCall 

type CoursesTeachersCreateCall struct {
	// contains filtered or unexported fields
}

func (*CoursesTeachersCreateCall) Do 

func (c *CoursesTeachersCreateCall) Do() (*Teacher, error)

func (*CoursesTeachersCreateCall) Fields 

func (c *CoursesTeachersCreateCall) Fields(s ...googleapi.Field) *CoursesTeachersCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesTeachersDeleteCall 

type CoursesTeachersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*CoursesTeachersDeleteCall) Do 

func (c *CoursesTeachersDeleteCall) Do() (*Empty, error)

func (*CoursesTeachersDeleteCall) Fields 

func (c *CoursesTeachersDeleteCall) Fields(s ...googleapi.Field) *CoursesTeachersDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesTeachersGetCall 

type CoursesTeachersGetCall struct {
	// contains filtered or unexported fields
}

func (*CoursesTeachersGetCall) Do 

func (c *CoursesTeachersGetCall) Do() (*Teacher, error)

func (*CoursesTeachersGetCall) Fields 

func (c *CoursesTeachersGetCall) Fields(s ...googleapi.Field) *CoursesTeachersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type CoursesTeachersListCall 

type CoursesTeachersListCall struct {
	// contains filtered or unexported fields
}

func (*CoursesTeachersListCall) Do 

func (c *CoursesTeachersListCall) Do() (*ListTeachersResponse, error)

func (*CoursesTeachersListCall) Fields 

func (c *CoursesTeachersListCall) Fields(s ...googleapi.Field) *CoursesTeachersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CoursesTeachersListCall) PageSize 

func (c *CoursesTeachersListCall) PageSize(pageSize int64) *CoursesTeachersListCall

PageSize sets the optional parameter "pageSize": Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

func (*CoursesTeachersListCall) PageToken 

func (c *CoursesTeachersListCall) PageToken(pageToken string) *CoursesTeachersListCall

PageToken sets the optional parameter "pageToken": [nextPageToken][google.classroom.v1.ListTeachersResponse.next_page_tok en] value returned from a previous [list][google.classroom.v1.Users.ListTeachers] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListTeachers] request must be identical to the one which resulted in this token.

type CoursesTeachersService 

type CoursesTeachersService struct {
	// contains filtered or unexported fields
}

func NewCoursesTeachersService 

func NewCoursesTeachersService(s *Service) *CoursesTeachersService

func (*CoursesTeachersService) Create 

func (r *CoursesTeachersService) Create(courseId string, teacher *Teacher) *CoursesTeachersCreateCall

Create: Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

func (*CoursesTeachersService) Delete 

func (r *CoursesTeachersService) Delete(courseId string, userId string) *CoursesTeachersDeleteCall

Delete: Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.

func (*CoursesTeachersService) Get 

func (r *CoursesTeachersService) Get(courseId string, userId string) *CoursesTeachersGetCall

Get: Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

func (*CoursesTeachersService) List 

func (r *CoursesTeachersService) List(courseId string) *CoursesTeachersListCall

List: Returns a list of teachers of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.

type CoursesUpdateCall 

type CoursesUpdateCall struct {
	// contains filtered or unexported fields
}

func (*CoursesUpdateCall) Do 

func (c *CoursesUpdateCall) Do() (*Course, error)

func (*CoursesUpdateCall) Fields 

func (c *CoursesUpdateCall) Fields(s ...googleapi.Field) *CoursesUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type Empty 

type Empty struct {
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

type GlobalPermission 

type GlobalPermission struct {
	// Permission: Permission value.
	//
	// Possible values:
	//   "PERMISSION_UNSPECIFIED"
	//   "CREATE_COURSE"
	Permission string `json:"permission,omitempty"`
}

GlobalPermission: Global user permission description.

type Invitation 

type Invitation struct {
	// CourseId: Identifier of the course to invite the user to.
	CourseId string `json:"courseId,omitempty"`

	// Id: Unique identifier assigned by Classroom. Read-only
	Id string `json:"id,omitempty"`

	// Role: Role to invite the user to have. Must not be
	// `COURSE_ROLE_UNSPECIFIED`.
	//
	// Possible values:
	//   "COURSE_ROLE_UNSPECIFIED"
	//   "STUDENT"
	//   "TEACHER"
	Role string `json:"role,omitempty"`

	// UserId: Identifier of the invited user. When specified as a parameter
	// of a request, this may be set to an alias that identifies the user to
	// invite. The supported aliases are: * the e-mail address of the user *
	// the string literal "me", indicating that the requesting user
	UserId string `json:"userId,omitempty"`
}

Invitation: An invitation to join a course.

type InvitationsAcceptCall 

type InvitationsAcceptCall struct {
	// contains filtered or unexported fields
}

func (*InvitationsAcceptCall) Do 

func (c *InvitationsAcceptCall) Do() (*Empty, error)

func (*InvitationsAcceptCall) Fields 

func (c *InvitationsAcceptCall) Fields(s ...googleapi.Field) *InvitationsAcceptCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type InvitationsCreateCall 

type InvitationsCreateCall struct {
	// contains filtered or unexported fields
}

func (*InvitationsCreateCall) Do 

func (c *InvitationsCreateCall) Do() (*Invitation, error)

func (*InvitationsCreateCall) Fields 

func (c *InvitationsCreateCall) Fields(s ...googleapi.Field) *InvitationsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type InvitationsDeleteCall 

type InvitationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*InvitationsDeleteCall) Do 

func (c *InvitationsDeleteCall) Do() (*Empty, error)

func (*InvitationsDeleteCall) Fields 

func (c *InvitationsDeleteCall) Fields(s ...googleapi.Field) *InvitationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type InvitationsGetCall 

type InvitationsGetCall struct {
	// contains filtered or unexported fields
}

func (*InvitationsGetCall) Do 

func (c *InvitationsGetCall) Do() (*Invitation, error)

func (*InvitationsGetCall) Fields 

func (c *InvitationsGetCall) Fields(s ...googleapi.Field) *InvitationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type InvitationsListCall 

type InvitationsListCall struct {
	// contains filtered or unexported fields
}

func (*InvitationsListCall) CourseId 

func (c *InvitationsListCall) CourseId(courseId string) *InvitationsListCall

CourseId sets the optional parameter "courseId": Restricts returned invitations to those for a course with the specified identifier.

func (*InvitationsListCall) Do 

func (c *InvitationsListCall) Do() (*ListInvitationsResponse, error)

func (*InvitationsListCall) Fields 

func (c *InvitationsListCall) Fields(s ...googleapi.Field) *InvitationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*InvitationsListCall) PageSize 

func (c *InvitationsListCall) PageSize(pageSize int64) *InvitationsListCall

PageSize sets the optional parameter "pageSize": The maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

func (*InvitationsListCall) PageToken 

func (c *InvitationsListCall) PageToken(pageToken string) *InvitationsListCall

PageToken sets the optional parameter "pageToken": [nextPageToken][google.classroom.v1.ListInvitationsRespnse.next_page_t oken] value returned from a previous [list][google.classroom.v1.Users.ListInvitations] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListInvitations] request must be identical to the one which resulted in this token.

func (*InvitationsListCall) UserId 

func (c *InvitationsListCall) UserId(userId string) *InvitationsListCall

UserId sets the optional parameter "userId": Restricts returned invitations to those for a specific user. This may be the unique identifier for the user or an alias. The supported aliases are: * the e-mail address of the user * the string literal "me", indicating the requesting user

type InvitationsService 

type InvitationsService struct {
	// contains filtered or unexported fields
}

func NewInvitationsService 

func NewInvitationsService(s *Service) *InvitationsService

func (*InvitationsService) Accept 

func (r *InvitationsService) Accept(id string) *InvitationsAcceptCall

Accept: Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) Create 

func (r *InvitationsService) Create(invitation *Invitation) *InvitationsCreateCall

Create: Creates a invitation. Only one invitation for a user and course may exist at a time. Delete and recreate an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course. * `NOT_FOUND` if the course or the user does not exist. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

func (*InvitationsService) Delete 

func (r *InvitationsService) Delete(id string) *InvitationsDeleteCall

Delete: Deletes a invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) Get 

func (r *InvitationsService) Get(id string) *InvitationsGetCall

Get: Returns a invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) List 

func (r *InvitationsService) List() *InvitationsListCall

List: Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the request. *Note:* At least one of `user_id` or `course_id` must be supplied.

type ListCourseAliasesResponse 

type ListCourseAliasesResponse struct {
	// Aliases: The course aliases.
	Aliases []*CourseAlias `json:"aliases,omitempty"`

	// NextPageToken: Token identifying the next page of results to return.
	// If empty, no further results are available.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

ListCourseAliasesResponse: Response when listing course aliases.

type ListCoursesResponse 

type ListCoursesResponse struct {
	// Courses: Courses that match the request.
	Courses []*Course `json:"courses,omitempty"`

	// NextPageToken: Token identifying the next page of results to return.
	// If empty, no further results are available.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

ListCoursesResponse: Response when listing courses.

type ListInvitationsResponse 

type ListInvitationsResponse struct {
	// Invitations: Invitations that match the request.
	Invitations []*Invitation `json:"invitations,omitempty"`

	// NextPageToken: Token identifying the next page of results to return.
	// If empty, no further results are available.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

ListInvitationsResponse: Response when listing invitations.

type ListStudentsResponse 

type ListStudentsResponse struct {
	// NextPageToken: Token identifying the next page of results to return.
	// If empty, no further results are available.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Students: The students who match the list request.
	Students []*Student `json:"students,omitempty"`
}

ListStudentsResponse: Response when listing students.

type ListTeachersResponse 

type ListTeachersResponse struct {
	// NextPageToken: Token identifying the next page of results to return.
	// If empty, no further results are available.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Teachers: The teachers who match the list request.
	Teachers []*Teacher `json:"teachers,omitempty"`
}

ListTeachersResponse: Response when listing teachers.

type Name 

type Name struct {
	// FamilyName: The user's last name. Read-only
	FamilyName string `json:"familyName,omitempty"`

	// FullName: The user's full name formed by concatenating the first and
	// last name values. Read-only
	FullName string `json:"fullName,omitempty"`

	// GivenName: The user's first name. Read-only
	GivenName string `json:"givenName,omitempty"`
}

Name: Details of the user's name.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Courses *CoursesService

	Invitations *InvitationsService

	UserProfiles *UserProfilesService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

type Student 

type Student struct {
	// CourseId: Unique identifier of the course. Read-only
	CourseId string `json:"courseId,omitempty"`

	// Profile: Global user information for the student. Read-only
	Profile *UserProfile `json:"profile,omitempty"`

	// UserId: The identifier of the user. When specified as a parameter of
	// request, this field may be set to an alias that identifies the
	// student. The following are supported: * the e-mail address of the
	// user * the string literal "me", indicating that the requesting user
	UserId string `json:"userId,omitempty"`
}

Student: Student in a course.

type Teacher 

type Teacher struct {
	// CourseId: Unique identifier of the course. Read-only
	CourseId string `json:"courseId,omitempty"`

	// Profile: Global user information for the teacher. Read-only
	Profile *UserProfile `json:"profile,omitempty"`

	// UserId: The identifier of the user. When specified as a parameter of
	// request, this field may be set to an alias that identifies the
	// teacher. The following are supported: * the e-mail address of the
	// user * the string literal "me", indicating the requesting user
	UserId string `json:"userId,omitempty"`
}

Teacher: Teacher of a course.

type UserProfile 

type UserProfile struct {
	// EmailAddress: E-mail address of the user. Read-only
	EmailAddress string `json:"emailAddress,omitempty"`

	// Id: Unique identifier of the user. Read-only
	Id string `json:"id,omitempty"`

	// Name: Name of the user. Read-only
	Name *Name `json:"name,omitempty"`

	// Permissions: Global permissions of the user. Read-only
	Permissions []*GlobalPermission `json:"permissions,omitempty"`

	// PhotoUrl: Url of user's profile photo. Read-only
	PhotoUrl string `json:"photoUrl,omitempty"`
}

UserProfile: Global information for a user.

type UserProfilesGetCall 

type UserProfilesGetCall struct {
	// contains filtered or unexported fields
}

func (*UserProfilesGetCall) Do 

func (c *UserProfilesGetCall) Do() (*UserProfile, error)

func (*UserProfilesGetCall) Fields 

func (c *UserProfilesGetCall) Fields(s ...googleapi.Field) *UserProfilesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type UserProfilesService 

type UserProfilesService struct {
	// contains filtered or unexported fields
}

func NewUserProfilesService 

func NewUserProfilesService(s *Service) *UserProfilesService

func (*UserProfilesService) Get 

func (r *UserProfilesService) Get(userId string) *UserProfilesGetCall

Get: Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile. * `NOT_FOUND` if the profile does not exist.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.