#include <annotation.h>

Inheritance diagram for google_books_api::Annotation:

Classes
class	AnnotationClientVersionRanges

class	AnnotationCurrentVersionRanges

class	AnnotationLayerSummary

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

	Annotation (Json::Value *storage)

virtual	~Annotation ()

const StringPiece	GetTypeName () const

bool	has_after_selected_text () const

void	clear_after_selected_text ()

const StringPiece	get_after_selected_text () const

void	set_after_selected_text (const StringPiece &value)

bool	has_before_selected_text () const

void	clear_before_selected_text ()

const StringPiece	get_before_selected_text () const

void	set_before_selected_text (const StringPiece &value)

bool	has_client_version_ranges () const

void	clear_client_version_ranges ()

const AnnotationClientVersionRanges	get_client_version_ranges () const

AnnotationClientVersionRanges	mutable_clientVersionRanges ()

bool	has_created () const

void	clear_created ()

client::DateTime	get_created () const

void	set_created (client::DateTime value)

bool	has_current_version_ranges () const

void	clear_current_version_ranges ()

const AnnotationCurrentVersionRanges	get_current_version_ranges () const

AnnotationCurrentVersionRanges	mutable_currentVersionRanges ()

bool	has_data () const

void	clear_data ()

const StringPiece	get_data () const

void	set_data (const StringPiece &value)

bool	has_deleted () const

void	clear_deleted ()

bool	get_deleted () const

void	set_deleted (bool value)

bool	has_highlight_style () const

void	clear_highlight_style ()

const StringPiece	get_highlight_style () const

