#include <course_work.h>
Course work created by a teacher for students of the course.
◆ CourseWork() [1/2]
google_classroom_api::CourseWork::CourseWork |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ CourseWork() [2/2]
google_classroom_api::CourseWork::CourseWork |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ~CourseWork()
google_classroom_api::CourseWork::~CourseWork |
( |
| ) |
|
|
virtual |
◆ clear_alternate_link()
void google_classroom_api::CourseWork::clear_alternate_link |
( |
| ) |
|
|
inline |
Clears the 'alternateLink
' attribute.
◆ clear_assignee_mode()
void google_classroom_api::CourseWork::clear_assignee_mode |
( |
| ) |
|
|
inline |
Clears the 'assigneeMode
' attribute.
◆ clear_assignment()
void google_classroom_api::CourseWork::clear_assignment |
( |
| ) |
|
|
inline |
Clears the 'assignment
' attribute.
◆ clear_associated_with_developer()
void google_classroom_api::CourseWork::clear_associated_with_developer |
( |
| ) |
|
|
inline |
Clears the 'associatedWithDeveloper
' attribute.
◆ clear_course_id()
void google_classroom_api::CourseWork::clear_course_id |
( |
| ) |
|
|
inline |
Clears the 'courseId
' attribute.
◆ clear_creation_time()
void google_classroom_api::CourseWork::clear_creation_time |
( |
| ) |
|
|
inline |
Clears the 'creationTime
' attribute.
◆ clear_creator_user_id()
void google_classroom_api::CourseWork::clear_creator_user_id |
( |
| ) |
|
|
inline |
Clears the 'creatorUserId
' attribute.
◆ clear_description()
void google_classroom_api::CourseWork::clear_description |
( |
| ) |
|
|
inline |
Clears the 'description
' attribute.
◆ clear_due_date()
void google_classroom_api::CourseWork::clear_due_date |
( |
| ) |
|
|
inline |
Clears the 'dueDate
' attribute.
◆ clear_due_time()
void google_classroom_api::CourseWork::clear_due_time |
( |
| ) |
|
|
inline |
Clears the 'dueTime
' attribute.
◆ clear_id()
void google_classroom_api::CourseWork::clear_id |
( |
| ) |
|
|
inline |
Clears the 'id
' attribute.
◆ clear_individual_students_options()
void google_classroom_api::CourseWork::clear_individual_students_options |
( |
| ) |
|
|
inline |
Clears the 'individualStudentsOptions
' attribute.
◆ clear_materials()
void google_classroom_api::CourseWork::clear_materials |
( |
| ) |
|
|
inline |
Clears the 'materials
' attribute.
◆ clear_max_points()
void google_classroom_api::CourseWork::clear_max_points |
( |
| ) |
|
|
inline |
Clears the 'maxPoints
' attribute.
◆ clear_multiple_choice_question()
void google_classroom_api::CourseWork::clear_multiple_choice_question |
( |
| ) |
|
|
inline |
Clears the 'multipleChoiceQuestion
' attribute.
◆ clear_scheduled_time()
void google_classroom_api::CourseWork::clear_scheduled_time |
( |
| ) |
|
|
inline |
Clears the 'scheduledTime
' attribute.
◆ clear_state()
void google_classroom_api::CourseWork::clear_state |
( |
| ) |
|
|
inline |
Clears the 'state
' attribute.
◆ clear_submission_modification_mode()
void google_classroom_api::CourseWork::clear_submission_modification_mode |
( |
| ) |
|
|
inline |
Clears the 'submissionModificationMode
' attribute.
◆ clear_title()
void google_classroom_api::CourseWork::clear_title |
( |
| ) |
|
|
inline |
Clears the 'title
' attribute.
◆ clear_topic_id()
void google_classroom_api::CourseWork::clear_topic_id |
( |
| ) |
|
|
inline |
Clears the 'topicId
' attribute.
◆ clear_update_time()
void google_classroom_api::CourseWork::clear_update_time |
( |
| ) |
|
|
inline |
Clears the 'updateTime
' attribute.
◆ clear_work_type()
void google_classroom_api::CourseWork::clear_work_type |
( |
| ) |
|
|
inline |
Clears the 'workType
' attribute.
◆ get_alternate_link()
const StringPiece google_classroom_api::CourseWork::get_alternate_link |
( |
| ) |
const |
|
inline |
Get the value of the 'alternateLink
' attribute.
◆ get_assignee_mode()
const StringPiece google_classroom_api::CourseWork::get_assignee_mode |
( |
| ) |
const |
|
inline |
Get the value of the 'assigneeMode
' attribute.
◆ get_assignment()
const Assignment google_classroom_api::CourseWork::get_assignment |
( |
| ) |
const |
Get a reference to the value of the 'assignment
' attribute.
◆ get_associated_with_developer()
bool google_classroom_api::CourseWork::get_associated_with_developer |
( |
| ) |
const |
|
inline |
Get the value of the 'associatedWithDeveloper
' attribute.
◆ get_course_id()
const StringPiece google_classroom_api::CourseWork::get_course_id |
( |
| ) |
const |
|
inline |
Get the value of the 'courseId
' attribute.
◆ get_creation_time()
const StringPiece google_classroom_api::CourseWork::get_creation_time |
( |
| ) |
const |
|
inline |
Get the value of the 'creationTime
' attribute.
◆ get_creator_user_id()
const StringPiece google_classroom_api::CourseWork::get_creator_user_id |
( |
| ) |
const |
|
inline |
Get the value of the 'creatorUserId
' attribute.
◆ get_description()
const StringPiece google_classroom_api::CourseWork::get_description |
( |
| ) |
const |
|
inline |
Get the value of the 'description
' attribute.
◆ get_due_date()
const Date google_classroom_api::CourseWork::get_due_date |
( |
| ) |
const |
Get a reference to the value of the 'dueDate
' attribute.
◆ get_due_time()
const TimeOfDay google_classroom_api::CourseWork::get_due_time |
( |
| ) |
const |
Get a reference to the value of the 'dueTime
' attribute.
◆ get_id()
const StringPiece google_classroom_api::CourseWork::get_id |
( |
| ) |
const |
|
inline |
Get the value of the 'id
' attribute.
◆ get_individual_students_options()
Get a reference to the value of the 'individualStudentsOptions
' attribute.
◆ get_materials()
const client::JsonCppArray<Material > google_classroom_api::CourseWork::get_materials |
( |
| ) |
const |
Get a reference to the value of the 'materials
' attribute.
◆ get_max_points()
double google_classroom_api::CourseWork::get_max_points |
( |
| ) |
const |
|
inline |
Get the value of the 'maxPoints
' attribute.
◆ get_multiple_choice_question()
Get a reference to the value of the 'multipleChoiceQuestion
' attribute.
◆ get_scheduled_time()
const StringPiece google_classroom_api::CourseWork::get_scheduled_time |
( |
| ) |
const |
|
inline |
Get the value of the 'scheduledTime
' attribute.
◆ get_state()
const StringPiece google_classroom_api::CourseWork::get_state |
( |
| ) |
const |
|
inline |
Get the value of the 'state
' attribute.
◆ get_submission_modification_mode()
const StringPiece google_classroom_api::CourseWork::get_submission_modification_mode |
( |
| ) |
const |
|
inline |
Get the value of the 'submissionModificationMode
' attribute.
◆ get_title()
const StringPiece google_classroom_api::CourseWork::get_title |
( |
| ) |
const |
|
inline |
Get the value of the 'title
' attribute.
◆ get_topic_id()
const StringPiece google_classroom_api::CourseWork::get_topic_id |
( |
| ) |
const |
|
inline |
Get the value of the 'topicId
' attribute.
◆ get_update_time()
const StringPiece google_classroom_api::CourseWork::get_update_time |
( |
| ) |
const |
|
inline |
Get the value of the 'updateTime
' attribute.
◆ get_work_type()
const StringPiece google_classroom_api::CourseWork::get_work_type |
( |
| ) |
const |
|
inline |
Get the value of the 'workType
' attribute.
◆ GetTypeName()
const StringPiece google_classroom_api::CourseWork::GetTypeName |
( |
| ) |
const |
|
inline |
◆ has_alternate_link()
bool google_classroom_api::CourseWork::has_alternate_link |
( |
| ) |
const |
|
inline |
Determine if the 'alternateLink
' attribute was set.
- Returns
- true if the '
alternateLink
' attribute was set.
◆ has_assignee_mode()
bool google_classroom_api::CourseWork::has_assignee_mode |
( |
| ) |
const |
|
inline |
Determine if the 'assigneeMode
' attribute was set.
- Returns
- true if the '
assigneeMode
' attribute was set.
◆ has_assignment()
bool google_classroom_api::CourseWork::has_assignment |
( |
| ) |
const |
|
inline |
Determine if the 'assignment
' attribute was set.
- Returns
- true if the '
assignment
' attribute was set.
◆ has_associated_with_developer()
bool google_classroom_api::CourseWork::has_associated_with_developer |
( |
| ) |
const |
|
inline |
Determine if the 'associatedWithDeveloper
' attribute was set.
- Returns
- true if the '
associatedWithDeveloper
' attribute was set.
◆ has_course_id()
bool google_classroom_api::CourseWork::has_course_id |
( |
| ) |
const |
|
inline |
Determine if the 'courseId
' attribute was set.
- Returns
- true if the '
courseId
' attribute was set.
◆ has_creation_time()
bool google_classroom_api::CourseWork::has_creation_time |
( |
| ) |
const |
|
inline |
Determine if the 'creationTime
' attribute was set.
- Returns
- true if the '
creationTime
' attribute was set.
◆ has_creator_user_id()
bool google_classroom_api::CourseWork::has_creator_user_id |
( |
| ) |
const |
|
inline |
Determine if the 'creatorUserId
' attribute was set.
- Returns
- true if the '
creatorUserId
' attribute was set.
◆ has_description()
bool google_classroom_api::CourseWork::has_description |
( |
| ) |
const |
|
inline |
Determine if the 'description
' attribute was set.
- Returns
- true if the '
description
' attribute was set.
◆ has_due_date()
bool google_classroom_api::CourseWork::has_due_date |
( |
| ) |
const |
|
inline |
Determine if the 'dueDate
' attribute was set.
- Returns
- true if the '
dueDate
' attribute was set.
◆ has_due_time()
bool google_classroom_api::CourseWork::has_due_time |
( |
| ) |
const |
|
inline |
Determine if the 'dueTime
' attribute was set.
- Returns
- true if the '
dueTime
' attribute was set.
◆ has_id()
bool google_classroom_api::CourseWork::has_id |
( |
| ) |
const |
|
inline |
Determine if the 'id
' attribute was set.
- Returns
- true if the '
id
' attribute was set.
◆ has_individual_students_options()
bool google_classroom_api::CourseWork::has_individual_students_options |
( |
| ) |
const |
|
inline |
Determine if the 'individualStudentsOptions
' attribute was set.
- Returns
- true if the '
individualStudentsOptions
' attribute was set.
◆ has_materials()
bool google_classroom_api::CourseWork::has_materials |
( |
| ) |
const |
|
inline |
Determine if the 'materials
' attribute was set.
- Returns
- true if the '
materials
' attribute was set.
◆ has_max_points()
bool google_classroom_api::CourseWork::has_max_points |
( |
| ) |
const |
|
inline |
Determine if the 'maxPoints
' attribute was set.
- Returns
- true if the '
maxPoints
' attribute was set.
◆ has_multiple_choice_question()
bool google_classroom_api::CourseWork::has_multiple_choice_question |
( |
| ) |
const |
|
inline |
Determine if the 'multipleChoiceQuestion
' attribute was set.
- Returns
- true if the '
multipleChoiceQuestion
' attribute was set.
◆ has_scheduled_time()
bool google_classroom_api::CourseWork::has_scheduled_time |
( |
| ) |
const |
|
inline |
Determine if the 'scheduledTime
' attribute was set.
- Returns
- true if the '
scheduledTime
' attribute was set.
◆ has_state()
bool google_classroom_api::CourseWork::has_state |
( |
| ) |
const |
|
inline |
Determine if the 'state
' attribute was set.
- Returns
- true if the '
state
' attribute was set.
◆ has_submission_modification_mode()
bool google_classroom_api::CourseWork::has_submission_modification_mode |
( |
| ) |
const |
|
inline |
Determine if the 'submissionModificationMode
' attribute was set.
- Returns
- true if the '
submissionModificationMode
' attribute was set.
◆ has_title()
bool google_classroom_api::CourseWork::has_title |
( |
| ) |
const |
|
inline |
Determine if the 'title
' attribute was set.
- Returns
- true if the '
title
' attribute was set.
◆ has_topic_id()
bool google_classroom_api::CourseWork::has_topic_id |
( |
| ) |
const |
|
inline |
Determine if the 'topicId
' attribute was set.
- Returns
- true if the '
topicId
' attribute was set.
◆ has_update_time()
bool google_classroom_api::CourseWork::has_update_time |
( |
| ) |
const |
|
inline |
Determine if the 'updateTime
' attribute was set.
- Returns
- true if the '
updateTime
' attribute was set.
◆ has_work_type()
bool google_classroom_api::CourseWork::has_work_type |
( |
| ) |
const |
|
inline |
Determine if the 'workType
' attribute was set.
- Returns
- true if the '
workType
' attribute was set.
◆ mutable_assignment()
Assignment google_classroom_api::CourseWork::mutable_assignment |
( |
| ) |
|
Gets a reference to a mutable value of the 'assignment
' property.
Assignment details. This is populated only when work_type
is ASSIGNMENT
.
Read-only.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_dueDate()
Date google_classroom_api::CourseWork::mutable_dueDate |
( |
| ) |
|
Gets a reference to a mutable value of the 'dueDate
' property.
Optional date, in UTC, that submissions for this course work are due. This must be specified if due_time
is specified.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_dueTime()
TimeOfDay google_classroom_api::CourseWork::mutable_dueTime |
( |
| ) |
|
Gets a reference to a mutable value of the 'dueTime
' property.
Optional time of day, in UTC, that submissions for this course work are due. This must be specified if due_date
is specified.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_individualStudentsOptions()
Gets a reference to a mutable value of the 'individualStudentsOptions
' property.
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.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_materials()
client::JsonCppArray<Material > google_classroom_api::CourseWork::mutable_materials |
( |
| ) |
|
Gets a reference to a mutable value of the 'materials
' property.
Additional materials.
CourseWork must have no more than 20 material items.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_multipleChoiceQuestion()
Gets a reference to a mutable value of the 'multipleChoiceQuestion
' property.
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.
- Returns
- The result can be modified to change the attribute value.
◆ New()
CourseWork * google_classroom_api::CourseWork::New |
( |
| ) |
|
|
static |
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_alternate_link()
void google_classroom_api::CourseWork::set_alternate_link |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'alternateLink
' attribute.
Absolute link to this course work in the Classroom web UI. This is only populated if state
is PUBLISHED
.
Read-only.
- Parameters
-
◆ set_assignee_mode()
void google_classroom_api::CourseWork::set_assignee_mode |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'assigneeMode
' attribute.
Assignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS
.
- Parameters
-
◆ set_associated_with_developer()
void google_classroom_api::CourseWork::set_associated_with_developer |
( |
bool |
value | ) |
|
|
inline |
Change the 'associatedWithDeveloper
' attribute.
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.
- Parameters
-
◆ set_course_id()
void google_classroom_api::CourseWork::set_course_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'courseId
' attribute.
Identifier of the course.
Read-only.
- Parameters
-
◆ set_creation_time()
void google_classroom_api::CourseWork::set_creation_time |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'creationTime
' attribute.
Timestamp when this course work was created.
Read-only.
- Parameters
-
◆ set_creator_user_id()
void google_classroom_api::CourseWork::set_creator_user_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'creatorUserId
' attribute.
Identifier for the user that created the coursework.
Read-only.
- Parameters
-
◆ set_description()
void google_classroom_api::CourseWork::set_description |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'description
' attribute.
Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
- Parameters
-
◆ set_id()
void google_classroom_api::CourseWork::set_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'id
' attribute.
- Classroom
- assigned identifier of this course work, unique per course.
- Read
- only.
- Parameters
-
◆ set_max_points()
void google_classroom_api::CourseWork::set_max_points |
( |
double |
value | ) |
|
|
inline |
Change the 'maxPoints
' attribute.
Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
- Parameters
-
◆ set_scheduled_time()
void google_classroom_api::CourseWork::set_scheduled_time |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'scheduledTime
' attribute.
Optional timestamp when this course work is scheduled to be published.
- Parameters
-
◆ set_state()
void google_classroom_api::CourseWork::set_state |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'state
' attribute.
Status of this course work. If unspecified, the default state is DRAFT
.
- Parameters
-
◆ set_submission_modification_mode()
void google_classroom_api::CourseWork::set_submission_modification_mode |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'submissionModificationMode
' attribute.
Setting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN
.
- Parameters
-
◆ set_title()
void google_classroom_api::CourseWork::set_title |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'title
' attribute.
Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
- Parameters
-
◆ set_topic_id()
void google_classroom_api::CourseWork::set_topic_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'topicId
' attribute.
Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.
- Parameters
-
◆ set_update_time()
void google_classroom_api::CourseWork::set_update_time |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'updateTime
' attribute.
Timestamp of the most recent change to this course work.
Read-only.
- Parameters
-
◆ set_work_type()
void google_classroom_api::CourseWork::set_work_type |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'workType
' attribute.
Type of this course work.
The type is set when the course work is created and cannot be changed.
- Parameters
-
The documentation for this class was generated from the following files:
- google/classroom_api/course_work.h
- google/classroom_api/course_work.cc