api: google.golang.org/api/classroom/v1 Index | Files

package classroom

import "google.golang.org/api/classroom/v1"

Package classroom provides access to the Google Classroom API.

For product documentation, see: https://developers.google.com/classroom/

Creating a client

Usage example:

import "google.golang.org/api/classroom/v1"
...
ctx := context.Background()
classroomService, err := classroom.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

classroomService, err := classroom.NewService(ctx, option.WithScopes(classroom.ClassroomTopicsReadonlyScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

classroomService, err := classroom.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
classroomService, err := classroom.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

classroom-gen.go

Constants

const (
    // View and manage announcements in Google Classroom
    ClassroomAnnouncementsScope = "https://www.googleapis.com/auth/classroom.announcements"

    // View announcements in Google Classroom
    ClassroomAnnouncementsReadonlyScope = "https://www.googleapis.com/auth/classroom.announcements.readonly"

    // 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"

    // Manage your course work and view your grades in Google Classroom
    ClassroomCourseworkMeScope = "https://www.googleapis.com/auth/classroom.coursework.me"

    // View your course work and grades in Google Classroom
    ClassroomCourseworkMeReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.me.readonly"

    // Manage course work and grades for students in the Google Classroom
    // classes you teach and view the course work and grades for classes you
    // administer
    ClassroomCourseworkStudentsScope = "https://www.googleapis.com/auth/classroom.coursework.students"

    // View course work and grades for students in the Google Classroom
    // classes you teach or administer
    ClassroomCourseworkStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.coursework.students.readonly"

    // View your Google Classroom guardians
    ClassroomGuardianlinksMeReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly"

    // View and manage guardians for students in your Google Classroom
    // classes
    ClassroomGuardianlinksStudentsScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students"

    // View guardians for students in your Google Classroom classes
    ClassroomGuardianlinksStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.guardianlinks.students.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"

    // Receive notifications about your Google Classroom data
    ClassroomPushNotificationsScope = "https://www.googleapis.com/auth/classroom.push-notifications"

    // 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"

    // View your course work and grades in Google Classroom
    ClassroomStudentSubmissionsMeReadonlyScope = "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly"

    // View course work and grades for students in the Google Classroom
    // classes you teach or administer
    ClassroomStudentSubmissionsStudentsReadonlyScope = "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"

    // See, create, and edit topics in Google Classroom
    ClassroomTopicsScope = "https://www.googleapis.com/auth/classroom.topics"

    // View topics in Google Classroom
    ClassroomTopicsReadonlyScope = "https://www.googleapis.com/auth/classroom.topics.readonly"
)

OAuth2 scopes used by this API.

type Announcement Uses

type Announcement struct {
    // AlternateLink: Absolute link to this announcement in the Classroom
    // web UI.
    // This is only populated if `state` is `PUBLISHED`.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // AssigneeMode: Assignee mode of the announcement.
    // If unspecified, the default value is `ALL_STUDENTS`.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never
    // returned.
    //   "ALL_STUDENTS" - All students can see the item.
    // This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`

    // CourseId: Identifier of the course.
    //
    // Read-only.
    CourseId string `json:"courseId,omitempty"`

    // CreationTime: Timestamp when this announcement was
    // created.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

    // CreatorUserId: Identifier for the user that created the
    // announcement.
    //
    // Read-only.
    CreatorUserId string `json:"creatorUserId,omitempty"`

    // Id: Classroom-assigned identifier of this announcement, unique per
    // course.
    //
    // Read-only.
    Id  string `json:"id,omitempty"`

    // IndividualStudentsOptions: Identifiers of students with access to the
    // announcement.
    // This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
    // If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only
    // students
    // specified in this field will be able to see the announcement.
    IndividualStudentsOptions *IndividualStudentsOptions `json:"individualStudentsOptions,omitempty"`

    // Materials: Additional materials.
    //
    // Announcements must have no more than 20 material items.
    Materials []*Material `json:"materials,omitempty"`

    // ScheduledTime: Optional timestamp when this announcement is scheduled
    // to be published.
    ScheduledTime string `json:"scheduledTime,omitempty"`

    // State: Status of this announcement.
    // If unspecified, the default state is `DRAFT`.
    //
    // Possible values:
    //   "ANNOUNCEMENT_STATE_UNSPECIFIED" - No state specified. This is
    // never returned.
    //   "PUBLISHED" - Status for announcement that has been published.
    // This is the default state.
    //   "DRAFT" - Status for an announcement that is not yet
    // published.
    // Announcement in this state is visible only to course teachers and
    // domain
    // administrators.
    //   "DELETED" - Status for announcement that was published but is now
    // deleted.
    // Announcement in this state is visible only to course teachers and
    // domain
    // administrators.
    // Announcement in this state is deleted after some time.
    State string `json:"state,omitempty"`

    // Text: Description of this announcement.
    // The text must be a valid UTF-8 string containing no more
    // than 30,000 characters.
    Text string `json:"text,omitempty"`

    // UpdateTime: Timestamp of the most recent change to this
    // announcement.
    //
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AlternateLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Announcement: Announcement created by a teacher for students of the course

func (*Announcement) MarshalJSON Uses

func (s *Announcement) MarshalJSON() ([]byte, error)

type Assignment Uses

type Assignment struct {
    // StudentWorkFolder: Drive folder where attachments from student
    // submissions are placed.
    // This is only populated for course teachers and administrators.
    StudentWorkFolder *DriveFolder `json:"studentWorkFolder,omitempty"`

    // ForceSendFields is a list of field names (e.g. "StudentWorkFolder")
    // to unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "StudentWorkFolder") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Assignment: Additional details for assignments.

func (*Assignment) MarshalJSON Uses

func (s *Assignment) MarshalJSON() ([]byte, error)

type AssignmentSubmission Uses

type AssignmentSubmission struct {
    // Attachments: Attachments added by the student.
    // Drive files that correspond to materials with a share mode
    // of
    // STUDENT_COPY may not exist yet if the student has not accessed
    // the
    // assignment in Classroom.
    //
    // Some attachment metadata is only populated if the requesting user
    // has
    // permission to access it. Identifier and alternate_link fields are
    // always
    // available, but others (e.g. title) may not be.
    Attachments []*Attachment `json:"attachments,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Attachments") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Attachments") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

AssignmentSubmission: Student work for an assignment.

func (*AssignmentSubmission) MarshalJSON Uses

func (s *AssignmentSubmission) MarshalJSON() ([]byte, error)

type Attachment Uses

type Attachment struct {
    // DriveFile: Google Drive file attachment.
    DriveFile *DriveFile `json:"driveFile,omitempty"`

    // Form: Google Forms attachment.
    Form *Form `json:"form,omitempty"`

    // Link: Link attachment.
    Link *Link `json:"link,omitempty"`

    // YouTubeVideo: Youtube video attachment.
    YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DriveFile") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Attachment: Attachment added to student assignment work.

When creating attachments, setting the `form` field is not supported.

func (*Attachment) MarshalJSON Uses

func (s *Attachment) MarshalJSON() ([]byte, error)

type CloudPubsubTopic Uses

type CloudPubsubTopic struct {
    // TopicName: The `name` field of a Cloud
    // Pub/Sub
    // [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1
    // /projects.topics#Topic).
    TopicName string `json:"topicName,omitempty"`

    // ForceSendFields is a list of field names (e.g. "TopicName") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "TopicName") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CloudPubsubTopic: A reference to a Cloud Pub/Sub topic.

To register for notifications, the owner of the topic must grant `classroom-notifications@system.gserviceaccount.com` the

`projects.topics.publish` permission.

func (*CloudPubsubTopic) MarshalJSON Uses

func (s *CloudPubsubTopic) MarshalJSON() ([]byte, error)

type Course Uses

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

    // CalendarId: The Calendar ID for a calendar that all course members
    // can see, to which
    // Classroom adds events for course work and announcements in the
    // course.
    //
    // Read-only.
    CalendarId string `json:"calendarId,omitempty"`

    // CourseGroupEmail: The email address of a Google group containing all
    // members of the course.
    // This group does not accept email and can only be used for
    // permissions.
    //
    // Read-only.
    CourseGroupEmail string `json:"courseGroupEmail,omitempty"`

    // CourseMaterialSets: Sets of materials that appear on the "about" page
    // of this course.
    //
    // Read-only.
    CourseMaterialSets []*CourseMaterialSet `json:"courseMaterialSets,omitempty"`

    // CourseState: State of the course.
    // If unspecified, the default state is `PROVISIONED`.
    //
    // Possible values:
    //   "COURSE_STATE_UNSPECIFIED" - No course state. No returned Course
    // message will use this value.
    //   "ACTIVE" - The course is active.
    //   "ARCHIVED" - The course has been archived. You cannot modify it
    // except to change it
    // to a different state.
    //   "PROVISIONED" - The course has been created, but not yet activated.
    // It is accessible by
    // the primary teacher and domain administrators, who may modify it
    // or
    // change it to the `ACTIVE` or `DECLINED` states.
    // A course may only be changed to `PROVISIONED` if it is in the
    // `DECLINED`
    // state.
    //   "DECLINED" - The course has been created, but declined. It is
    // accessible by the
    // course owner and domain administrators, though it will not
    // be
    // displayed in the web UI. You cannot modify the course except to
    // change it
    // to the `PROVISIONED` state.
    // A course may only be changed to `DECLINED` if it is in the
    // `PROVISIONED`
    // state.
    //   "SUSPENDED" - The course has been suspended. You cannot modify the
    // course, and only the
    // user identified by the `owner_id` can view the course.
    // A course may be placed in this state if it potentially violates
    // the
    // Terms of Service.
    CourseState string `json:"courseState,omitempty"`

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

    // Description: Optional description.
    // For example, "We'll be learning 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 results in an
    // error.
    //
    // Read-only.
    EnrollmentCode string `json:"enrollmentCode,omitempty"`

    // GuardiansEnabled: Whether or not guardian notifications are enabled
    // for this course.
    //
    // Read-only.
    GuardiansEnabled bool `json:"guardiansEnabled,omitempty"`

    // Id: Identifier for this course assigned by Classroom.
    //
    // When
    // creating a course,
    // you may optionally set this identifier to an
    // alias string in the
    // request to create a corresponding alias. The `id` is still assigned
    // by
    // Classroom and cannot be updated after the course is
    // created.
    //
    // Specifying this field in a course update mask results in an error.
    Id  string `json:"id,omitempty"`

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

    // OwnerId: The identifier of the owner of a course.
    //
    // When specified as a parameter of a
    // create course request, this
    // field is required.
    // The identifier can be one of the following:
    //
    // * the numeric identifier for the user
    // * the email address of the user
    // * the string literal "me", indicating the requesting user
    //
    // This must be set in a create request. Admins can also specify this
    // field
    // in a patch course request to
    // transfer ownership. In other contexts, it is read-only.
    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"`

    // TeacherFolder: Information about a Drive Folder that is shared with
    // all teachers of the
    // course.
    //
    // This field will only be set for teachers of the course and
    // domain
    // administrators.
    //
    // Read-only.
    TeacherFolder *DriveFolder `json:"teacherFolder,omitempty"`

    // TeacherGroupEmail: The email address of a Google group containing all
    // teachers of the course.
    // This group does not accept email and can only be used for
    // permissions.
    //
    // Read-only.
    TeacherGroupEmail string `json:"teacherGroupEmail,omitempty"`

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AlternateLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Course: A Course in Classroom.

func (*Course) MarshalJSON Uses

func (s *Course) MarshalJSON() ([]byte, error)

type CourseAlias Uses

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Alias") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Alias") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CourseAlias: Alternative identifier for a course.

An alias uniquely identifies a course. It must 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 can be created only 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 can 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.

func (*CourseAlias) MarshalJSON Uses

func (s *CourseAlias) MarshalJSON() ([]byte, error)

type CourseMaterial Uses

type CourseMaterial struct {
    // DriveFile: Google Drive file attachment.
    DriveFile *DriveFile `json:"driveFile,omitempty"`

    // Form: Google Forms attachment.
    Form *Form `json:"form,omitempty"`

    // Link: Link atatchment.
    Link *Link `json:"link,omitempty"`

    // YouTubeVideo: Youtube video attachment.
    YouTubeVideo *YouTubeVideo `json:"youTubeVideo,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DriveFile") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CourseMaterial: A material attached to a course as part of a material set.

func (*CourseMaterial) MarshalJSON Uses

func (s *CourseMaterial) MarshalJSON() ([]byte, error)

type CourseMaterialSet Uses

type CourseMaterialSet struct {
    // Materials: Materials attached to this set.
    Materials []*CourseMaterial `json:"materials,omitempty"`

    // Title: Title for this set.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Materials") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Materials") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CourseMaterialSet: A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.

func (*CourseMaterialSet) MarshalJSON Uses

func (s *CourseMaterialSet) MarshalJSON() ([]byte, error)

type CourseRosterChangesInfo Uses

type CourseRosterChangesInfo struct {
    // CourseId: The `course_id` of the course to subscribe to roster
    // changes for.
    CourseId string `json:"courseId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CourseRosterChangesInfo: Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.

func (*CourseRosterChangesInfo) MarshalJSON Uses

func (s *CourseRosterChangesInfo) MarshalJSON() ([]byte, error)

type CourseWork Uses

type CourseWork struct {
    // AlternateLink: Absolute link to this course work in the Classroom web
    // UI.
    // This is only populated if `state` is `PUBLISHED`.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // AssigneeMode: Assignee mode of the coursework.
    // If unspecified, the default value is `ALL_STUDENTS`.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never
    // returned.
    //   "ALL_STUDENTS" - All students can see the item.
    // This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`

    // Assignment: Assignment details.
    // This is populated only when `work_type` is `ASSIGNMENT`.
    //
    // Read-only.
    Assignment *Assignment `json:"assignment,omitempty"`

    // AssociatedWithDeveloper: Whether this course work item is associated
    // with the Developer Console
    // project making the request.
    //
    // See google.classroom.Work.CreateCourseWork for
    // more
    // details.
    //
    // Read-only.
    AssociatedWithDeveloper bool `json:"associatedWithDeveloper,omitempty"`

    // CourseId: Identifier of the course.
    //
    // Read-only.
    CourseId string `json:"courseId,omitempty"`

    // CreationTime: Timestamp when this course work was
    // created.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

    // CreatorUserId: Identifier for the user that created the
    // coursework.
    //
    // Read-only.
    CreatorUserId string `json:"creatorUserId,omitempty"`

    // Description: Optional description of this course work.
    // If set, the description must be a valid UTF-8 string containing no
    // more
    // than 30,000 characters.
    Description string `json:"description,omitempty"`

    // DueDate: Optional date, in UTC, that submissions for this course work
    // are due.
    // This must be specified if `due_time` is specified.
    DueDate *Date `json:"dueDate,omitempty"`

    // DueTime: Optional time of day, in UTC, that submissions for this
    // course work
    // are due.
    // This must be specified if `due_date` is specified.
    DueTime *TimeOfDay `json:"dueTime,omitempty"`

    // Id: Classroom-assigned identifier of this course work, unique per
    // course.
    //
    // Read-only.
    Id  string `json:"id,omitempty"`

    // IndividualStudentsOptions: Identifiers of students with access to the
    // coursework.
    // This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.
    // If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only
    // students
    // specified in this field will be assigned the coursework.
    IndividualStudentsOptions *IndividualStudentsOptions `json:"individualStudentsOptions,omitempty"`

    // Materials: Additional materials.
    //
    // CourseWork must have no more than 20 material items.
    Materials []*Material `json:"materials,omitempty"`

    // MaxPoints: Maximum grade for this course work.
    // If zero or unspecified, this assignment is considered ungraded.
    // This must be a non-negative integer value.
    MaxPoints float64 `json:"maxPoints,omitempty"`

    // MultipleChoiceQuestion: Multiple choice question details.
    // For read operations, this field is populated only when `work_type`
    // is
    // `MULTIPLE_CHOICE_QUESTION`.
    // For write operations, this field must be specified when creating
    // course
    // work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must
    // not be
    // set otherwise.
    MultipleChoiceQuestion *MultipleChoiceQuestion `json:"multipleChoiceQuestion,omitempty"`

    // ScheduledTime: Optional timestamp when this course work is scheduled
    // to be published.
    ScheduledTime string `json:"scheduledTime,omitempty"`

    // State: Status of this course work.
    // If unspecified, the default state is `DRAFT`.
    //
    // Possible values:
    //   "COURSE_WORK_STATE_UNSPECIFIED" - No state specified. This is never
    // returned.
    //   "PUBLISHED" - Status for work that has been published.
    // This is the default state.
    //   "DRAFT" - Status for work that is not yet published.
    // Work in this state is visible only to course teachers and
    // domain
    // administrators.
    //   "DELETED" - Status for work that was published but is now
    // deleted.
    // Work in this state is visible only to course teachers and
    // domain
    // administrators.
    // Work in this state is deleted after some time.
    State string `json:"state,omitempty"`

    // SubmissionModificationMode: Setting to determine when students are
    // allowed to modify submissions.
    // If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
    //
    // Possible values:
    //   "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED" - No modification mode
    // specified. This is never returned.
    //   "MODIFIABLE_UNTIL_TURNED_IN" - Submissions can be modified before
    // being turned in.
    //   "MODIFIABLE" - Submissions can be modified at any time.
    SubmissionModificationMode string `json:"submissionModificationMode,omitempty"`

    // Title: Title of this course work.
    // The title must be a valid UTF-8 string containing between 1 and
    // 3000
    // characters.
    Title string `json:"title,omitempty"`

    // TopicId: Identifier for the topic that this coursework is associated
    // with.
    // Must match an existing topic in the course.
    TopicId string `json:"topicId,omitempty"`

    // UpdateTime: Timestamp of the most recent change to this course
    // work.
    //
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // WorkType: Type of this course work.
    //
    // The type is set when the course work is created and cannot be
    // changed.
    //
    // Possible values:
    //   "COURSE_WORK_TYPE_UNSPECIFIED" - No work type specified. This is
    // never returned.
    //   "ASSIGNMENT" - An assignment.
    //   "SHORT_ANSWER_QUESTION" - A short answer question.
    //   "MULTIPLE_CHOICE_QUESTION" - A multiple-choice question.
    WorkType string `json:"workType,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AlternateLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CourseWork: Course work created by a teacher for students of the course.

func (*CourseWork) MarshalJSON Uses

func (s *CourseWork) MarshalJSON() ([]byte, error)

func (*CourseWork) UnmarshalJSON Uses

func (s *CourseWork) UnmarshalJSON(data []byte) error

type CourseWorkChangesInfo Uses

type CourseWorkChangesInfo struct {
    // CourseId: The `course_id` of the course to subscribe to work changes
    // for.
    CourseId string `json:"courseId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CourseWorkChangesInfo: Information about a `Feed` with a `feed_type` of `COURSE_WORK_CHANGES`.

func (*CourseWorkChangesInfo) MarshalJSON Uses

func (s *CourseWorkChangesInfo) MarshalJSON() ([]byte, error)

type CoursesAliasesCreateCall Uses

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

func (*CoursesAliasesCreateCall) Context Uses

func (c *CoursesAliasesCreateCall) Context(ctx context.Context) *CoursesAliasesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAliasesCreateCall) Do Uses

func (c *CoursesAliasesCreateCall) Do(opts ...googleapi.CallOption) (*CourseAlias, error)

Do executes the "classroom.courses.aliases.create" call. Exactly one of *CourseAlias or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CourseAlias.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAliasesCreateCall) Fields Uses

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.

func (*CoursesAliasesCreateCall) Header Uses

func (c *CoursesAliasesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesAliasesDeleteCall Uses

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

func (*CoursesAliasesDeleteCall) Context Uses

func (c *CoursesAliasesDeleteCall) Context(ctx context.Context) *CoursesAliasesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAliasesDeleteCall) Do Uses

func (c *CoursesAliasesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.aliases.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAliasesDeleteCall) Fields Uses

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.

func (*CoursesAliasesDeleteCall) Header Uses

func (c *CoursesAliasesDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesAliasesListCall Uses

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

func (*CoursesAliasesListCall) Context Uses

func (c *CoursesAliasesListCall) Context(ctx context.Context) *CoursesAliasesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAliasesListCall) Do Uses

func (c *CoursesAliasesListCall) Do(opts ...googleapi.CallOption) (*ListCourseAliasesResponse, error)

Do executes the "classroom.courses.aliases.list" call. Exactly one of *ListCourseAliasesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListCourseAliasesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAliasesListCall) Fields Uses

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) Header Uses

func (c *CoursesAliasesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesAliasesListCall) IfNoneMatch Uses

func (c *CoursesAliasesListCall) IfNoneMatch(entityTag string) *CoursesAliasesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesAliasesListCall) PageSize Uses

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 Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesAliasesListCall) Pages Uses

