books  v1
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_books_api::Volume::VolumeUserInfo Class Reference
Books API Data Objects

#include <volume.h>

Inheritance diagram for google_books_api::Volume::VolumeUserInfo:

Classes

class  VolumeUserInfoCopy
 
class  VolumeUserInfoFamilySharing
 
class  VolumeUserInfoRentalPeriod
 
class  VolumeUserInfoUserUploadedVolumeInfo
 

Public Member Functions

 VolumeUserInfo (const Json::Value &storage)
 
 VolumeUserInfo (Json::Value *storage)
 
virtual ~VolumeUserInfo ()
 
const StringPiece GetTypeName () const
 
bool has_acquired_time () const
 
void clear_acquired_time ()
 
client::DateTime get_acquired_time () const
 
void set_acquired_time (client::DateTime value)
 
bool has_acquisition_type () const
 
void clear_acquisition_type ()
 
int32 get_acquisition_type () const
 
void set_acquisition_type (int32 value)
 
bool has_copy () const
 
void clear_copy ()
 
const VolumeUserInfoCopy get_copy () const
 
VolumeUserInfoCopy mutable_copy ()
 
bool has_entitlement_type () const
 
void clear_entitlement_type ()
 
int32 get_entitlement_type () const
 
void set_entitlement_type (int32 value)
 
bool has_family_sharing () const
 
void clear_family_sharing ()
 
const VolumeUserInfoFamilySharing get_family_sharing () const
 
VolumeUserInfoFamilySharing mutable_familySharing ()
 
bool has_is_family_shared_from_user () const
 
void clear_is_family_shared_from_user ()
 
bool get_is_family_shared_from_user () const
 
void set_is_family_shared_from_user (bool value)
 
bool has_is_family_shared_to_user () const
 
void clear_is_family_shared_to_user ()
 
bool get_is_family_shared_to_user () const
 
void set_is_family_shared_to_user (bool value)
 
bool has_is_family_sharing_allowed () const
 
void clear_is_family_sharing_allowed ()
 
bool get_is_family_sharing_allowed () const
 
void set_is_family_sharing_allowed (bool value)
 
bool has_is_family_sharing_disabled_by_fop () const
 
void clear_is_family_sharing_disabled_by_fop ()
 
bool get_is_family_sharing_disabled_by_fop () const
 
void set_is_family_sharing_disabled_by_fop (bool value)
 
bool has_is_in_my_books () const
 
void clear_is_in_my_books ()
 
bool get_is_in_my_books () const
 
void set_is_in_my_books (bool value)
 
bool has_is_preordered () const
 
void clear_is_preordered ()
 
bool get_is_preordered () const
 
void set_is_preordered (bool value)
 
bool has_is_purchased () const
 
void clear_is_purchased ()
 
bool get_is_purchased () const
 
void set_is_purchased (bool value)
 
bool has_is_uploaded () const
 
void clear_is_uploaded ()
 
bool get_is_uploaded () const
 
void set_is_uploaded (bool value)
 
bool has_reading_position () const
 
void clear_reading_position ()
 
const ReadingPosition get_reading_position () const
 
ReadingPosition mutable_readingPosition ()
 
bool has_rental_period () const
 
void clear_rental_period ()
 
const VolumeUserInfoRentalPeriod get_rental_period () const
 
VolumeUserInfoRentalPeriod mutable_rentalPeriod ()
 
bool has_rental_state () const
 
void clear_rental_state ()
 
const StringPiece get_rental_state () const
 
void set_rental_state (const StringPiece &value)
 
bool has_review () const
 
void clear_review ()
 
const Review get_review () const
 
Review mutable_review ()
 
bool has_updated () const
 
void clear_updated ()
 
client::DateTime get_updated () const
 
void set_updated (client::DateTime value)
 
bool has_user_uploaded_volume_info () const
 
void clear_user_uploaded_volume_info ()
 
const VolumeUserInfoUserUploadedVolumeInfo get_user_uploaded_volume_info () const
 
VolumeUserInfoUserUploadedVolumeInfo mutable_userUploadedVolumeInfo ()
 

Static Public Member Functions

static VolumeUserInfo * New ()
 

Detailed Description

