#include <volume.h>

Inheritance diagram for google_books_api::Volume::VolumeAccessInfo:

Classes
class	VolumeAccessInfoEpub

class	VolumeAccessInfoPdf

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

	VolumeAccessInfo (Json::Value *storage)

virtual	~VolumeAccessInfo ()

const StringPiece	GetTypeName () const

bool	has_access_view_status () const

void	clear_access_view_status ()

const StringPiece	get_access_view_status () const

void	set_access_view_status (const StringPiece &value)

bool	has_country () const

void	clear_country ()

const StringPiece	get_country () const

void	set_country (const StringPiece &value)

bool	has_download_access () const

void	clear_download_access ()

const DownloadAccessRestriction	get_download_access () const

DownloadAccessRestriction	mutable_downloadAccess ()

bool	has_drive_imported_content_link () const

void	clear_drive_imported_content_link ()

const StringPiece	get_drive_imported_content_link () const

void	set_drive_imported_content_link (const StringPiece &value)

bool	has_embeddable () const

void	clear_embeddable ()

bool	get_embeddable () const

void	set_embeddable (bool value)

bool	has_epub () const

void	clear_epub ()

const VolumeAccessInfoEpub	get_epub () const

VolumeAccessInfoEpub	mutable_epub ()

bool	has_explicit_offline_license_management () const

void	clear_explicit_offline_license_management ()

bool	get_explicit_offline_license_management () const

void	set_explicit_offline_license_management (bool value)

bool	has_pdf () const

void	clear_pdf ()

const VolumeAccessInfoPdf	get_pdf () const

VolumeAccessInfoPdf	mutable_pdf ()

bool	has_public_domain () const

void	clear_public_domain ()

bool	get_public_domain () const

void	set_public_domain (bool value)

bool	has_quote_sharing_allowed () const

void	clear_quote_sharing_allowed ()

bool	get_quote_sharing_allowed () const

void	set_quote_sharing_allowed (bool value)

bool	has_text_to_speech_permission () const

void	clear_text_to_speech_permission ()

const StringPiece	get_text_to_speech_permission () const

void	set_text_to_speech_permission (const StringPiece &value)

bool	has_view_order_url () const

void	clear_view_order_url ()

const StringPiece	get_view_order_url () const

void	set_view_order_url (const StringPiece &value)

bool	has_viewability () const

void	clear_viewability ()

const StringPiece	get_viewability () const

void	set_viewability (const StringPiece &value)

bool	has_web_reader_link () const

void	clear_web_reader_link ()

const StringPiece	get_web_reader_link () const

void	set_web_reader_link (const StringPiece &value)

Static Public Member Functions
static VolumeAccessInfo *	New ()

Detailed Description

Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).

Constructor & Destructor Documentation

◆ VolumeAccessInfo() [1/2]

google_books_api::Volume::VolumeAccessInfo::VolumeAccessInfo ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ VolumeAccessInfo() [2/2]

google_books_api::Volume::VolumeAccessInfo::VolumeAccessInfo ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~VolumeAccessInfo()

google_books_api::Volume::VolumeAccessInfo::~VolumeAccessInfo ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_access_view_status()

void google_books_api::Volume::VolumeAccessInfo::clear_access_view_status ( )

inline

Clears the 'accessViewStatus' attribute.

◆ clear_country()

void google_books_api::Volume::VolumeAccessInfo::clear_country ( )

inline

Clears the 'country' attribute.

◆ clear_download_access()

void google_books_api::Volume::VolumeAccessInfo::clear_download_access ( )

inline

Clears the 'downloadAccess' attribute.

◆ clear_drive_imported_content_link()

void google_books_api::Volume::VolumeAccessInfo::clear_drive_imported_content_link ( )

inline

Clears the 'driveImportedContentLink' attribute.

◆ clear_embeddable()

void google_books_api::Volume::VolumeAccessInfo::clear_embeddable ( )

inline

Clears the 'embeddable' attribute.

◆ clear_epub()

void google_books_api::Volume::VolumeAccessInfo::clear_epub ( )

inline

Clears the 'epub' attribute.

