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

#include <reading_position.h>

Inheritance diagram for google_books_api::ReadingPosition:

Public Member Functions

 ReadingPosition (const Json::Value &storage)
 
 ReadingPosition (Json::Value *storage)
 
virtual ~ReadingPosition ()
 
const StringPiece GetTypeName () const
 
bool has_epub_cfi_position () const
 
void clear_epub_cfi_position ()
 
const StringPiece get_epub_cfi_position () const
 
void set_epub_cfi_position (const StringPiece &value)
 
bool has_gb_image_position () const
 
void clear_gb_image_position ()
 
const StringPiece get_gb_image_position () const
 
void set_gb_image_position (const StringPiece &value)
 
bool has_gb_text_position () const
 
void clear_gb_text_position ()
 
const StringPiece get_gb_text_position () const
 
void set_gb_text_position (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_pdf_position () const
 
void clear_pdf_position ()
 
const StringPiece get_pdf_position () const
 
void set_pdf_position (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 ReadingPositionNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ ReadingPosition() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ ReadingPosition() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~ReadingPosition()

google_books_api::ReadingPosition::~ReadingPosition ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_epub_cfi_position()

void google_books_api::ReadingPosition::clear_epub_cfi_position ( )
inline

Clears the 'epubCfiPosition' attribute.

◆ clear_gb_image_position()

void google_books_api::ReadingPosition::clear_gb_image_position ( )
inline

Clears the 'gbImagePosition' attribute.

◆ clear_gb_text_position()

void google_books_api::ReadingPosition::clear_gb_text_position ( )
inline

Clears the 'gbTextPosition' attribute.

◆ clear_kind()

void google_books_api::ReadingPosition::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_pdf_position()

void google_books_api::ReadingPosition::clear_pdf_position ( )
inline

Clears the 'pdfPosition' attribute.

◆ clear_updated()

void google_books_api::ReadingPosition::clear_updated ( )
inline

Clears the 'updated' attribute.

◆ clear_volume_id()

void google_books_api::ReadingPosition::clear_volume_id ( )
inline

Clears the 'volumeId' attribute.

◆ get_epub_cfi_position()

const StringPiece google_books_api::ReadingPosition::get_epub_cfi_position ( ) const
inline

Get the value of the 'epubCfiPosition' attribute.

◆ get_gb_image_position()

const StringPiece google_books_api::ReadingPosition::get_gb_image_position ( ) const
inline

Get the value of the 'gbImagePosition' attribute.

◆ get_gb_text_position()

const StringPiece google_books_api::ReadingPosition::get_gb_text_position ( ) const
inline

Get the value of the 'gbTextPosition' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_pdf_position()

const StringPiece google_books_api::ReadingPosition::get_pdf_position ( ) const
inline

Get the value of the 'pdfPosition' attribute.

◆ get_updated()

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

Get the value of the 'updated' attribute.

◆ get_volume_id()

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

Get the value of the 'volumeId' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_books_api::ReadingPosition

◆ has_epub_cfi_position()

bool google_books_api::ReadingPosition::has_epub_cfi_position ( ) const
inline

Determine if the 'epubCfiPosition' attribute was set.

Returns
true if the 'epubCfiPosition' attribute was set.

◆ has_gb_image_position()

bool google_books_api::ReadingPosition::has_gb_image_position ( ) const
inline

Determine if the 'gbImagePosition' attribute was set.

Returns
true if the 'gbImagePosition' attribute was set.

◆ has_gb_text_position()

bool google_books_api::ReadingPosition::has_gb_text_position ( ) const
inline

Determine if the 'gbTextPosition' attribute was set.

Returns
true if the 'gbTextPosition' attribute was set.

◆ has_kind()

bool google_books_api::ReadingPosition::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_pdf_position()

bool google_books_api::ReadingPosition::has_pdf_position ( ) const
inline

Determine if the 'pdfPosition' attribute was set.

Returns
true if the 'pdfPosition' attribute was set.

◆ has_updated()

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

Determine if the 'volumeId' attribute was set.

Returns
true if the 'volumeId' attribute was set.

◆ New()

ReadingPosition * google_books_api::ReadingPosition::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_epub_cfi_position()

void google_books_api::ReadingPosition::set_epub_cfi_position ( const StringPiece &  value)
inline

Change the 'epubCfiPosition' attribute.

Position in an EPUB as a CFI.

Parameters
[in]valueThe new value.

◆ set_gb_image_position()

void google_books_api::ReadingPosition::set_gb_image_position ( const StringPiece &  value)
inline

Change the 'gbImagePosition' attribute.

Position in a volume for image-based content.

Parameters
[in]valueThe new value.

◆ set_gb_text_position()

void google_books_api::ReadingPosition::set_gb_text_position ( const StringPiece &  value)
inline

Change the 'gbTextPosition' attribute.

Position in a volume for text-based content.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

Resource type for a reading position.

Parameters
[in]valueThe new value.

◆ set_pdf_position()

void google_books_api::ReadingPosition::set_pdf_position ( const StringPiece &  value)
inline

Change the 'pdfPosition' attribute.

Position in a PDF file.

Parameters
[in]valueThe new value.

◆ set_updated()

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

Change the 'updated' attribute.

Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).

Parameters
[in]valueThe new value.

◆ set_volume_id()

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

Change the 'volumeId' attribute.

Volume id associated with this reading position.

Parameters
[in]valueThe new value.

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