google_drive_api::Comment Class Reference

#include <comment.h>

Inheritance diagram for google_drive_api::Comment:

Classes
class	CommentContext

Public Member Functions
	Comment (const Json::Value &storage)
	Comment (Json::Value *storage)
virtual	~Comment ()
const StringPiece	GetTypeName () const
bool	has_anchor () const
void	clear_anchor ()
const StringPiece	get_anchor () const
void	set_anchor (const StringPiece &value)
bool	has_author () const
void	clear_author ()
const User	get_author () const
User	mutable_author ()
bool	has_comment_id () const
void	clear_comment_id ()
const StringPiece	get_comment_id () const
void	set_comment_id (const StringPiece &value)
bool	has_content () const
void	clear_content ()
const StringPiece	get_content () const
void	set_content (const StringPiece &value)
bool	has_context () const
void	clear_context ()
const CommentContext	get_context () const
CommentContext	mutable_context ()
bool	has_created_date () const
void	clear_created_date ()
client::DateTime	get_created_date () const
void	set_created_date (client::DateTime value)
bool	has_deleted () const
void	clear_deleted ()
bool	get_deleted () const
void	set_deleted (bool value)
bool	has_file_id () const
void	clear_file_id ()
const StringPiece	get_file_id () const
void	set_file_id (const StringPiece &value)
bool	has_file_title () const
void	clear_file_title ()
const StringPiece	get_file_title () const
void	set_file_title (const StringPiece &value)
bool	has_html_content () const
void	clear_html_content ()
const StringPiece	get_html_content () const
void	set_html_content (const StringPiece &value)
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_modified_date () const
void	clear_modified_date ()
client::DateTime	get_modified_date () const
void	set_modified_date (client::DateTime value)
bool	has_replies () const
void	clear_replies ()
const client::JsonCppArray< CommentReply >	get_replies () const
client::JsonCppArray< CommentReply >	mutable_replies ()
bool	has_self_link () const
void	clear_self_link ()
const StringPiece	get_self_link () const
void	set_self_link (const StringPiece &value)
bool	has_status () const
void	clear_status ()
const StringPiece	get_status () const
void	set_status (const StringPiece &value)

Static Public Member Functions
static Comment *	New ()

Detailed Description

A comment on a file in Google Drive.

Constructor & Destructor Documentation

Comment() [1/2]

google_drive_api::Comment::Comment ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Comment() [2/2]

google_drive_api::Comment::Comment ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Comment()

google_drive_api::Comment::~Comment ( )

virtual

Standard destructor.

Member Function Documentation

clear_anchor()

void google_drive_api::Comment::clear_anchor ( )

inline

Clears the 'anchor' attribute.

clear_author()

void google_drive_api::Comment::clear_author ( )

inline

Clears the 'author' attribute.

clear_comment_id()

void google_drive_api::Comment::clear_comment_id ( )

inline

Clears the 'commentId' attribute.

clear_content()

void google_drive_api::Comment::clear_content ( )

inline

Clears the 'content' attribute.

clear_context()

void google_drive_api::Comment::clear_context ( )

inline

Clears the 'context' attribute.

clear_created_date()

void google_drive_api::Comment::clear_created_date ( )

inline

Clears the 'createdDate' attribute.

clear_deleted()

void google_drive_api::Comment::clear_deleted ( )

inline

Clears the 'deleted' attribute.

clear_file_id()

void google_drive_api::Comment::clear_file_id ( )

inline

Clears the 'fileId' attribute.

clear_file_title()

void google_drive_api::Comment::clear_file_title ( )

inline

Clears the 'fileTitle' attribute.

clear_html_content()

void google_drive_api::Comment::clear_html_content ( )

inline

Clears the 'htmlContent' attribute.

clear_kind()

void google_drive_api::Comment::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_modified_date()

void google_drive_api::Comment::clear_modified_date ( )

inline

