google_classroom_api::ClassroomService::UserProfilesResource::GuardiansResource Class Reference

#include <classroom_service.h>

Public Member Functions
	GuardiansResource (ClassroomService *service)
	~GuardiansResource ()
UserProfilesResource_GuardiansResource_DeleteMethod *	NewDeleteMethod (client::AuthorizationCredential *_credential_, const absl::string_view &student_id, const absl::string_view &guardian_id) const
UserProfilesResource_GuardiansResource_GetMethod *	NewGetMethod (client::AuthorizationCredential *_credential_, const absl::string_view &student_id, const absl::string_view &guardian_id) const
UserProfilesResource_GuardiansResource_ListMethod *	NewListMethod (client::AuthorizationCredential *_credential_, const absl::string_view &student_id) const
UserProfilesResource_GuardiansResource_ListMethodPager *	NewListMethodPager (client::AuthorizationCredential *_credential_, const absl::string_view &student_id) const

Detailed Description

Acts as message factory for accessing data.

Constructor & Destructor Documentation

GuardiansResource()

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

~GuardiansResource()

google_classroom_api::ClassroomService::UserProfilesResource::GuardiansResource::~GuardiansResource ( )

inline

Standard destructor.

Member Function Documentation

NewDeleteMethod()

UserProfilesResource_GuardiansResource_DeleteMethod * google_classroom_api::ClassroomService::UserProfilesResource::GuardiansResource::NewDeleteMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	student_id,
		const absl::string_view &	guardian_id
	)		const

Creates a new UserProfilesResource_GuardiansResource_DeleteMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	student_id	The student whose guardian is to be deleted. One of the following:

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

  Parameters

  [in]

  guardian_id

  The id field from a Guardian.

  Returns

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

NewGetMethod()

UserProfilesResource_GuardiansResource_GetMethod * google_classroom_api::ClassroomService::UserProfilesResource::GuardiansResource::NewGetMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	student_id,
		const absl::string_view &	guardian_id
	)		const

Creates a new UserProfilesResource_GuardiansResource_GetMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	student_id	The student whose guardian is being requested. One of the following:

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

  Parameters

  [in]

  guardian_id

  The id field from a Guardian.

  Returns

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

NewListMethod()

UserProfilesResource_GuardiansResource_ListMethod * google_classroom_api::ClassroomService::UserProfilesResource::GuardiansResource::NewListMethod	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	student_id
	)		const

Creates a new UserProfilesResource_GuardiansResource_ListMethod instance.

Parameters

[in]	<em>credential</em>	Can be NULL. NULL credentials will not authorize the request.
[in]	student_id	Filter results by the student who the guardian is linked to. 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
• the string literal "-", indicating that results should be returned for all students that the requesting user has access to view.

  Returns

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

NewListMethodPager()

UserProfilesResource_GuardiansResource_ListMethodPager * google_classroom_api::ClassroomService::UserProfilesResource::GuardiansResource::NewListMethodPager	(	client::AuthorizationCredential *	_credential_,
		const absl::string_view &	student_id
	)		const

Creates a pager for iterating over incremental result pages.

Parameters

[in]	<em>credential</em>	NULL credentials will not authorize the request.
[in]	student_id	Filter results by the student who the guardian is linked to. 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
• the string literal "-", indicating that results should be returned for all students that the requesting user has access to view.

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