books  v1
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_books_api::Volumeannotation Class Reference

#include <volumeannotation.h>

Inheritance diagram for google_books_api::Volumeannotation:

Classes

class  VolumeannotationContentRanges
 

Public Member Functions

 Volumeannotation (const Json::Value &storage)
 
 Volumeannotation (Json::Value *storage)
 
virtual ~Volumeannotation ()
 
const StringPiece GetTypeName () const
 
bool has_annotation_data_id () const
 
void clear_annotation_data_id ()
 
const StringPiece get_annotation_data_id () const
 
void set_annotation_data_id (const StringPiece &value)
 
bool has_annotation_data_link () const
 
void clear_annotation_data_link ()
 
const StringPiece get_annotation_data_link () const
 
void set_annotation_data_link (const StringPiece &value)
 
bool has_annotation_type () const
 
void clear_annotation_type ()
 
const StringPiece get_annotation_type () const
 
void set_annotation_type (const StringPiece &value)
 
bool has_content_ranges () const
 
void clear_content_ranges ()
 
const VolumeannotationContentRanges get_content_ranges () const
 
VolumeannotationContentRanges mutable_contentRanges ()
 
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_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_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 VolumeannotationNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ Volumeannotation() [1/2]

google_books_api::Volumeannotation::Volumeannotation ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ Volumeannotation() [2/2]

google_books_api::Volumeannotation::Volumeannotation ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~Volumeannotation()

google_books_api::Volumeannotation::~Volumeannotation ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_annotation_data_id()

void google_books_api::Volumeannotation::clear_annotation_data_id ( )
inline

Clears the 'annotationDataId' attribute.

◆ clear_annotation_data_link()

void google_books_api::Volumeannotation::clear_annotation_data_link ( )
inline

Clears the 'annotationDataLink' attribute.

◆ clear_annotation_type()

void google_books_api::Volumeannotation::clear_annotation_type ( )
inline

Clears the 'annotationType' attribute.

◆ clear_content_ranges()

void google_books_api::Volumeannotation::clear_content_ranges ( )
inline

Clears the 'contentRanges' attribute.

◆ clear_data()

void google_books_api::Volumeannotation::clear_data ( )
inline

Clears the 'data' attribute.

◆ clear_deleted()

void google_books_api::Volumeannotation::clear_deleted ( )
inline

Clears the 'deleted' attribute.

◆ clear_id()

void google_books_api::Volumeannotation::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_books_api::Volumeannotation::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_layer_id()

void google_books_api::Volumeannotation::clear_layer_id ( )
inline

Clears the 'layerId' attribute.

◆ clear_page_ids()

void google_books_api::Volumeannotation::clear_page_ids ( )
inline

Clears the 'pageIds' attribute.

◆ clear_selected_text()

void google_books_api::Volumeannotation::clear_selected_text ( )
inline

Clears the 'selectedText' attribute.

◆ clear_self_link()

void google_books_api::Volumeannotation::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_updated()

void google_books_api::Volumeannotation::clear_updated ( )
inline

Clears the 'updated' attribute.

◆ clear_volume_id()

void google_books_api::Volumeannotation::clear_volume_id ( )
inline

Clears the 'volumeId' attribute.

◆ get_annotation_data_id()

const StringPiece google_books_api::Volumeannotation::get_annotation_data_id ( ) const
inline

Get the value of the 'annotationDataId' attribute.

◆ get_annotation_data_link()

const StringPiece google_books_api::Volumeannotation::get_annotation_data_link ( ) const
inline

Get the value of the 'annotationDataLink' attribute.

◆ get_annotation_type()

const StringPiece google_books_api::Volumeannotation::get_annotation_type ( ) const
inline

Get the value of the 'annotationType' attribute.

◆ get_content_ranges()

const VolumeannotationContentRanges google_books_api::Volumeannotation::get_content_ranges ( ) const
inline

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

◆ get_data()

const StringPiece google_books_api::Volumeannotation::get_data ( ) const
inline

Get the value of the 'data' attribute.

◆ get_deleted()

bool google_books_api::Volumeannotation::get_deleted ( ) const
inline

Get the value of the 'deleted' attribute.

◆ get_id()

const StringPiece google_books_api::Volumeannotation::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_books_api::Volumeannotation::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_layer_id()

const StringPiece google_books_api::Volumeannotation::get_layer_id ( ) const
inline

Get the value of the 'layerId' attribute.

◆ get_page_ids()

const client::JsonCppArray<string > google_books_api::Volumeannotation::get_page_ids ( ) const
inline

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

◆ get_selected_text()

const StringPiece google_books_api::Volumeannotation::get_selected_text ( ) const
inline

Get the value of the 'selectedText' attribute.

◆ get_self_link()

const StringPiece google_books_api::Volumeannotation::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_updated()

