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

Constructor Details

#initialize(**args) ⇒ UserInfo

Returns a new instance of UserInfo.



3702
3703
3704
 
# File 'generated/google/apis/books_v1/classes.rb', line 3702

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

Instance Attribute Details

#acquired_time ⇒ String

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:

  • (String) 


3597
3598
3599
 
# File 'generated/google/apis/books_v1/classes.rb', line 3597

def acquired_time
  @acquired_time
end

#acquisition_type ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3602
3603
3604
 
# File 'generated/google/apis/books_v1/classes.rb', line 3602

def acquisition_type
  @acquisition_type
end

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

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

Returns:



3607
3608
3609
 
# File 'generated/google/apis/books_v1/classes.rb', line 3607

def copy
  @copy
end

#entitlement_type ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3612
3613
3614
 
# File 'generated/google/apis/books_v1/classes.rb', line 3612

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:



3617
3618
3619
 
# File 'generated/google/apis/books_v1/classes.rb', line 3617

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) 


3622
3623
3624
 
# File 'generated/google/apis/books_v1/classes.rb', line 3622

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) 


3628
3629
3630
 
# File 'generated/google/apis/books_v1/classes.rb', line 3628

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) 


3634
3635
3636
 
# File 'generated/google/apis/books_v1/classes.rb', line 3634

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) 


3640
3641
3642
 
# File 'generated/google/apis/books_v1/classes.rb', line 3640

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) 


3646
3647
3648
 
# File 'generated/google/apis/books_v1/classes.rb', line 3646

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) 


3653
3654
3655
 
# File 'generated/google/apis/books_v1/classes.rb', line 3653

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) 


3660
3661
3662
 
# File 'generated/google/apis/books_v1/classes.rb', line 3660

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) 


3666
3667
3668
 
# File 'generated/google/apis/books_v1/classes.rb', line 3666

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:



3673
3674
3675
 
# File 'generated/google/apis/books_v1/classes.rb', line 3673

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:



3678
3679
3680
 
# File 'generated/google/apis/books_v1/classes.rb', line 3678

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) 


3683
3684
3685
 
# File 'generated/google/apis/books_v1/classes.rb', line 3683

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:



3688
3689
3690
 
# File 'generated/google/apis/books_v1/classes.rb', line 3688

def review
  @review
end

#updated ⇒ String

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:

  • (String) 


3695
3696
3697
 
# File 'generated/google/apis/books_v1/classes.rb', line 3695

def updated
  @updated
end

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

Corresponds to the JSON property userUploadedVolumeInfo

Returns:



3700
3701
3702
 
# File 'generated/google/apis/books_v1/classes.rb', line 3700

def user_uploaded_volume_info
  @user_uploaded_volume_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
 
# File 'generated/google/apis/books_v1/classes.rb', line 3707

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