#include <course.h>

Inheritance diagram for google_classroom_api::Course:

Public Member Functions
	Course (const Json::Value &storage)

	Course (Json::Value *storage)

virtual	~Course ()

const StringPiece	GetTypeName () const

bool	has_alternate_link () const

void	clear_alternate_link ()

const StringPiece	get_alternate_link () const

void	set_alternate_link (const StringPiece &value)

bool	has_calendar_id () const

void	clear_calendar_id ()

const StringPiece	get_calendar_id () const

void	set_calendar_id (const StringPiece &value)

bool	has_course_group_email () const

void	clear_course_group_email ()

const StringPiece	get_course_group_email () const

void	set_course_group_email (const StringPiece &value)

bool	has_course_material_sets () const

void	clear_course_material_sets ()

const client::JsonCppArray< CourseMaterialSet >	get_course_material_sets () const

client::JsonCppArray< CourseMaterialSet >	mutable_courseMaterialSets ()

bool	has_course_state () const

void	clear_course_state ()

const StringPiece	get_course_state () const

void	set_course_state (const StringPiece &value)

bool	has_creation_time () const

void	clear_creation_time ()

const StringPiece	get_creation_time () const

void	set_creation_time (const StringPiece &value)

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_description_heading () const

void	clear_description_heading ()

const StringPiece	get_description_heading () const

void	set_description_heading (const StringPiece &value)

bool	has_enrollment_code () const

void	clear_enrollment_code ()

const StringPiece	get_enrollment_code () const

void	set_enrollment_code (const StringPiece &value)

bool	has_guardians_enabled () const

void	clear_guardians_enabled ()

bool	get_guardians_enabled () const

void	set_guardians_enabled (bool value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_name () const

void	clear_name ()

const StringPiece	get_name () const

void	set_name (const StringPiece &value)

bool	has_owner_id () const

void	clear_owner_id ()

const StringPiece	get_owner_id () const

void	set_owner_id (const StringPiece &value)

bool	has_room () const

void	clear_room ()

const StringPiece	get_room () const

void	set_room (const StringPiece &value)

bool	has_section () const

void	clear_section ()

const StringPiece	get_section () const

void	set_section (const StringPiece &value)

bool	has_teacher_folder () const

void	clear_teacher_folder ()

const DriveFolder	get_teacher_folder () const

DriveFolder	mutable_teacherFolder ()

bool	has_teacher_group_email () const

void	clear_teacher_group_email ()

const StringPiece	get_teacher_group_email () const

void	set_teacher_group_email (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 Course *	New ()

Detailed Description

A Course in Classroom.

Constructor & Destructor Documentation

◆ Course() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Course() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Course()

google_classroom_api::Course::~Course ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_alternate_link()

void google_classroom_api::Course::clear_alternate_link ( )

inline

Clears the 'alternateLink' attribute.

◆ clear_calendar_id()

void google_classroom_api::Course::clear_calendar_id ( )

inline

Clears the 'calendarId' attribute.

◆ clear_course_group_email()

void google_classroom_api::Course::clear_course_group_email ( )

inline

Clears the 'courseGroupEmail' attribute.

◆ clear_course_material_sets()

void google_classroom_api::Course::clear_course_material_sets ( )

inline

Clears the 'courseMaterialSets' attribute.

◆ clear_course_state()

void google_classroom_api::Course::clear_course_state ( )

inline

Clears the 'courseState' attribute.

◆ clear_creation_time()

void google_classroom_api::Course::clear_creation_time ( )

inline

Clears the 'creationTime' attribute.

◆ clear_description()

void google_classroom_api::Course::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_description_heading()

void google_classroom_api::Course::clear_description_heading ( )

inline

Clears the 'descriptionHeading' attribute.

◆ clear_enrollment_code()

void google_classroom_api::Course::clear_enrollment_code ( )

inline

Clears the 'enrollmentCode' attribute.

◆ clear_guardians_enabled()

void google_classroom_api::Course::clear_guardians_enabled ( )

inline

Clears the 'guardiansEnabled' attribute.

◆ clear_id()

void google_classroom_api::Course::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_name()

void google_classroom_api::Course::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_owner_id()

void google_classroom_api::Course::clear_owner_id ( )

inline

Clears the 'ownerId' attribute.

◆ clear_room()

void google_classroom_api::Course::clear_room ( )

inline

Clears the 'room' attribute.

◆ clear_section()

void google_classroom_api::Course::clear_section ( )

inline

Clears the 'section' attribute.

◆ clear_teacher_folder()

void google_classroom_api::Course::clear_teacher_folder ( )

inline

Clears the 'teacherFolder' attribute.

◆ clear_teacher_group_email()

void google_classroom_api::Course::clear_teacher_group_email ( )

inline

Clears the 'teacherGroupEmail' attribute.

◆ clear_update_time()

void google_classroom_api::Course::clear_update_time ( )

inline

Clears the 'updateTime' attribute.

◆ get_alternate_link()

const StringPiece google_classroom_api::Course::get_alternate_link ( ) const

inline

Get the value of the 'alternateLink' attribute.

◆ get_calendar_id()

const StringPiece google_classroom_api::Course::get_calendar_id ( ) const

inline

Get the value of the 'calendarId' attribute.

◆ get_course_group_email()

const StringPiece google_classroom_api::Course::get_course_group_email ( ) const

inline

Get the value of the 'courseGroupEmail' attribute.

◆ get_course_material_sets()

const client::JsonCppArray<CourseMaterialSet > google_classroom_api::Course::get_course_material_sets ( ) const

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

◆ get_course_state()

const StringPiece google_classroom_api::Course::get_course_state ( ) const

inline

Get the value of the 'courseState' attribute.

◆ get_creation_time()

const StringPiece google_classroom_api::Course::get_creation_time ( ) const

inline

Get the value of the 'creationTime' attribute.

◆ get_description()

const StringPiece google_classroom_api::Course::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_description_heading()

const StringPiece google_classroom_api::Course::get_description_heading ( ) const

inline

Get the value of the 'descriptionHeading' attribute.

◆ get_enrollment_code()

const StringPiece google_classroom_api::Course::get_enrollment_code ( ) const

inline

Get the value of the 'enrollmentCode' attribute.

◆ get_guardians_enabled()

bool google_classroom_api::Course::get_guardians_enabled ( ) const

inline

Get the value of the 'guardiansEnabled' attribute.

◆ get_id()

const StringPiece google_classroom_api::Course::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_name()

const StringPiece google_classroom_api::Course::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_owner_id()

const StringPiece google_classroom_api::Course::get_owner_id ( ) const

inline

Get the value of the 'ownerId' attribute.

◆ get_room()

const StringPiece google_classroom_api::Course::get_room ( ) const

inline

Get the value of the 'room' attribute.

◆ get_section()

const StringPiece google_classroom_api::Course::get_section ( ) const

inline

Get the value of the 'section' attribute.

◆ get_teacher_folder()

const DriveFolder google_classroom_api::Course::get_teacher_folder ( ) const

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

◆ get_teacher_group_email()

const StringPiece google_classroom_api::Course::get_teacher_group_email ( ) const

inline

Get the value of the 'teacherGroupEmail' attribute.

◆ get_update_time()

const StringPiece google_classroom_api::Course::get_update_time ( ) const

inline

Get the value of the 'updateTime' attribute.

◆ GetTypeName()

const StringPiece google_classroom_api::Course::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_classroom_api::Course

◆ has_alternate_link()

bool google_classroom_api::Course::has_alternate_link ( ) const

inline

Determine if the 'alternateLink' attribute was set.

Returns: true if the 'alternateLink' attribute was set.

◆ has_calendar_id()

bool google_classroom_api::Course::has_calendar_id ( ) const

inline

Determine if the 'calendarId' attribute was set.

Returns: true if the 'calendarId' attribute was set.

◆ has_course_group_email()

bool google_classroom_api::Course::has_course_group_email ( ) const

inline

Determine if the 'courseGroupEmail' attribute was set.

Returns: true if the 'courseGroupEmail' attribute was set.

◆ has_course_material_sets()

bool google_classroom_api::Course::has_course_material_sets ( ) const

inline

Determine if the 'courseMaterialSets' attribute was set.

Returns: true if the 'courseMaterialSets' attribute was set.

◆ has_course_state()

bool google_classroom_api::Course::has_course_state ( ) const

inline

Determine if the 'courseState' attribute was set.

Returns: true if the 'courseState' attribute was set.

◆ has_creation_time()

bool google_classroom_api::Course::has_creation_time ( ) const

inline

Determine if the 'creationTime' attribute was set.

Returns: true if the 'creationTime' attribute was set.

◆ has_description()

bool google_classroom_api::Course::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_description_heading()

bool google_classroom_api::Course::has_description_heading ( ) const

inline

Determine if the 'descriptionHeading' attribute was set.

Returns: true if the 'descriptionHeading' attribute was set.

◆ has_enrollment_code()

bool google_classroom_api::Course::has_enrollment_code ( ) const

inline

Determine if the 'enrollmentCode' attribute was set.

Returns: true if the 'enrollmentCode' attribute was set.

◆ has_guardians_enabled()

bool google_classroom_api::Course::has_guardians_enabled ( ) const

inline

Determine if the 'guardiansEnabled' attribute was set.

Returns: true if the 'guardiansEnabled' attribute was set.

◆ has_id()

bool google_classroom_api::Course::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_name()

bool google_classroom_api::Course::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_owner_id()

bool google_classroom_api::Course::has_owner_id ( ) const

inline

Determine if the 'ownerId' attribute was set.

Returns: true if the 'ownerId' attribute was set.

◆ has_room()

bool google_classroom_api::Course::has_room ( ) const

inline

Determine if the 'room' attribute was set.

Returns: true if the 'room' attribute was set.

◆ has_section()

bool google_classroom_api::Course::has_section ( ) const

inline

Determine if the 'section' attribute was set.

Returns: true if the 'section' attribute was set.

◆ has_teacher_folder()

bool google_classroom_api::Course::has_teacher_folder ( ) const

inline

Determine if the 'teacherFolder' attribute was set.

Returns: true if the 'teacherFolder' attribute was set.

◆ has_teacher_group_email()

bool google_classroom_api::Course::has_teacher_group_email ( ) const

inline

Determine if the 'teacherGroupEmail' attribute was set.

Returns: true if the 'teacherGroupEmail' attribute was set.

◆ has_update_time()

bool google_classroom_api::Course::has_update_time ( ) const

inline

Determine if the 'updateTime' attribute was set.

Returns: true if the 'updateTime' attribute was set.

◆ mutable_courseMaterialSets()

client::JsonCppArray<CourseMaterialSet > google_classroom_api::Course::mutable_courseMaterialSets ( )

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

Sets of materials that appear on the "about" page of this course.

Read-only.

Returns: The result can be modified to change the attribute value.

◆ mutable_teacherFolder()

DriveFolder google_classroom_api::Course::mutable_teacherFolder ( )

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

Information about a Drive Folder that is shared with all teachers of the course.

This field will only be set for teachers of the course and domain administrators.

Read-only.

Returns: The result can be modified to change the attribute value.

◆ New()

Course * google_classroom_api::Course::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_alternate_link()

void google_classroom_api::Course::set_alternate_link ( const StringPiece & value )

inline

Change the 'alternateLink' attribute.

Absolute link to this course in the Classroom web UI.

Read-only.

Parameters

[in] value The new value.

◆ set_calendar_id()

void google_classroom_api::Course::set_calendar_id ( const StringPiece & value )

inline

Change the 'calendarId' attribute.

The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course.

Read-only.

Parameters

[in] value The new value.

◆ set_course_group_email()

void google_classroom_api::Course::set_course_group_email ( const StringPiece & value )

inline

Change the 'courseGroupEmail' attribute.

The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions.

Read-only.

Parameters

[in] value The new value.

◆ set_course_state()

void google_classroom_api::Course::set_course_state ( const StringPiece & value )

inline

Change the 'courseState' attribute.

State of the course. If unspecified, the default state is PROVISIONED.

Parameters

[in] value The new value.

◆ set_creation_time()

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

inline

Change the 'creationTime' attribute.

Creation time of the course. Specifying this field in a course update mask results in an error.

Read-only.

Parameters

[in] value The new value.

◆ set_description()

void google_classroom_api::Course::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.

Parameters

[in] value The new value.

◆ set_description_heading()

void google_classroom_api::Course::set_description_heading ( const StringPiece & value )

inline

Change the 'descriptionHeading' attribute.

Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.

Parameters

[in] value The new value.

◆ set_enrollment_code()

void google_classroom_api::Course::set_enrollment_code ( const StringPiece & value )

inline

Change the 'enrollmentCode' attribute.

Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error.

Read-only.

Parameters

[in] value The new value.

◆ set_guardians_enabled()

void google_classroom_api::Course::set_guardians_enabled ( bool value )

inline

Change the 'guardiansEnabled' attribute.

Whether or not guardian notifications are enabled for this course.

Read-only.

Parameters

[in] value The new value.

◆ set_id()

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

inline

Change the 'id' attribute.

Identifier for this course assigned by Classroom.

When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The id is still assigned by Classroom and cannot be updated after the course is created.

Specifying this field in a course update mask results in an error.

Parameters

[in] value The new value.

◆ set_name()

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

inline

Change the 'name' attribute.

Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.

Parameters

[in] value The new value.

◆ set_owner_id()

void google_classroom_api::Course::set_owner_id ( const StringPiece & value )

inline

Change the 'ownerId' attribute.

The identifier of the owner of a course.

When specified as a parameter of a create course request, this field is required. The 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

This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only.

Parameters

[in] value The new value.

◆ set_room()

void google_classroom_api::Course::set_room ( const StringPiece & value )

inline

Change the 'room' attribute.

Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.

Parameters

[in] value The new value.

◆ set_section()

void google_classroom_api::Course::set_section ( const StringPiece & value )

inline

Change the 'section' attribute.

Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.

Parameters

[in] value The new value.

◆ set_teacher_group_email()

void google_classroom_api::Course::set_teacher_group_email ( const StringPiece & value )

inline

Change the 'teacherGroupEmail' attribute.

The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions.

Read-only.

Parameters

[in] value The new value.

◆ set_update_time()

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

inline

Change the 'updateTime' attribute.

Time of the most recent update to this course. Specifying this field in a course update mask results in an error.

Read-only.

Parameters

[in] value The new value.

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

google/classroom_api/course.h
google/classroom_api/course.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Course() [1/2]

◆ Course() [2/2]

◆ ~Course()

Member Function Documentation

◆ clear_alternate_link()

◆ clear_calendar_id()

◆ clear_course_group_email()

◆ clear_course_material_sets()

◆ clear_course_state()

◆ clear_creation_time()

◆ clear_description()

◆ clear_description_heading()

◆ clear_enrollment_code()

◆ clear_guardians_enabled()

◆ clear_id()

◆ clear_name()

◆ clear_owner_id()

◆ clear_room()

◆ clear_section()

◆ clear_teacher_folder()

◆ clear_teacher_group_email()

◆ clear_update_time()

◆ get_alternate_link()

◆ get_calendar_id()

◆ get_course_group_email()

◆ get_course_material_sets()

◆ get_course_state()

◆ get_creation_time()

◆ get_description()

◆ get_description_heading()

◆ get_enrollment_code()

◆ get_guardians_enabled()

◆ get_id()

◆ get_name()

◆ get_owner_id()

◆ get_room()

◆ get_section()

◆ get_teacher_folder()

◆ get_teacher_group_email()

◆ get_update_time()

◆ GetTypeName()

◆ has_alternate_link()

◆ has_calendar_id()

◆ has_course_group_email()

◆ has_course_material_sets()

◆ has_course_state()

◆ has_creation_time()

◆ has_description()

◆ has_description_heading()

◆ has_enrollment_code()

◆ has_guardians_enabled()

◆ has_id()

◆ has_name()

◆ has_owner_id()

◆ has_room()

◆ has_section()

◆ has_teacher_folder()

◆ has_teacher_group_email()

◆ has_update_time()

◆ mutable_courseMaterialSets()

◆ mutable_teacherFolder()

◆ New()

◆ set_alternate_link()

◆ set_calendar_id()

◆ set_course_group_email()

◆ set_course_state()

◆ set_creation_time()

◆ set_description()

◆ set_description_heading()

◆ set_enrollment_code()

◆ set_guardians_enabled()

◆ set_id()

◆ set_name()

◆ set_owner_id()

◆ set_room()

◆ set_section()