func (c *CoursesAliasesListCall) Pages(ctx context.Context, f func(*ListCourseAliasesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesAliasesService Uses

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

func NewCoursesAliasesService Uses

func NewCoursesAliasesService(s *Service) *CoursesAliasesService

func (*CoursesAliasesService) Create Uses

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

Create: Creates an alias for a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the

requesting user or course (for example, if a user not in a domain
attempts to access a domain-scoped alias).

func (*CoursesAliasesService) Delete Uses

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 or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the

requesting user or course (for example, if a user not in a domain
attempts to delete a domain-scoped alias).

func (*CoursesAliasesService) List Uses

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

List: Returns a list of aliases for a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.

type CoursesAnnouncementsCreateCall Uses

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

func (*CoursesAnnouncementsCreateCall) Context Uses

func (c *CoursesAnnouncementsCreateCall) Context(ctx context.Context) *CoursesAnnouncementsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAnnouncementsCreateCall) Do Uses

func (c *CoursesAnnouncementsCreateCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.create" call. Exactly one of *Announcement or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsCreateCall) Fields Uses

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

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

func (*CoursesAnnouncementsCreateCall) Header Uses

func (c *CoursesAnnouncementsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesAnnouncementsDeleteCall Uses

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

func (*CoursesAnnouncementsDeleteCall) Context Uses

func (c *CoursesAnnouncementsDeleteCall) Context(ctx context.Context) *CoursesAnnouncementsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAnnouncementsDeleteCall) Do Uses

func (c *CoursesAnnouncementsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.announcements.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsDeleteCall) Fields Uses

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

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

func (*CoursesAnnouncementsDeleteCall) Header Uses

func (c *CoursesAnnouncementsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesAnnouncementsGetCall Uses

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

func (*CoursesAnnouncementsGetCall) Context Uses

func (c *CoursesAnnouncementsGetCall) Context(ctx context.Context) *CoursesAnnouncementsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAnnouncementsGetCall) Do Uses

func (c *CoursesAnnouncementsGetCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.get" call. Exactly one of *Announcement or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsGetCall) Fields Uses

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

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

func (*CoursesAnnouncementsGetCall) Header Uses

func (c *CoursesAnnouncementsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesAnnouncementsGetCall) IfNoneMatch Uses

func (c *CoursesAnnouncementsGetCall) IfNoneMatch(entityTag string) *CoursesAnnouncementsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesAnnouncementsListCall Uses

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

func (*CoursesAnnouncementsListCall) AnnouncementStates Uses

func (c *CoursesAnnouncementsListCall) AnnouncementStates(announcementStates ...string) *CoursesAnnouncementsListCall

AnnouncementStates sets the optional parameter "announcementStates": Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.

Possible values:

"ANNOUNCEMENT_STATE_UNSPECIFIED"
"PUBLISHED"
"DRAFT"
"DELETED"

func (*CoursesAnnouncementsListCall) Context Uses

func (c *CoursesAnnouncementsListCall) Context(ctx context.Context) *CoursesAnnouncementsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAnnouncementsListCall) Do Uses

func (c *CoursesAnnouncementsListCall) Do(opts ...googleapi.CallOption) (*ListAnnouncementsResponse, error)

Do executes the "classroom.courses.announcements.list" call. Exactly one of *ListAnnouncementsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAnnouncementsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsListCall) Fields Uses

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

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

func (*CoursesAnnouncementsListCall) Header Uses

func (c *CoursesAnnouncementsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesAnnouncementsListCall) IfNoneMatch Uses

func (c *CoursesAnnouncementsListCall) IfNoneMatch(entityTag string) *CoursesAnnouncementsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesAnnouncementsListCall) OrderBy Uses

func (c *CoursesAnnouncementsListCall) OrderBy(orderBy string) *CoursesAnnouncementsListCall

