google_classroom_api::Invitation Class Reference

#include <invitation.h>

Inheritance diagram for google_classroom_api::Invitation:

Public Member Functions
	Invitation (const Json::Value &storage)
	Invitation (Json::Value *storage)
virtual	~Invitation ()
const StringPiece	GetTypeName () const
bool	has_course_id () const
void	clear_course_id ()
const StringPiece	get_course_id () const
void	set_course_id (const StringPiece &value)
bool	has_id () const
void	clear_id ()
const StringPiece	get_id () const
void	set_id (const StringPiece &value)
bool	has_role () const
void	clear_role ()
const StringPiece	get_role () const
void	set_role (const StringPiece &value)
bool	has_user_id () const
void	clear_user_id ()
const StringPiece	get_user_id () const
void	set_user_id (const StringPiece &value)

Static Public Member Functions
static Invitation *	New ()

Detailed Description

An invitation to join a course.

Constructor & Destructor Documentation

Invitation() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Invitation() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Invitation()

google_classroom_api::Invitation::~Invitation ( )

virtual

Standard destructor.

Member Function Documentation

clear_course_id()

void google_classroom_api::Invitation::clear_course_id ( )

inline

Clears the 'courseId' attribute.

clear_id()

void google_classroom_api::Invitation::clear_id ( )

inline

Clears the 'id' attribute.

clear_role()

void google_classroom_api::Invitation::clear_role ( )

inline

Clears the 'role' attribute.

clear_user_id()

void google_classroom_api::Invitation::clear_user_id ( )

inline

Clears the 'userId' attribute.

get_course_id()

const StringPiece google_classroom_api::Invitation::get_course_id ( ) const

inline

Get the value of the 'courseId' attribute.

get_id()

const StringPiece google_classroom_api::Invitation::get_id ( ) const

inline

Get the value of the 'id' attribute.

get_role()

const StringPiece google_classroom_api::Invitation::get_role ( ) const

inline

Get the value of the 'role' attribute.

get_user_id()

const StringPiece google_classroom_api::Invitation::get_user_id ( ) const

inline

Get the value of the 'userId' attribute.

GetTypeName()

const StringPiece google_classroom_api::Invitation::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::Invitation

has_course_id()

bool google_classroom_api::Invitation::has_course_id ( ) const

inline

Determine if the 'courseId' attribute was set.

Returns

true if the 'courseId' attribute was set.

has_id()

bool google_classroom_api::Invitation::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns

true if the 'id' attribute was set.

has_role()

bool google_classroom_api::Invitation::has_role ( ) const

inline

Determine if the 'role' attribute was set.

Returns

true if the 'role' attribute was set.

has_user_id()

bool google_classroom_api::Invitation::has_user_id ( ) const

inline

Determine if the 'userId' attribute was set.

Returns

true if the 'userId' attribute was set.

New()

Invitation * google_classroom_api::Invitation::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_course_id()

void google_classroom_api::Invitation::set_course_id ( const StringPiece &  value )

inline

Change the 'courseId' attribute.

Identifier of the course to invite the user to.

Parameters

[in]

value

The new value.

set_id()

void google_classroom_api::Invitation::set_id ( const StringPiece &  value )

inline

Change the 'id' attribute.

Identifier assigned by Classroom.

Read-only.

Parameters

[in]

value

The new value.

set_role()

void google_classroom_api::Invitation::set_role ( const StringPiece &  value )

inline

Change the 'role' attribute.

Role to invite the user to have. Must not be COURSE_ROLE_UNSPECIFIED.

Parameters

[in]

value

The new value.

set_user_id()

void google_classroom_api::Invitation::set_user_id ( const StringPiece &  value )

inline

Change the 'userId' attribute.

Identifier of the invited user.

When specified as a parameter of a request, this identifier can be set to 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]

value

The new value.

---

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

• google/classroom_api/invitation.h
• google/classroom_api/invitation.cc