Class: Google::Apis::BooksV1::Volume::AccessInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/books_v1/classes.rb,
generated/google/apis/books_v1/representations.rb,
generated/google/apis/books_v1/representations.rb

Overview

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

Defined Under Namespace

Classes: Epub, Pdf

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AccessInfo

Returns a new instance of AccessInfo.



3074
3075
3076
 
# File 'generated/google/apis/books_v1/classes.rb', line 3074

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_view_status ⇒ String

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.) Corresponds to the JSON property accessViewStatus

Returns:

  • (String) 


2991
2992
2993
 
# File 'generated/google/apis/books_v1/classes.rb', line 2991

def access_view_status
  @access_view_status
end

#country ⇒ String

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

Returns:

  • (String) 


2997
2998
2999
 
# File 'generated/google/apis/books_v1/classes.rb', line 2997

def country
  @country
end

#download_access ⇒ Google::Apis::BooksV1::DownloadAccessRestriction

Information about a volume's download license access restrictions. Corresponds to the JSON property downloadAccess

Returns:



3002
3003
3004
 
# File 'generated/google/apis/books_v1/classes.rb', line 3002

def download_access
  @download_access
end

#drive_imported_content_link ⇒ String

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

Returns:

  • (String) 


3008
3009
3010
 
# File 'generated/google/apis/books_v1/classes.rb', line 3008

def drive_imported_content_link
  @drive_imported_content_link
end

#embeddable ⇒ Boolean Also known as: embeddable?

Whether this volume can be embedded in a viewport using the Embedded Viewer API. Corresponds to the JSON property embeddable

Returns:

  • (Boolean) 


3014
3015
3016
 
# File 'generated/google/apis/books_v1/classes.rb', line 3014

def embeddable
  @embeddable
end

#epub ⇒ Google::Apis::BooksV1::Volume::AccessInfo::Epub

Information about epub content. (In LITE projection.) Corresponds to the JSON property epub

Returns:



3020
3021
3022
 
# File 'generated/google/apis/books_v1/classes.rb', line 3020

def epub
  @epub
end

#explicit_offline_license_management ⇒ Boolean Also known as: explicit_offline_license_management?

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. Corresponds to the JSON property explicitOfflineLicenseManagement

Returns:

  • (Boolean) 


3027
3028
3029
 
# File 'generated/google/apis/books_v1/classes.rb', line 3027

def explicit_offline_license_management
  @explicit_offline_license_management
end

#pdf ⇒ Google::Apis::BooksV1::Volume::AccessInfo::Pdf

Information about pdf content. (In LITE projection.) Corresponds to the JSON property pdf

Returns:



3033
3034
3035
 
# File 'generated/google/apis/books_v1/classes.rb', line 3033

def pdf
  @pdf
end

#public_domain ⇒ Boolean Also known as: public_domain?

Whether or not this book is public domain in the country listed above. Corresponds to the JSON property publicDomain

Returns:

  • (Boolean) 


3038
3039
3040
 
# File 'generated/google/apis/books_v1/classes.rb', line 3038

def public_domain
  @public_domain
end

#quote_sharing_allowed ⇒ Boolean Also known as: quote_sharing_allowed?

Whether quote sharing is allowed for this volume. Corresponds to the JSON property quoteSharingAllowed

Returns:

  • (Boolean) 


3044
3045
3046
 
# File 'generated/google/apis/books_v1/classes.rb', line 3044

def quote_sharing_allowed
  @quote_sharing_allowed
end

#text_to_speech_permission ⇒ String

Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED. Corresponds to the JSON property textToSpeechPermission

Returns:

  • (String) 


3051
3052
3053
 
# File 'generated/google/apis/books_v1/classes.rb', line 3051

def text_to_speech_permission
  @text_to_speech_permission
end

#view_order_url ⇒ String

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

Returns:

  • (String) 


3057
3058
3059
 
# File 'generated/google/apis/books_v1/classes.rb', line 3057

def view_order_url
  @view_order_url
end

#viewability ⇒ String

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. Corresponds to the JSON property viewability

Returns:

  • (String) 


3066
3067
3068
 
# File 'generated/google/apis/books_v1/classes.rb', line 3066

def viewability
  @viewability
end

#web_reader_link ⇒ String

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

Returns:

  • (String) 


3072
3073
3074
 
# File 'generated/google/apis/books_v1/classes.rb', line 3072

def web_reader_link
  @web_reader_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
 
# File 'generated/google/apis/books_v1/classes.rb', line 3079

def update!(**args)
  @access_view_status = args[:access_view_status] if args.key?(:access_view_status)
  @country = args[:country] if args.key?(:country)
  @download_access = args[:download_access] if args.key?(:download_access)
  @drive_imported_content_link = args[:drive_imported_content_link] if args.key?(:drive_imported_content_link)
  @embeddable = args[:embeddable] if args.key?(:embeddable)
  @epub = args[:epub] if args.key?(:epub)
  @explicit_offline_license_management = args[:explicit_offline_license_management] if args.key?(:explicit_offline_license_management)
  @pdf = args[:pdf] if args.key?(:pdf)
  @public_domain = args[:public_domain] if args.key?(:public_domain)
  @quote_sharing_allowed = args[:quote_sharing_allowed] if args.key?(:quote_sharing_allowed)
  @text_to_speech_permission = args[:text_to_speech_permission] if args.key?(:text_to_speech_permission)
  @view_order_url = args[:view_order_url] if args.key?(:view_order_url)
  @viewability = args[:viewability] if args.key?(:viewability)
  @web_reader_link = args[:web_reader_link] if args.key?(:web_reader_link)
end