google_classroom_api::ClassroomService::CoursesResource::StudentsResource Class Reference

#include <classroom_service.h>

Public Member Functions
	StudentsResource (ClassroomService *service)
	~StudentsResource ()
CoursesResource_StudentsResource_CreateMethod *	NewCreateMethod (client::AuthorizationCredential *_credential_, const absl::string_view &course_id, const Student &_content_) const
CoursesResource_StudentsResource_DeleteMethod *	NewDeleteMethod (client::AuthorizationCredential *_credential_, const absl::string_view &course_id, const absl::string_view &user_id) const
CoursesResource_StudentsResource_GetMethod *	NewGetMethod (client::AuthorizationCredential *_credential_, const absl::string_view &course_id, const absl::string_view &user_id) const
CoursesResource_StudentsResource_ListMethod *	NewListMethod (client::AuthorizationCredential *_credential_, const absl::string_view &course_id) const
CoursesResource_StudentsResource_ListMethodPager *	NewListMethodPager (client::AuthorizationCredential *_credential_, const absl::string_view &course_id) const

Detailed Description

Acts as message factory for accessing data.

Constructor & Destructor Documentation

StudentsResource()

google_classroom_api::ClassroomService::CoursesResource::StudentsResource::StudentsResource ( ClassroomService *  service )

explicit

Standard constructor.

Parameters

[in]

service

The service instance is used to bind to the methods created from this resource instance. This will be the service that methods are invoked on.

~StudentsResource()

google_classroom_api::ClassroomService::CoursesResource::StudentsResource::~StudentsResource ( )

inline

Standard destructor.

Member Function Documentation

NewCreateMethod()

CoursesResource_StudentsResource_CreateMethod * google_classroom_api::ClassroomService::CoursesResource::StudentsResource::NewCreateMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	course_id,
		const Student &	_content_
	)		const

Creates a new CoursesResource_StudentsResource_CreateMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[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.

Returns

The caller should Execute the method instance, then destroy it when they are finished.

NewDeleteMethod()

CoursesResource_StudentsResource_DeleteMethod * google_classroom_api::ClassroomService::CoursesResource::StudentsResource::NewDeleteMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	course_id,
		const absl::string_view &	user_id
	)		const

Creates a new CoursesResource_StudentsResource_DeleteMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	course_id	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
[in]	user_id	Identifier of the student to delete. The identifier can be one of the following:

• the numeric identifier for the user
• the email address of the user
• the string literal "me", indicating the requesting user.

  Returns

  The caller should Execute the method instance, then destroy it when they are finished.

NewGetMethod()

CoursesResource_StudentsResource_GetMethod * google_classroom_api::ClassroomService::CoursesResource::StudentsResource::NewGetMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	course_id,
		const absl::string_view &	user_id
	)		const

Creates a new CoursesResource_StudentsResource_GetMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	course_id	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
[in]	user_id	Identifier of the student to return. The identifier can be one of the following:

• the numeric identifier for the user
• the email address of the user
• the string literal "me", indicating the requesting user.

  Returns

  The caller should Execute the method instance, then destroy it when they are finished.

NewListMethod()

CoursesResource_StudentsResource_ListMethod * google_classroom_api::ClassroomService::CoursesResource::StudentsResource::NewListMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	course_id
	)		const

Creates a new CoursesResource_StudentsResource_ListMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	course_id	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Returns

The caller should Execute the method instance, then destroy it when they are finished.

NewListMethodPager()

CoursesResource_StudentsResource_ListMethodPager * google_classroom_api::ClassroomService::CoursesResource::StudentsResource::NewListMethodPager	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	course_id
	)		const

Creates a pager for iterating over incremental result pages.

Parameters

[in]	<em>credential</em>	NULL credentials will not authorize the request.
[in]	course_id	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

See also

googleapis::googleapis::ServiceRequestPager

---

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

• google/classroom_api/classroom_service.h
• google/classroom_api/classroom_service.cc