google_classroom_api::Student Class Reference

#include <student.h>

Inheritance diagram for google_classroom_api::Student:

Public Member Functions
	Student (const Json::Value &storage)
	Student (Json::Value *storage)
virtual	~Student ()
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_profile () const
void	clear_profile ()
const UserProfile	get_profile () const
UserProfile	mutable_profile ()
bool	has_student_work_folder () const
void	clear_student_work_folder ()
const DriveFolder	get_student_work_folder () const
DriveFolder	mutable_studentWorkFolder ()
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 Student *	New ()

Detailed Description

Student in a course.

Constructor & Destructor Documentation

Student() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Student() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Student()

google_classroom_api::Student::~Student ( )

virtual

Standard destructor.

Member Function Documentation

clear_course_id()

void google_classroom_api::Student::clear_course_id ( )

inline

Clears the 'courseId' attribute.

clear_profile()

void google_classroom_api::Student::clear_profile ( )

inline

Clears the 'profile' attribute.

clear_student_work_folder()

void google_classroom_api::Student::clear_student_work_folder ( )

inline

Clears the 'studentWorkFolder' attribute.

clear_user_id()

void google_classroom_api::Student::clear_user_id ( )

inline

Clears the 'userId' attribute.

get_course_id()

const StringPiece google_classroom_api::Student::get_course_id ( ) const

inline

Get the value of the 'courseId' attribute.

get_profile()

const UserProfile google_classroom_api::Student::get_profile

(

)

const

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

get_student_work_folder()

const DriveFolder google_classroom_api::Student::get_student_work_folder

(

)

const

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

get_user_id()

const StringPiece google_classroom_api::Student::get_user_id ( ) const

inline

Get the value of the 'userId' attribute.

GetTypeName()

const StringPiece google_classroom_api::Student::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::Student

has_course_id()

bool google_classroom_api::Student::has_course_id ( ) const

inline

Determine if the 'courseId' attribute was set.

Returns

true if the 'courseId' attribute was set.

has_profile()

bool google_classroom_api::Student::has_profile ( ) const

inline

Determine if the 'profile' attribute was set.

Returns

true if the 'profile' attribute was set.

has_student_work_folder()

bool google_classroom_api::Student::has_student_work_folder ( ) const

inline

Determine if the 'studentWorkFolder' attribute was set.

Returns

true if the 'studentWorkFolder' attribute was set.

has_user_id()

bool google_classroom_api::Student::has_user_id ( ) const

inline

Determine if the 'userId' attribute was set.

Returns

true if the 'userId' attribute was set.

mutable_profile()

UserProfile google_classroom_api::Student::mutable_profile

(

)

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

Global user information for the student.

Read-only.

Returns

The result can be modified to change the attribute value.

mutable_studentWorkFolder()

DriveFolder google_classroom_api::Student::mutable_studentWorkFolder

(

)

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

Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators.

Read-only.

Returns

The result can be modified to change the attribute value.

New()

Student * google_classroom_api::Student::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_course_id()

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

inline

Change the 'courseId' attribute.

Identifier of the course.

Read-only.

Parameters

[in]

value

The new value.

set_user_id()

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

inline

Change the 'userId' attribute.

Identifier of the user.

When specified as a parameter of a request, this 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.

Parameters

[in]

value

The new value.

---

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

• google/classroom_api/student.h
• google/classroom_api/student.cc