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



3496
3497
3498
 
# File 'generated/google/apis/books_v1/classes.rb', line 3496

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

Instance Attribute Details

#acquired_time ⇒ DateTime

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) 


3391
3392
3393
 
# File 'generated/google/apis/books_v1/classes.rb', line 3391

def acquired_time
  @acquired_time
end

#acquisition_type ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3396
3397
3398
 
# File 'generated/google/apis/books_v1/classes.rb', line 3396

def acquisition_type
  @acquisition_type
end

#copy ⇒ Google::Apis::BooksV1::Volume::UserInfo::Copy

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

Returns:



3401
3402
3403
 
# File 'generated/google/apis/books_v1/classes.rb', line 3401

def copy
  @copy
end

#entitlement_type ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3406
3407
3408
 
# File 'generated/google/apis/books_v1/classes.rb', line 3406

def entitlement_type
  @entitlement_type
end

#family_sharing ⇒ Google::Apis::BooksV1::Volume::UserInfo::FamilySharing

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

Returns:



3411
3412
3413
 
# File 'generated/google/apis/books_v1/classes.rb', line 3411

def family_sharing
  @family_sharing
end

#is_family_shared_from_user ⇒ Boolean 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) 


3416
3417
3418
 
# File 'generated/google/apis/books_v1/classes.rb', line 3416

def is_family_shared_from_user
  @is_family_shared_from_user
end

#is_family_shared_to_user ⇒ Boolean 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) 


3422
3423
3424
 
# File 'generated/google/apis/books_v1/classes.rb', line 3422

def is_family_shared_to_user
  @is_family_shared_to_user
end

#is_family_sharing_allowed ⇒ Boolean Also known as: is_family_sharing_allowed?

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

Returns:

  • (Boolean) 


3428
3429
3430
 
# File 'generated/google/apis/books_v1/classes.rb', line 3428

def is_family_sharing_allowed
  @is_family_sharing_allowed
end

#is_family_sharing_disabled_by_fop ⇒ Boolean Also known as: is_family_sharing_disabled_by_fop?

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

Returns:

  • (Boolean) 


3434
3435
3436
 
# File 'generated/google/apis/books_v1/classes.rb', line 3434

def is_family_sharing_disabled_by_fop
  @is_family_sharing_disabled_by_fop
end

#is_in_my_books ⇒ Boolean 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) 


3440
3441
3442
 
# File 'generated/google/apis/books_v1/classes.rb', line 3440

def is_in_my_books
  @is_in_my_books
end

#is_preordered ⇒ Boolean 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) 


3447
3448
3449
 
# File 'generated/google/apis/books_v1/classes.rb', line 3447

def is_preordered
  @is_preordered
end

#is_purchased ⇒ Boolean 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) 


3454
3455
3456
 
# File 'generated/google/apis/books_v1/classes.rb', line 3454

def is_purchased
  @is_purchased
end

#is_uploaded ⇒ Boolean Also known as: is_uploaded?

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

Returns:

  • (Boolean) 


3460
3461
3462
 
# File 'generated/google/apis/books_v1/classes.rb', line 3460

def is_uploaded
  @is_uploaded
end

#reading_position ⇒ Google::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

Returns:



3467
3468
3469
 
# File 'generated/google/apis/books_v1/classes.rb', line 3467

def reading_position
  @reading_position
end

#rental_period ⇒ Google::Apis::BooksV1::Volume::UserInfo::RentalPeriod

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

Returns:



3472
3473
3474
 
# File 'generated/google/apis/books_v1/classes.rb', line 3472

def rental_period
  @rental_period
end

#rental_state ⇒ String

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

Returns:

  • (String) 


3477
3478
3479
 
# File 'generated/google/apis/books_v1/classes.rb', line 3477

def rental_state
  @rental_state
end

#review ⇒ Google::Apis::BooksV1::Review

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

Returns:



3482
3483
3484
 
# File 'generated/google/apis/books_v1/classes.rb', line 3482

def review
  @review
end

#updated ⇒ DateTime

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) 


3489
3490
3491
 
# File 'generated/google/apis/books_v1/classes.rb', line 3489

def updated
  @updated
end

#user_uploaded_volume_info ⇒ Google::Apis::BooksV1::Volume::UserInfo::UserUploadedVolumeInfo

Corresponds to the JSON property userUploadedVolumeInfo

Returns:



3494
3495
3496
 
# File 'generated/google/apis/books_v1/classes.rb', line 3494

def user_uploaded_volume_info
  @user_uploaded_volume_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
 
# File 'generated/google/apis/books_v1/classes.rb', line 3501

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