#include <announcement.h>

Inheritance diagram for google_classroom_api::Announcement:

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

	Announcement (Json::Value *storage)

virtual	~Announcement ()

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_assignee_mode () const

void	clear_assignee_mode ()

const StringPiece	get_assignee_mode () const

void	set_assignee_mode (const StringPiece &value)

bool	has_course_id () const

void	clear_course_id ()

const StringPiece	get_course_id () const

void	set_course_id (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_creator_user_id () const

void	clear_creator_user_id ()

const StringPiece	get_creator_user_id () const

void	set_creator_user_id (const StringPiece &value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_individual_students_options () const

void	clear_individual_students_options ()

const IndividualStudentsOptions	get_individual_students_options () const

IndividualStudentsOptions	mutable_individualStudentsOptions ()

bool	has_materials () const

void	clear_materials ()

const client::JsonCppArray< Material >	get_materials () const

client::JsonCppArray< Material >	mutable_materials ()

bool	has_scheduled_time () const

void	clear_scheduled_time ()

const StringPiece	get_scheduled_time () const

void	set_scheduled_time (const StringPiece &value)

bool	has_state () const

void	clear_state ()

const StringPiece	get_state () const

void	set_state (const StringPiece &value)

bool	has_text () const

void	clear_text ()

const StringPiece	get_text () const

void	set_text (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 Announcement *	New ()

Detailed Description

Announcement created by a teacher for students of the course.

Constructor & Destructor Documentation

◆ Announcement() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Announcement() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Announcement()

google_classroom_api::Announcement::~Announcement ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_alternate_link()

void google_classroom_api::Announcement::clear_alternate_link ( )

inline

Clears the 'alternateLink' attribute.

◆ clear_assignee_mode()

void google_classroom_api::Announcement::clear_assignee_mode ( )

inline

Clears the 'assigneeMode' attribute.

◆ clear_course_id()

void google_classroom_api::Announcement::clear_course_id ( )

inline

Clears the 'courseId' attribute.

◆ clear_creation_time()

void google_classroom_api::Announcement::clear_creation_time ( )

inline

Clears the 'creationTime' attribute.

◆ clear_creator_user_id()

void google_classroom_api::Announcement::clear_creator_user_id ( )

inline

Clears the 'creatorUserId' attribute.

◆ clear_id()

void google_classroom_api::Announcement::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_individual_students_options()

void google_classroom_api::Announcement::clear_individual_students_options ( )

inline

Clears the 'individualStudentsOptions' attribute.

◆ clear_materials()

void google_classroom_api::Announcement::clear_materials ( )

inline

Clears the 'materials' attribute.

◆ clear_scheduled_time()

void google_classroom_api::Announcement::clear_scheduled_time ( )

inline

Clears the 'scheduledTime' attribute.

◆ clear_state()

void google_classroom_api::Announcement::clear_state ( )

inline

Clears the 'state' attribute.

◆ clear_text()

void google_classroom_api::Announcement::clear_text ( )

inline

Clears the 'text' attribute.

◆ clear_update_time()

void google_classroom_api::Announcement::clear_update_time ( )

inline

Clears the 'updateTime' attribute.

◆ get_alternate_link()

const StringPiece google_classroom_api::Announcement::get_alternate_link ( ) const

inline

Get the value of the 'alternateLink' attribute.

◆ get_assignee_mode()

const StringPiece google_classroom_api::Announcement::get_assignee_mode ( ) const

inline

Get the value of the 'assigneeMode' attribute.

◆ get_course_id()

const StringPiece google_classroom_api::Announcement::get_course_id ( ) const

inline

Get the value of the 'courseId' attribute.

◆ get_creation_time()

const StringPiece google_classroom_api::Announcement::get_creation_time ( ) const

inline

Get the value of the 'creationTime' attribute.

◆ get_creator_user_id()

const StringPiece google_classroom_api::Announcement::get_creator_user_id ( ) const

inline

Get the value of the 'creatorUserId' attribute.

◆ get_id()

const StringPiece google_classroom_api::Announcement::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_individual_students_options()

const IndividualStudentsOptions google_classroom_api::Announcement::get_individual_students_options ( ) const

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

◆ get_materials()

const client::JsonCppArray<Material > google_classroom_api::Announcement::get_materials ( ) const

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

◆ get_scheduled_time()

const StringPiece google_classroom_api::Announcement::get_scheduled_time ( ) const

inline

Get the value of the 'scheduledTime' attribute.

◆ get_state()

const StringPiece google_classroom_api::Announcement::get_state ( ) const

inline

Get the value of the 'state' attribute.

◆ get_text()

const StringPiece google_classroom_api::Announcement::get_text ( ) const

inline

Get the value of the 'text' attribute.

◆ get_update_time()

const StringPiece google_classroom_api::Announcement::get_update_time ( ) const

inline

Get the value of the 'updateTime' attribute.

◆ GetTypeName()

const StringPiece google_classroom_api::Announcement::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_classroom_api::Announcement

◆ has_alternate_link()

bool google_classroom_api::Announcement::has_alternate_link ( ) const

inline

Determine if the 'alternateLink' attribute was set.

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

◆ has_assignee_mode()

bool google_classroom_api::Announcement::has_assignee_mode ( ) const

inline

Determine if the 'assigneeMode' attribute was set.

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

◆ has_course_id()

bool google_classroom_api::Announcement::has_course_id ( ) const

inline

Determine if the 'courseId' attribute was set.

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

◆ has_creation_time()

bool google_classroom_api::Announcement::has_creation_time ( ) const

inline

Determine if the 'creationTime' attribute was set.

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

◆ has_creator_user_id()

bool google_classroom_api::Announcement::has_creator_user_id ( ) const

inline

Determine if the 'creatorUserId' attribute was set.

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

◆ has_id()

bool google_classroom_api::Announcement::has_id ( ) const

inline

Determine if the 'id' attribute was set.

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

◆ has_individual_students_options()

bool google_classroom_api::Announcement::has_individual_students_options ( ) const

inline

Determine if the 'individualStudentsOptions' attribute was set.

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

◆ has_materials()

bool google_classroom_api::Announcement::has_materials ( ) const

inline

Determine if the 'materials' attribute was set.

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

◆ has_scheduled_time()

bool google_classroom_api::Announcement::has_scheduled_time ( ) const

inline

Determine if the 'scheduledTime' attribute was set.

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

◆ has_state()

bool google_classroom_api::Announcement::has_state ( ) const

inline

Determine if the 'state' attribute was set.

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

◆ has_text()

bool google_classroom_api::Announcement::has_text ( ) const

inline

Determine if the 'text' attribute was set.

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

◆ has_update_time()

bool google_classroom_api::Announcement::has_update_time ( ) const

inline

Determine if the 'updateTime' attribute was set.

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

◆ mutable_individualStudentsOptions()

IndividualStudentsOptions google_classroom_api::Announcement::mutable_individualStudentsOptions ( )

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

Identifiers of students with access to the announcement. This field is set only if assigneeMode is INDIVIDUAL_STUDENTS. If the assigneeMode is INDIVIDUAL_STUDENTS, then only students specified in this field will be able to see the announcement.

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

◆ mutable_materials()

client::JsonCppArray<Material > google_classroom_api::Announcement::mutable_materials ( )

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

Additional materials.

Announcements must have no more than 20 material items.

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

◆ New()

Announcement * google_classroom_api::Announcement::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_alternate_link()

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

inline

Change the 'alternateLink' attribute.

Absolute link to this announcement in the Classroom web UI. This is only populated if state is PUBLISHED.

Read-only.

Parameters

[in] value The new value.

◆ set_assignee_mode()

void google_classroom_api::Announcement::set_assignee_mode ( const StringPiece & value )

inline

Change the 'assigneeMode' attribute.

Assignee mode of the announcement. If unspecified, the default value is ALL_STUDENTS.

Parameters

[in] value The new value.

◆ set_course_id()

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

inline

Change the 'courseId' attribute.

Identifier of the course.

Read-only.

Parameters

[in] value The new value.

◆ set_creation_time()

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

inline

Change the 'creationTime' attribute.

Timestamp when this announcement was created.

Read-only.

Parameters

[in] value The new value.

◆ set_creator_user_id()

void google_classroom_api::Announcement::set_creator_user_id ( const StringPiece & value )

inline

Change the 'creatorUserId' attribute.

Identifier for the user that created the announcement.

Read-only.

Parameters

[in] value The new value.

◆ set_id()

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

inline

Change the 'id' attribute.

Classroom: assigned identifier of this announcement, unique per course.
Read: only.

Parameters

[in] value The new value.

◆ set_scheduled_time()

void google_classroom_api::Announcement::set_scheduled_time ( const StringPiece & value )

inline

Change the 'scheduledTime' attribute.

Optional timestamp when this announcement is scheduled to be published.

Parameters

[in] value The new value.

◆ set_state()

void google_classroom_api::Announcement::set_state ( const StringPiece & value )

inline

Change the 'state' attribute.

Status of this announcement. If unspecified, the default state is DRAFT.

Parameters

[in] value The new value.

◆ set_text()

void google_classroom_api::Announcement::set_text ( const StringPiece & value )

inline

Change the 'text' attribute.

Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.

Parameters

[in] value The new value.

◆ set_update_time()

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

inline

Change the 'updateTime' attribute.

Timestamp of the most recent change to this announcement.

Read-only.

Parameters

[in] value The new value.

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

google/classroom_api/announcement.h
google/classroom_api/announcement.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Announcement() [1/2]

◆ Announcement() [2/2]

◆ ~Announcement()

Member Function Documentation

◆ clear_alternate_link()

◆ clear_assignee_mode()

◆ clear_course_id()

◆ clear_creation_time()

◆ clear_creator_user_id()

◆ clear_id()

◆ clear_individual_students_options()

◆ clear_materials()

◆ clear_scheduled_time()

◆ clear_state()

◆ clear_text()

◆ clear_update_time()

◆ get_alternate_link()

◆ get_assignee_mode()

◆ get_course_id()

◆ get_creation_time()

◆ get_creator_user_id()

◆ get_id()

◆ get_individual_students_options()

◆ get_materials()

◆ get_scheduled_time()

◆ get_state()

◆ get_text()

◆ get_update_time()

◆ GetTypeName()

◆ has_alternate_link()

◆ has_assignee_mode()

◆ has_course_id()

◆ has_creation_time()

◆ has_creator_user_id()

◆ has_id()

◆ has_individual_students_options()

◆ has_materials()

◆ has_scheduled_time()

◆ has_state()

◆ has_text()

◆ has_update_time()

◆ mutable_individualStudentsOptions()

◆ mutable_materials()

◆ New()

◆ set_alternate_link()

◆ set_assignee_mode()

◆ set_course_id()

◆ set_creation_time()

◆ set_creator_user_id()

◆ set_id()

◆ set_scheduled_time()

◆ set_state()

◆ set_text()

◆ set_update_time()