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

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

Information on the ability to share with the family.

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

Returns a new instance of FamilySharing.



3420
3421
3422
 
# File 'generated/google/apis/books_v1/classes.rb', line 3420

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) 


3403
3404
3405
 
# File 'generated/google/apis/books_v1/classes.rb', line 3403

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) 


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

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) 


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

def is_sharing_disabled_by_fop
  @is_sharing_disabled_by_fop
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3425
3426
3427
3428
3429
 
# File 'generated/google/apis/books_v1/classes.rb', line 3425

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