google_api_books v0.5.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
nil
. - acquisitionType (integer()): How this volume was acquired. Defaults to
nil
. - copy (GoogleApi.Books.V1.Model.VolumeUserInfoCopy.t): Copy/Paste accounting information. Defaults to
nil
. - entitlementType (integer()): Whether this volume is purchased, sample, pd download etc. Defaults to
nil
. - familySharing (GoogleApi.Books.V1.Model.VolumeUserInfoFamilySharing.t): Information on the ability to share with the family. Defaults to
nil
. - isFamilySharedFromUser (boolean()): Whether or not the user shared this volume with the family. Defaults to
nil
. - isFamilySharedToUser (boolean()): Whether or not the user received this volume through family sharing. Defaults to
nil
. - isFamilySharingAllowed (boolean()): Deprecated: Replaced by familySharing. Defaults to
nil
. - isFamilySharingDisabledByFop (boolean()): Deprecated: Replaced by familySharing. Defaults to
nil
. - isInMyBooks (boolean()): Whether or not this volume is currently in "my books." Defaults to
nil
. - isPreordered (boolean()): Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) Defaults to
nil
. - isPurchased (boolean()): Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) Defaults to
nil
. - isUploaded (boolean()): Whether or not this volume was user uploaded. Defaults to
nil
. - readingPosition (GoogleApi.Books.V1.Model.ReadingPosition.t): The user's current reading position in the volume, if one is available. (In LITE projection.) Defaults to
nil
. - rentalPeriod (GoogleApi.Books.V1.Model.VolumeUserInfoRentalPeriod.t): Period during this book is/was a valid rental. Defaults to
nil
. - rentalState (String.t): Whether this book is an active or an expired rental. Defaults to
nil
. - review (GoogleApi.Books.V1.Model.Review.t): This user's review of this volume, if one exists. Defaults to
nil
. - 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
nil
. - userUploadedVolumeInfo (GoogleApi.Books.V1.Model.VolumeUserInfoUserUploadedVolumeInfo.t): Defaults to
nil
.
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()
View Source
t() :: %GoogleApi.Books.V1.Model.VolumeUserInfo{
acquiredTime: DateTime.t(),
acquisitionType: integer(),
copy: GoogleApi.Books.V1.Model.VolumeUserInfoCopy.t(),
entitlementType: integer(),
familySharing: GoogleApi.Books.V1.Model.VolumeUserInfoFamilySharing.t(),
isFamilySharedFromUser: boolean(),
isFamilySharedToUser: boolean(),
isFamilySharingAllowed: boolean(),
isFamilySharingDisabledByFop: boolean(),
isInMyBooks: boolean(),
isPreordered: boolean(),
isPurchased: boolean(),
isUploaded: boolean(),
readingPosition: GoogleApi.Books.V1.Model.ReadingPosition.t(),
rentalPeriod: GoogleApi.Books.V1.Model.VolumeUserInfoRentalPeriod.t(),
rentalState: String.t(),
review: GoogleApi.Books.V1.Model.Review.t(),
updated: DateTime.t(),
userUploadedVolumeInfo:
GoogleApi.Books.V1.Model.VolumeUserInfoUserUploadedVolumeInfo.t()
}
t() :: %GoogleApi.Books.V1.Model.VolumeUserInfo{ acquiredTime: DateTime.t(), acquisitionType: integer(), copy: GoogleApi.Books.V1.Model.VolumeUserInfoCopy.t(), entitlementType: integer(), familySharing: GoogleApi.Books.V1.Model.VolumeUserInfoFamilySharing.t(), isFamilySharedFromUser: boolean(), isFamilySharedToUser: boolean(), isFamilySharingAllowed: boolean(), isFamilySharingDisabledByFop: boolean(), isInMyBooks: boolean(), isPreordered: boolean(), isPurchased: boolean(), isUploaded: boolean(), readingPosition: GoogleApi.Books.V1.Model.ReadingPosition.t(), rentalPeriod: GoogleApi.Books.V1.Model.VolumeUserInfoRentalPeriod.t(), rentalState: String.t(), review: GoogleApi.Books.V1.Model.Review.t(), updated: DateTime.t(), userUploadedVolumeInfo: GoogleApi.Books.V1.Model.VolumeUserInfoUserUploadedVolumeInfo.t() }
Link to this section Functions
Link to this function
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.