Clears the 'modifiedDate' attribute.

clear_replies()

void google_drive_api::Comment::clear_replies ( )

inline

Clears the 'replies' attribute.

clear_self_link()

void google_drive_api::Comment::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

clear_status()

void google_drive_api::Comment::clear_status ( )

inline

Clears the 'status' attribute.

get_anchor()

const StringPiece google_drive_api::Comment::get_anchor ( ) const

inline

Get the value of the 'anchor' attribute.

get_author()

const User google_drive_api::Comment::get_author

(

)

const

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

get_comment_id()

const StringPiece google_drive_api::Comment::get_comment_id ( ) const

inline

Get the value of the 'commentId' attribute.

get_content()

const StringPiece google_drive_api::Comment::get_content ( ) const

inline

Get the value of the 'content' attribute.

get_context()

const CommentContext google_drive_api::Comment::get_context ( ) const

inline

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

get_created_date()

client::DateTime google_drive_api::Comment::get_created_date ( ) const

inline

Get the value of the 'createdDate' attribute.

get_deleted()

bool google_drive_api::Comment::get_deleted ( ) const

inline

Get the value of the 'deleted' attribute.

get_file_id()

const StringPiece google_drive_api::Comment::get_file_id ( ) const

inline

Get the value of the 'fileId' attribute.

get_file_title()

const StringPiece google_drive_api::Comment::get_file_title ( ) const

inline

Get the value of the 'fileTitle' attribute.

get_html_content()

const StringPiece google_drive_api::Comment::get_html_content ( ) const

inline

Get the value of the 'htmlContent' attribute.

get_kind()

const StringPiece google_drive_api::Comment::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_modified_date()

client::DateTime google_drive_api::Comment::get_modified_date ( ) const

inline

Get the value of the 'modifiedDate' attribute.

get_replies()

const client::JsonCppArray<CommentReply > google_drive_api::Comment::get_replies

(

)

const

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

get_self_link()

const StringPiece google_drive_api::Comment::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

get_status()

const StringPiece google_drive_api::Comment::get_status ( ) const

inline

Get the value of the 'status' attribute.

GetTypeName()

const StringPiece google_drive_api::Comment::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_drive_api::Comment

has_anchor()

bool google_drive_api::Comment::has_anchor ( ) const

inline

Determine if the 'anchor' attribute was set.

Returns

true if the 'anchor' attribute was set.

has_author()

bool google_drive_api::Comment::has_author ( ) const

inline

Determine if the 'author' attribute was set.

Returns

true if the 'author' attribute was set.

has_comment_id()

bool google_drive_api::Comment::has_comment_id ( ) const

inline

Determine if the 'commentId' attribute was set.

Returns

true if the 'commentId' attribute was set.

has_content()

bool google_drive_api::Comment::has_content ( ) const

inline

Determine if the 'content' attribute was set.

Returns

true if the 'content' attribute was set.

has_context()

bool google_drive_api::Comment::has_context ( ) const

inline

Determine if the 'context' attribute was set.

Returns

true if the 'context' attribute was set.

has_created_date()

bool google_drive_api::Comment::has_created_date ( ) const

inline

Determine if the 'createdDate' attribute was set.

Returns

true if the 'createdDate' attribute was set.

has_deleted()

bool google_drive_api::Comment::has_deleted ( ) const

inline

Determine if the 'deleted' attribute was set.

Returns

true if the 'deleted' attribute was set.

has_file_id()

bool google_drive_api::Comment::has_file_id ( ) const

inline

Determine if the 'fileId' attribute was set.

Returns

true if the 'fileId' attribute was set.

has_file_title()

bool google_drive_api::Comment::has_file_title ( ) const

inline

Determine if the 'fileTitle' attribute was set.

Returns

true if the 'fileTitle' attribute was set.

has_html_content()

bool google_drive_api::Comment::has_html_content ( ) const

inline

Determine if the 'htmlContent' attribute was set.