void	set_highlight_style (const StringPiece &value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_layer_id () const

void	clear_layer_id ()

const StringPiece	get_layer_id () const

void	set_layer_id (const StringPiece &value)

bool	has_layer_summary () const

void	clear_layer_summary ()

const AnnotationLayerSummary	get_layer_summary () const

AnnotationLayerSummary	mutable_layerSummary ()

bool	has_page_ids () const

void	clear_page_ids ()

const client::JsonCppArray< string >	get_page_ids () const

client::JsonCppArray< string >	mutable_pageIds ()

bool	has_selected_text () const

void	clear_selected_text ()

const StringPiece	get_selected_text () const

void	set_selected_text (const StringPiece &value)

bool	has_self_link () const

void	clear_self_link ()

const StringPiece	get_self_link () const

void	set_self_link (const StringPiece &value)

bool	has_updated () const

void	clear_updated ()

client::DateTime	get_updated () const

void	set_updated (client::DateTime value)

bool	has_volume_id () const

void	clear_volume_id ()

const StringPiece	get_volume_id () const

void	set_volume_id (const StringPiece &value)

Static Public Member Functions
static Annotation *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ Annotation() [1/2]

google_books_api::Annotation::Annotation ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Annotation() [2/2]

google_books_api::Annotation::Annotation ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Annotation()

google_books_api::Annotation::~Annotation ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_after_selected_text()

void google_books_api::Annotation::clear_after_selected_text ( )

inline

Clears the 'afterSelectedText' attribute.

◆ clear_before_selected_text()

void google_books_api::Annotation::clear_before_selected_text ( )

inline

Clears the 'beforeSelectedText' attribute.

◆ clear_client_version_ranges()

void google_books_api::Annotation::clear_client_version_ranges ( )

inline

Clears the 'clientVersionRanges' attribute.

◆ clear_created()

void google_books_api::Annotation::clear_created ( )

inline

Clears the 'created' attribute.

◆ clear_current_version_ranges()

void google_books_api::Annotation::clear_current_version_ranges ( )

inline

Clears the 'currentVersionRanges' attribute.

◆ clear_data()

void google_books_api::Annotation::clear_data ( )

inline

Clears the 'data' attribute.

◆ clear_deleted()

void google_books_api::Annotation::clear_deleted ( )

inline

Clears the 'deleted' attribute.

◆ clear_highlight_style()

void google_books_api::Annotation::clear_highlight_style ( )

inline

Clears the 'highlightStyle' attribute.

◆ clear_id()

void google_books_api::Annotation::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_books_api::Annotation::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_layer_id()

void google_books_api::Annotation::clear_layer_id ( )

inline

Clears the 'layerId' attribute.

◆ clear_layer_summary()

void google_books_api::Annotation::clear_layer_summary ( )

inline

Clears the 'layerSummary' attribute.

◆ clear_page_ids()

void google_books_api::Annotation::clear_page_ids ( )

inline

Clears the 'pageIds' attribute.

◆ clear_selected_text()

void google_books_api::Annotation::clear_selected_text ( )

inline

Clears the 'selectedText' attribute.

◆ clear_self_link()

void google_books_api::Annotation::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

◆ clear_updated()

void google_books_api::Annotation::clear_updated ( )

inline

Clears the 'updated' attribute.

◆ clear_volume_id()

void google_books_api::Annotation::clear_volume_id ( )

inline

Clears the 'volumeId' attribute.

◆ get_after_selected_text()

const StringPiece google_books_api::Annotation::get_after_selected_text ( ) const

inline

Get the value of the 'afterSelectedText' attribute.

◆ get_before_selected_text()

const StringPiece google_books_api::Annotation::get_before_selected_text ( ) const

inline

Get the value of the 'beforeSelectedText' attribute.

◆ get_client_version_ranges()

const AnnotationClientVersionRanges google_books_api::Annotation::get_client_version_ranges ( ) const

inline

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

◆ get_created()

client::DateTime google_books_api::Annotation::get_created ( ) const

inline

Get the value of the 'created' attribute.

◆ get_current_version_ranges()

const AnnotationCurrentVersionRanges google_books_api::Annotation::get_current_version_ranges ( ) const

inline

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

◆ get_data()

const StringPiece google_books_api::Annotation::get_data ( ) const

inline

Get the value of the 'data' attribute.

◆ get_deleted()

bool google_books_api::Annotation::get_deleted ( ) const

inline

Get the value of the 'deleted' attribute.

◆ get_highlight_style()

const StringPiece google_books_api::Annotation::get_highlight_style ( ) const

inline

Get the value of the 'highlightStyle' attribute.

◆ get_id()

const StringPiece google_books_api::Annotation::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_books_api::Annotation::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_layer_id()

const StringPiece google_books_api::Annotation::get_layer_id ( ) const

inline

Get the value of the 'layerId' attribute.

◆ get_layer_summary()

const AnnotationLayerSummary google_books_api::Annotation::get_layer_summary ( ) const

inline

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

◆ get_page_ids()

const client::JsonCppArray<string > google_books_api::Annotation::get_page_ids ( ) const

inline

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

◆ get_selected_text()

const StringPiece google_books_api::Annotation::get_selected_text ( ) const

inline

Get the value of the 'selectedText' attribute.

◆ get_self_link()

const StringPiece google_books_api::Annotation::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

◆ get_updated()

client::DateTime google_books_api::Annotation::get_updated ( ) const

inline

Get the value of the 'updated' attribute.

◆ get_volume_id()

const StringPiece google_books_api::Annotation::get_volume_id ( ) const

inline

Get the value of the 'volumeId' attribute.

◆ GetTypeName()

const StringPiece google_books_api::Annotation::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_books_api::Annotation

◆ has_after_selected_text()

bool google_books_api::Annotation::has_after_selected_text ( ) const

inline

Determine if the 'afterSelectedText' attribute was set.

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

◆ has_before_selected_text()

bool google_books_api::Annotation::has_before_selected_text ( ) const

inline

Determine if the 'beforeSelectedText' attribute was set.

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

◆ has_client_version_ranges()

bool google_books_api::Annotation::has_client_version_ranges ( ) const

inline

Determine if the 'clientVersionRanges' attribute was set.

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

◆ has_created()

bool google_books_api::Annotation::has_created ( ) const

inline

Determine if the 'created' attribute was set.

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

◆ has_current_version_ranges()

bool google_books_api::Annotation::has_current_version_ranges ( ) const

inline

Determine if the 'currentVersionRanges' attribute was set.

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

◆ has_data()

bool google_books_api::Annotation::has_data ( ) const

inline

Determine if the 'data' attribute was set.

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

◆ has_deleted()

bool google_books_api::Annotation::has_deleted ( ) const

inline

Determine if the 'deleted' attribute was set.

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

◆ has_highlight_style()

bool google_books_api::Annotation::has_highlight_style ( ) const

inline

Determine if the 'highlightStyle' attribute was set.

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

◆ has_id()

bool google_books_api::Annotation::has_id ( ) const

inline

Determine if the 'id' attribute was set.

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

◆ has_kind()

bool google_books_api::Annotation::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

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

◆ has_layer_id()

bool google_books_api::Annotation::has_layer_id ( ) const

inline

Determine if the 'layerId' attribute was set.

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

◆ has_layer_summary()

bool google_books_api::Annotation::has_layer_summary ( ) const

inline

Determine if the 'layerSummary' attribute was set.

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

◆ has_page_ids()

bool google_books_api::Annotation::has_page_ids ( ) const

inline

Determine if the 'pageIds' attribute was set.

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

◆ has_selected_text()

bool google_books_api::Annotation::has_selected_text ( ) const

inline

Determine if the 'selectedText' attribute was set.

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

◆ has_self_link()

bool google_books_api::Annotation::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

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

◆ has_updated()

bool google_books_api::Annotation::has_updated ( ) const

inline

Determine if the 'updated' attribute was set.

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

◆ has_volume_id()

bool google_books_api::Annotation::has_volume_id ( ) const

inline

Determine if the 'volumeId' attribute was set.

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

◆ mutable_clientVersionRanges()

AnnotationClientVersionRanges google_books_api::Annotation::mutable_clientVersionRanges ( )

inline

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

Selection ranges sent from the client.

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

◆ mutable_currentVersionRanges()

AnnotationCurrentVersionRanges google_books_api::Annotation::mutable_currentVersionRanges ( )

inline

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

Selection ranges for the most recent content version.

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

◆ mutable_layerSummary()

AnnotationLayerSummary google_books_api::Annotation::mutable_layerSummary ( )

inline

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

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

◆ mutable_pageIds()

client::JsonCppArray<string > google_books_api::Annotation::mutable_pageIds ( )

inline

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

Pages that this annotation spans.

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

◆ New()

Annotation * google_books_api::Annotation::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_after_selected_text()

void google_books_api::Annotation::set_after_selected_text ( const StringPiece & value )

inline

Change the 'afterSelectedText' attribute.

Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

Parameters

[in] value The new value.

◆ set_before_selected_text()

void google_books_api::Annotation::set_before_selected_text ( const StringPiece & value )

inline

Change the 'beforeSelectedText' attribute.

Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

Parameters

[in] value The new value.

◆ set_created()

void google_books_api::Annotation::set_created ( client::DateTime value )

inline

Change the 'created' attribute.

Timestamp for the created time of this annotation.

Parameters

[in] value The new value.

◆ set_data()

void google_books_api::Annotation::set_data ( const StringPiece & value )

inline

Change the 'data' attribute.

User-created data for this annotation.

Parameters

[in] value The new value.

◆ set_deleted()

void google_books_api::Annotation::set_deleted ( bool value )

inline

Change the 'deleted' attribute.

Indicates that this annotation is deleted.

Parameters

[in] value The new value.

◆ set_highlight_style()

void google_books_api::Annotation::set_highlight_style ( const StringPiece & value )

inline

Change the 'highlightStyle' attribute.

The highlight style for this annotation.

Parameters

[in] value The new value.

◆ set_id()

void google_books_api::Annotation::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

Id of this annotation, in the form of a GUID.

Parameters

[in] value The new value.

◆ set_kind()

void google_books_api::Annotation::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Resource type.

Parameters

[in] value The new value.

◆ set_layer_id()

void google_books_api::Annotation::set_layer_id ( const StringPiece & value )

inline

Change the 'layerId' attribute.

The layer this annotation is for.

Parameters

[in] value The new value.

◆ set_selected_text()

void google_books_api::Annotation::set_selected_text ( const StringPiece & value )

inline

Change the 'selectedText' attribute.

Excerpt from the volume.

Parameters

[in] value The new value.

◆ set_self_link()

void google_books_api::Annotation::set_self_link ( const StringPiece & value )

inline

Change the 'selfLink' attribute.

URL to this resource.

Parameters

[in] value The new value.

◆ set_updated()

void google_books_api::Annotation::set_updated ( client::DateTime value )

inline

Change the 'updated' attribute.

Timestamp for the last time this annotation was modified.

Parameters

[in] value The new value.

◆ set_volume_id()

void google_books_api::Annotation::set_volume_id ( const StringPiece & value )

inline

Change the 'volumeId' attribute.

The volume that this annotation belongs to.

Parameters

[in] value The new value.

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

google/books_api/annotation.h
google/books_api/annotation.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Annotation() [1/2]

◆ Annotation() [2/2]

◆ ~Annotation()

Member Function Documentation

◆ clear_after_selected_text()

◆ clear_before_selected_text()

◆ clear_client_version_ranges()

◆ clear_created()

◆ clear_current_version_ranges()

◆ clear_data()

◆ clear_deleted()

◆ clear_highlight_style()

◆ clear_id()

◆ clear_kind()

◆ clear_layer_id()

◆ clear_layer_summary()

◆ clear_page_ids()

◆ clear_selected_text()

◆ clear_self_link()

◆ clear_updated()

◆ clear_volume_id()

◆ get_after_selected_text()

◆ get_before_selected_text()

◆ get_client_version_ranges()

◆ get_created()

◆ get_current_version_ranges()

◆ get_data()

◆ get_deleted()

◆ get_highlight_style()

◆ get_id()

◆ get_kind()

◆ get_layer_id()

◆ get_layer_summary()

◆ get_page_ids()

◆ get_selected_text()

◆ get_self_link()

◆ get_updated()

◆ get_volume_id()

◆ GetTypeName()

◆ has_after_selected_text()

◆ has_before_selected_text()

◆ has_client_version_ranges()

◆ has_created()

◆ has_current_version_ranges()

◆ has_data()

◆ has_deleted()

◆ has_highlight_style()

◆ has_id()

◆ has_kind()

◆ has_layer_id()

◆ has_layer_summary()

◆ has_page_ids()

◆ has_selected_text()

◆ has_self_link()

◆ has_updated()

◆ has_volume_id()

◆ mutable_clientVersionRanges()

◆ mutable_currentVersionRanges()

◆ mutable_layerSummary()

◆ mutable_pageIds()

◆ New()

◆ set_after_selected_text()

◆ set_before_selected_text()

◆ set_created()

◆ set_data()

◆ set_deleted()

◆ set_highlight_style()

◆ set_id()

◆ set_kind()

◆ set_layer_id()

◆ set_selected_text()

◆ set_self_link()

◆ set_updated()

◆ set_volume_id()