Class: Google::Apis::BooksV1::Volume::UserInfo

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

User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)

Defined Under Namespace

Classes: Copy, FamilySharing, RentalPeriod, UserUploadedVolumeInfo

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) ⇒ UserInfo

Returns a new instance of UserInfo.


3333
3334
3335
# File 'generated/google/apis/books_v1/classes.rb', line 3333

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

Instance Attribute Details

#acquired_timeDateTime

Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. Corresponds to the JSON property acquiredTime

Returns:

  • (DateTime)

3228
3229
3230
# File 'generated/google/apis/books_v1/classes.rb', line 3228

def acquired_time
  @acquired_time
end

#acquisition_typeFixnum

How this volume was acquired. Corresponds to the JSON property acquisitionType

Returns:

  • (Fixnum)

3233
3234
3235
# File 'generated/google/apis/books_v1/classes.rb', line 3233

def acquisition_type
  @acquisition_type
end

#copyGoogle::Apis::BooksV1::Volume::UserInfo::Copy

Copy/Paste accounting information. Corresponds to the JSON property copy


3238
3239
3240
# File 'generated/google/apis/books_v1/classes.rb', line 3238

def copy
  @copy
end

#entitlement_typeFixnum

Whether this volume is purchased, sample, pd download etc. Corresponds to the JSON property entitlementType

Returns:

  • (Fixnum)

3243
3244
3245
# File 'generated/google/apis/books_v1/classes.rb', line 3243

def entitlement_type
  @entitlement_type
end

#family_sharingGoogle::Apis::BooksV1::Volume::UserInfo::FamilySharing

Information on the ability to share with the family. Corresponds to the JSON property familySharing


3248
3249
3250
# File 'generated/google/apis/books_v1/classes.rb', line 3248

def family_sharing
  @family_sharing
end

#is_family_shared_from_userBoolean Also known as: is_family_shared_from_user?

Whether or not the user shared this volume with the family. Corresponds to the JSON property isFamilySharedFromUser

Returns:

  • (Boolean)

3253
3254
3255
# File 'generated/google/apis/books_v1/classes.rb', line 3253

def is_family_shared_from_user
  @is_family_shared_from_user
end

#is_family_shared_to_userBoolean Also known as: is_family_shared_to_user?

Whether or not the user received this volume through family sharing. Corresponds to the JSON property isFamilySharedToUser

Returns:

  • (Boolean)

3259
3260
3261
# File 'generated/google/apis/books_v1/classes.rb', line 3259

def is_family_shared_to_user
  @is_family_shared_to_user
end

#is_family_sharing_allowedBoolean Also known as: is_family_sharing_allowed?

Deprecated: Replaced by familySharing. Corresponds to the JSON property isFamilySharingAllowed

Returns:

  • (Boolean)

3265
3266
3267
# File 'generated/google/apis/books_v1/classes.rb', line 3265

def is_family_sharing_allowed
  @is_family_sharing_allowed
end

#is_family_sharing_disabled_by_fopBoolean Also known as: is_family_sharing_disabled_by_fop?

Deprecated: Replaced by familySharing. Corresponds to the JSON property isFamilySharingDisabledByFop

Returns:

  • (Boolean)

3271
3272
3273
# File 'generated/google/apis/books_v1/classes.rb', line 3271

def is_family_sharing_disabled_by_fop
  @is_family_sharing_disabled_by_fop
end

#is_in_my_booksBoolean Also known as: is_in_my_books?

Whether or not this volume is currently in "my books." Corresponds to the JSON property isInMyBooks

Returns:

  • (Boolean)

3277
3278
3279
# File 'generated/google/apis/books_v1/classes.rb', line 3277

def is_in_my_books
  @is_in_my_books
end

#is_preorderedBoolean Also known as: is_preordered?

Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) Corresponds to the JSON property isPreordered

Returns:

  • (Boolean)

3284
3285
3286
# File 'generated/google/apis/books_v1/classes.rb', line 3284

def is_preordered
  @is_preordered
end

#is_purchasedBoolean Also known as: is_purchased?

Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) Corresponds to the JSON property isPurchased

Returns:

  • (Boolean)

3291
3292
3293
# File 'generated/google/apis/books_v1/classes.rb', line 3291

def is_purchased
  @is_purchased
end

#is_uploadedBoolean Also known as: is_uploaded?

Whether or not this volume was user uploaded. Corresponds to the JSON property isUploaded

Returns:

  • (Boolean)

3297
3298
3299
# File 'generated/google/apis/books_v1/classes.rb', line 3297

def is_uploaded
  @is_uploaded
end

#reading_positionGoogle::Apis::BooksV1::ReadingPosition

The user's current reading position in the volume, if one is available. (In LITE projection.) Corresponds to the JSON property readingPosition


3304
3305
3306
# File 'generated/google/apis/books_v1/classes.rb', line 3304

def reading_position
  @reading_position
end

#rental_periodGoogle::Apis::BooksV1::Volume::UserInfo::RentalPeriod

Period during this book is/was a valid rental. Corresponds to the JSON property rentalPeriod


3309
3310
3311
# File 'generated/google/apis/books_v1/classes.rb', line 3309

def rental_period
  @rental_period
end

#rental_stateString

Whether this book is an active or an expired rental. Corresponds to the JSON property rentalState

Returns:

  • (String)

3314
3315
3316
# File 'generated/google/apis/books_v1/classes.rb', line 3314

def rental_state
  @rental_state
end

#reviewGoogle::Apis::BooksV1::Review

This user's review of this volume, if one exists. Corresponds to the JSON property review


3319
3320
3321
# File 'generated/google/apis/books_v1/classes.rb', line 3319

def review
  @review
end

#updatedDateTime

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

Returns:

  • (DateTime)

3326
3327
3328
# File 'generated/google/apis/books_v1/classes.rb', line 3326

def updated
  @updated
end

#user_uploaded_volume_infoGoogle::Apis::BooksV1::Volume::UserInfo::UserUploadedVolumeInfo

Corresponds to the JSON property userUploadedVolumeInfo


3331
3332
3333
# File 'generated/google/apis/books_v1/classes.rb', line 3331

def user_uploaded_volume_info
  @user_uploaded_volume_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
# File 'generated/google/apis/books_v1/classes.rb', line 3338

def update!(**args)
  @acquired_time = args[:acquired_time] if args.key?(:acquired_time)
  @acquisition_type = args[:acquisition_type] if args.key?(:acquisition_type)
  @copy = args[:copy] if args.key?(:copy)
  @entitlement_type = args[:entitlement_type] if args.key?(:entitlement_type)
  @family_sharing = args[:family_sharing] if args.key?(:family_sharing)
  @is_family_shared_from_user = args[:is_family_shared_from_user] if args.key?(:is_family_shared_from_user)
  @is_family_shared_to_user = args[:is_family_shared_to_user] if args.key?(:is_family_shared_to_user)
  @is_family_sharing_allowed = args[:is_family_sharing_allowed] if args.key?(:is_family_sharing_allowed)
  @is_family_sharing_disabled_by_fop = args[:is_family_sharing_disabled_by_fop] if args.key?(:is_family_sharing_disabled_by_fop)
  @is_in_my_books = args[:is_in_my_books] if args.key?(:is_in_my_books)
  @is_preordered = args[:is_preordered] if args.key?(:is_preordered)
  @is_purchased = args[:is_purchased] if args.key?(:is_purchased)
  @is_uploaded = args[:is_uploaded] if args.key?(:is_uploaded)
  @reading_position = args[:reading_position] if args.key?(:reading_position)
  @rental_period = args[:rental_period] if args.key?(:rental_period)
  @rental_state = args[:rental_state] if args.key?(:rental_state)
  @review = args[:review] if args.key?(:review)
  @updated = args[:updated] if args.key?(:updated)
  @user_uploaded_volume_info = args[:user_uploaded_volume_info] if args.key?(:user_uploaded_volume_info)
end