#include <classroom_service.h>
Implements the create 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.profile.emails https://www.googleapis.com/auth/classroom.profile.photos https://www.googleapis.com/auth/classroom.rosters
◆ CoursesResource_StudentsResource_CreateMethod()
google_classroom_api::CoursesResource_StudentsResource_CreateMethod::CoursesResource_StudentsResource_CreateMethod |
( |
const ClassroomService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
course_id, |
|
|
const Student & |
_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_id | Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. |
[in] | <em>content</em> | The data object to create. |
◆ ~CoursesResource_StudentsResource_CreateMethod()
google_classroom_api::CoursesResource_StudentsResource_CreateMethod::~CoursesResource_StudentsResource_CreateMethod |
( |
| ) |
|
|
virtual |
◆ AppendOptionalQueryParameters()
util::Status google_classroom_api::CoursesResource_StudentsResource_CreateMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_classroom_api::CoursesResource_StudentsResource_CreateMethod::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_name | The name of the templated variable. |
[in] | config | A pass-through parameter used for lists and maps. |
[in,out] | target | The string to append the value to. |
Reimplemented from google_classroom_api::ClassroomServiceBaseRequest.
◆ clear_enrollment_code()
void google_classroom_api::CoursesResource_StudentsResource_CreateMethod::clear_enrollment_code |
( |
| ) |
|
|
inline |
Clears the 'enrollmentCode
' attribute so it is no longer set.
◆ ExecuteAndParseResponse()
util::Status google_classroom_api::CoursesResource_StudentsResource_CreateMethod::ExecuteAndParseResponse |
( |
Student * |
data | ) |
|
|
inline |
Executes the method and parses the response into a data object on success.
- Parameters
-
[out] | data | Loads 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_enrollment_code()
const string& google_classroom_api::CoursesResource_StudentsResource_CreateMethod::get_enrollment_code |
( |
| ) |
const |
|
inline |
Gets the optional 'enrollmentCode
' attribute.
If the value is not set then the default value will be returned.
◆ mutable_enrollmentCode()
string* google_classroom_api::CoursesResource_StudentsResource_CreateMethod::mutable_enrollmentCode |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional enrollmentCode
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ set_enrollment_code()
void google_classroom_api::CoursesResource_StudentsResource_CreateMethod::set_enrollment_code |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'enrollmentCode
' attribute.
- Parameters
-
[in] | value | Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user. |
The documentation for this class was generated from the following files: