google_classroom_api::GuardianInvitation Class Reference

#include <guardian_invitation.h>

Inheritance diagram for google_classroom_api::GuardianInvitation:

Public Member Functions
	GuardianInvitation (const Json::Value &storage)
	GuardianInvitation (Json::Value *storage)
virtual	~GuardianInvitation ()
const StringPiece	GetTypeName () const
bool	has_creation_time () const
void	clear_creation_time ()
const StringPiece	get_creation_time () const
void	set_creation_time (const StringPiece &value)
bool	has_invitation_id () const
void	clear_invitation_id ()
const StringPiece	get_invitation_id () const
void	set_invitation_id (const StringPiece &value)
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_state () const
void	clear_state ()
const StringPiece	get_state () const
void	set_state (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 GuardianInvitation *	New ()

Detailed Description

An invitation to become the guardian of a specified user, sent to a specified email address.

Constructor & Destructor Documentation

GuardianInvitation() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

GuardianInvitation() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~GuardianInvitation()

google_classroom_api::GuardianInvitation::~GuardianInvitation ( )

virtual

Standard destructor.

Member Function Documentation

clear_creation_time()

void google_classroom_api::GuardianInvitation::clear_creation_time ( )

inline

Clears the 'creationTime' attribute.

clear_invitation_id()

void google_classroom_api::GuardianInvitation::clear_invitation_id ( )

inline

Clears the 'invitationId' attribute.

clear_invited_email_address()

void google_classroom_api::GuardianInvitation::clear_invited_email_address ( )

inline

Clears the 'invitedEmailAddress' attribute.

clear_state()

void google_classroom_api::GuardianInvitation::clear_state ( )

inline

Clears the 'state' attribute.

clear_student_id()

void google_classroom_api::GuardianInvitation::clear_student_id ( )

inline

Clears the 'studentId' attribute.

get_creation_time()

const StringPiece google_classroom_api::GuardianInvitation::get_creation_time ( ) const

inline

Get the value of the 'creationTime' attribute.

get_invitation_id()

const StringPiece google_classroom_api::GuardianInvitation::get_invitation_id ( ) const

inline

Get the value of the 'invitationId' attribute.

get_invited_email_address()

const StringPiece google_classroom_api::GuardianInvitation::get_invited_email_address ( ) const

inline

Get the value of the 'invitedEmailAddress' attribute.

get_state()

const StringPiece google_classroom_api::GuardianInvitation::get_state ( ) const

inline

Get the value of the 'state' attribute.

get_student_id()

const StringPiece google_classroom_api::GuardianInvitation::get_student_id ( ) const

inline

Get the value of the 'studentId' attribute.

GetTypeName()

const StringPiece google_classroom_api::GuardianInvitation::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::GuardianInvitation

has_creation_time()

bool google_classroom_api::GuardianInvitation::has_creation_time ( ) const

inline

Determine if the 'creationTime' attribute was set.

Returns

true if the 'creationTime' attribute was set.

has_invitation_id()

bool google_classroom_api::GuardianInvitation::has_invitation_id ( ) const

inline

Determine if the 'invitationId' attribute was set.

Returns

true if the 'invitationId' attribute was set.

has_invited_email_address()

bool google_classroom_api::GuardianInvitation::has_invited_email_address ( ) const

inline

Determine if the 'invitedEmailAddress' attribute was set.

Returns

true if the 'invitedEmailAddress' attribute was set.

has_state()

bool google_classroom_api::GuardianInvitation::has_state ( ) const

inline

Determine if the 'state' attribute was set.

Returns

true if the 'state' attribute was set.

has_student_id()

bool google_classroom_api::GuardianInvitation::has_student_id ( ) const

inline

Determine if the 'studentId' attribute was set.

Returns

true if the 'studentId' attribute was set.

New()

GuardianInvitation * google_classroom_api::GuardianInvitation::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_creation_time()

void google_classroom_api::GuardianInvitation::set_creation_time ( const StringPiece &  value )

inline

Change the 'creationTime' attribute.

The time that this invitation was created.

Read-only.

Parameters

[in]

value

The new value.

set_invitation_id()

void google_classroom_api::GuardianInvitation::set_invitation_id ( const StringPiece &  value )

inline

Change the 'invitationId' attribute.

Unique identifier for this invitation.

Read-only.

Parameters

[in]

value

The new value.

set_invited_email_address()

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

inline

Change the 'invitedEmailAddress' attribute.

Email address that the invitation was sent to. This field is only visible to domain administrators.

Parameters

[in]

value

The new value.

set_state()

void google_classroom_api::GuardianInvitation::set_state ( const StringPiece &  value )

inline

Change the 'state' attribute.

The state that this invitation is in.

Parameters

[in]

value

The new value.

set_student_id()

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

inline

Change the 'studentId' attribute.

ID of the student (in standard format).

Parameters

[in]

value

The new value.

---

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

• google/classroom_api/guardian_invitation.h
• google/classroom_api/guardian_invitation.cc