User specific information related to this volume. (e.g. page this user last read or whether they purchased this book).

Constructor & Destructor Documentation

◆ VolumeUserInfo() [1/2]

google_books_api::Volume::VolumeUserInfo::VolumeUserInfo ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ VolumeUserInfo() [2/2]

google_books_api::Volume::VolumeUserInfo::VolumeUserInfo ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~VolumeUserInfo()

google_books_api::Volume::VolumeUserInfo::~VolumeUserInfo ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_acquired_time()

void google_books_api::Volume::VolumeUserInfo::clear_acquired_time ( )
inline

Clears the 'acquiredTime' attribute.

◆ clear_acquisition_type()

void google_books_api::Volume::VolumeUserInfo::clear_acquisition_type ( )
inline

Clears the 'acquisitionType' attribute.

◆ clear_copy()

void google_books_api::Volume::VolumeUserInfo::clear_copy ( )
inline

Clears the 'copy' attribute.

◆ clear_entitlement_type()

void google_books_api::Volume::VolumeUserInfo::clear_entitlement_type ( )
inline

Clears the 'entitlementType' attribute.

◆ clear_family_sharing()

void google_books_api::Volume::VolumeUserInfo::clear_family_sharing ( )
inline

Clears the 'familySharing' attribute.

◆ clear_is_family_shared_from_user()

void google_books_api::Volume::VolumeUserInfo::clear_is_family_shared_from_user ( )
inline

Clears the 'isFamilySharedFromUser' attribute.

◆ clear_is_family_shared_to_user()

void google_books_api::Volume::VolumeUserInfo::clear_is_family_shared_to_user ( )
inline

Clears the 'isFamilySharedToUser' attribute.

◆ clear_is_family_sharing_allowed()

void google_books_api::Volume::VolumeUserInfo::clear_is_family_sharing_allowed ( )
inline

Clears the 'isFamilySharingAllowed' attribute.

◆ clear_is_family_sharing_disabled_by_fop()

void google_books_api::Volume::VolumeUserInfo::clear_is_family_sharing_disabled_by_fop ( )
inline

Clears the 'isFamilySharingDisabledByFop' attribute.

◆ clear_is_in_my_books()

void google_books_api::Volume::VolumeUserInfo::clear_is_in_my_books ( )
inline

Clears the 'isInMyBooks' attribute.

◆ clear_is_preordered()

void google_books_api::Volume::VolumeUserInfo::clear_is_preordered ( )
inline

Clears the 'isPreordered' attribute.

◆ clear_is_purchased()

void google_books_api::Volume::VolumeUserInfo::clear_is_purchased ( )
inline

Clears the 'isPurchased' attribute.

◆ clear_is_uploaded()

void google_books_api::Volume::VolumeUserInfo::clear_is_uploaded ( )
inline

Clears the 'isUploaded' attribute.

◆ clear_reading_position()

void google_books_api::Volume::VolumeUserInfo::clear_reading_position ( )
inline

Clears the 'readingPosition' attribute.

◆ clear_rental_period()

void google_books_api::Volume::VolumeUserInfo::clear_rental_period ( )
inline

Clears the 'rentalPeriod' attribute.

◆ clear_rental_state()

void google_books_api::Volume::VolumeUserInfo::clear_rental_state ( )
inline

Clears the 'rentalState' attribute.

◆ clear_review()

void google_books_api::Volume::VolumeUserInfo::clear_review ( )
inline

Clears the 'review' attribute.

◆ clear_updated()

void google_books_api::Volume::VolumeUserInfo::clear_updated ( )
inline

Clears the 'updated' attribute.

◆ clear_user_uploaded_volume_info()

void google_books_api::Volume::VolumeUserInfo::clear_user_uploaded_volume_info ( )
inline

Clears the 'userUploadedVolumeInfo' attribute.

◆ get_acquired_time()

client::DateTime google_books_api::Volume::VolumeUserInfo::get_acquired_time ( ) const
inline

Get the value of the 'acquiredTime' attribute.

◆ get_acquisition_type()

int32 google_books_api::Volume::VolumeUserInfo::get_acquisition_type ( ) const
inline

Get the value of the 'acquisitionType' attribute.

◆ get_copy()

const VolumeUserInfoCopy google_books_api::Volume::VolumeUserInfo::get_copy ( ) const
inline

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

◆ get_entitlement_type()

int32 google_books_api::Volume::VolumeUserInfo::get_entitlement_type ( ) const
inline

Get the value of the 'entitlementType' attribute.

◆ get_family_sharing()

const VolumeUserInfoFamilySharing google_books_api::Volume::VolumeUserInfo::get_family_sharing ( ) const
inline

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

◆ get_is_family_shared_from_user()

bool google_books_api::Volume::VolumeUserInfo::get_is_family_shared_from_user ( ) const
inline

Get the value of the 'isFamilySharedFromUser' attribute.

◆ get_is_family_shared_to_user()

bool google_books_api::Volume::VolumeUserInfo::get_is_family_shared_to_user ( ) const
inline

Get the value of the 'isFamilySharedToUser' attribute.

◆ get_is_family_sharing_allowed()

bool google_books_api::Volume::VolumeUserInfo::get_is_family_sharing_allowed ( ) const
inline

Get the value of the 'isFamilySharingAllowed' attribute.

◆ get_is_family_sharing_disabled_by_fop()

bool google_books_api::Volume::VolumeUserInfo::get_is_family_sharing_disabled_by_fop ( ) const
inline

Get the value of the 'isFamilySharingDisabledByFop' attribute.

◆ get_is_in_my_books()

bool google_books_api::Volume::VolumeUserInfo::get_is_in_my_books ( ) const
inline

Get the value of the 'isInMyBooks' attribute.

◆ get_is_preordered()

bool google_books_api::Volume::VolumeUserInfo::get_is_preordered ( ) const
inline

Get the value of the 'isPreordered' attribute.

◆ get_is_purchased()

bool google_books_api::Volume::VolumeUserInfo::get_is_purchased ( ) const
inline

Get the value of the 'isPurchased' attribute.

◆ get_is_uploaded()

bool google_books_api::Volume::VolumeUserInfo::get_is_uploaded ( ) const
inline

Get the value of the 'isUploaded' attribute.

◆ get_reading_position()

const ReadingPosition google_books_api::Volume::VolumeUserInfo::get_reading_position ( ) const

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

◆ get_rental_period()

const VolumeUserInfoRentalPeriod google_books_api::Volume::VolumeUserInfo::get_rental_period ( ) const
inline

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

◆ get_rental_state()

const StringPiece google_books_api::Volume::VolumeUserInfo::get_rental_state ( ) const
inline

Get the value of the 'rentalState' attribute.

◆ get_review()

const Review google_books_api::Volume::VolumeUserInfo::get_review ( ) const

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

◆ get_updated()

client::DateTime google_books_api::Volume::VolumeUserInfo::get_updated ( ) const
inline

Get the value of the 'updated' attribute.

◆ get_user_uploaded_volume_info()

const VolumeUserInfoUserUploadedVolumeInfo google_books_api::Volume::VolumeUserInfo::get_user_uploaded_volume_info ( ) const
inline

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

◆ GetTypeName()

const StringPiece google_books_api::Volume::VolumeUserInfo::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_books_api::VolumeUserInfo

◆ has_acquired_time()

bool google_books_api::Volume::VolumeUserInfo::has_acquired_time ( ) const
inline

Determine if the 'acquiredTime' attribute was set.

Returns
true if the 'acquiredTime' attribute was set.

◆ has_acquisition_type()

bool google_books_api::Volume::VolumeUserInfo::has_acquisition_type ( ) const
inline

Determine if the 'acquisitionType' attribute was set.

Returns
true if the 'acquisitionType' attribute was set.

◆ has_copy()

bool google_books_api::Volume::VolumeUserInfo::has_copy ( ) const
inline

Determine if the 'copy' attribute was set.

Returns
true if the 'copy' attribute was set.

◆ has_entitlement_type()

bool google_books_api::Volume::VolumeUserInfo::has_entitlement_type ( ) const
inline

Determine if the 'entitlementType' attribute was set.

Returns
true if the 'entitlementType' attribute was set.

◆ has_family_sharing()

bool google_books_api::Volume::VolumeUserInfo::has_family_sharing ( ) const
inline

Determine if the 'familySharing' attribute was set.

Returns
true if the 'familySharing' attribute was set.

◆ has_is_family_shared_from_user()

bool google_books_api::Volume::VolumeUserInfo::has_is_family_shared_from_user ( ) const
inline

Determine if the 'isFamilySharedFromUser' attribute was set.

Returns
true if the 'isFamilySharedFromUser' attribute was set.

◆ has_is_family_shared_to_user()

bool google_books_api::Volume::VolumeUserInfo::has_is_family_shared_to_user ( ) const
inline

Determine if the 'isFamilySharedToUser' attribute was set.

Returns
true if the 'isFamilySharedToUser' attribute was set.

◆ has_is_family_sharing_allowed()

bool google_books_api::Volume::VolumeUserInfo::has_is_family_sharing_allowed ( ) const
inline

Determine if the 'isFamilySharingAllowed' attribute was set.

Returns
true if the 'isFamilySharingAllowed' attribute was set.

◆ has_is_family_sharing_disabled_by_fop()

bool google_books_api::Volume::VolumeUserInfo::has_is_family_sharing_disabled_by_fop ( ) const
inline

Determine if the 'isFamilySharingDisabledByFop' attribute was set.

Returns
true if the 'isFamilySharingDisabledByFop' attribute was set.

◆ has_is_in_my_books()

bool google_books_api::Volume::VolumeUserInfo::has_is_in_my_books ( ) const
inline

Determine if the 'isInMyBooks' attribute was set.

Returns
true if the 'isInMyBooks' attribute was set.

◆ has_is_preordered()

bool google_books_api::Volume::VolumeUserInfo::has_is_preordered ( ) const
inline

Determine if the 'isPreordered' attribute was set.

Returns
true if the 'isPreordered' attribute was set.

◆ has_is_purchased()

bool google_books_api::Volume::VolumeUserInfo::has_is_purchased ( ) const
inline

Determine if the 'isPurchased' attribute was set.

Returns
true if the 'isPurchased' attribute was set.

◆ has_is_uploaded()

bool google_books_api::Volume::VolumeUserInfo::has_is_uploaded ( ) const
inline

Determine if the 'isUploaded' attribute was set.

Returns
true if the 'isUploaded' attribute was set.

◆ has_reading_position()

bool google_books_api::Volume::VolumeUserInfo::has_reading_position ( ) const
inline

Determine if the 'readingPosition' attribute was set.

Returns
true if the 'readingPosition' attribute was set.

◆ has_rental_period()

bool google_books_api::Volume::VolumeUserInfo::has_rental_period ( ) const
inline

Determine if the 'rentalPeriod' attribute was set.

Returns
true if the 'rentalPeriod' attribute was set.

◆ has_rental_state()

bool google_books_api::Volume::VolumeUserInfo::has_rental_state ( ) const
inline

Determine if the 'rentalState' attribute was set.

Returns
true if the 'rentalState' attribute was set.

◆ has_review()

bool google_books_api::Volume::VolumeUserInfo::has_review ( ) const
inline

Determine if the 'review' attribute was set.

Returns
true if the 'review' attribute was set.

◆ has_updated()

bool google_books_api::Volume::VolumeUserInfo::has_updated ( ) const
inline

Determine if the 'updated' attribute was set.

Returns
true if the 'updated' attribute was set.

◆ has_user_uploaded_volume_info()

bool google_books_api::Volume::VolumeUserInfo::has_user_uploaded_volume_info ( ) const
inline

Determine if the 'userUploadedVolumeInfo' attribute was set.

Returns
true if the 'userUploadedVolumeInfo' attribute was set.

◆ mutable_copy()

VolumeUserInfoCopy google_books_api::Volume::VolumeUserInfo::mutable_copy ( )
inline

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

Copy/Paste accounting information.

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

◆ mutable_familySharing()

VolumeUserInfoFamilySharing google_books_api::Volume::VolumeUserInfo::mutable_familySharing ( )
inline

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

Information on the ability to share with the family.

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

◆ mutable_readingPosition()

ReadingPosition google_books_api::Volume::VolumeUserInfo::mutable_readingPosition ( )

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

The user's current reading position in the volume, if one is available. (In LITE projection.).

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

◆ mutable_rentalPeriod()

VolumeUserInfoRentalPeriod google_books_api::Volume::VolumeUserInfo::mutable_rentalPeriod ( )
inline

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

Period during this book is/was a valid rental.

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

◆ mutable_review()

Review google_books_api::Volume::VolumeUserInfo::mutable_review ( )

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

This user's review of this volume, if one exists.

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

◆ mutable_userUploadedVolumeInfo()

VolumeUserInfoUserUploadedVolumeInfo google_books_api::Volume::VolumeUserInfo::mutable_userUploadedVolumeInfo ( )
inline

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

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

◆ New()

Volume::VolumeUserInfo * google_books_api::Volume::VolumeUserInfo::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_acquired_time()

void google_books_api::Volume::VolumeUserInfo::set_acquired_time ( client::DateTime  value)
inline

Change the 'acquiredTime' attribute.

Timestamp when this volume was acquired by the user. (RFC 3339 UTC date- time format) Acquiring includes purchase, user upload, receiving family sharing, etc.

Parameters
[in]valueThe new value.

◆ set_acquisition_type()

void google_books_api::Volume::VolumeUserInfo::set_acquisition_type ( int32  value)
inline

Change the 'acquisitionType' attribute.

How this volume was acquired.

Parameters
[in]valueThe new value.

◆ set_entitlement_type()

void google_books_api::Volume::VolumeUserInfo::set_entitlement_type ( int32  value)
inline

Change the 'entitlementType' attribute.

Whether this volume is purchased, sample, pd download etc.

Parameters
[in]valueThe new value.

◆ set_is_family_shared_from_user()

void google_books_api::Volume::VolumeUserInfo::set_is_family_shared_from_user ( bool  value)
inline

Change the 'isFamilySharedFromUser' attribute.

Whether or not the user shared this volume with the family.

Parameters
[in]valueThe new value.

◆ set_is_family_shared_to_user()

void google_books_api::Volume::VolumeUserInfo::set_is_family_shared_to_user ( bool  value)
inline

Change the 'isFamilySharedToUser' attribute.

Whether or not the user received this volume through family sharing.

Parameters
[in]valueThe new value.

◆ set_is_family_sharing_allowed()

void google_books_api::Volume::VolumeUserInfo::set_is_family_sharing_allowed ( bool  value)
inline

Change the 'isFamilySharingAllowed' attribute.

Deprecated:

Deprecated: Replaced by familySharing.

Parameters
[in]valueThe new value.

◆ set_is_family_sharing_disabled_by_fop()

void google_books_api::Volume::VolumeUserInfo::set_is_family_sharing_disabled_by_fop ( bool  value)
inline

Change the 'isFamilySharingDisabledByFop' attribute.

Deprecated:

Deprecated: Replaced by familySharing.

Parameters
[in]valueThe new value.

◆ set_is_in_my_books()

void google_books_api::Volume::VolumeUserInfo::set_is_in_my_books ( bool  value)
inline

Change the 'isInMyBooks' attribute.

Whether or not this volume is currently in "my books.".

Parameters
[in]valueThe new value.

◆ set_is_preordered()

void google_books_api::Volume::VolumeUserInfo::set_is_preordered ( bool  value)
inline

Change the 'isPreordered' attribute.

Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.).

Parameters
[in]valueThe new value.

◆ set_is_purchased()

void google_books_api::Volume::VolumeUserInfo::set_is_purchased ( bool  value)
inline

Change the 'isPurchased' attribute.

Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.).

Parameters
[in]valueThe new value.

◆ set_is_uploaded()

void google_books_api::Volume::VolumeUserInfo::set_is_uploaded ( bool  value)
inline

Change the 'isUploaded' attribute.

Whether or not this volume was user uploaded.

Parameters
[in]valueThe new value.

◆ set_rental_state()

void google_books_api::Volume::VolumeUserInfo::set_rental_state ( const StringPiece &  value)
inline

Change the 'rentalState' attribute.

Whether this book is an active or an expired rental.

Parameters
[in]valueThe new value.

◆ set_updated()

void google_books_api::Volume::VolumeUserInfo::set_updated ( client::DateTime  value)
inline

Change the 'updated' attribute.

Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: