Class Course
A Course in Classroom.
Implements
Inherited Members
Namespace: Google.Apis.Classroom.v1.Data
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class Course : IDirectResponseSchema
Properties
AlternateLink
Absolute link to this course in the Classroom web UI. Read-only.
Declaration
[JsonProperty("alternateLink")]
public virtual string AlternateLink { get; set; }
Property Value
Type | Description |
---|---|
string |
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. The Calendar for a course is created asynchronously when the course is
set to CourseState.ACTIVE
for the first time (at creation time or when it is updated to ACTIVE
through
the UI or the API). The Calendar ID will not be populated until the creation process is completed.
Read-only.
Declaration
[JsonProperty("calendarId")]
public virtual string CalendarId { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("courseGroupEmail")]
public virtual string CourseGroupEmail { get; set; }
Property Value
Type | Description |
---|---|
string |
CourseMaterialSets
Sets of materials that appear on the "about" page of this course. Read-only.
Declaration
[JsonProperty("courseMaterialSets")]
public virtual IList<CourseMaterialSet> CourseMaterialSets { get; set; }
Property Value
Type | Description |
---|---|
IList<CourseMaterialSet> |
CourseState
State of the course. If unspecified, the default state is PROVISIONED
.
Declaration
[JsonProperty("courseState")]
public virtual string CourseState { get; set; }
Property Value
Type | Description |
---|---|
string |
CreationTime
object representation of CreationTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreationTimeDateTimeOffset instead.")]
public virtual object CreationTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreationTimeDateTimeOffset
DateTimeOffset representation of CreationTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreationTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreationTimeRaw
Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
Declaration
[JsonProperty("creationTime")]
public virtual string CreationTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("descriptionHeading")]
public virtual string DescriptionHeading { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EnrollmentCode
Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.
Declaration
[JsonProperty("enrollmentCode")]
public virtual string EnrollmentCode { get; set; }
Property Value
Type | Description |
---|---|
string |
GradebookSettings
The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only
Declaration
[JsonProperty("gradebookSettings")]
public virtual GradebookSettings GradebookSettings { get; set; }
Property Value
Type | Description |
---|---|
GradebookSettings |
GuardiansEnabled
Whether or not guardian notifications are enabled for this course. Read-only.
Declaration
[JsonProperty("guardiansEnabled")]
public virtual bool? GuardiansEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("ownerId")]
public virtual string OwnerId { get; set; }
Property Value
Type | Description |
---|---|
string |
Room
Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
Declaration
[JsonProperty("room")]
public virtual string Room { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("section")]
public virtual string Section { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("teacherFolder")]
public virtual DriveFolder TeacherFolder { get; set; }
Property Value
Type | Description |
---|---|
DriveFolder |
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.
Declaration
[JsonProperty("teacherGroupEmail")]
public virtual string TeacherGroupEmail { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateTime
object representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UpdateTimeDateTimeOffset
DateTimeOffset representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UpdateTimeRaw
Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |