google_classroom_api::CourseMaterialSet Class Reference

#include <course_material_set.h>

Inheritance diagram for google_classroom_api::CourseMaterialSet:

Public Member Functions
	CourseMaterialSet (const Json::Value &storage)
	CourseMaterialSet (Json::Value *storage)
virtual	~CourseMaterialSet ()
const StringPiece	GetTypeName () const
bool	has_materials () const
void	clear_materials ()
const client::JsonCppArray< CourseMaterial >	get_materials () const
client::JsonCppArray< CourseMaterial >	mutable_materials ()
bool	has_title () const
void	clear_title ()
const StringPiece	get_title () const
void	set_title (const StringPiece &value)

Static Public Member Functions
static CourseMaterialSet *	New ()

Detailed Description

A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.

Constructor & Destructor Documentation

CourseMaterialSet() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

CourseMaterialSet() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~CourseMaterialSet()

google_classroom_api::CourseMaterialSet::~CourseMaterialSet ( )

virtual

Standard destructor.

Member Function Documentation

clear_materials()

void google_classroom_api::CourseMaterialSet::clear_materials ( )

inline

Clears the 'materials' attribute.

clear_title()

void google_classroom_api::CourseMaterialSet::clear_title ( )

inline

Clears the 'title' attribute.

get_materials()

const client::JsonCppArray<CourseMaterial > google_classroom_api::CourseMaterialSet::get_materials

(

)

const

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

get_title()

const StringPiece google_classroom_api::CourseMaterialSet::get_title ( ) const

inline

Get the value of the 'title' attribute.

GetTypeName()

const StringPiece google_classroom_api::CourseMaterialSet::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::CourseMaterialSet

has_materials()

bool google_classroom_api::CourseMaterialSet::has_materials ( ) const

inline

Determine if the 'materials' attribute was set.

Returns

true if the 'materials' attribute was set.

has_title()

bool google_classroom_api::CourseMaterialSet::has_title ( ) const

inline

Determine if the 'title' attribute was set.

Returns

true if the 'title' attribute was set.

mutable_materials()

client::JsonCppArray<CourseMaterial > google_classroom_api::CourseMaterialSet::mutable_materials

(

)

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

Materials attached to this set.

Returns

The result can be modified to change the attribute value.

New()

CourseMaterialSet * google_classroom_api::CourseMaterialSet::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_title()

void google_classroom_api::CourseMaterialSet::set_title ( const StringPiece &  value )

inline

Change the 'title' attribute.

Title for this set.

Parameters

[in]

value

The new value.

---

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

• google/classroom_api/course_material_set.h
• google/classroom_api/course_material_set.cc