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

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

Information on the ability to share with the family.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FamilySharing

Returns a new instance of FamilySharing.



3789
3790
3791
 
# File 'lib/google/apis/books_v1/classes.rb', line 3789

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

Instance Attribute Details

#family_role ⇒ String

The role of the user in the family. Corresponds to the JSON property familyRole

Returns:

  • (String) 


3772
3773
3774
 
# File 'lib/google/apis/books_v1/classes.rb', line 3772

def family_role
  @family_role
end

#is_sharing_allowed ⇒ Boolean Also known as: is_sharing_allowed?

Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. Corresponds to the JSON property isSharingAllowed

Returns:

  • (Boolean) 


3779
3780
3781
 
# File 'lib/google/apis/books_v1/classes.rb', line 3779

def is_sharing_allowed
  @is_sharing_allowed
end

#is_sharing_disabled_by_fop ⇒ Boolean Also known as: is_sharing_disabled_by_fop?

Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet. Corresponds to the JSON property isSharingDisabledByFop

Returns:

  • (Boolean) 


3786
3787
3788
 
# File 'lib/google/apis/books_v1/classes.rb', line 3786

def is_sharing_disabled_by_fop
  @is_sharing_disabled_by_fop
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3794
3795
3796
3797
3798
 
# File 'lib/google/apis/books_v1/classes.rb', line 3794

def update!(**args)
  @family_role = args[:family_role] if args.key?(:family_role)
  @is_sharing_allowed = args[:is_sharing_allowed] if args.key?(:is_sharing_allowed)
  @is_sharing_disabled_by_fop = args[:is_sharing_disabled_by_fop] if args.key?(:is_sharing_disabled_by_fop)
end