#include <classroom_service.h>
Implements the get 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.guardianlinks.students https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
◆ UserProfilesResource_GuardianInvitationsResource_GetMethod()
google_classroom_api::UserProfilesResource_GuardianInvitationsResource_GetMethod::UserProfilesResource_GuardianInvitationsResource_GetMethod |
( |
const ClassroomService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
student_id, |
|
|
const absl::string_view & |
invitation_id |
|
) |
| |
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] | student_id | The ID of the student whose guardian invitation is being requested. |
[in] | invitation_id | The id field of the GuardianInvitation being requested. |
◆ ~UserProfilesResource_GuardianInvitationsResource_GetMethod()
google_classroom_api::UserProfilesResource_GuardianInvitationsResource_GetMethod::~UserProfilesResource_GuardianInvitationsResource_GetMethod |
( |
| ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_classroom_api::UserProfilesResource_GuardianInvitationsResource_GetMethod::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.
◆ ExecuteAndParseResponse()
util::Status google_classroom_api::UserProfilesResource_GuardianInvitationsResource_GetMethod::ExecuteAndParseResponse |
( |
GuardianInvitation * |
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.
The documentation for this class was generated from the following files: