google_api_books v0.2.0 GoogleApi.Books.V1.Model.VolumeAccessInfo View Source

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.).

Attributes

  • accessViewStatus (String.t): 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.) Defaults to: null.
  • country (String.t): The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.) Defaults to: null.
  • downloadAccess (DownloadAccessRestriction): Information about a volume's download license access restrictions. Defaults to: null.
  • driveImportedContentLink (String.t): URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive. Defaults to: null.
  • embeddable (boolean()): Whether this volume can be embedded in a viewport using the Embedded Viewer API. Defaults to: null.
  • epub (VolumeAccessInfoEpub): Defaults to: null.
  • explicitOfflineLicenseManagement (boolean()): 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. Defaults to: null.
  • pdf (VolumeAccessInfoPdf): Defaults to: null.
  • publicDomain (boolean()): Whether or not this book is public domain in the country listed above. Defaults to: null.
  • quoteSharingAllowed (boolean()): Whether quote sharing is allowed for this volume. Defaults to: null.
  • textToSpeechPermission (String.t): Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED. Defaults to: null.
  • viewOrderUrl (String.t): For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page. Defaults to: null.
  • viewability (String.t): 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. Defaults to: null.
  • webReaderLink (String.t): URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes. 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.VolumeAccessInfo{
  accessViewStatus: any(),
  country: any(),
  downloadAccess: GoogleApi.Books.V1.Model.DownloadAccessRestriction.t(),
  driveImportedContentLink: any(),
  embeddable: any(),
  epub: GoogleApi.Books.V1.Model.VolumeAccessInfoEpub.t(),
  explicitOfflineLicenseManagement: any(),
  pdf: GoogleApi.Books.V1.Model.VolumeAccessInfoPdf.t(),
  publicDomain: any(),
  quoteSharingAllowed: any(),
  textToSpeechPermission: any(),
  viewOrderUrl: any(),
  viewability: any(),
  webReaderLink: any()
}

Link to this section Functions

Link to this function decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.