google_classroom_api::Topic Class Reference

#include <topic.h>

Inheritance diagram for google_classroom_api::Topic:

Public Member Functions
	Topic (const Json::Value &storage)
	Topic (Json::Value *storage)
virtual	~Topic ()
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_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)
bool	has_topic_id () const
void	clear_topic_id ()
const StringPiece	get_topic_id () const
void	set_topic_id (const StringPiece &value)
bool	has_update_time () const
void	clear_update_time ()
const StringPiece	get_update_time () const
void	set_update_time (const StringPiece &value)

Static Public Member Functions
static Topic *	New ()

Detailed Description

Topic created by a teacher for the course.

Constructor & Destructor Documentation

Topic() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Topic() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Topic()

google_classroom_api::Topic::~Topic ( )

virtual

Standard destructor.

Member Function Documentation

clear_course_id()

void google_classroom_api::Topic::clear_course_id ( )

inline

Clears the 'courseId' attribute.

clear_name()

void google_classroom_api::Topic::clear_name ( )

inline

Clears the 'name' attribute.

clear_topic_id()

void google_classroom_api::Topic::clear_topic_id ( )

inline

Clears the 'topicId' attribute.

clear_update_time()

void google_classroom_api::Topic::clear_update_time ( )

inline

Clears the 'updateTime' attribute.

get_course_id()

const StringPiece google_classroom_api::Topic::get_course_id ( ) const

inline

Get the value of the 'courseId' attribute.

get_name()

const StringPiece google_classroom_api::Topic::get_name ( ) const

inline

Get the value of the 'name' attribute.

get_topic_id()

const StringPiece google_classroom_api::Topic::get_topic_id ( ) const

inline

Get the value of the 'topicId' attribute.

get_update_time()

const StringPiece google_classroom_api::Topic::get_update_time ( ) const

inline

Get the value of the 'updateTime' attribute.

GetTypeName()

const StringPiece google_classroom_api::Topic::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_classroom_api::Topic

has_course_id()

bool google_classroom_api::Topic::has_course_id ( ) const

inline

Determine if the 'courseId' attribute was set.

Returns

true if the 'courseId' attribute was set.

has_name()

bool google_classroom_api::Topic::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

has_topic_id()

bool google_classroom_api::Topic::has_topic_id ( ) const

inline

Determine if the 'topicId' attribute was set.

Returns

true if the 'topicId' attribute was set.

has_update_time()

bool google_classroom_api::Topic::has_update_time ( ) const

inline

Determine if the 'updateTime' attribute was set.

Returns

true if the 'updateTime' attribute was set.

New()

Topic * google_classroom_api::Topic::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_course_id()

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

inline

Change the 'courseId' attribute.

Identifier of the course.

Read-only.

Parameters

[in]

value

The new value.

set_name()

void google_classroom_api::Topic::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters.

Parameters

[in]

value

The new value.

set_topic_id()

void google_classroom_api::Topic::set_topic_id ( const StringPiece &  value )

inline

Change the 'topicId' attribute.

Unique identifier for the topic.

Read-only.

Parameters

[in]

value

The new value.

set_update_time()

void google_classroom_api::Topic::set_update_time ( const StringPiece &  value )

inline

Change the 'updateTime' attribute.

The time the topic was last updated by the system.

Read-only.

Parameters

[in]

value

The new value.

---

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

• google/classroom_api/topic.h
• google/classroom_api/topic.cc