classroom  v1
Public Member Functions | Static Public Member Functions | List of all members
google_classroom_api::CourseWork Class Reference

#include <course_work.h>

Inheritance diagram for google_classroom_api::CourseWork:

Public Member Functions

 CourseWork (const Json::Value &storage)
 
 CourseWork (Json::Value *storage)
 
virtual ~CourseWork ()
 
const StringPiece GetTypeName () const
 
bool has_alternate_link () const
 
void clear_alternate_link ()
 
const StringPiece get_alternate_link () const
 
void set_alternate_link (const StringPiece &value)
 
bool has_assignee_mode () const
 
void clear_assignee_mode ()
 
const StringPiece get_assignee_mode () const
 
void set_assignee_mode (const StringPiece &value)
 
bool has_assignment () const
 
void clear_assignment ()
 
const Assignment get_assignment () const
 
Assignment mutable_assignment ()
 
bool has_associated_with_developer () const
 
void clear_associated_with_developer ()
 
bool get_associated_with_developer () const
 
void set_associated_with_developer (bool value)
 
bool has_course_id () const
 
void clear_course_id ()
 
const StringPiece get_course_id () const
 
void set_course_id (const StringPiece &value)
 
bool has_creation_time () const
 
void clear_creation_time ()
 
const StringPiece get_creation_time () const
 
void set_creation_time (const StringPiece &value)
 
bool has_creator_user_id () const
 
void clear_creator_user_id ()
 
const StringPiece get_creator_user_id () const
 
void set_creator_user_id (const StringPiece &value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_due_date () const
 
void clear_due_date ()
 
const Date get_due_date () const
 
Date mutable_dueDate ()
 
bool has_due_time () const
 
void clear_due_time ()
 
const TimeOfDay get_due_time () const
 
TimeOfDay mutable_dueTime ()
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_individual_students_options () const
 
void clear_individual_students_options ()
 
const IndividualStudentsOptions get_individual_students_options () const
 
IndividualStudentsOptions mutable_individualStudentsOptions ()
 
bool has_materials () const
 
void clear_materials ()
 
const client::JsonCppArray< Materialget_materials () const
 
client::JsonCppArray< Materialmutable_materials ()
 
bool has_max_points () const
 
void clear_max_points ()
 
double get_max_points () const
 
void set_max_points (double value)
 
bool has_multiple_choice_question () const
 
void clear_multiple_choice_question ()
 
const MultipleChoiceQuestion get_multiple_choice_question () const
 
MultipleChoiceQuestion mutable_multipleChoiceQuestion ()
 
bool has_scheduled_time () const
 
void clear_scheduled_time ()
 
const StringPiece get_scheduled_time () const
 
void set_scheduled_time (const StringPiece &value)
 
bool has_state () const
 
void clear_state ()
 
const StringPiece get_state () const
 
void set_state (const StringPiece &value)
 
bool has_submission_modification_mode () const
 
void clear_submission_modification_mode ()
 
const StringPiece get_submission_modification_mode () const
 
void set_submission_modification_mode (const StringPiece &value)
 
bool has_title () const
 
void clear_title ()
 
const StringPiece get_title () const
 
void set_title (const StringPiece &value)
 
bool has_topic_id () const
 
void clear_topic_id ()
 
const StringPiece get_topic_id () const
 
void set_topic_id (const StringPiece &value)
 
bool has_update_time () const
 
void clear_update_time ()
 
const StringPiece get_update_time () const
 
void set_update_time (const StringPiece &value)
 
bool has_work_type () const
 
void clear_work_type ()
 
const StringPiece get_work_type () const
 
void set_work_type (const StringPiece &value)
 

Static Public Member Functions

static CourseWorkNew ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CourseWork() [1/2]

google_classroom_api::CourseWork::CourseWork ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe 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]storageThe underlying data storage for this instance.

◆ ~CourseWork()

google_classroom_api::CourseWork::~CourseWork ( )
virtual

Standard destructor.

Member Function Documentation

◆ 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()

const IndividualStudentsOptions google_classroom_api::CourseWork::get_individual_students_options ( ) const

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()

const MultipleChoiceQuestion google_classroom_api::CourseWork::get_multiple_choice_question ( ) const

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

Returns a string denoting the type of this data object.

Returns
google_classroom_api::CourseWork

◆ 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()

IndividualStudentsOptions google_classroom_api::CourseWork::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()

MultipleChoiceQuestion google_classroom_api::CourseWork::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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

◆ 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
[in]valueThe new value.

The documentation for this class was generated from the following files: