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



3578
3579
3580
 
# File 'generated/google/apis/books_v1/classes.rb', line 3578

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) 


3561
3562
3563
 
# File 'generated/google/apis/books_v1/classes.rb', line 3561

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) 


3568
3569
3570
 
# File 'generated/google/apis/books_v1/classes.rb', line 3568

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) 


3575
3576
3577
 
# File 'generated/google/apis/books_v1/classes.rb', line 3575

def is_sharing_disabled_by_fop
  @is_sharing_disabled_by_fop
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3583
3584
3585
3586
3587
 
# File 'generated/google/apis/books_v1/classes.rb', line 3583

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