client::DateTime google_books_api::Volumeannotation::get_updated ( ) const
inline

Get the value of the 'updated' attribute.

◆ get_volume_id()

const StringPiece google_books_api::Volumeannotation::get_volume_id ( ) const
inline

Get the value of the 'volumeId' attribute.

◆ GetTypeName()

const StringPiece google_books_api::Volumeannotation::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_books_api::Volumeannotation

◆ has_annotation_data_id()

bool google_books_api::Volumeannotation::has_annotation_data_id ( ) const
inline

Determine if the 'annotationDataId' attribute was set.

Returns
true if the 'annotationDataId' attribute was set.

◆ has_annotation_data_link()

bool google_books_api::Volumeannotation::has_annotation_data_link ( ) const
inline

Determine if the 'annotationDataLink' attribute was set.

Returns
true if the 'annotationDataLink' attribute was set.

◆ has_annotation_type()

bool google_books_api::Volumeannotation::has_annotation_type ( ) const
inline

Determine if the 'annotationType' attribute was set.

Returns
true if the 'annotationType' attribute was set.

◆ has_content_ranges()

bool google_books_api::Volumeannotation::has_content_ranges ( ) const
inline

Determine if the 'contentRanges' attribute was set.

Returns
true if the 'contentRanges' attribute was set.

◆ has_data()

bool google_books_api::Volumeannotation::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::Volumeannotation::has_deleted ( ) const
inline

Determine if the 'deleted' attribute was set.

Returns
true if the 'deleted' attribute was set.

◆ has_id()

bool google_books_api::Volumeannotation::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::Volumeannotation::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::Volumeannotation::has_layer_id ( ) const
inline

Determine if the 'layerId' attribute was set.

Returns
true if the 'layerId' attribute was set.

◆ has_page_ids()

bool google_books_api::Volumeannotation::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::Volumeannotation::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::Volumeannotation::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::Volumeannotation::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::Volumeannotation::has_volume_id ( ) const
inline

Determine if the 'volumeId' attribute was set.

Returns
true if the 'volumeId' attribute was set.

◆ mutable_contentRanges()

VolumeannotationContentRanges google_books_api::Volumeannotation::mutable_contentRanges ( )
inline

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

The content ranges to identify the selected text.

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

◆ mutable_pageIds()

client::JsonCppArray<string > google_books_api::Volumeannotation::mutable_pageIds ( )
inline

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

Pages the annotation spans.

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

◆ New()

Volumeannotation * google_books_api::Volumeannotation::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_annotation_data_id()

void google_books_api::Volumeannotation::set_annotation_data_id ( const StringPiece &  value)
inline

Change the 'annotationDataId' attribute.

The annotation data id for this volume annotation.

Parameters
[in]valueThe new value.

◆ set_annotation_data_link()

void google_books_api::Volumeannotation::set_annotation_data_link ( const StringPiece &  value)
inline

Change the 'annotationDataLink' attribute.

Link to get data for this annotation.

Parameters
[in]valueThe new value.

◆ set_annotation_type()

void google_books_api::Volumeannotation::set_annotation_type ( const StringPiece &  value)
inline

Change the 'annotationType' attribute.

The type of annotation this is.

Parameters
[in]valueThe new value.

◆ set_data()

void google_books_api::Volumeannotation::set_data ( const StringPiece &  value)
inline

Change the 'data' attribute.

Data for this annotation.

Parameters
[in]valueThe new value.

◆ set_deleted()

void google_books_api::Volumeannotation::set_deleted ( bool  value)
inline

Change the 'deleted' attribute.

Indicates that this annotation is deleted.

Parameters
[in]valueThe new value.

◆ set_id()

void google_books_api::Volumeannotation::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

Unique id of this volume annotation.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_books_api::Volumeannotation::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Resource Type.

Parameters
[in]valueThe new value.

◆ set_layer_id()

void google_books_api::Volumeannotation::set_layer_id ( const StringPiece &  value)
inline

Change the 'layerId' attribute.

The Layer this annotation is for.

Parameters
[in]valueThe new value.

◆ set_selected_text()

void google_books_api::Volumeannotation::set_selected_text ( const StringPiece &  value)
inline

Change the 'selectedText' attribute.

Excerpt from the volume.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_books_api::Volumeannotation::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

URL to this resource.

Parameters
[in]valueThe new value.

◆ set_updated()

void google_books_api::Volumeannotation::set_updated ( client::DateTime  value)
inline

Change the 'updated' attribute.

Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).

Parameters
[in]valueThe new value.

◆ set_volume_id()

void google_books_api::Volumeannotation::set_volume_id ( const StringPiece &  value)
inline

Change the 'volumeId' attribute.

The Volume this annotation is for.

Parameters
[in]valueThe new value.

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