OrderBy sets the optional parameter "orderBy": Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`

func (*CoursesAnnouncementsListCall) PageSize Uses

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

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 (*CoursesAnnouncementsListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesAnnouncementsListCall) Pages Uses

func (c *CoursesAnnouncementsListCall) Pages(ctx context.Context, f func(*ListAnnouncementsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesAnnouncementsModifyAssigneesCall Uses

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

func (*CoursesAnnouncementsModifyAssigneesCall) Context Uses

func (c *CoursesAnnouncementsModifyAssigneesCall) Context(ctx context.Context) *CoursesAnnouncementsModifyAssigneesCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAnnouncementsModifyAssigneesCall) Do Uses

func (c *CoursesAnnouncementsModifyAssigneesCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.modifyAssignees" call. Exactly one of *Announcement or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsModifyAssigneesCall) Fields Uses

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

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

func (*CoursesAnnouncementsModifyAssigneesCall) Header Uses

func (c *CoursesAnnouncementsModifyAssigneesCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesAnnouncementsPatchCall Uses

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

func (*CoursesAnnouncementsPatchCall) Context Uses

func (c *CoursesAnnouncementsPatchCall) Context(ctx context.Context) *CoursesAnnouncementsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesAnnouncementsPatchCall) Do Uses

func (c *CoursesAnnouncementsPatchCall) Do(opts ...googleapi.CallOption) (*Announcement, error)

Do executes the "classroom.courses.announcements.patch" call. Exactly one of *Announcement or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Announcement.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesAnnouncementsPatchCall) Fields Uses

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

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

func (*CoursesAnnouncementsPatchCall) Header Uses

func (c *CoursesAnnouncementsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesAnnouncementsPatchCall) UpdateMask Uses

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

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned.

The following fields may be specified by teachers:

* `text` * `state` * `scheduled_time`

type CoursesAnnouncementsService Uses

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

func NewCoursesAnnouncementsService Uses

func NewCoursesAnnouncementsService(s *Service) *CoursesAnnouncementsService

func (*CoursesAnnouncementsService) Create Uses

func (r *CoursesAnnouncementsService) Create(courseId string, announcement *Announcement) *CoursesAnnouncementsCreateCall

Create: Creates an announcement.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error:

* AttachmentNotVisible

func (*CoursesAnnouncementsService) Delete Uses

func (r *CoursesAnnouncementsService) Delete(courseId string, id string) *CoursesAnnouncementsDeleteCall

Delete: Deletes an announcement.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesAnnouncementsService) Get Uses

func (r *CoursesAnnouncementsService) Get(courseId string, id string) *CoursesAnnouncementsGetCall

Get: Returns an announcement.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.

func (*CoursesAnnouncementsService) List Uses

func (r *CoursesAnnouncementsService) List(courseId string) *CoursesAnnouncementsListCall

List: Returns a list of announcements that the requester is permitted to view.

Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

func (*CoursesAnnouncementsService) ModifyAssignees Uses

func (r *CoursesAnnouncementsService) ModifyAssignees(courseId string, id string, modifyannouncementassigneesrequest *ModifyAnnouncementAssigneesRequest) *CoursesAnnouncementsModifyAssigneesCall

ModifyAssignees: Modifies assignee mode and options of an announcement.

Only a teacher of the course that contains the announcement may call this method.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

func (*CoursesAnnouncementsService) Patch Uses

func (r *CoursesAnnouncementsService) Patch(courseId string, id string, announcement *Announcement) *CoursesAnnouncementsPatchCall

Patch: Updates one or more fields of an announcement.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist

type CoursesCourseWorkCreateCall Uses

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

func (*CoursesCourseWorkCreateCall) Context Uses

func (c *CoursesCourseWorkCreateCall) Context(ctx context.Context) *CoursesCourseWorkCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkCreateCall) Do Uses

func (c *CoursesCourseWorkCreateCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.create" call. Exactly one of *CourseWork or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkCreateCall) Fields Uses

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

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

func (*CoursesCourseWorkCreateCall) Header Uses

func (c *CoursesCourseWorkCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesCourseWorkDeleteCall Uses

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

func (*CoursesCourseWorkDeleteCall) Context Uses

func (c *CoursesCourseWorkDeleteCall) Context(ctx context.Context) *CoursesCourseWorkDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkDeleteCall) Do Uses

func (c *CoursesCourseWorkDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkDeleteCall) Fields Uses

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

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

func (*CoursesCourseWorkDeleteCall) Header Uses

func (c *CoursesCourseWorkDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesCourseWorkGetCall Uses

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

func (*CoursesCourseWorkGetCall) Context Uses

func (c *CoursesCourseWorkGetCall) Context(ctx context.Context) *CoursesCourseWorkGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkGetCall) Do Uses

func (c *CoursesCourseWorkGetCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.get" call. Exactly one of *CourseWork or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkGetCall) Fields Uses

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

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

func (*CoursesCourseWorkGetCall) Header Uses

func (c *CoursesCourseWorkGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesCourseWorkGetCall) IfNoneMatch Uses

func (c *CoursesCourseWorkGetCall) IfNoneMatch(entityTag string) *CoursesCourseWorkGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesCourseWorkListCall Uses

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

func (*CoursesCourseWorkListCall) Context Uses

func (c *CoursesCourseWorkListCall) Context(ctx context.Context) *CoursesCourseWorkListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkListCall) CourseWorkStates Uses

func (c *CoursesCourseWorkListCall) CourseWorkStates(courseWorkStates ...string) *CoursesCourseWorkListCall

CourseWorkStates sets the optional parameter "courseWorkStates": Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.

Possible values:

"COURSE_WORK_STATE_UNSPECIFIED"
"PUBLISHED"
"DRAFT"
"DELETED"

func (*CoursesCourseWorkListCall) Do Uses

func (c *CoursesCourseWorkListCall) Do(opts ...googleapi.CallOption) (*ListCourseWorkResponse, error)

Do executes the "classroom.courses.courseWork.list" call. Exactly one of *ListCourseWorkResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListCourseWorkResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkListCall) Fields Uses

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

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

func (*CoursesCourseWorkListCall) Header Uses

func (c *CoursesCourseWorkListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesCourseWorkListCall) IfNoneMatch Uses

func (c *CoursesCourseWorkListCall) IfNoneMatch(entityTag string) *CoursesCourseWorkListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesCourseWorkListCall) OrderBy Uses

func (c *CoursesCourseWorkListCall) OrderBy(orderBy string) *CoursesCourseWorkListCall

OrderBy sets the optional parameter "orderBy": Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`

func (*CoursesCourseWorkListCall) PageSize Uses

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

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 (*CoursesCourseWorkListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesCourseWorkListCall) Pages Uses

func (c *CoursesCourseWorkListCall) Pages(ctx context.Context, f func(*ListCourseWorkResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesCourseWorkModifyAssigneesCall Uses

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

func (*CoursesCourseWorkModifyAssigneesCall) Context Uses

func (c *CoursesCourseWorkModifyAssigneesCall) Context(ctx context.Context) *CoursesCourseWorkModifyAssigneesCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkModifyAssigneesCall) Do Uses

func (c *CoursesCourseWorkModifyAssigneesCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.modifyAssignees" call. Exactly one of *CourseWork or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkModifyAssigneesCall) Fields Uses

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

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

func (*CoursesCourseWorkModifyAssigneesCall) Header Uses

func (c *CoursesCourseWorkModifyAssigneesCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesCourseWorkPatchCall Uses

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

func (*CoursesCourseWorkPatchCall) Context Uses

func (c *CoursesCourseWorkPatchCall) Context(ctx context.Context) *CoursesCourseWorkPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkPatchCall) Do Uses

func (c *CoursesCourseWorkPatchCall) Do(opts ...googleapi.CallOption) (*CourseWork, error)

Do executes the "classroom.courses.courseWork.patch" call. Exactly one of *CourseWork or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CourseWork.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkPatchCall) Fields Uses

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

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

func (*CoursesCourseWorkPatchCall) Header Uses

func (c *CoursesCourseWorkPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesCourseWorkPatchCall) UpdateMask Uses

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

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned.

The following fields may be specified by teachers:

* `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`

type CoursesCourseWorkService Uses

type CoursesCourseWorkService struct {
    StudentSubmissions *CoursesCourseWorkStudentSubmissionsService
    // contains filtered or unexported fields
}

func NewCoursesCourseWorkService Uses

func NewCoursesCourseWorkService(s *Service) *CoursesCourseWorkService

func (*CoursesCourseWorkService) Create Uses

func (r *CoursesCourseWorkService) Create(courseId string, coursework *CourseWork) *CoursesCourseWorkCreateCall

Create: Creates course work.

The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error:

* AttachmentNotVisible

func (*CoursesCourseWorkService) Delete Uses

func (r *CoursesCourseWorkService) Delete(courseId string, id string) *CoursesCourseWorkDeleteCall

Delete: Deletes a course work.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesCourseWorkService) Get Uses

func (r *CoursesCourseWorkService) Get(courseId string, id string) *CoursesCourseWorkGetCall

Get: Returns course work.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

func (*CoursesCourseWorkService) List Uses

func (r *CoursesCourseWorkService) List(courseId string) *CoursesCourseWorkListCall

List: Returns a list of course work that the requester is permitted to view.

Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

func (*CoursesCourseWorkService) ModifyAssignees Uses

func (r *CoursesCourseWorkService) ModifyAssignees(courseId string, id string, modifycourseworkassigneesrequest *ModifyCourseWorkAssigneesRequest) *CoursesCourseWorkModifyAssigneesCall

ModifyAssignees: Modifies assignee mode and options of a coursework.

Only a teacher of the course that contains the coursework may call this method.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

func (*CoursesCourseWorkService) Patch Uses

func (r *CoursesCourseWorkService) Patch(courseId string, id string, coursework *CourseWork) *CoursesCourseWorkPatchCall

Patch: Updates one or more fields of a course work.

See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

type CoursesCourseWorkStudentSubmissionsGetCall Uses

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

func (*CoursesCourseWorkStudentSubmissionsGetCall) Context Uses

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsGetCall) Do Uses

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Do(opts ...googleapi.CallOption) (*StudentSubmission, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.get" call. Exactly one of *StudentSubmission or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *StudentSubmission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsGetCall) Fields Uses

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

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

func (*CoursesCourseWorkStudentSubmissionsGetCall) Header Uses

func (c *CoursesCourseWorkStudentSubmissionsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesCourseWorkStudentSubmissionsGetCall) IfNoneMatch Uses

func (c *CoursesCourseWorkStudentSubmissionsGetCall) IfNoneMatch(entityTag string) *CoursesCourseWorkStudentSubmissionsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesCourseWorkStudentSubmissionsListCall Uses

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

func (*CoursesCourseWorkStudentSubmissionsListCall) Context Uses

func (c *CoursesCourseWorkStudentSubmissionsListCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsListCall) Do Uses

func (c *CoursesCourseWorkStudentSubmissionsListCall) Do(opts ...googleapi.CallOption) (*ListStudentSubmissionsResponse, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.list" call. Exactly one of *ListStudentSubmissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListStudentSubmissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsListCall) Fields Uses

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

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

func (*CoursesCourseWorkStudentSubmissionsListCall) Header Uses

func (c *CoursesCourseWorkStudentSubmissionsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesCourseWorkStudentSubmissionsListCall) IfNoneMatch Uses

func (c *CoursesCourseWorkStudentSubmissionsListCall) IfNoneMatch(entityTag string) *CoursesCourseWorkStudentSubmissionsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesCourseWorkStudentSubmissionsListCall) Late Uses

func (c *CoursesCourseWorkStudentSubmissionsListCall) Late(late string) *CoursesCourseWorkStudentSubmissionsListCall

Late sets the optional parameter "late": Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.

Possible values:

"LATE_VALUES_UNSPECIFIED"
"LATE_ONLY"
"NOT_LATE_ONLY"

func (*CoursesCourseWorkStudentSubmissionsListCall) PageSize Uses

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

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 (*CoursesCourseWorkStudentSubmissionsListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesCourseWorkStudentSubmissionsListCall) Pages Uses

func (c *CoursesCourseWorkStudentSubmissionsListCall) Pages(ctx context.Context, f func(*ListStudentSubmissionsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*CoursesCourseWorkStudentSubmissionsListCall) States Uses

func (c *CoursesCourseWorkStudentSubmissionsListCall) States(states ...string) *CoursesCourseWorkStudentSubmissionsListCall

States sets the optional parameter "states": Requested submission states. If specified, returned student submissions match one of the specified submission states.

Possible values:

"SUBMISSION_STATE_UNSPECIFIED"
"NEW"
"CREATED"
"TURNED_IN"
"RETURNED"
"RECLAIMED_BY_STUDENT"

func (*CoursesCourseWorkStudentSubmissionsListCall) UserId Uses

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

UserId sets the optional parameter "userId": Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following:

* the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

type CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall Uses

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

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Context Uses

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Do Uses

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Do(opts ...googleapi.CallOption) (*StudentSubmission, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.modifyAttachments" call. Exactly one of *StudentSubmission or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *StudentSubmission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Fields Uses

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

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

func (*CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Header Uses

func (c *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesCourseWorkStudentSubmissionsPatchCall Uses

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Context Uses

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Do Uses

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Do(opts ...googleapi.CallOption) (*StudentSubmission, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.patch" call. Exactly one of *StudentSubmission or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *StudentSubmission.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Fields Uses

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

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

func (*CoursesCourseWorkStudentSubmissionsPatchCall) Header Uses

func (c *CoursesCourseWorkStudentSubmissionsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesCourseWorkStudentSubmissionsPatchCall) UpdateMask Uses

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

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified.

The following fields may be specified by teachers:

* `draft_grade` * `assigned_grade`

type CoursesCourseWorkStudentSubmissionsReclaimCall Uses

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

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Context Uses

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsReclaimCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Do Uses

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.reclaim" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Fields Uses

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

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

func (*CoursesCourseWorkStudentSubmissionsReclaimCall) Header Uses

func (c *CoursesCourseWorkStudentSubmissionsReclaimCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesCourseWorkStudentSubmissionsReturnCall Uses

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

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Context Uses

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsReturnCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Do Uses

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.return" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Fields Uses

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

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

func (*CoursesCourseWorkStudentSubmissionsReturnCall) Header Uses

func (c *CoursesCourseWorkStudentSubmissionsReturnCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesCourseWorkStudentSubmissionsService Uses

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

func NewCoursesCourseWorkStudentSubmissionsService Uses

func NewCoursesCourseWorkStudentSubmissionsService(s *Service) *CoursesCourseWorkStudentSubmissionsService

func (*CoursesCourseWorkStudentSubmissionsService) Get Uses

func (r *CoursesCourseWorkStudentSubmissionsService) Get(courseId string, courseWorkId string, id string) *CoursesCourseWorkStudentSubmissionsGetCall

Get: Returns a student submission.

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) List Uses

func (r *CoursesCourseWorkStudentSubmissionsService) List(courseId string, courseWorkId string) *CoursesCourseWorkStudentSubmissionsListCall

List: Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items.

Course students may only view their own work. Course teachers and domain administrators may view all student submissions.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) ModifyAttachments Uses

func (r *CoursesCourseWorkStudentSubmissionsService) ModifyAttachments(courseId string, courseWorkId string, id string, modifyattachmentsrequest *ModifyAttachmentsRequest) *CoursesCourseWorkStudentSubmissionsModifyAttachmentsCall

ModifyAttachments: Modifies attachments of student submission.

Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) Patch Uses

func (r *CoursesCourseWorkStudentSubmissionsService) Patch(courseId string, courseWorkId string, id string, studentsubmission *StudentSubmission) *CoursesCourseWorkStudentSubmissionsPatchCall

Patch: Updates one or more fields of a student submission.

See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) Reclaim Uses

func (r *CoursesCourseWorkStudentSubmissionsService) Reclaim(courseId string, courseWorkId string, id string, reclaimstudentsubmissionrequest *ReclaimStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsReclaimCall

Reclaim: Reclaims a student submission on behalf of the student that owns it.

Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state.

Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) Return Uses

func (r *CoursesCourseWorkStudentSubmissionsService) Return(courseId string, courseWorkId string, id string, returnstudentsubmissionrequest *ReturnStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsReturnCall

Return: Returns a student submission.

Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value.

Only a teacher of the course that contains the requested student submission may call this method.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

func (*CoursesCourseWorkStudentSubmissionsService) TurnIn Uses

func (r *CoursesCourseWorkStudentSubmissionsService) TurnIn(courseId string, courseWorkId string, id string, turninstudentsubmissionrequest *TurnInStudentSubmissionRequest) *CoursesCourseWorkStudentSubmissionsTurnInCall

TurnIn: Turns in a student submission.

Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state.

This may only be called by the student that owns the specified student submission.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

type CoursesCourseWorkStudentSubmissionsTurnInCall Uses

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

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Context Uses

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Context(ctx context.Context) *CoursesCourseWorkStudentSubmissionsTurnInCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Do Uses

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.courseWork.studentSubmissions.turnIn" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Fields Uses

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

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

func (*CoursesCourseWorkStudentSubmissionsTurnInCall) Header Uses

func (c *CoursesCourseWorkStudentSubmissionsTurnInCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesCreateCall Uses

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

func (*CoursesCreateCall) Context Uses

func (c *CoursesCreateCall) Context(ctx context.Context) *CoursesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesCreateCall) Do Uses

func (c *CoursesCreateCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.create" call. Exactly one of *Course or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesCreateCall) Fields Uses

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.

func (*CoursesCreateCall) Header Uses

func (c *CoursesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesDeleteCall Uses

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

func (*CoursesDeleteCall) Context Uses

func (c *CoursesDeleteCall) Context(ctx context.Context) *CoursesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesDeleteCall) Do Uses

func (c *CoursesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesDeleteCall) Fields Uses

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.

func (*CoursesDeleteCall) Header Uses

func (c *CoursesDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesGetCall Uses

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

func (*CoursesGetCall) Context Uses

func (c *CoursesGetCall) Context(ctx context.Context) *CoursesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesGetCall) Do Uses

func (c *CoursesGetCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.get" call. Exactly one of *Course or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesGetCall) Fields Uses

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.

func (*CoursesGetCall) Header Uses

func (c *CoursesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesGetCall) IfNoneMatch Uses

func (c *CoursesGetCall) IfNoneMatch(entityTag string) *CoursesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesListCall Uses

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

func (*CoursesListCall) Context Uses

func (c *CoursesListCall) Context(ctx context.Context) *CoursesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesListCall) CourseStates Uses

func (c *CoursesListCall) CourseStates(courseStates ...string) *CoursesListCall

CourseStates sets the optional parameter "courseStates": Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

Possible values:

"COURSE_STATE_UNSPECIFIED"
"ACTIVE"
"ARCHIVED"
"PROVISIONED"
"DECLINED"
"SUSPENDED"

func (*CoursesListCall) Do Uses

func (c *CoursesListCall) Do(opts ...googleapi.CallOption) (*ListCoursesResponse, error)

Do executes the "classroom.courses.list" call. Exactly one of *ListCoursesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListCoursesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesListCall) Fields Uses

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) Header Uses

func (c *CoursesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesListCall) IfNoneMatch Uses

func (c *CoursesListCall) IfNoneMatch(entityTag string) *CoursesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesListCall) PageSize Uses

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 Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesListCall) Pages Uses

func (c *CoursesListCall) Pages(ctx context.Context, f func(*ListCoursesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*CoursesListCall) StudentId Uses

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. The identifier can be one of the following:

* the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

func (*CoursesListCall) TeacherId Uses

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. The identifier can be one of the following:

* the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

type CoursesPatchCall Uses

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

func (*CoursesPatchCall) Context Uses

func (c *CoursesPatchCall) Context(ctx context.Context) *CoursesPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesPatchCall) Do Uses

func (c *CoursesPatchCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.patch" call. Exactly one of *Course or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesPatchCall) Fields Uses

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) Header Uses

func (c *CoursesPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesPatchCall) UpdateMask Uses

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

UpdateMask sets the optional parameter "updateMask": Mask that 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. The following fields are valid:

* `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId`

Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete.

When set in a query parameter, this field should be specified as

`updateMask=<field1>,<field2>,...`

type CoursesService Uses

type CoursesService struct {
    Aliases *CoursesAliasesService

    Announcements *CoursesAnnouncementsService

    CourseWork *CoursesCourseWorkService

    Students *CoursesStudentsService

    Teachers *CoursesTeachersService

    Topics *CoursesTopicsService
    // contains filtered or unexported fields
}

func NewCoursesService Uses

func NewCoursesService(s *Service) *CoursesService

func (*CoursesService) Create Uses

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

Create: Creates a course.

The user specified in `ownerId` 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 or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors:

* UserGroupsMembershipLimitReached

* `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.

func (*CoursesService) Delete Uses

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 or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesService) Get Uses

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 or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

func (*CoursesService) List Uses

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. Returned courses are ordered by creation time, with the most recently created coming first.

This method returns the following error codes:

* `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

func (*CoursesService) Patch Uses

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

Patch: Updates one or more fields in a course.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `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. * `FAILED_PRECONDITION` for the following request errors:

* CourseNotModifiable

func (*CoursesService) Update Uses

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 or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors:

* CourseNotModifiable

type CoursesStudentsCreateCall Uses

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

func (*CoursesStudentsCreateCall) Context Uses

func (c *CoursesStudentsCreateCall) Context(ctx context.Context) *CoursesStudentsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsCreateCall) Do Uses

func (c *CoursesStudentsCreateCall) Do(opts ...googleapi.CallOption) (*Student, error)

Do executes the "classroom.courses.students.create" call. Exactly one of *Student or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Student.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsCreateCall) EnrollmentCode Uses

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

EnrollmentCode sets the optional parameter "enrollmentCode": Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.

func (*CoursesStudentsCreateCall) Fields Uses

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.

func (*CoursesStudentsCreateCall) Header Uses

func (c *CoursesStudentsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesStudentsDeleteCall Uses

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

func (*CoursesStudentsDeleteCall) Context Uses

func (c *CoursesStudentsDeleteCall) Context(ctx context.Context) *CoursesStudentsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsDeleteCall) Do Uses

func (c *CoursesStudentsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.students.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsDeleteCall) Fields Uses

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.

func (*CoursesStudentsDeleteCall) Header Uses

func (c *CoursesStudentsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesStudentsGetCall Uses

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

func (*CoursesStudentsGetCall) Context Uses

func (c *CoursesStudentsGetCall) Context(ctx context.Context) *CoursesStudentsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsGetCall) Do Uses

func (c *CoursesStudentsGetCall) Do(opts ...googleapi.CallOption) (*Student, error)

Do executes the "classroom.courses.students.get" call. Exactly one of *Student or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Student.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsGetCall) Fields Uses

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.

func (*CoursesStudentsGetCall) Header Uses

func (c *CoursesStudentsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesStudentsGetCall) IfNoneMatch Uses

func (c *CoursesStudentsGetCall) IfNoneMatch(entityTag string) *CoursesStudentsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesStudentsListCall Uses

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

func (*CoursesStudentsListCall) Context Uses

func (c *CoursesStudentsListCall) Context(ctx context.Context) *CoursesStudentsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesStudentsListCall) Do Uses

func (c *CoursesStudentsListCall) Do(opts ...googleapi.CallOption) (*ListStudentsResponse, error)

Do executes the "classroom.courses.students.list" call. Exactly one of *ListStudentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListStudentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesStudentsListCall) Fields Uses

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) Header Uses

func (c *CoursesStudentsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesStudentsListCall) IfNoneMatch Uses

func (c *CoursesStudentsListCall) IfNoneMatch(entityTag string) *CoursesStudentsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesStudentsListCall) PageSize Uses

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 Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesStudentsListCall) Pages Uses

func (c *CoursesStudentsListCall) Pages(ctx context.Context, f func(*ListStudentsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesStudentsService Uses

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

func NewCoursesStudentsService Uses

func NewCoursesStudentsService(s *Service) *CoursesStudentsService

func (*CoursesStudentsService) Create Uses

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 or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors:

* CourseMemberLimitReached
* CourseNotModifiable
* UserGroupsMembershipLimitReached

* `ALREADY_EXISTS` if the user is already a student or teacher in the course.

func (*CoursesStudentsService) Delete Uses

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 or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

func (*CoursesStudentsService) Get Uses

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 or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

func (*CoursesStudentsService) List Uses

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

List: Returns a list of students of this course that the requester is permitted to view.

This method returns the following error codes:

* `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

type CoursesTeachersCreateCall Uses

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

func (*CoursesTeachersCreateCall) Context Uses

func (c *CoursesTeachersCreateCall) Context(ctx context.Context) *CoursesTeachersCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersCreateCall) Do Uses

func (c *CoursesTeachersCreateCall) Do(opts ...googleapi.CallOption) (*Teacher, error)

Do executes the "classroom.courses.teachers.create" call. Exactly one of *Teacher or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Teacher.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersCreateCall) Fields Uses

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.

func (*CoursesTeachersCreateCall) Header Uses

func (c *CoursesTeachersCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesTeachersDeleteCall Uses

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

func (*CoursesTeachersDeleteCall) Context Uses

func (c *CoursesTeachersDeleteCall) Context(ctx context.Context) *CoursesTeachersDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersDeleteCall) Do Uses

func (c *CoursesTeachersDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.teachers.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersDeleteCall) Fields Uses

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.

func (*CoursesTeachersDeleteCall) Header Uses

func (c *CoursesTeachersDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesTeachersGetCall Uses

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

func (*CoursesTeachersGetCall) Context Uses

func (c *CoursesTeachersGetCall) Context(ctx context.Context) *CoursesTeachersGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersGetCall) Do Uses

func (c *CoursesTeachersGetCall) Do(opts ...googleapi.CallOption) (*Teacher, error)

Do executes the "classroom.courses.teachers.get" call. Exactly one of *Teacher or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Teacher.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersGetCall) Fields Uses

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.

func (*CoursesTeachersGetCall) Header Uses

func (c *CoursesTeachersGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesTeachersGetCall) IfNoneMatch Uses

func (c *CoursesTeachersGetCall) IfNoneMatch(entityTag string) *CoursesTeachersGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesTeachersListCall Uses

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

func (*CoursesTeachersListCall) Context Uses

func (c *CoursesTeachersListCall) Context(ctx context.Context) *CoursesTeachersListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTeachersListCall) Do Uses

func (c *CoursesTeachersListCall) Do(opts ...googleapi.CallOption) (*ListTeachersResponse, error)

Do executes the "classroom.courses.teachers.list" call. Exactly one of *ListTeachersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTeachersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTeachersListCall) Fields Uses

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) Header Uses

func (c *CoursesTeachersListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesTeachersListCall) IfNoneMatch Uses

func (c *CoursesTeachersListCall) IfNoneMatch(entityTag string) *CoursesTeachersListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesTeachersListCall) PageSize Uses

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 Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesTeachersListCall) Pages Uses

func (c *CoursesTeachersListCall) Pages(ctx context.Context, f func(*ListTeachersResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesTeachersService Uses

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

func NewCoursesTeachersService Uses

func NewCoursesTeachersService(s *Service) *CoursesTeachersService

func (*CoursesTeachersService) Create Uses

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 or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors:

* CourseMemberLimitReached
* CourseNotModifiable
* CourseTeacherLimitReached
* UserGroupsMembershipLimitReached

* `ALREADY_EXISTS` if the user is already a teacher or student in the course.

func (*CoursesTeachersService) Delete Uses

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 or for access errors. * `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 Uses

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 or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

func (*CoursesTeachersService) List Uses

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

List: Returns a list of teachers of this course that the requester is permitted to view.

This method returns the following error codes:

* `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

type CoursesTopicsCreateCall Uses

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

func (*CoursesTopicsCreateCall) Context Uses

func (c *CoursesTopicsCreateCall) Context(ctx context.Context) *CoursesTopicsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTopicsCreateCall) Do Uses

func (c *CoursesTopicsCreateCall) Do(opts ...googleapi.CallOption) (*Topic, error)

Do executes the "classroom.courses.topics.create" call. Exactly one of *Topic or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Topic.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsCreateCall) Fields Uses

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

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

func (*CoursesTopicsCreateCall) Header Uses

func (c *CoursesTopicsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesTopicsDeleteCall Uses

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

func (*CoursesTopicsDeleteCall) Context Uses

func (c *CoursesTopicsDeleteCall) Context(ctx context.Context) *CoursesTopicsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTopicsDeleteCall) Do Uses

func (c *CoursesTopicsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.courses.topics.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsDeleteCall) Fields Uses

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

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

func (*CoursesTopicsDeleteCall) Header Uses

func (c *CoursesTopicsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CoursesTopicsGetCall Uses

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

func (*CoursesTopicsGetCall) Context Uses

func (c *CoursesTopicsGetCall) Context(ctx context.Context) *CoursesTopicsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTopicsGetCall) Do Uses

func (c *CoursesTopicsGetCall) Do(opts ...googleapi.CallOption) (*Topic, error)

Do executes the "classroom.courses.topics.get" call. Exactly one of *Topic or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Topic.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsGetCall) Fields Uses

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

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

func (*CoursesTopicsGetCall) Header Uses

func (c *CoursesTopicsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesTopicsGetCall) IfNoneMatch Uses

func (c *CoursesTopicsGetCall) IfNoneMatch(entityTag string) *CoursesTopicsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type CoursesTopicsListCall Uses

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

func (*CoursesTopicsListCall) Context Uses

func (c *CoursesTopicsListCall) Context(ctx context.Context) *CoursesTopicsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTopicsListCall) Do Uses

func (c *CoursesTopicsListCall) Do(opts ...googleapi.CallOption) (*ListTopicResponse, error)

Do executes the "classroom.courses.topics.list" call. Exactly one of *ListTopicResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTopicResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsListCall) Fields Uses

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

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

