classroom  v1
Public Member Functions | List of all members
google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod Class Reference
Google Classroom API Service Methods

#include <classroom_service.h>

Inheritance diagram for google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod:
google_classroom_api::ClassroomServiceBaseRequest

Public Member Functions

 CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod (const ClassroomService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &course_id, const absl::string_view &course_work_id, const absl::string_view &id, const StudentSubmission &_content_)
 
virtual ~CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod ()
 
void clear_update_mask ()
 
const string & get_update_mask () const
 
string * mutable_updateMask ()
 
void set_update_mask (const string &value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (StudentSubmission *data)
 
- Public Member Functions inherited from google_classroom_api::ClassroomServiceBaseRequest
 ClassroomServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~ClassroomServiceBaseRequest ()
 
void clear_xgafv ()
 
const string & get_xgafv () const
 
string *mutable_ $Xgafv ()
 
void set_xgafv (const string &value)
 
void clear_access_token ()
 
const string & get_access_token () const
 
string * mutable_accessToken ()
 
void set_access_token (const string &value)
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_callback ()
 
const string & get_callback () const
 
string * mutable_callback ()
 
void set_callback (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_upload_type ()
 
const string & get_upload_type () const
 
string * mutable_uploadType ()
 
void set_upload_type (const string &value)
 
void clear_upload_protocol ()
 
const string & get_upload_protocol () const
 
string * mutable_uploadProtocol ()
 
void set_upload_protocol (const string &value)
 

Additional Inherited Members

- Protected Member Functions inherited from google_classroom_api::ClassroomServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the patch method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/classroom.coursework.me https://www.googleapis.com/auth/classroom.coursework.students

Constructor & Destructor Documentation

◆ CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod()

google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod ( const ClassroomService *  _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  course_id,
const absl::string_view &  course_work_id,
const absl::string_view &  id,
const StudentSubmission &  _content_ 
)

The standard constructor takes all the required method parameters.

Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]course_idIdentifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
[in]course_work_idIdentifier of the course work.
[in]idIdentifier of the student submission.
[in]<em>content</em>The data object to patch.

◆ ~CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod()

google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::~CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_classroom_api::ClassroomServiceBaseRequest.

◆ AppendVariable()

util::Status google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::AppendVariable ( const StringPiece &  variable_name,
const client::UriTemplateConfig &  config,
string *  target 
)
virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters
[in]variable_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_classroom_api::ClassroomServiceBaseRequest.

◆ clear_update_mask()

void google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::clear_update_mask ( )
inline

Clears the 'updateMask' attribute so it is no longer set.

◆ ExecuteAndParseResponse()

util::Status google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::ExecuteAndParseResponse ( StudentSubmission *  data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_update_mask()

const string& google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::get_update_mask ( ) const
inline

Gets the optional 'updateMask' attribute.

If the value is not set then the default value will be returned.

◆ mutable_updateMask()

string* google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::mutable_updateMask ( )
inline

Gets a modifiable pointer to the optional updateMask' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_update_mask()

void google_classroom_api::CoursesResource_CourseWorkResource_StudentSubmissionsResource_PatchMethod::set_update_mask ( const string &  value)
inline

Sets the 'updateMask' attribute.

Parameters
[in]valueMask 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.
The documentation for this class was generated from the following files: