google_classroom_api::ClassroomService::CoursesResource Class Reference

#include <classroom_service.h>

Classes
class	AliasesResource
class	AnnouncementsResource
class	CourseWorkResource
class	StudentsResource
class	TeachersResource
class	TopicsResource

Public Member Functions
	CoursesResource (ClassroomService *service)
	~CoursesResource ()
const AliasesResource &	get_aliases () const
const AnnouncementsResource &	get_announcements () const
const CourseWorkResource &	get_course_work () const
const StudentsResource &	get_students () const
const TeachersResource &	get_teachers () const
const TopicsResource &	get_topics () const
CoursesResource_CreateMethod *	NewCreateMethod (client::AuthorizationCredential *_credential_, const Course &_content_) const
CoursesResource_DeleteMethod *	NewDeleteMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id) const
CoursesResource_GetMethod *	NewGetMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id) const
CoursesResource_ListMethod *	NewListMethod (client::AuthorizationCredential *_credential_) const
CoursesResource_ListMethodPager *	NewListMethodPager (client::AuthorizationCredential *_credential_) const
CoursesResource_PatchMethod *	NewPatchMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id, const Course &_content_) const
CoursesResource_UpdateMethod *	NewUpdateMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id, const Course &_content_) const

Detailed Description

Acts as message factory for accessing data.

Constructor & Destructor Documentation

CoursesResource()

google_classroom_api::ClassroomService::CoursesResource::CoursesResource ( 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.

~CoursesResource()

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

inline

Standard destructor.

Member Function Documentation

get_aliases()

const AliasesResource& google_classroom_api::ClassroomService::CoursesResource::get_aliases ( ) const

inline

Gets the aliases resource method factory.

Returns

AliasesResource for creating methods.

get_announcements()

const AnnouncementsResource& google_classroom_api::ClassroomService::CoursesResource::get_announcements ( ) const

inline

Gets the announcements resource method factory.

Returns

AnnouncementsResource for creating methods.

get_course_work()

const CourseWorkResource& google_classroom_api::ClassroomService::CoursesResource::get_course_work ( ) const

inline

Gets the courseWork resource method factory.

Returns

CourseWorkResource for creating methods.

get_students()

const StudentsResource& google_classroom_api::ClassroomService::CoursesResource::get_students ( ) const

inline

Gets the students resource method factory.

Returns

StudentsResource for creating methods.

get_teachers()

const TeachersResource& google_classroom_api::ClassroomService::CoursesResource::get_teachers ( ) const

inline

Gets the teachers resource method factory.

Returns

TeachersResource for creating methods.

get_topics()

const TopicsResource& google_classroom_api::ClassroomService::CoursesResource::get_topics ( ) const

inline

Gets the topics resource method factory.

Returns

TopicsResource for creating methods.

NewCreateMethod()

CoursesResource_CreateMethod * google_classroom_api::ClassroomService::CoursesResource::NewCreateMethod	(	client::AuthorizationCredential *	_credential_,
		const Course &	_content_
	)		const

Creates a new CoursesResource_CreateMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[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_DeleteMethod * google_classroom_api::ClassroomService::CoursesResource::NewDeleteMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	id
	)		const

Creates a new CoursesResource_DeleteMethod instance.

Parameters

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

NewGetMethod()

CoursesResource_GetMethod * google_classroom_api::ClassroomService::CoursesResource::NewGetMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	id
	)		const

Creates a new CoursesResource_GetMethod instance.

Parameters

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

NewListMethod()

CoursesResource_ListMethod * google_classroom_api::ClassroomService::CoursesResource::NewListMethod

(

client::AuthorizationCredential *

_credential_

)

const

Creates a new CoursesResource_ListMethod instance.

Parameters

[in]

<em>credential</em>

Can be NULL. NULL credentials will not authorize the request.

Returns

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

NewListMethodPager()

CoursesResource_ListMethodPager * google_classroom_api::ClassroomService::CoursesResource::NewListMethodPager

(

client::AuthorizationCredential *

_credential_

)

const

Creates a pager for iterating over incremental result pages.

Parameters

[in]

<em>credential</em>

NULL credentials will not authorize the request.

See also

googleapis::googleapis::ServiceRequestPager

NewPatchMethod()

CoursesResource_PatchMethod * google_classroom_api::ClassroomService::CoursesResource::NewPatchMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	id,
		const Course &	_content_
	)		const

Creates a new CoursesResource_PatchMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	id	Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
[in]	<em>content</em>	The data object to patch.

Returns

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

NewUpdateMethod()

CoursesResource_UpdateMethod * google_classroom_api::ClassroomService::CoursesResource::NewUpdateMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	id,
		const Course &	_content_
	)		const

Creates a new CoursesResource_UpdateMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	id	Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
[in]	<em>content</em>	The data object to update.

Returns

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

---

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

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