func (*CoursesTopicsListCall) Header Uses

func (c *CoursesTopicsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesTopicsListCall) IfNoneMatch Uses

func (c *CoursesTopicsListCall) IfNoneMatch(entityTag string) *CoursesTopicsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CoursesTopicsListCall) PageSize Uses

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

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 (*CoursesTopicsListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*CoursesTopicsListCall) Pages Uses

func (c *CoursesTopicsListCall) Pages(ctx context.Context, f func(*ListTopicResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type CoursesTopicsPatchCall Uses

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

func (*CoursesTopicsPatchCall) Context Uses

func (c *CoursesTopicsPatchCall) Context(ctx context.Context) *CoursesTopicsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesTopicsPatchCall) Do Uses

func (c *CoursesTopicsPatchCall) Do(opts ...googleapi.CallOption) (*Topic, error)

Do executes the "classroom.courses.topics.patch" call. Exactly one of *Topic or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Topic.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesTopicsPatchCall) Fields Uses

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

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

func (*CoursesTopicsPatchCall) Header Uses

func (c *CoursesTopicsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CoursesTopicsPatchCall) UpdateMask Uses

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

UpdateMask sets the optional parameter "updateMask": Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned.

The following fields may be specified:

* `name`

type CoursesTopicsService Uses

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

func NewCoursesTopicsService Uses

func NewCoursesTopicsService(s *Service) *CoursesTopicsService

func (*CoursesTopicsService) Create Uses

func (r *CoursesTopicsService) Create(courseId string, topic *Topic) *CoursesTopicsCreateCall

Create: Creates a topic.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

func (*CoursesTopicsService) Delete Uses

func (r *CoursesTopicsService) Delete(courseId string, id string) *CoursesTopicsDeleteCall

Delete: Deletes a topic.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.

func (*CoursesTopicsService) Get Uses

func (r *CoursesTopicsService) Get(courseId string, id string) *CoursesTopicsGetCall

Get: Returns a topic.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.

func (*CoursesTopicsService) List Uses

func (r *CoursesTopicsService) List(courseId string) *CoursesTopicsListCall

List: Returns the list of topics that the requester is permitted to view.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

func (*CoursesTopicsService) Patch Uses

func (r *CoursesTopicsService) Patch(courseId string, id string, topic *Topic) *CoursesTopicsPatchCall

Patch: Updates one or more fields of a topic.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist

type CoursesUpdateCall Uses

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

func (*CoursesUpdateCall) Context Uses

func (c *CoursesUpdateCall) Context(ctx context.Context) *CoursesUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CoursesUpdateCall) Do Uses

func (c *CoursesUpdateCall) Do(opts ...googleapi.CallOption) (*Course, error)

Do executes the "classroom.courses.update" call. Exactly one of *Course or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Course.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*CoursesUpdateCall) Fields Uses

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.

func (*CoursesUpdateCall) Header Uses

func (c *CoursesUpdateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type Date Uses

type Date struct {
    // Day: Day of month. Must be from 1 to 31 and valid for the year and
    // month, or 0
    // if specifying a year by itself or a year and month where the day is
    // not
    // significant.
    Day int64 `json:"day,omitempty"`

    // Month: Month of year. Must be from 1 to 12, or 0 if specifying a year
    // without a
    // month and day.
    Month int64 `json:"month,omitempty"`

    // Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date
    // without
    // a year.
    Year int64 `json:"year,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Day") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Day") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Date: Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:

* A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date

Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

func (*Date) MarshalJSON Uses

func (s *Date) MarshalJSON() ([]byte, error)

type DriveFile Uses

type DriveFile struct {
    // AlternateLink: URL that can be used to access the Drive
    // item.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // Id: Drive API resource ID.
    Id  string `json:"id,omitempty"`

    // ThumbnailUrl: URL of a thumbnail image of the Drive item.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the Drive item.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AlternateLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

DriveFile: Representation of a Google Drive file.

func (*DriveFile) MarshalJSON Uses

func (s *DriveFile) MarshalJSON() ([]byte, error)

type DriveFolder Uses

type DriveFolder struct {
    // AlternateLink: URL that can be used to access the Drive
    // folder.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // Id: Drive API resource ID.
    Id  string `json:"id,omitempty"`

    // Title: Title of the Drive folder.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AlternateLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

DriveFolder: Representation of a Google Drive folder.

func (*DriveFolder) MarshalJSON Uses

func (s *DriveFolder) MarshalJSON() ([]byte, error)

type Empty Uses

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`
}

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 Feed Uses

type Feed struct {
    // CourseRosterChangesInfo: Information about a `Feed` with a
    // `feed_type` of `COURSE_ROSTER_CHANGES`.
    // This field must be specified if `feed_type` is
    // `COURSE_ROSTER_CHANGES`.
    CourseRosterChangesInfo *CourseRosterChangesInfo `json:"courseRosterChangesInfo,omitempty"`

    // CourseWorkChangesInfo: Information about a `Feed` with a `feed_type`
    // of `COURSE_WORK_CHANGES`.
    // This field must be specified if `feed_type` is `COURSE_WORK_CHANGES`.
    CourseWorkChangesInfo *CourseWorkChangesInfo `json:"courseWorkChangesInfo,omitempty"`

    // FeedType: The type of feed.
    //
    // Possible values:
    //   "FEED_TYPE_UNSPECIFIED" - Should never be returned or provided.
    //   "DOMAIN_ROSTER_CHANGES" - All roster changes for a particular
    // domain.
    //
    // Notifications will be generated whenever a user joins or leaves a
    // course.
    //
    // No notifications will be generated when an invitation is created
    // or
    // deleted, but notifications will be generated when a user joins a
    // course
    // by accepting an invitation.
    //   "COURSE_ROSTER_CHANGES" - All roster changes for a particular
    // course.
    //
    // Notifications will be generated whenever a user joins or leaves a
    // course.
    //
    // No notifications will be generated when an invitation is created
    // or
    // deleted, but notifications will be generated when a user joins a
    // course
    // by accepting an invitation.
    //   "COURSE_WORK_CHANGES" - All course work activity for a particular
    // course.
    //
    // Notifications will be generated when a CourseWork
    // or
    // StudentSubmission object is created or modified. No notification will
    // be
    // generated when a StudentSubmission object is created in connection
    // with
    // the creation or modification of its parent CourseWork object (but
    // a
    // notification will be generated for that CourseWork object's creation
    // or
    // modification).
    FeedType string `json:"feedType,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "CourseRosterChangesInfo") to unconditionally include in API
    // requests. By default, fields with empty values are omitted from API
    // requests. However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseRosterChangesInfo")
    // to include in API requests with the JSON null value. By default,
    // fields with empty values are omitted from API requests. However, any
    // field with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Feed: A class of notifications that an application can register to receive. For example: "all roster changes for a domain".

func (*Feed) MarshalJSON Uses

func (s *Feed) MarshalJSON() ([]byte, error)

type Form Uses

type Form struct {
    // FormUrl: URL of the form.
    FormUrl string `json:"formUrl,omitempty"`

    // ResponseUrl: URL of the form responses document.
    // Only set if respsonses have been recorded and only when
    // the
    // requesting user is an editor of the form.
    //
    // Read-only.
    ResponseUrl string `json:"responseUrl,omitempty"`

    // ThumbnailUrl: URL of a thumbnail image of the Form.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the Form.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "FormUrl") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "FormUrl") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Form: Google Forms item.

func (*Form) MarshalJSON Uses

func (s *Form) MarshalJSON() ([]byte, error)

type GlobalPermission Uses

type GlobalPermission struct {
    // Permission: Permission value.
    //
    // Possible values:
    //   "PERMISSION_UNSPECIFIED" - No permission is specified. This is not
    // returned and is not a
    // valid value.
    //   "CREATE_COURSE" - User is permitted to create a course.
    Permission string `json:"permission,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Permission") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Permission") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GlobalPermission: Global user permission description.

func (*GlobalPermission) MarshalJSON Uses

func (s *GlobalPermission) MarshalJSON() ([]byte, error)

type GradeHistory Uses

type GradeHistory struct {
    // ActorUserId: The teacher who made the grade change.
    ActorUserId string `json:"actorUserId,omitempty"`

    // GradeChangeType: The type of grade change at this time in the
    // submission grade history.
    //
    // Possible values:
    //   "UNKNOWN_GRADE_CHANGE_TYPE" - No grade change type specified. This
    // should never be returned.
    //   "DRAFT_GRADE_POINTS_EARNED_CHANGE" - A change in the numerator of
    // the draft grade.
    //   "ASSIGNED_GRADE_POINTS_EARNED_CHANGE" - A change in the numerator
    // of the assigned grade.
    //   "MAX_POINTS_CHANGE" - A change in the denominator of the grade.
    GradeChangeType string `json:"gradeChangeType,omitempty"`

    // GradeTimestamp: When the grade of the submission was changed.
    GradeTimestamp string `json:"gradeTimestamp,omitempty"`

    // MaxPoints: The denominator of the grade at this time in the
    // submission grade
    // history.
    MaxPoints float64 `json:"maxPoints,omitempty"`

    // PointsEarned: The numerator of the grade at this time in the
    // submission grade history.
    PointsEarned float64 `json:"pointsEarned,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ActorUserId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ActorUserId") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GradeHistory: The history of each grade on this submission.

func (*GradeHistory) MarshalJSON Uses

func (s *GradeHistory) MarshalJSON() ([]byte, error)

func (*GradeHistory) UnmarshalJSON Uses

func (s *GradeHistory) UnmarshalJSON(data []byte) error

type Guardian Uses

type Guardian struct {
    // GuardianId: Identifier for the guardian.
    GuardianId string `json:"guardianId,omitempty"`

    // GuardianProfile: User profile for the guardian.
    GuardianProfile *UserProfile `json:"guardianProfile,omitempty"`

    // InvitedEmailAddress: The email address to which the initial guardian
    // invitation was sent.
    // This field is only visible to domain administrators.
    InvitedEmailAddress string `json:"invitedEmailAddress,omitempty"`

    // StudentId: Identifier for the student to whom the guardian
    // relationship applies.
    StudentId string `json:"studentId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "GuardianId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "GuardianId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Guardian: Association between a student and a guardian of that student. The guardian may receive information about the student's course work.

func (*Guardian) MarshalJSON Uses

func (s *Guardian) MarshalJSON() ([]byte, error)

type GuardianInvitation Uses

type GuardianInvitation struct {
    // CreationTime: The time that this invitation was created.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

    // InvitationId: Unique identifier for this invitation.
    //
    // Read-only.
    InvitationId string `json:"invitationId,omitempty"`

    // InvitedEmailAddress: Email address that the invitation was sent
    // to.
    // This field is only visible to domain administrators.
    InvitedEmailAddress string `json:"invitedEmailAddress,omitempty"`

    // State: The state that this invitation is in.
    //
    // Possible values:
    //   "GUARDIAN_INVITATION_STATE_UNSPECIFIED" - Should never be returned.
    //   "PENDING" - The invitation is active and awaiting a response.
    //   "COMPLETE" - The invitation is no longer active. It may have been
    // accepted, declined,
    // withdrawn or it may have expired.
    State string `json:"state,omitempty"`

    // StudentId: ID of the student (in standard format)
    StudentId string `json:"studentId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CreationTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CreationTime") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GuardianInvitation: An invitation to become the guardian of a specified user, sent to a specified email address.

func (*GuardianInvitation) MarshalJSON Uses

func (s *GuardianInvitation) MarshalJSON() ([]byte, error)

type IndividualStudentsOptions Uses

type IndividualStudentsOptions struct {
    // StudentIds: Identifiers for the students that have access to
    // the
    // coursework/announcement.
    StudentIds []string `json:"studentIds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "StudentIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "StudentIds") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

IndividualStudentsOptions: Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.

func (*IndividualStudentsOptions) MarshalJSON Uses

func (s *IndividualStudentsOptions) MarshalJSON() ([]byte, error)

type Invitation Uses

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

    // Id: 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" - No course role.
    //   "STUDENT" - Student in the course.
    //   "TEACHER" - Teacher of the course.
    //   "OWNER" - Owner of the course.
    Role string `json:"role,omitempty"`

    // UserId: Identifier of the invited user.
    //
    // When specified as a parameter of a request, this identifier can be
    // set to
    // one of the following:
    //
    // * the numeric identifier for the user
    // * the email address of the user
    // * the string literal "me", indicating the requesting user
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Invitation: An invitation to join a course.

func (*Invitation) MarshalJSON Uses

func (s *Invitation) MarshalJSON() ([]byte, error)

type InvitationsAcceptCall Uses

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

func (*InvitationsAcceptCall) Context Uses

func (c *InvitationsAcceptCall) Context(ctx context.Context) *InvitationsAcceptCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsAcceptCall) Do Uses

func (c *InvitationsAcceptCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.invitations.accept" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsAcceptCall) Fields Uses

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.

func (*InvitationsAcceptCall) Header Uses

func (c *InvitationsAcceptCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type InvitationsCreateCall Uses

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

func (*InvitationsCreateCall) Context Uses

func (c *InvitationsCreateCall) Context(ctx context.Context) *InvitationsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsCreateCall) Do Uses

func (c *InvitationsCreateCall) Do(opts ...googleapi.CallOption) (*Invitation, error)

Do executes the "classroom.invitations.create" call. Exactly one of *Invitation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Invitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsCreateCall) Fields Uses

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.

func (*InvitationsCreateCall) Header Uses

func (c *InvitationsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type InvitationsDeleteCall Uses

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

func (*InvitationsDeleteCall) Context Uses

func (c *InvitationsDeleteCall) Context(ctx context.Context) *InvitationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsDeleteCall) Do Uses

func (c *InvitationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.invitations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsDeleteCall) Fields Uses

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.

func (*InvitationsDeleteCall) Header Uses

func (c *InvitationsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type InvitationsGetCall Uses

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

func (*InvitationsGetCall) Context Uses

func (c *InvitationsGetCall) Context(ctx context.Context) *InvitationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsGetCall) Do Uses

func (c *InvitationsGetCall) Do(opts ...googleapi.CallOption) (*Invitation, error)

Do executes the "classroom.invitations.get" call. Exactly one of *Invitation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Invitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsGetCall) Fields Uses

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.

