google_api_books v0.2.0 GoogleApi.Books.V1.Model.VolumeUserInfo View Source
User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
Attributes
- acquiredTime (DateTime.t): Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. Defaults to:
null
. - acquisitionType (integer()): How this volume was acquired. Defaults to:
null
. - copy (VolumeUserInfoCopy): Defaults to:
null
. - entitlementType (integer()): Whether this volume is purchased, sample, pd download etc. Defaults to:
null
. - familySharing (VolumeUserInfoFamilySharing): Defaults to:
null
. - isFamilySharedFromUser (boolean()): Whether or not the user shared this volume with the family. Defaults to:
null
. - isFamilySharedToUser (boolean()): Whether or not the user received this volume through family sharing. Defaults to:
null
. - isFamilySharingAllowed (boolean()): Deprecated: Replaced by familySharing. Defaults to:
null
. - isFamilySharingDisabledByFop (boolean()): Deprecated: Replaced by familySharing. Defaults to:
null
. - isInMyBooks (boolean()): Whether or not this volume is currently in "my books." Defaults to:
null
. - isPreordered (boolean()): Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) Defaults to:
null
. - isPurchased (boolean()): Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) Defaults to:
null
. - isUploaded (boolean()): Whether or not this volume was user uploaded. Defaults to:
null
. - readingPosition (ReadingPosition): The user's current reading position in the volume, if one is available. (In LITE projection.) Defaults to:
null
. - rentalPeriod (VolumeUserInfoRentalPeriod): Defaults to:
null
. - rentalState (String.t): Whether this book is an active or an expired rental. Defaults to:
null
. - review (Review): This user's review of this volume, if one exists. Defaults to:
null
. - updated (DateTime.t): 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). Defaults to:
null
. - userUploadedVolumeInfo (VolumeUserInfoUserUploadedVolumeInfo): Defaults to:
null
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields
Link to this section Types
Link to this type
t()
View Source
t() :: %GoogleApi.Books.V1.Model.VolumeUserInfo{ acquiredTime: DateTime.t(), acquisitionType: any(), copy: GoogleApi.Books.V1.Model.VolumeUserInfoCopy.t(), entitlementType: any(), familySharing: GoogleApi.Books.V1.Model.VolumeUserInfoFamilySharing.t(), isFamilySharedFromUser: any(), isFamilySharedToUser: any(), isFamilySharingAllowed: any(), isFamilySharingDisabledByFop: any(), isInMyBooks: any(), isPreordered: any(), isPurchased: any(), isUploaded: any(), readingPosition: GoogleApi.Books.V1.Model.ReadingPosition.t(), rentalPeriod: GoogleApi.Books.V1.Model.VolumeUserInfoRentalPeriod.t(), rentalState: any(), review: GoogleApi.Books.V1.Model.Review.t(), updated: DateTime.t(), userUploadedVolumeInfo: GoogleApi.Books.V1.Model.VolumeUserInfoUserUploadedVolumeInfo.t() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.