google_classroom_api::Guardian Class Reference

#include <guardian.h>

Inheritance diagram for google_classroom_api::Guardian:

Public Member Functions
	Guardian (const Json::Value &storage)
	Guardian (Json::Value *storage)
virtual	~Guardian ()
const StringPiece	GetTypeName () const
bool	has_guardian_id () const
void	clear_guardian_id ()
const StringPiece	get_guardian_id () const
void	set_guardian_id (const StringPiece &value)
bool	has_guardian_profile () const
void	clear_guardian_profile ()
const UserProfile	get_guardian_profile () const
UserProfile	mutable_guardianProfile ()
bool	has_invited_email_address () const
void	clear_invited_email_address ()
const StringPiece	get_invited_email_address () const
void	set_invited_email_address (const StringPiece &value)
bool	has_student_id () const
void	clear_student_id ()
const StringPiece	get_student_id () const
void	set_student_id (const StringPiece &value)

Static Public Member Functions
static Guardian *	New ()

Detailed Description

Association between a student and a guardian of that student. The guardian may receive information about the student's course work.

Constructor & Destructor Documentation

Guardian() [1/2]

google_classroom_api::Guardian::Guardian ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Guardian() [2/2]

google_classroom_api::Guardian::Guardian ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Guardian()

google_classroom_api::Guardian::~Guardian ( )

virtual

Standard destructor.

Member Function Documentation

clear_guardian_id()

void google_classroom_api::Guardian::clear_guardian_id ( )

inline

Clears the 'guardianId' attribute.

clear_guardian_profile()

void google_classroom_api::Guardian::clear_guardian_profile ( )

inline

Clears the 'guardianProfile' attribute.

clear_invited_email_address()

void google_classroom_api::Guardian::clear_invited_email_address ( )

inline

Clears the 'invitedEmailAddress' attribute.

clear_student_id()

void google_classroom_api::Guardian::clear_student_id ( )

inline

Clears the 'studentId' attribute.

get_guardian_id()

const StringPiece google_classroom_api::Guardian::get_guardian_id ( ) const

inline

Get the value of the 'guardianId' attribute.

get_guardian_profile()

const UserProfile google_classroom_api::Guardian::get_guardian_profile

(

)

const

Get a reference to the value of the 'guardianProfile' attribute.

get_invited_email_address()

const StringPiece google_classroom_api::Guardian::get_invited_email_address ( ) const

inline

Get the value of the 'invitedEmailAddress' attribute.

get_student_id()

const StringPiece google_classroom_api::Guardian::get_student_id ( ) const

inline

Get the value of the 'studentId' attribute.

GetTypeName()

const StringPiece google_classroom_api::Guardian::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::Guardian

has_guardian_id()

bool google_classroom_api::Guardian::has_guardian_id ( ) const

inline

Determine if the 'guardianId' attribute was set.

Returns

true if the 'guardianId' attribute was set.

has_guardian_profile()

bool google_classroom_api::Guardian::has_guardian_profile ( ) const

inline

Determine if the 'guardianProfile' attribute was set.

Returns

true if the 'guardianProfile' attribute was set.

has_invited_email_address()

bool google_classroom_api::Guardian::has_invited_email_address ( ) const

inline

Determine if the 'invitedEmailAddress' attribute was set.

Returns

true if the 'invitedEmailAddress' attribute was set.

has_student_id()

bool google_classroom_api::Guardian::has_student_id ( ) const

inline

Determine if the 'studentId' attribute was set.

Returns

true if the 'studentId' attribute was set.

mutable_guardianProfile()

UserProfile google_classroom_api::Guardian::mutable_guardianProfile

(

)

Gets a reference to a mutable value of the 'guardianProfile' property.

User profile for the guardian.

Returns

The result can be modified to change the attribute value.

New()

Guardian * google_classroom_api::Guardian::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_guardian_id()

void google_classroom_api::Guardian::set_guardian_id ( const StringPiece &  value )

inline

Change the 'guardianId' attribute.

Identifier for the guardian.

Parameters

[in]

value

The new value.

set_invited_email_address()

void google_classroom_api::Guardian::set_invited_email_address ( const StringPiece &  value )

inline

Change the 'invitedEmailAddress' attribute.

The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.

Parameters

[in]

value

The new value.

set_student_id()

void google_classroom_api::Guardian::set_student_id ( const StringPiece &  value )

inline

Change the 'studentId' attribute.

Identifier for the student to whom the guardian relationship applies.

Parameters

[in]

value

The new value.

---

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

• google/classroom_api/guardian.h
• google/classroom_api/guardian.cc