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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/books_v1/classes.rb,
lib/google/apis/books_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ AccessInfo

Returns a new instance of AccessInfo.



3173
3174
3175
 
# File 'lib/google/apis/books_v1/classes.rb', line 3173

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) 


3090
3091
3092
 
# File 'lib/google/apis/books_v1/classes.rb', line 3090

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) 


3096
3097
3098
 
# File 'lib/google/apis/books_v1/classes.rb', line 3096

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:



3101
3102
3103
 
# File 'lib/google/apis/books_v1/classes.rb', line 3101

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) 


3107
3108
3109
 
# File 'lib/google/apis/books_v1/classes.rb', line 3107

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) 


3113
3114
3115
 
# File 'lib/google/apis/books_v1/classes.rb', line 3113

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:



3119
3120
3121
 
# File 'lib/google/apis/books_v1/classes.rb', line 3119

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) 


3126
3127
3128
 
# File 'lib/google/apis/books_v1/classes.rb', line 3126

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:



3132
3133
3134
 
# File 'lib/google/apis/books_v1/classes.rb', line 3132

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) 


3137
3138
3139
 
# File 'lib/google/apis/books_v1/classes.rb', line 3137

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) 


3143
3144
3145
 
# File 'lib/google/apis/books_v1/classes.rb', line 3143

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) 


3150
3151
3152
 
# File 'lib/google/apis/books_v1/classes.rb', line 3150

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) 


3156
3157
3158
 
# File 'lib/google/apis/books_v1/classes.rb', line 3156

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) 


3165
3166
3167
 
# File 'lib/google/apis/books_v1/classes.rb', line 3165

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) 


3171
3172
3173
 
# File 'lib/google/apis/books_v1/classes.rb', line 3171

def web_reader_link
  @web_reader_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'lib/google/apis/books_v1/classes.rb', line 3178

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