Returns

true if the 'htmlContent' attribute was set.

has_kind()

bool google_drive_api::Comment::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_modified_date()

bool google_drive_api::Comment::has_modified_date ( ) const

inline

Determine if the 'modifiedDate' attribute was set.

Returns

true if the 'modifiedDate' attribute was set.

has_replies()

bool google_drive_api::Comment::has_replies ( ) const

inline

Determine if the 'replies' attribute was set.

Returns

true if the 'replies' attribute was set.

has_self_link()

bool google_drive_api::Comment::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

Returns

true if the 'selfLink' attribute was set.

has_status()

bool google_drive_api::Comment::has_status ( ) const

inline

Determine if the 'status' attribute was set.

Returns

true if the 'status' attribute was set.

mutable_author()

User google_drive_api::Comment::mutable_author

(

)

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

The author of the comment. The author's email address and permission ID will not be populated.

Returns

The result can be modified to change the attribute value.

mutable_context()

CommentContext google_drive_api::Comment::mutable_context ( )

inline

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

The context of the file which is being commented on.

Returns

The result can be modified to change the attribute value.

mutable_replies()

client::JsonCppArray<CommentReply > google_drive_api::Comment::mutable_replies

(

)

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

Replies to this post.

Returns

The result can be modified to change the attribute value.

New()

Comment * google_drive_api::Comment::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_anchor()

void google_drive_api::Comment::set_anchor ( const StringPiece &  value )

inline

Change the 'anchor' attribute.

A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.

Parameters

[in]

value

The new value.

set_comment_id()

void google_drive_api::Comment::set_comment_id ( const StringPiece &  value )

inline

Change the 'commentId' attribute.

The ID of the comment.

Parameters

[in]

value

The new value.

set_content()

void google_drive_api::Comment::set_content ( const StringPiece &  value )

inline

Change the 'content' attribute.

The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.

Parameters

[in]

value

The new value.

set_created_date()

void google_drive_api::Comment::set_created_date ( client::DateTime  value )

inline

Change the 'createdDate' attribute.

The date when this comment was first created.

Parameters

[in]

value

The new value.

set_deleted()

void google_drive_api::Comment::set_deleted ( bool  value )

inline

Change the 'deleted' attribute.

Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.

Parameters

[in]

value

The new value.

set_file_id()

void google_drive_api::Comment::set_file_id ( const StringPiece &  value )

inline

Change the 'fileId' attribute.

The file which this comment is addressing.

Parameters

[in]

value

The new value.

set_file_title()

void google_drive_api::Comment::set_file_title ( const StringPiece &  value )

inline

Change the 'fileTitle' attribute.

The title of the file which this comment is addressing.

Parameters

[in]

value

The new value.

set_html_content()

void google_drive_api::Comment::set_html_content ( const StringPiece &  value )

inline

Change the 'htmlContent' attribute.

HTML formatted content for this comment.

Parameters

[in]

value

The new value.

set_kind()

void google_drive_api::Comment::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

This is always drive::comment.

Parameters

[in]

value

The new value.

set_modified_date()

void google_drive_api::Comment::set_modified_date ( client::DateTime  value )

inline

Change the 'modifiedDate' attribute.

The date when this comment or any of its replies were last modified.

Parameters

[in]

value

The new value.

set_self_link()

void google_drive_api::Comment::set_self_link ( const StringPiece &  value )

inline

Change the 'selfLink' attribute.

A link back to this comment.

Parameters

[in]

value

The new value.

set_status()

void google_drive_api::Comment::set_status ( const StringPiece &  value )

inline

Change the 'status' attribute.

The status of this comment. Status can be changed by posting a reply to a comment with the desired status.

"open"

The comment is still open.

"resolved"

The comment has been resolved by one of its replies.

Parameters

[in]

value

The new value.

---

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

• google/drive_api/comment.h
• google/drive_api/comment.cc