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

#include <student_submission.h>

Inheritance diagram for google_classroom_api::StudentSubmission:

Public Member Functions

 StudentSubmission (const Json::Value &storage)
 
 StudentSubmission (Json::Value *storage)
 
virtual ~StudentSubmission ()
 
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_assigned_grade () const
 
void clear_assigned_grade ()
 
double get_assigned_grade () const
 
void set_assigned_grade (double value)
 
bool has_assignment_submission () const
 
void clear_assignment_submission ()
 
const AssignmentSubmission get_assignment_submission () const
 
AssignmentSubmission mutable_assignmentSubmission ()
 
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_course_work_id () const
 
void clear_course_work_id ()
 
const StringPiece get_course_work_id () const
 
void set_course_work_id (const StringPiece &value)
 
bool has_course_work_type () const
 
void clear_course_work_type ()
 
const StringPiece get_course_work_type () const
 
void set_course_work_type (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_draft_grade () const
 
void clear_draft_grade ()
 
double get_draft_grade () const
 
void set_draft_grade (double value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_late () const
 
void clear_late ()
 
bool get_late () const
 
void set_late (bool value)
 
bool has_multiple_choice_submission () const
 
void clear_multiple_choice_submission ()
 
const MultipleChoiceSubmission get_multiple_choice_submission () const
 
MultipleChoiceSubmission mutable_multipleChoiceSubmission ()
 
bool has_short_answer_submission () const
 
void clear_short_answer_submission ()
 
const ShortAnswerSubmission get_short_answer_submission () const
 
ShortAnswerSubmission mutable_shortAnswerSubmission ()
 
bool has_state () const
 
void clear_state ()
 
const StringPiece get_state () const
 
void set_state (const StringPiece &value)
 
bool has_submission_history () const
 
void clear_submission_history ()
 
const client::JsonCppArray< SubmissionHistoryget_submission_history () const
 
client::JsonCppArray< SubmissionHistorymutable_submissionHistory ()
 
bool has_update_time () const
 
void clear_update_time ()
 
const StringPiece get_update_time () const
 
void set_update_time (const StringPiece &value)
 
bool has_user_id () const
 
void clear_user_id ()
 
const StringPiece get_user_id () const
 
void set_user_id (const StringPiece &value)
 

Static Public Member Functions

static StudentSubmissionNew ()
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ StudentSubmission() [1/2]

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

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ StudentSubmission() [2/2]

google_classroom_api::StudentSubmission::StudentSubmission ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~StudentSubmission()

google_classroom_api::StudentSubmission::~StudentSubmission ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_alternate_link()

void google_classroom_api::StudentSubmission::clear_alternate_link ( )
inline

Clears the 'alternateLink' attribute.

◆ clear_assigned_grade()

void google_classroom_api::StudentSubmission::clear_assigned_grade ( )
inline

Clears the 'assignedGrade' attribute.

◆ clear_assignment_submission()

void google_classroom_api::StudentSubmission::clear_assignment_submission ( )
inline

Clears the 'assignmentSubmission' attribute.

◆ clear_associated_with_developer()

void google_classroom_api::StudentSubmission::clear_associated_with_developer ( )
inline

Clears the 'associatedWithDeveloper' attribute.

◆ clear_course_id()

void google_classroom_api::StudentSubmission::clear_course_id ( )
inline

Clears the 'courseId' attribute.

◆ clear_course_work_id()

void google_classroom_api::StudentSubmission::clear_course_work_id ( )
inline

Clears the 'courseWorkId' attribute.

◆ clear_course_work_type()

void google_classroom_api::StudentSubmission::clear_course_work_type ( )
inline

Clears the 'courseWorkType' attribute.

◆ clear_creation_time()

void google_classroom_api::StudentSubmission::clear_creation_time ( )
inline

Clears the 'creationTime' attribute.

◆ clear_draft_grade()

void google_classroom_api::StudentSubmission::clear_draft_grade ( )
inline

Clears the 'draftGrade' attribute.

◆ clear_id()

void google_classroom_api::StudentSubmission::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_late()

void google_classroom_api::StudentSubmission::clear_late ( )
inline

Clears the 'late' attribute.

◆ clear_multiple_choice_submission()

void google_classroom_api::StudentSubmission::clear_multiple_choice_submission ( )
inline

Clears the 'multipleChoiceSubmission' attribute.

◆ clear_short_answer_submission()

void google_classroom_api::StudentSubmission::clear_short_answer_submission ( )
inline

Clears the 'shortAnswerSubmission' attribute.

◆ clear_state()

void google_classroom_api::StudentSubmission::clear_state ( )
inline

Clears the 'state' attribute.

◆ clear_submission_history()

void google_classroom_api::StudentSubmission::clear_submission_history ( )
inline

Clears the 'submissionHistory' attribute.

◆ clear_update_time()

void google_classroom_api::StudentSubmission::clear_update_time ( )
inline

Clears the 'updateTime' attribute.

◆ clear_user_id()

void google_classroom_api::StudentSubmission::clear_user_id ( )
inline

Clears the 'userId' attribute.

◆ get_alternate_link()

const StringPiece google_classroom_api::StudentSubmission::get_alternate_link ( ) const
inline

Get the value of the 'alternateLink' attribute.

◆ get_assigned_grade()

double google_classroom_api::StudentSubmission::get_assigned_grade ( ) const
inline

Get the value of the 'assignedGrade' attribute.

◆ get_assignment_submission()

const AssignmentSubmission google_classroom_api::StudentSubmission::get_assignment_submission ( ) const

Get a reference to the value of the 'assignmentSubmission' attribute.

◆ get_associated_with_developer()

bool google_classroom_api::StudentSubmission::get_associated_with_developer ( ) const
inline

Get the value of the 'associatedWithDeveloper' attribute.

◆ get_course_id()

const StringPiece google_classroom_api::StudentSubmission::get_course_id ( ) const
inline

Get the value of the 'courseId' attribute.

◆ get_course_work_id()

const StringPiece google_classroom_api::StudentSubmission::get_course_work_id ( ) const
inline

Get the value of the 'courseWorkId' attribute.

◆ get_course_work_type()

const StringPiece google_classroom_api::StudentSubmission::get_course_work_type ( ) const
inline

Get the value of the 'courseWorkType' attribute.

◆ get_creation_time()

const StringPiece google_classroom_api::StudentSubmission::get_creation_time ( ) const
inline

Get the value of the 'creationTime' attribute.

◆ get_draft_grade()

double google_classroom_api::StudentSubmission::get_draft_grade ( ) const
inline

Get the value of the 'draftGrade' attribute.

◆ get_id()

const StringPiece google_classroom_api::StudentSubmission::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_late()

bool google_classroom_api::StudentSubmission::get_late ( ) const
inline

Get the value of the 'late' attribute.

◆ get_multiple_choice_submission()

const MultipleChoiceSubmission google_classroom_api::StudentSubmission::get_multiple_choice_submission ( ) const

Get a reference to the value of the 'multipleChoiceSubmission' attribute.

◆ get_short_answer_submission()

const ShortAnswerSubmission google_classroom_api::StudentSubmission::get_short_answer_submission ( ) const

Get a reference to the value of the 'shortAnswerSubmission' attribute.

◆ get_state()

const StringPiece google_classroom_api::StudentSubmission::get_state ( ) const
inline

Get the value of the 'state' attribute.

◆ get_submission_history()

const client::JsonCppArray<SubmissionHistory > google_classroom_api::StudentSubmission::get_submission_history ( ) const

Get a reference to the value of the 'submissionHistory' attribute.

◆ get_update_time()

const StringPiece google_classroom_api::StudentSubmission::get_update_time ( ) const
inline

Get the value of the 'updateTime' attribute.

◆ get_user_id()

const StringPiece google_classroom_api::StudentSubmission::get_user_id ( ) const
inline

Get the value of the 'userId' attribute.

◆ GetTypeName()

const StringPiece google_classroom_api::StudentSubmission::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_classroom_api::StudentSubmission

◆ has_alternate_link()

bool google_classroom_api::StudentSubmission::has_alternate_link ( ) const
inline

Determine if the 'alternateLink' attribute was set.

Returns
true if the 'alternateLink' attribute was set.

◆ has_assigned_grade()

bool google_classroom_api::StudentSubmission::has_assigned_grade ( ) const
inline

Determine if the 'assignedGrade' attribute was set.

Returns
true if the 'assignedGrade' attribute was set.

◆ has_assignment_submission()

bool google_classroom_api::StudentSubmission::has_assignment_submission ( ) const
inline

Determine if the 'assignmentSubmission' attribute was set.

Returns
true if the 'assignmentSubmission' attribute was set.

◆ has_associated_with_developer()

bool google_classroom_api::StudentSubmission::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::StudentSubmission::has_course_id ( ) const
inline

Determine if the 'courseId' attribute was set.

Returns
true if the 'courseId' attribute was set.

◆ has_course_work_id()

bool google_classroom_api::StudentSubmission::has_course_work_id ( ) const
inline

Determine if the 'courseWorkId' attribute was set.

Returns
true if the 'courseWorkId' attribute was set.

◆ has_course_work_type()

bool google_classroom_api::StudentSubmission::has_course_work_type ( ) const
inline

Determine if the 'courseWorkType' attribute was set.

Returns
true if the 'courseWorkType' attribute was set.

◆ has_creation_time()

bool google_classroom_api::StudentSubmission::has_creation_time ( ) const
inline

Determine if the 'creationTime' attribute was set.

Returns
true if the 'creationTime' attribute was set.

◆ has_draft_grade()

bool google_classroom_api::StudentSubmission::has_draft_grade ( ) const
inline

Determine if the 'draftGrade' attribute was set.

Returns
true if the 'draftGrade' attribute was set.

◆ has_id()

bool google_classroom_api::StudentSubmission::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_late()

bool google_classroom_api::StudentSubmission::has_late ( ) const
inline

Determine if the 'late' attribute was set.

Returns
true if the 'late' attribute was set.

◆ has_multiple_choice_submission()

bool google_classroom_api::StudentSubmission::has_multiple_choice_submission ( ) const
inline

Determine if the 'multipleChoiceSubmission' attribute was set.

Returns
true if the 'multipleChoiceSubmission' attribute was set.

◆ has_short_answer_submission()

bool google_classroom_api::StudentSubmission::has_short_answer_submission ( ) const
inline

Determine if the 'shortAnswerSubmission' attribute was set.

Returns
true if the 'shortAnswerSubmission' attribute was set.

◆ has_state()

bool google_classroom_api::StudentSubmission::has_state ( ) const
inline

Determine if the 'state' attribute was set.

Returns
true if the 'state' attribute was set.

◆ has_submission_history()

bool google_classroom_api::StudentSubmission::has_submission_history ( ) const
inline

Determine if the 'submissionHistory' attribute was set.

Returns
true if the 'submissionHistory' attribute was set.

◆ has_update_time()

bool google_classroom_api::StudentSubmission::has_update_time ( ) const
inline

Determine if the 'updateTime' attribute was set.

Returns
true if the 'updateTime' attribute was set.

◆ has_user_id()

bool google_classroom_api::StudentSubmission::has_user_id ( ) const
inline

Determine if the 'userId' attribute was set.

Returns
true if the 'userId' attribute was set.

◆ mutable_assignmentSubmission()

AssignmentSubmission google_classroom_api::StudentSubmission::mutable_assignmentSubmission ( )

Gets a reference to a mutable value of the 'assignmentSubmission' property.

Submission content when course_work_type is ASSIGNMENT.

Students can modify this content using google.classroom.Work.ModifyAttachments.

Returns
The result can be modified to change the attribute value.

◆ mutable_multipleChoiceSubmission()

MultipleChoiceSubmission google_classroom_api::StudentSubmission::mutable_multipleChoiceSubmission ( )

Gets a reference to a mutable value of the 'multipleChoiceSubmission' property.

Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.

Returns
The result can be modified to change the attribute value.

◆ mutable_shortAnswerSubmission()

ShortAnswerSubmission google_classroom_api::StudentSubmission::mutable_shortAnswerSubmission ( )

Gets a reference to a mutable value of the 'shortAnswerSubmission' property.

Submission content when course_work_type is SHORT_ANSWER_QUESTION.

Returns
The result can be modified to change the attribute value.

◆ mutable_submissionHistory()

client::JsonCppArray<SubmissionHistory > google_classroom_api::StudentSubmission::mutable_submissionHistory ( )

Gets a reference to a mutable value of the 'submissionHistory' property.

The history of the submission (includes state and grade histories).

Read-only.

Returns
The result can be modified to change the attribute value.

◆ New()

StudentSubmission * google_classroom_api::StudentSubmission::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_alternate_link()

void google_classroom_api::StudentSubmission::set_alternate_link ( const StringPiece &  value)
inline

Change the 'alternateLink' attribute.

Absolute link to the submission in the Classroom web UI.

Read-only.

Parameters
[in]valueThe new value.

◆ set_assigned_grade()

void google_classroom_api::StudentSubmission::set_assigned_grade ( double  value)
inline

Change the 'assignedGrade' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_associated_with_developer()

void google_classroom_api::StudentSubmission::set_associated_with_developer ( bool  value)
inline

Change the 'associatedWithDeveloper' attribute.

Whether this student submission 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::StudentSubmission::set_course_id ( const StringPiece &  value)
inline

Change the 'courseId' attribute.

Identifier of the course.

Read-only.

Parameters
[in]valueThe new value.

◆ set_course_work_id()

void google_classroom_api::StudentSubmission::set_course_work_id ( const StringPiece &  value)
inline

Change the 'courseWorkId' attribute.

Identifier for the course work this corresponds to.

Read-only.

Parameters
[in]valueThe new value.

◆ set_course_work_type()

void google_classroom_api::StudentSubmission::set_course_work_type ( const StringPiece &  value)
inline

Change the 'courseWorkType' attribute.

Type of course work this submission is for.

Read-only.

Parameters
[in]valueThe new value.

◆ set_creation_time()

void google_classroom_api::StudentSubmission::set_creation_time ( const StringPiece &  value)
inline

Change the 'creationTime' attribute.

Creation time of this submission. This may be unset if the student has not accessed this item.

Read-only.

Parameters
[in]valueThe new value.

◆ set_draft_grade()

void google_classroom_api::StudentSubmission::set_draft_grade ( double  value)
inline

Change the 'draftGrade' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_id()

void google_classroom_api::StudentSubmission::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work.

Read-only.

Parameters
[in]valueThe new value.

◆ set_late()

void google_classroom_api::StudentSubmission::set_late ( bool  value)
inline

Change the 'late' attribute.

Whether this submission is late.

Read-only.

Parameters
[in]valueThe new value.

◆ set_state()

void google_classroom_api::StudentSubmission::set_state ( const StringPiece &  value)
inline

Change the 'state' attribute.

State of this submission.

Read-only.

Parameters
[in]valueThe new value.

◆ set_update_time()

void google_classroom_api::StudentSubmission::set_update_time ( const StringPiece &  value)
inline

Change the 'updateTime' attribute.

Last update time of this submission. This may be unset if the student has not accessed this item.

Read-only.

Parameters
[in]valueThe new value.

◆ set_user_id()

void google_classroom_api::StudentSubmission::set_user_id ( const StringPiece &  value)
inline

Change the 'userId' attribute.

Identifier for the student that owns this submission.

Read-only.

Parameters
[in]valueThe new value.

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