func (*InvitationsGetCall) Header Uses

func (c *InvitationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*InvitationsGetCall) IfNoneMatch Uses

func (c *InvitationsGetCall) IfNoneMatch(entityTag string) *InvitationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type InvitationsListCall Uses

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

func (*InvitationsListCall) Context Uses

func (c *InvitationsListCall) Context(ctx context.Context) *InvitationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*InvitationsListCall) CourseId Uses

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 Uses

func (c *InvitationsListCall) Do(opts ...googleapi.CallOption) (*ListInvitationsResponse, error)

Do executes the "classroom.invitations.list" call. Exactly one of *ListInvitationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListInvitationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InvitationsListCall) Fields Uses

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) Header Uses

func (c *InvitationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*InvitationsListCall) IfNoneMatch Uses

func (c *InvitationsListCall) IfNoneMatch(entityTag string) *InvitationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*InvitationsListCall) PageSize Uses

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

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 (*InvitationsListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*InvitationsListCall) Pages Uses

func (c *InvitationsListCall) Pages(ctx context.Context, f func(*ListInvitationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*InvitationsListCall) UserId Uses

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

UserId sets the optional parameter "userId": Restricts returned invitations to those for a specific user. The identifier can be one of the following:

* the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

type InvitationsService Uses

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

func NewInvitationsService Uses

func NewInvitationsService(s *Service) *InvitationsService

func (*InvitationsService) Accept Uses

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 or for access errors. * `FAILED_PRECONDITION` for the following request errors:

* CourseMemberLimitReached
* CourseNotModifiable
* CourseTeacherLimitReached
* UserGroupsMembershipLimitReached

* `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) Create Uses

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

Create: Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create 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 or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

func (*InvitationsService) Delete Uses

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

Delete: Deletes an invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) Get Uses

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

Get: Returns an invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

func (*InvitationsService) List Uses

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 list request.

*Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied.

This method returns the following error codes:

* `PERMISSION_DENIED` for access errors.

type Link struct {
    // ThumbnailUrl: URL of a thumbnail image of the target URL.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the target of the URL.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // Url: URL to link to.
    // This must be a valid UTF-8 string containing between 1 and 2024
    // characters.
    Url string `json:"url,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ThumbnailUrl") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ThumbnailUrl") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Link: URL item.

func (*Link) MarshalJSON Uses

func (s *Link) MarshalJSON() ([]byte, error)

type ListAnnouncementsResponse Uses

type ListAnnouncementsResponse struct {
    // Announcements: Announcement items that match the request.
    Announcements []*Announcement `json:"announcements,omitempty"`

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Announcements") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Announcements") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListAnnouncementsResponse: Response when listing course work.

func (*ListAnnouncementsResponse) MarshalJSON Uses

func (s *ListAnnouncementsResponse) MarshalJSON() ([]byte, error)

type ListCourseAliasesResponse Uses

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"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Aliases") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Aliases") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListCourseAliasesResponse: Response when listing course aliases.

func (*ListCourseAliasesResponse) MarshalJSON Uses

func (s *ListCourseAliasesResponse) MarshalJSON() ([]byte, error)

type ListCourseWorkResponse Uses

type ListCourseWorkResponse struct {
    // CourseWork: Course work items that match the request.
    CourseWork []*CourseWork `json:"courseWork,omitempty"`

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseWork") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseWork") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListCourseWorkResponse: Response when listing course work.

func (*ListCourseWorkResponse) MarshalJSON Uses

func (s *ListCourseWorkResponse) MarshalJSON() ([]byte, error)

type ListCoursesResponse Uses

type ListCoursesResponse struct {
    // Courses: Courses that match the list 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"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Courses") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Courses") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListCoursesResponse: Response when listing courses.

func (*ListCoursesResponse) MarshalJSON Uses

func (s *ListCoursesResponse) MarshalJSON() ([]byte, error)

type ListGuardianInvitationsResponse Uses

type ListGuardianInvitationsResponse struct {
    // GuardianInvitations: Guardian invitations that matched the list
    // request.
    GuardianInvitations []*GuardianInvitation `json:"guardianInvitations,omitempty"`

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "GuardianInvitations")
    // to unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "GuardianInvitations") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

ListGuardianInvitationsResponse: Response when listing guardian invitations.

func (*ListGuardianInvitationsResponse) MarshalJSON Uses

func (s *ListGuardianInvitationsResponse) MarshalJSON() ([]byte, error)

type ListGuardiansResponse Uses

type ListGuardiansResponse struct {
    // Guardians: Guardians on this page of results that met the criteria
    // specified in
    // the request.
    Guardians []*Guardian `json:"guardians,omitempty"`

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Guardians") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Guardians") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListGuardiansResponse: Response when listing guardians.

func (*ListGuardiansResponse) MarshalJSON Uses

func (s *ListGuardiansResponse) MarshalJSON() ([]byte, error)

type ListInvitationsResponse Uses

type ListInvitationsResponse struct {
    // Invitations: Invitations that match the list 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"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Invitations") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Invitations") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListInvitationsResponse: Response when listing invitations.

func (*ListInvitationsResponse) MarshalJSON Uses

func (s *ListInvitationsResponse) MarshalJSON() ([]byte, error)

type ListStudentSubmissionsResponse Uses

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

    // StudentSubmissions: Student work that matches the request.
    StudentSubmissions []*StudentSubmission `json:"studentSubmissions,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListStudentSubmissionsResponse: Response when listing student submissions.

func (*ListStudentSubmissionsResponse) MarshalJSON Uses

func (s *ListStudentSubmissionsResponse) MarshalJSON() ([]byte, error)

type ListStudentsResponse Uses

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: Students who match the list request.
    Students []*Student `json:"students,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListStudentsResponse: Response when listing students.

func (*ListStudentsResponse) MarshalJSON Uses

func (s *ListStudentsResponse) MarshalJSON() ([]byte, error)

type ListTeachersResponse Uses

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: Teachers who match the list request.
    Teachers []*Teacher `json:"teachers,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListTeachersResponse: Response when listing teachers.

func (*ListTeachersResponse) MarshalJSON Uses

func (s *ListTeachersResponse) MarshalJSON() ([]byte, error)

type ListTopicResponse Uses

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

    // Topic: Topic items that match the request.
    Topic []*Topic `json:"topic,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListTopicResponse: Response when listing topics.

func (*ListTopicResponse) MarshalJSON Uses

func (s *ListTopicResponse) MarshalJSON() ([]byte, error)

type Material Uses

type Material struct {
    // DriveFile: Google Drive file material.
    DriveFile *SharedDriveFile `json:"driveFile,omitempty"`

    // Form: Google Forms material.
    Form *Form `json:"form,omitempty"`

    // Link: Link material. On creation, will be upgraded to a more
    // appropriate type
    // if possible, and this will be reflected in the response.
    Link *Link `json:"link,omitempty"`

    // YoutubeVideo: YouTube video material.
    YoutubeVideo *YouTubeVideo `json:"youtubeVideo,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DriveFile") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Material: Material attached to course work.

When creating attachments, setting the `form` field is not supported.

func (*Material) MarshalJSON Uses

func (s *Material) MarshalJSON() ([]byte, error)

type ModifyAnnouncementAssigneesRequest Uses

type ModifyAnnouncementAssigneesRequest struct {
    // AssigneeMode: Mode of the announcement describing whether it will be
    // accessible by all
    // students or specified individual students.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never
    // returned.
    //   "ALL_STUDENTS" - All students can see the item.
    // This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`

    // ModifyIndividualStudentsOptions: Set which students can view or
    // cannot view the announcement.
    // Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
    ModifyIndividualStudentsOptions *ModifyIndividualStudentsOptions `json:"modifyIndividualStudentsOptions,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AssigneeMode") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AssigneeMode") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ModifyAnnouncementAssigneesRequest: Request to modify assignee mode and options of an announcement.

func (*ModifyAnnouncementAssigneesRequest) MarshalJSON Uses

func (s *ModifyAnnouncementAssigneesRequest) MarshalJSON() ([]byte, error)

type ModifyAttachmentsRequest Uses

type ModifyAttachmentsRequest struct {
    // AddAttachments: Attachments to add.
    // A student submission may not have more than 20 attachments.
    //
    // Form attachments are not supported.
    AddAttachments []*Attachment `json:"addAttachments,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AddAttachments") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AddAttachments") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

ModifyAttachmentsRequest: Request to modify the attachments of a student submission.

func (*ModifyAttachmentsRequest) MarshalJSON Uses

func (s *ModifyAttachmentsRequest) MarshalJSON() ([]byte, error)

type ModifyCourseWorkAssigneesRequest Uses

type ModifyCourseWorkAssigneesRequest struct {
    // AssigneeMode: Mode of the coursework describing whether it will be
    // assigned to all
    // students or specified individual students.
    //
    // Possible values:
    //   "ASSIGNEE_MODE_UNSPECIFIED" - No mode specified. This is never
    // returned.
    //   "ALL_STUDENTS" - All students can see the item.
    // This is the default state.
    //   "INDIVIDUAL_STUDENTS" - A subset of the students can see the item.
    AssigneeMode string `json:"assigneeMode,omitempty"`

    // ModifyIndividualStudentsOptions: Set which students are assigned or
    // not assigned to the coursework.
    // Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
    ModifyIndividualStudentsOptions *ModifyIndividualStudentsOptions `json:"modifyIndividualStudentsOptions,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AssigneeMode") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AssigneeMode") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ModifyCourseWorkAssigneesRequest: Request to modify assignee mode and options of a coursework.

func (*ModifyCourseWorkAssigneesRequest) MarshalJSON Uses

func (s *ModifyCourseWorkAssigneesRequest) MarshalJSON() ([]byte, error)

type ModifyIndividualStudentsOptions Uses

type ModifyIndividualStudentsOptions struct {
    // AddStudentIds: Ids of students to be added as having access to
    // this
    // coursework/announcement.
    AddStudentIds []string `json:"addStudentIds,omitempty"`

    // RemoveStudentIds: Ids of students to be removed from having access to
    // this
    // coursework/announcement.
    RemoveStudentIds []string `json:"removeStudentIds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AddStudentIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AddStudentIds") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ModifyIndividualStudentsOptions: Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.

func (*ModifyIndividualStudentsOptions) MarshalJSON Uses

func (s *ModifyIndividualStudentsOptions) MarshalJSON() ([]byte, error)

type MultipleChoiceQuestion Uses

type MultipleChoiceQuestion struct {
    // Choices: Possible choices.
    Choices []string `json:"choices,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Choices") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Choices") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

MultipleChoiceQuestion: Additional details for multiple-choice questions.

func (*MultipleChoiceQuestion) MarshalJSON Uses

func (s *MultipleChoiceQuestion) MarshalJSON() ([]byte, error)

type MultipleChoiceSubmission Uses

type MultipleChoiceSubmission struct {
    // Answer: Student's select choice.
    Answer string `json:"answer,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Answer") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Answer") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

MultipleChoiceSubmission: Student work for a multiple-choice question.

func (*MultipleChoiceSubmission) MarshalJSON Uses

func (s *MultipleChoiceSubmission) MarshalJSON() ([]byte, error)

type Name Uses

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"`

    // ForceSendFields is a list of field names (e.g. "FamilyName") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "FamilyName") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Name: Details of the user's name.

func (*Name) MarshalJSON Uses

func (s *Name) MarshalJSON() ([]byte, error)

type ReclaimStudentSubmissionRequest Uses

type ReclaimStudentSubmissionRequest struct {
}

ReclaimStudentSubmissionRequest: Request to reclaim a student submission.

type Registration Uses

type Registration struct {
    // CloudPubsubTopic: The Cloud Pub/Sub topic that notifications are to
    // be sent to.
    CloudPubsubTopic *CloudPubsubTopic `json:"cloudPubsubTopic,omitempty"`

    // ExpiryTime: The time until which the `Registration` is
    // effective.
    //
    // This is a read-only field assigned by the server.
    ExpiryTime string `json:"expiryTime,omitempty"`

    // Feed: Specification for the class of notifications that Classroom
    // should deliver
    // to the destination.
    Feed *Feed `json:"feed,omitempty"`

    // RegistrationId: A server-generated unique identifier for this
    // `Registration`.
    //
    // Read-only.
    RegistrationId string `json:"registrationId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CloudPubsubTopic") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CloudPubsubTopic") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Registration: An instruction to Classroom to send notifications from the `feed` to the provided destination.

func (*Registration) MarshalJSON Uses

func (s *Registration) MarshalJSON() ([]byte, error)

type RegistrationsCreateCall Uses

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

func (*RegistrationsCreateCall) Context Uses

func (c *RegistrationsCreateCall) Context(ctx context.Context) *RegistrationsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*RegistrationsCreateCall) Do Uses

func (c *RegistrationsCreateCall) Do(opts ...googleapi.CallOption) (*Registration, error)

Do executes the "classroom.registrations.create" call. Exactly one of *Registration or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Registration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RegistrationsCreateCall) Fields Uses

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

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

func (*RegistrationsCreateCall) Header Uses

func (c *RegistrationsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type RegistrationsDeleteCall Uses

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

func (*RegistrationsDeleteCall) Context Uses

func (c *RegistrationsDeleteCall) Context(ctx context.Context) *RegistrationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*RegistrationsDeleteCall) Do Uses

func (c *RegistrationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.registrations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RegistrationsDeleteCall) Fields Uses

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

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

func (*RegistrationsDeleteCall) Header Uses

func (c *RegistrationsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type RegistrationsService Uses

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

func NewRegistrationsService Uses

func NewRegistrationsService(s *Service) *RegistrationsService

func (*RegistrationsService) Create Uses

func (r *RegistrationsService) Create(registration *Registration) *RegistrationsCreateCall

Create: Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`.

Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in.

Note that any value specified for the `expiry_time` or `id` fields will be ignored.

While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it.

This method may return the following error codes:

* `PERMISSION_DENIED` if:

* the authenticated user does not have permission to receive
  notifications from the requested field; or
* the credential provided does not include the appropriate scope

for

  the requested feed.
* another access error is encountered.

* `INVALID_ARGUMENT` if:

* no `cloudPubsubTopic` is specified, or the specified
  `cloudPubsubTopic` is not valid; or
* no `feed` is specified, or the specified `feed` is not valid.

* `NOT_FOUND` if:

* the specified `feed` cannot be located, or the requesting user

does

  not have permission to determine whether or not it exists; or
* the specified `cloudPubsubTopic` cannot be located, or

Classroom has

not been granted permission to publish to it.

func (*RegistrationsService) Delete Uses

func (r *RegistrationsService) Delete(registrationId string) *RegistrationsDeleteCall

Delete: Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`.

type ReturnStudentSubmissionRequest Uses

type ReturnStudentSubmissionRequest struct {
}

ReturnStudentSubmissionRequest: Request to return a student submission.

type Service Uses

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

    Courses *CoursesService

    Invitations *InvitationsService

    Registrations *RegistrationsService

    UserProfiles *UserProfilesService
    // contains filtered or unexported fields
}

func New Uses

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

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService Uses

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SharedDriveFile Uses

type SharedDriveFile struct {
    // DriveFile: Drive file details.
    DriveFile *DriveFile `json:"driveFile,omitempty"`

    // ShareMode: Mechanism by which students access the Drive item.
    //
    // Possible values:
    //   "UNKNOWN_SHARE_MODE" - No sharing mode specified. This should never
    // be returned.
    //   "VIEW" - Students can view the shared file.
    //   "EDIT" - Students can edit the shared file.
    //   "STUDENT_COPY" - Students have a personal copy of the shared file.
    ShareMode string `json:"shareMode,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DriveFile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DriveFile") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

SharedDriveFile: Drive file that is used as material for course work.

func (*SharedDriveFile) MarshalJSON Uses

func (s *SharedDriveFile) MarshalJSON() ([]byte, error)

type ShortAnswerSubmission Uses

type ShortAnswerSubmission struct {
    // Answer: Student response to a short-answer question.
    Answer string `json:"answer,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Answer") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Answer") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ShortAnswerSubmission: Student work for a short answer question.

func (*ShortAnswerSubmission) MarshalJSON Uses

func (s *ShortAnswerSubmission) MarshalJSON() ([]byte, error)

type StateHistory Uses

type StateHistory struct {
    // ActorUserId: The teacher or student who made the change
    ActorUserId string `json:"actorUserId,omitempty"`

    // State: The workflow pipeline stage.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - No state specified. This should never be
    // returned.
    //   "CREATED" - The Submission has been created.
    //   "TURNED_IN" - The student has turned in an assigned document, which
    // may or may not be
    // a template.
    //   "RETURNED" - The teacher has returned the assigned document to the
    // student.
    //   "RECLAIMED_BY_STUDENT" - The student turned in the assigned
    // document, and then chose to
    // "unsubmit" the assignment, giving the student control again as
    // the
    // owner.
    //   "STUDENT_EDITED_AFTER_TURN_IN" - The student edited their
    // submission after turning it in. Currently,
    // only used by Questions, when the student edits their answer.
    State string `json:"state,omitempty"`

    // StateTimestamp: When the submission entered this state.
    StateTimestamp string `json:"stateTimestamp,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ActorUserId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ActorUserId") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

StateHistory: The history of each state this submission has been in.

func (*StateHistory) MarshalJSON Uses

func (s *StateHistory) MarshalJSON() ([]byte, error)

type Student Uses

type Student struct {
    // CourseId: 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"`

    // StudentWorkFolder: Information about a Drive Folder for this
    // student's work in this course.
    // Only visible to the student and domain administrators.
    //
    // Read-only.
    StudentWorkFolder *DriveFolder `json:"studentWorkFolder,omitempty"`

    // UserId: Identifier of the user.
    //
    // When specified as a parameter of a request, this identifier can be
    // one of
    // the following:
    //
    // * the numeric identifier for the user
    // * the email address of the user
    // * the string literal "me", indicating the requesting user
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Student: Student in a course.

func (*Student) MarshalJSON Uses

func (s *Student) MarshalJSON() ([]byte, error)

type StudentSubmission Uses

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

    // AssignedGrade: Optional grade. If unset, no grade was set.
    // This value must be non-negative. Decimal (i.e. non-integer) values
    // are
    // allowed, but will be rounded to two decimal places.
    //
    // This may be modified only by course teachers.
    AssignedGrade float64 `json:"assignedGrade,omitempty"`

    // AssignmentSubmission: Submission content when course_work_type is
    // ASSIGNMENT.
    //
    // Students can modify this content
    // using
    // google.classroom.Work.ModifyAttachments.
    AssignmentSubmission *AssignmentSubmission `json:"assignmentSubmission,omitempty"`

    // AssociatedWithDeveloper: Whether this student submission is
    // associated with the Developer Console
    // project making the request.
    //
    // See google.classroom.Work.CreateCourseWork for
    // more
    // details.
    //
    // Read-only.
    AssociatedWithDeveloper bool `json:"associatedWithDeveloper,omitempty"`

    // CourseId: Identifier of the course.
    //
    // Read-only.
    CourseId string `json:"courseId,omitempty"`

    // CourseWorkId: Identifier for the course work this corresponds
    // to.
    //
    // Read-only.
    CourseWorkId string `json:"courseWorkId,omitempty"`

    // CourseWorkType: Type of course work this submission is
    // for.
    //
    // Read-only.
    //
    // Possible values:
    //   "COURSE_WORK_TYPE_UNSPECIFIED" - No work type specified. This is
    // never returned.
    //   "ASSIGNMENT" - An assignment.
    //   "SHORT_ANSWER_QUESTION" - A short answer question.
    //   "MULTIPLE_CHOICE_QUESTION" - A multiple-choice question.
    CourseWorkType string `json:"courseWorkType,omitempty"`

    // CreationTime: Creation time of this submission.
    // This may be unset if the student has not accessed this
    // item.
    //
    // Read-only.
    CreationTime string `json:"creationTime,omitempty"`

    // DraftGrade: Optional pending grade. If unset, no grade was set.
    // This value must be non-negative. Decimal (i.e. non-integer) values
    // are
    // allowed, but will be rounded to two decimal places.
    //
    // This is only visible to and modifiable by course teachers.
    DraftGrade float64 `json:"draftGrade,omitempty"`

    // Id: Classroom-assigned Identifier for the student submission.
    // This is unique among submissions for the relevant course
    // work.
    //
    // Read-only.
    Id  string `json:"id,omitempty"`

    // Late: Whether this submission is late.
    //
    // Read-only.
    Late bool `json:"late,omitempty"`

    // MultipleChoiceSubmission: Submission content when course_work_type is
    // MULTIPLE_CHOICE_QUESTION.
    MultipleChoiceSubmission *MultipleChoiceSubmission `json:"multipleChoiceSubmission,omitempty"`

    // ShortAnswerSubmission: Submission content when course_work_type is
    // SHORT_ANSWER_QUESTION.
    ShortAnswerSubmission *ShortAnswerSubmission `json:"shortAnswerSubmission,omitempty"`

    // State: State of this submission.
    //
    // Read-only.
    //
    // Possible values:
    //   "SUBMISSION_STATE_UNSPECIFIED" - No state specified. This should
    // never be returned.
    //   "NEW" - The student has never accessed this submission. Attachments
    // are not
    // returned and timestamps is not set.
    //   "CREATED" - Has been created.
    //   "TURNED_IN" - Has been turned in to the teacher.
    //   "RETURNED" - Has been returned to the student.
    //   "RECLAIMED_BY_STUDENT" - Student chose to "unsubmit" the
    // assignment.
    State string `json:"state,omitempty"`

    // SubmissionHistory: The history of the submission (includes state and
    // grade histories).
    //
    // Read-only.
    SubmissionHistory []*SubmissionHistory `json:"submissionHistory,omitempty"`

    // UpdateTime: Last update time of this submission.
    // This may be unset if the student has not accessed this
    // item.
    //
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // UserId: Identifier for the student that owns this
    // submission.
    //
    // Read-only.
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AlternateLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

StudentSubmission: Student submission for course work.

StudentSubmission items are generated when a CourseWork item is created.

StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.

func (*StudentSubmission) MarshalJSON Uses

func (s *StudentSubmission) MarshalJSON() ([]byte, error)

func (*StudentSubmission) UnmarshalJSON Uses

func (s *StudentSubmission) UnmarshalJSON(data []byte) error

type SubmissionHistory Uses

type SubmissionHistory struct {
    // GradeHistory: The grade history information of the submission, if
    // present.
    GradeHistory *GradeHistory `json:"gradeHistory,omitempty"`

    // StateHistory: The state history information of the submission, if
    // present.
    StateHistory *StateHistory `json:"stateHistory,omitempty"`

    // ForceSendFields is a list of field names (e.g. "GradeHistory") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "GradeHistory") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

SubmissionHistory: The history of the submission. This currently includes state and grade histories.

func (*SubmissionHistory) MarshalJSON Uses

func (s *SubmissionHistory) MarshalJSON() ([]byte, error)

type Teacher Uses

type Teacher struct {
    // CourseId: 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: Identifier of the user.
    //
    // When specified as a parameter of a request, this identifier can be
    // one of
    // the following:
    //
    // * the numeric identifier for the user
    // * the email address of the user
    // * the string literal "me", indicating the requesting user
    UserId string `json:"userId,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Teacher: Teacher of a course.

func (*Teacher) MarshalJSON Uses

func (s *Teacher) MarshalJSON() ([]byte, error)

type TimeOfDay Uses

type TimeOfDay struct {
    // Hours: Hours of day in 24 hour format. Should be from 0 to 23. An API
    // may choose
    // to allow the value "24:00:00" for scenarios like business closing
    // time.
    Hours int64 `json:"hours,omitempty"`

    // Minutes: Minutes of hour of day. Must be from 0 to 59.
    Minutes int64 `json:"minutes,omitempty"`

    // Nanos: Fractions of seconds in nanoseconds. Must be from 0 to
    // 999,999,999.
    Nanos int64 `json:"nanos,omitempty"`

    // Seconds: Seconds of minutes of the time. Must normally be from 0 to
    // 59. An API may
    // allow the value 60 if it allows leap-seconds.
    Seconds int64 `json:"seconds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Hours") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Hours") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

TimeOfDay: Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

func (*TimeOfDay) MarshalJSON Uses

func (s *TimeOfDay) MarshalJSON() ([]byte, error)

type Topic Uses

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

    // Name: The name of the topic, generated by the user.
    // Leading and trailing whitespaces, if any, will be trimmed. Also,
    // multiple
    // consecutive whitespaces will be collapsed into one inside the name.
    // The
    // result must be a non-empty string. Topic names are case sensitive,
    // and must
    // be no longer than 100 characters.
    Name string `json:"name,omitempty"`

    // TopicId: Unique identifier for the topic.
    //
    // Read-only.
    TopicId string `json:"topicId,omitempty"`

    // UpdateTime: The time the topic was last updated by the
    // system.
    //
    // Read-only.
    UpdateTime string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CourseId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CourseId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Topic: Topic created by a teacher for the course

func (*Topic) MarshalJSON Uses

func (s *Topic) MarshalJSON() ([]byte, error)

type TurnInStudentSubmissionRequest Uses

type TurnInStudentSubmissionRequest struct {
}

TurnInStudentSubmissionRequest: Request to turn in a student submission.

type UserProfile Uses

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

    // Id: 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"`

    // VerifiedTeacher: Represents whether a G Suite for Education user's
    // domain administrator has
    // explicitly verified them as being a teacher. If the user is not a
    // member of
    // a G Suite for Education domain, than this field will always be
    // false.
    //
    // Read-only
    VerifiedTeacher bool `json:"verifiedTeacher,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "EmailAddress") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "EmailAddress") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

UserProfile: Global information for a user.

func (*UserProfile) MarshalJSON Uses

func (s *UserProfile) MarshalJSON() ([]byte, error)

type UserProfilesGetCall Uses

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

func (*UserProfilesGetCall) Context Uses

func (c *UserProfilesGetCall) Context(ctx context.Context) *UserProfilesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGetCall) Do Uses

func (c *UserProfilesGetCall) Do(opts ...googleapi.CallOption) (*UserProfile, error)

Do executes the "classroom.userProfiles.get" call. Exactly one of *UserProfile or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UserProfile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGetCall) Fields Uses

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.

func (*UserProfilesGetCall) Header Uses

func (c *UserProfilesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UserProfilesGetCall) IfNoneMatch Uses

func (c *UserProfilesGetCall) IfNoneMatch(entityTag string) *UserProfilesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UserProfilesGuardianInvitationsCreateCall Uses

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

func (*UserProfilesGuardianInvitationsCreateCall) Context Uses

func (c *UserProfilesGuardianInvitationsCreateCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsCreateCall) Do Uses

func (c *UserProfilesGuardianInvitationsCreateCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

Do executes the "classroom.userProfiles.guardianInvitations.create" call. Exactly one of *GuardianInvitation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GuardianInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsCreateCall) Fields Uses

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

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

func (*UserProfilesGuardianInvitationsCreateCall) Header Uses

func (c *UserProfilesGuardianInvitationsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type UserProfilesGuardianInvitationsGetCall Uses

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

func (*UserProfilesGuardianInvitationsGetCall) Context Uses

func (c *UserProfilesGuardianInvitationsGetCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsGetCall) Do Uses

func (c *UserProfilesGuardianInvitationsGetCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

Do executes the "classroom.userProfiles.guardianInvitations.get" call. Exactly one of *GuardianInvitation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GuardianInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsGetCall) Fields Uses

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

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

func (*UserProfilesGuardianInvitationsGetCall) Header Uses

func (c *UserProfilesGuardianInvitationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UserProfilesGuardianInvitationsGetCall) IfNoneMatch Uses

func (c *UserProfilesGuardianInvitationsGetCall) IfNoneMatch(entityTag string) *UserProfilesGuardianInvitationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UserProfilesGuardianInvitationsListCall Uses

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

func (*UserProfilesGuardianInvitationsListCall) Context Uses

func (c *UserProfilesGuardianInvitationsListCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsListCall) Do Uses

func (c *UserProfilesGuardianInvitationsListCall) Do(opts ...googleapi.CallOption) (*ListGuardianInvitationsResponse, error)

Do executes the "classroom.userProfiles.guardianInvitations.list" call. Exactly one of *ListGuardianInvitationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGuardianInvitationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsListCall) Fields Uses

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

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

func (*UserProfilesGuardianInvitationsListCall) Header Uses

func (c *UserProfilesGuardianInvitationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UserProfilesGuardianInvitationsListCall) IfNoneMatch Uses

func (c *UserProfilesGuardianInvitationsListCall) IfNoneMatch(entityTag string) *UserProfilesGuardianInvitationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*UserProfilesGuardianInvitationsListCall) InvitedEmailAddress Uses

func (c *UserProfilesGuardianInvitationsListCall) InvitedEmailAddress(invitedEmailAddress string) *UserProfilesGuardianInvitationsListCall

InvitedEmailAddress sets the optional parameter "invitedEmailAddress": If specified, only results with the specified `invited_email_address` will be returned.

func (*UserProfilesGuardianInvitationsListCall) PageSize Uses

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

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 (*UserProfilesGuardianInvitationsListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*UserProfilesGuardianInvitationsListCall) Pages Uses

func (c *UserProfilesGuardianInvitationsListCall) Pages(ctx context.Context, f func(*ListGuardianInvitationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*UserProfilesGuardianInvitationsListCall) States Uses

func (c *UserProfilesGuardianInvitationsListCall) States(states ...string) *UserProfilesGuardianInvitationsListCall

States sets the optional parameter "states": If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.

Possible values:

"GUARDIAN_INVITATION_STATE_UNSPECIFIED"
"PENDING"
"COMPLETE"

type UserProfilesGuardianInvitationsPatchCall Uses

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

func (*UserProfilesGuardianInvitationsPatchCall) Context Uses

func (c *UserProfilesGuardianInvitationsPatchCall) Context(ctx context.Context) *UserProfilesGuardianInvitationsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardianInvitationsPatchCall) Do Uses

func (c *UserProfilesGuardianInvitationsPatchCall) Do(opts ...googleapi.CallOption) (*GuardianInvitation, error)

Do executes the "classroom.userProfiles.guardianInvitations.patch" call. Exactly one of *GuardianInvitation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GuardianInvitation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardianInvitationsPatchCall) Fields Uses

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

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

func (*UserProfilesGuardianInvitationsPatchCall) Header Uses

func (c *UserProfilesGuardianInvitationsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UserProfilesGuardianInvitationsPatchCall) UpdateMask Uses

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

UpdateMask sets the optional parameter "updateMask": Mask that 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. The following fields are valid:

* `state`

When set in a query parameter, this field should be specified as

`updateMask=<field1>,<field2>,...`

type UserProfilesGuardianInvitationsService Uses

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

func NewUserProfilesGuardianInvitationsService Uses

func NewUserProfilesGuardianInvitationsService(s *Service) *UserProfilesGuardianInvitationsService

func (*UserProfilesGuardianInvitationsService) Create Uses

func (r *UserProfilesGuardianInvitationsService) Create(studentId string, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsCreateCall

Create: Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.

Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian.

The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.

This method returns the following error codes:

* `PERMISSION_DENIED` if the current user does not have permission to

manage guardians, if the guardian in question has already rejected
too many requests for that student, if guardians are not enabled

for the

domain in question, or for other access errors.

* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian

link limit.

* `INVALID_ARGUMENT` if the guardian email address is not valid (for

example, if it is too long), or if the format of the student ID

provided

cannot be recognized (it is not an email address, nor a `user_id`

from

this API). This error will also be returned if read-only fields are

set,

or if the `state` field is set to to a value other than

`PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but

Classroom has no record of that student.

* `ALREADY_EXISTS` if there is already a pending guardian invitation for

the student and `invited_email_address` provided, or if the

provided

`invited_email_address` matches the Google account of an existing
`Guardian` for this user.

func (*UserProfilesGuardianInvitationsService) Get Uses

func (r *UserProfilesGuardianInvitationsService) Get(studentId string, invitationId string) *UserProfilesGuardianInvitationsGetCall

Get: Returns a specific guardian invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the requesting user is not permitted to view

guardian invitations for the student identified by the

`student_id`, if

guardians are not enabled for the domain in question, or for other
access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`).

* `NOT_FOUND` if Classroom cannot find any record of the given student or

`invitation_id`. May also be returned if the student exists, but

the

requesting user does not have access to see that student.

func (*UserProfilesGuardianInvitationsService) List Uses

func (r *UserProfilesGuardianInvitationsService) List(studentId string) *UserProfilesGuardianInvitationsListCall

List: Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.

This method returns the following error codes:

* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting

user is not permitted to view guardian invitations for that

student, if

"-" is specified as the `student_id` and the user is not a

domain

administrator, if guardians are not enabled for the domain in

question,

or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`). May also be returned if an

invalid

`page_token` or `state` is provided.

* `NOT_FOUND` if a `student_id` is specified, and its format can be

recognized, but Classroom has no record of that student.

func (*UserProfilesGuardianInvitationsService) Patch Uses

func (r *UserProfilesGuardianInvitationsService) Patch(studentId string, invitationId string, guardianinvitation *GuardianInvitation) *UserProfilesGuardianInvitationsPatchCall

Patch: Modifies a guardian invitation.

Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.

This method returns the following error codes:

* `PERMISSION_DENIED` if the current user does not have permission to

manage guardians, if guardians are not enabled for the domain in

question

or for other access errors.

* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided

cannot be recognized (it is not an email address, nor a `user_id`

from

this API), or if the passed `GuardianInvitation` has a `state`

other than

`COMPLETE`, or if it modifies fields other than `state`.

* `NOT_FOUND` if the student ID provided is a valid student ID, but

Classroom has no record of that student, or if the `id` field does

not

refer to a guardian invitation known to Classroom.

type UserProfilesGuardiansDeleteCall Uses

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

func (*UserProfilesGuardiansDeleteCall) Context Uses

func (c *UserProfilesGuardiansDeleteCall) Context(ctx context.Context) *UserProfilesGuardiansDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardiansDeleteCall) Do Uses

func (c *UserProfilesGuardiansDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "classroom.userProfiles.guardians.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardiansDeleteCall) Fields Uses

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

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

func (*UserProfilesGuardiansDeleteCall) Header Uses

func (c *UserProfilesGuardiansDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type UserProfilesGuardiansGetCall Uses

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

func (*UserProfilesGuardiansGetCall) Context Uses

func (c *UserProfilesGuardiansGetCall) Context(ctx context.Context) *UserProfilesGuardiansGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardiansGetCall) Do Uses

func (c *UserProfilesGuardiansGetCall) Do(opts ...googleapi.CallOption) (*Guardian, error)

Do executes the "classroom.userProfiles.guardians.get" call. Exactly one of *Guardian or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Guardian.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardiansGetCall) Fields Uses

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

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

func (*UserProfilesGuardiansGetCall) Header Uses

func (c *UserProfilesGuardiansGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UserProfilesGuardiansGetCall) IfNoneMatch Uses

func (c *UserProfilesGuardiansGetCall) IfNoneMatch(entityTag string) *UserProfilesGuardiansGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UserProfilesGuardiansListCall Uses

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

func (*UserProfilesGuardiansListCall) Context Uses

func (c *UserProfilesGuardiansListCall) Context(ctx context.Context) *UserProfilesGuardiansListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UserProfilesGuardiansListCall) Do Uses

func (c *UserProfilesGuardiansListCall) Do(opts ...googleapi.CallOption) (*ListGuardiansResponse, error)

Do executes the "classroom.userProfiles.guardians.list" call. Exactly one of *ListGuardiansResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGuardiansResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UserProfilesGuardiansListCall) Fields Uses

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

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

func (*UserProfilesGuardiansListCall) Header Uses

func (c *UserProfilesGuardiansListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UserProfilesGuardiansListCall) IfNoneMatch Uses

func (c *UserProfilesGuardiansListCall) IfNoneMatch(entityTag string) *UserProfilesGuardiansListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*UserProfilesGuardiansListCall) InvitedEmailAddress Uses

func (c *UserProfilesGuardiansListCall) InvitedEmailAddress(invitedEmailAddress string) *UserProfilesGuardiansListCall

InvitedEmailAddress sets the optional parameter "invitedEmailAddress": Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.

func (*UserProfilesGuardiansListCall) PageSize Uses

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

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 (*UserProfilesGuardiansListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

func (*UserProfilesGuardiansListCall) Pages Uses

func (c *UserProfilesGuardiansListCall) Pages(ctx context.Context, f func(*ListGuardiansResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type UserProfilesGuardiansService Uses

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

func NewUserProfilesGuardiansService Uses

func NewUserProfilesGuardiansService(s *Service) *UserProfilesGuardiansService

func (*UserProfilesGuardiansService) Delete Uses

func (r *UserProfilesGuardiansService) Delete(studentId string, guardianId string) *UserProfilesGuardiansDeleteCall

Delete: Deletes a guardian.

The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API.

This method returns the following error codes:

* `PERMISSION_DENIED` if no user that matches the provided `student_id`

is visible to the requesting user, if the requesting user is not
permitted to manage guardians for the student identified by the
`student_id`, if guardians are not enabled for the domain in

question,

or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API).

* `NOT_FOUND` if the requesting user is permitted to modify guardians for

the requested `student_id`, but no `Guardian` record exists for

that

student with the provided `guardian_id`.

func (*UserProfilesGuardiansService) Get Uses

func (r *UserProfilesGuardiansService) Get(studentId string, guardianId string) *UserProfilesGuardiansGetCall

Get: Returns a specific guardian.

This method returns the following error codes:

* `PERMISSION_DENIED` if no user that matches the provided `student_id`

is visible to the requesting user, if the requesting user is not
permitted to view guardian information for the student identified

by the

`student_id`, if guardians are not enabled for the domain in

question,

or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`).

* `NOT_FOUND` if the requesting user is permitted to view guardians for

the requested `student_id`, but no `Guardian` record exists for

that

student that matches the provided `guardian_id`.

func (*UserProfilesGuardiansService) List Uses

func (r *UserProfilesGuardiansService) List(studentId string) *UserProfilesGuardiansListCall

List: Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.

To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID.

This method returns the following error codes:

* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting

user is not permitted to view guardian information for that

student, if

"-" is specified as the `student_id` and the user is not a

domain

administrator, if guardians are not enabled for the domain in

question,

if the `invited_email_address` filter is set by a user who is not

a

domain administrator, or for other access errors.

* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot

be recognized (it is not an email address, nor a `student_id` from

the

API, nor the literal string `me`). May also be returned if an

invalid

`page_token` is provided.

* `NOT_FOUND` if a `student_id` is specified, and its format can be

recognized, but Classroom has no record of that student.

type UserProfilesService Uses

type UserProfilesService struct {
    GuardianInvitations *UserProfilesGuardianInvitationsService

    Guardians *UserProfilesGuardiansService
    // contains filtered or unexported fields
}

func NewUserProfilesService Uses

func NewUserProfilesService(s *Service) *UserProfilesService

func (*UserProfilesService) Get Uses

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, if no profile exists with the requested ID, or for access errors.

type YouTubeVideo Uses

type YouTubeVideo struct {
    // AlternateLink: URL that can be used to view the YouTube
    // video.
    //
    // Read-only.
    AlternateLink string `json:"alternateLink,omitempty"`

    // Id: YouTube API resource ID.
    Id  string `json:"id,omitempty"`

    // ThumbnailUrl: URL of a thumbnail image of the YouTube
    // video.
    //
    // Read-only.
    ThumbnailUrl string `json:"thumbnailUrl,omitempty"`

    // Title: Title of the YouTube video.
    //
    // Read-only.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AlternateLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AlternateLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

YouTubeVideo: YouTube video item.

func (*YouTubeVideo) MarshalJSON Uses

func (s *YouTubeVideo) MarshalJSON() ([]byte, error)

Package classroom imports 14 packages (graph). Updated 2019-11-14. Refresh now. Tools for package owners.