◆ clear_explicit_offline_license_management()

void google_books_api::Volume::VolumeAccessInfo::clear_explicit_offline_license_management ( )

inline

Clears the 'explicitOfflineLicenseManagement' attribute.

◆ clear_pdf()

void google_books_api::Volume::VolumeAccessInfo::clear_pdf ( )

inline

Clears the 'pdf' attribute.

◆ clear_public_domain()

void google_books_api::Volume::VolumeAccessInfo::clear_public_domain ( )

inline

Clears the 'publicDomain' attribute.

◆ clear_quote_sharing_allowed()

void google_books_api::Volume::VolumeAccessInfo::clear_quote_sharing_allowed ( )

inline

Clears the 'quoteSharingAllowed' attribute.

◆ clear_text_to_speech_permission()

void google_books_api::Volume::VolumeAccessInfo::clear_text_to_speech_permission ( )

inline

Clears the 'textToSpeechPermission' attribute.

◆ clear_view_order_url()

void google_books_api::Volume::VolumeAccessInfo::clear_view_order_url ( )

inline

Clears the 'viewOrderUrl' attribute.

◆ clear_viewability()

void google_books_api::Volume::VolumeAccessInfo::clear_viewability ( )

inline

Clears the 'viewability' attribute.

◆ clear_web_reader_link()

void google_books_api::Volume::VolumeAccessInfo::clear_web_reader_link ( )

inline

Clears the 'webReaderLink' attribute.

◆ get_access_view_status()

const StringPiece google_books_api::Volume::VolumeAccessInfo::get_access_view_status ( ) const

inline

Get the value of the 'accessViewStatus' attribute.

◆ get_country()

const StringPiece google_books_api::Volume::VolumeAccessInfo::get_country ( ) const

inline

Get the value of the 'country' attribute.

◆ get_download_access()

const DownloadAccessRestriction google_books_api::Volume::VolumeAccessInfo::get_download_access ( ) const

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

◆ get_drive_imported_content_link()

const StringPiece google_books_api::Volume::VolumeAccessInfo::get_drive_imported_content_link ( ) const

inline

Get the value of the 'driveImportedContentLink' attribute.

◆ get_embeddable()

bool google_books_api::Volume::VolumeAccessInfo::get_embeddable ( ) const

inline

Get the value of the 'embeddable' attribute.

◆ get_epub()

const VolumeAccessInfoEpub google_books_api::Volume::VolumeAccessInfo::get_epub ( ) const

inline

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

◆ get_explicit_offline_license_management()

bool google_books_api::Volume::VolumeAccessInfo::get_explicit_offline_license_management ( ) const

inline

Get the value of the 'explicitOfflineLicenseManagement' attribute.

◆ get_pdf()

const VolumeAccessInfoPdf google_books_api::Volume::VolumeAccessInfo::get_pdf ( ) const

inline

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

◆ get_public_domain()

bool google_books_api::Volume::VolumeAccessInfo::get_public_domain ( ) const

inline

Get the value of the 'publicDomain' attribute.

◆ get_quote_sharing_allowed()

bool google_books_api::Volume::VolumeAccessInfo::get_quote_sharing_allowed ( ) const

inline

Get the value of the 'quoteSharingAllowed' attribute.

◆ get_text_to_speech_permission()

const StringPiece google_books_api::Volume::VolumeAccessInfo::get_text_to_speech_permission ( ) const

inline

Get the value of the 'textToSpeechPermission' attribute.

◆ get_view_order_url()

const StringPiece google_books_api::Volume::VolumeAccessInfo::get_view_order_url ( ) const

inline

Get the value of the 'viewOrderUrl' attribute.

◆ get_viewability()

const StringPiece google_books_api::Volume::VolumeAccessInfo::get_viewability ( ) const

inline

Get the value of the 'viewability' attribute.

◆ get_web_reader_link()

const StringPiece google_books_api::Volume::VolumeAccessInfo::get_web_reader_link ( ) const

inline

Get the value of the 'webReaderLink' attribute.

◆ GetTypeName()

const StringPiece google_books_api::Volume::VolumeAccessInfo::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_books_api::VolumeAccessInfo

◆ has_access_view_status()

bool google_books_api::Volume::VolumeAccessInfo::has_access_view_status ( ) const

inline

Determine if the 'accessViewStatus' attribute was set.

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

◆ has_country()

bool google_books_api::Volume::VolumeAccessInfo::has_country ( ) const

inline

Determine if the 'country' attribute was set.

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

◆ has_download_access()

bool google_books_api::Volume::VolumeAccessInfo::has_download_access ( ) const

inline

Determine if the 'downloadAccess' attribute was set.

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

◆ has_drive_imported_content_link()

bool google_books_api::Volume::VolumeAccessInfo::has_drive_imported_content_link ( ) const

inline

Determine if the 'driveImportedContentLink' attribute was set.

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

◆ has_embeddable()

bool google_books_api::Volume::VolumeAccessInfo::has_embeddable ( ) const

inline

Determine if the 'embeddable' attribute was set.

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

◆ has_epub()

bool google_books_api::Volume::VolumeAccessInfo::has_epub ( ) const

inline

Determine if the 'epub' attribute was set.

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

◆ has_explicit_offline_license_management()

bool google_books_api::Volume::VolumeAccessInfo::has_explicit_offline_license_management ( ) const

inline

Determine if the 'explicitOfflineLicenseManagement' attribute was set.

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

◆ has_pdf()

bool google_books_api::Volume::VolumeAccessInfo::has_pdf ( ) const

inline

Determine if the 'pdf' attribute was set.

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

◆ has_public_domain()

bool google_books_api::Volume::VolumeAccessInfo::has_public_domain ( ) const

inline

Determine if the 'publicDomain' attribute was set.

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

◆ has_quote_sharing_allowed()

bool google_books_api::Volume::VolumeAccessInfo::has_quote_sharing_allowed ( ) const

inline

Determine if the 'quoteSharingAllowed' attribute was set.

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

◆ has_text_to_speech_permission()

bool google_books_api::Volume::VolumeAccessInfo::has_text_to_speech_permission ( ) const

inline

Determine if the 'textToSpeechPermission' attribute was set.

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

◆ has_view_order_url()

bool google_books_api::Volume::VolumeAccessInfo::has_view_order_url ( ) const

inline

Determine if the 'viewOrderUrl' attribute was set.

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

◆ has_viewability()

bool google_books_api::Volume::VolumeAccessInfo::has_viewability ( ) const

inline

Determine if the 'viewability' attribute was set.

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

◆ has_web_reader_link()

bool google_books_api::Volume::VolumeAccessInfo::has_web_reader_link ( ) const

inline

Determine if the 'webReaderLink' attribute was set.

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

◆ mutable_downloadAccess()

DownloadAccessRestriction google_books_api::Volume::VolumeAccessInfo::mutable_downloadAccess ( )

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

Information about a volume's download license access restrictions.

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

◆ mutable_epub()

VolumeAccessInfoEpub google_books_api::Volume::VolumeAccessInfo::mutable_epub ( )

inline

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

Information about epub content. (In LITE projection.).

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

◆ mutable_pdf()

VolumeAccessInfoPdf google_books_api::Volume::VolumeAccessInfo::mutable_pdf ( )

inline

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

Information about pdf content. (In LITE projection.).

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

◆ New()

Volume::VolumeAccessInfo * google_books_api::Volume::VolumeAccessInfo::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_access_view_status()

void google_books_api::Volume::VolumeAccessInfo::set_access_view_status ( const StringPiece & value )

inline

Change the 'accessViewStatus' attribute.

Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.).

Parameters

[in] value The new value.

◆ set_country()

void google_books_api::Volume::VolumeAccessInfo::set_country ( const StringPiece & value )

inline

Change the 'country' attribute.

The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.).

Parameters

[in] value The new value.

◆ set_drive_imported_content_link()

void google_books_api::Volume::VolumeAccessInfo::set_drive_imported_content_link ( const StringPiece & value )

inline

Change the 'driveImportedContentLink' attribute.

URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.

Parameters

[in] value The new value.

◆ set_embeddable()

void google_books_api::Volume::VolumeAccessInfo::set_embeddable ( bool value )

inline

Change the 'embeddable' attribute.

Whether this volume can be embedded in a viewport using the Embedded Viewer API.

Parameters

[in] value The new value.

◆ set_explicit_offline_license_management()

void google_books_api::Volume::VolumeAccessInfo::set_explicit_offline_license_management ( bool value )

inline

Change the 'explicitOfflineLicenseManagement' attribute.

Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.

Parameters

[in] value The new value.

◆ set_public_domain()

void google_books_api::Volume::VolumeAccessInfo::set_public_domain ( bool value )

inline

Change the 'publicDomain' attribute.

Whether or not this book is public domain in the country listed above.

Parameters

[in] value The new value.

◆ set_quote_sharing_allowed()

void google_books_api::Volume::VolumeAccessInfo::set_quote_sharing_allowed ( bool value )

inline

Change the 'quoteSharingAllowed' attribute.

Whether quote sharing is allowed for this volume.

Parameters

[in] value The new value.

◆ set_text_to_speech_permission()

void google_books_api::Volume::VolumeAccessInfo::set_text_to_speech_permission ( const StringPiece & value )

inline

Change the 'textToSpeechPermission' attribute.

Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.

Parameters

[in] value The new value.

◆ set_view_order_url()

void google_books_api::Volume::VolumeAccessInfo::set_view_order_url ( const StringPiece & value )

inline

Change the 'viewOrderUrl' attribute.

For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.

Parameters

[in] value The new value.

◆ set_viewability()

void google_books_api::Volume::VolumeAccessInfo::set_viewability ( const StringPiece & value )

inline

Change the 'viewability' attribute.

The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.

Parameters

[in] value The new value.

◆ set_web_reader_link()

void google_books_api::Volume::VolumeAccessInfo::set_web_reader_link ( const StringPiece & value )

inline

Change the 'webReaderLink' attribute.

URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.

Parameters

[in] value The new value.

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

google/books_api/volume.h
google/books_api/volume.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VolumeAccessInfo() [1/2]

◆ VolumeAccessInfo() [2/2]

◆ ~VolumeAccessInfo()

Member Function Documentation

◆ clear_access_view_status()

◆ clear_country()

◆ clear_download_access()

◆ clear_drive_imported_content_link()

◆ clear_embeddable()

◆ clear_epub()

◆ clear_explicit_offline_license_management()

◆ clear_pdf()

◆ clear_public_domain()

◆ clear_quote_sharing_allowed()

◆ clear_text_to_speech_permission()

◆ clear_view_order_url()

◆ clear_viewability()

◆ clear_web_reader_link()

◆ get_access_view_status()

◆ get_country()

◆ get_download_access()

◆ get_drive_imported_content_link()

◆ get_embeddable()

◆ get_epub()

◆ get_explicit_offline_license_management()

◆ get_pdf()

◆ get_public_domain()

◆ get_quote_sharing_allowed()

◆ get_text_to_speech_permission()

◆ get_view_order_url()

◆ get_viewability()

◆ get_web_reader_link()

◆ GetTypeName()

◆ has_access_view_status()

◆ has_country()

◆ has_download_access()

◆ has_drive_imported_content_link()

◆ has_embeddable()

◆ has_epub()

◆ has_explicit_offline_license_management()

◆ has_pdf()

◆ has_public_domain()

◆ has_quote_sharing_allowed()

◆ has_text_to_speech_permission()

◆ has_view_order_url()

◆ has_viewability()

◆ has_web_reader_link()

◆ mutable_downloadAccess()

◆ mutable_epub()

◆ mutable_pdf()

◆ New()

◆ set_access_view_status()

◆ set_country()

◆ set_drive_imported_content_link()

◆ set_embeddable()

◆ set_explicit_offline_license_management()

◆ set_public_domain()

◆ set_quote_sharing_allowed()

◆ set_text_to_speech_permission()

◆ set_view_order_url()

◆ set_viewability()

◆ set_web_reader_link()