Class: Google::Apis::BooksV1::Volume::UserInfo::FamilySharing
- Inherits:
-
Object
- Object
- Google::Apis::BooksV1::Volume::UserInfo::FamilySharing
- 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
-
#family_role ⇒ String
The role of the user in the family.
-
#is_sharing_allowed ⇒ Boolean
(also: #is_sharing_allowed?)
Whether or not this volume can be shared with the family by the user.
-
#is_sharing_disabled_by_fop ⇒ Boolean
(also: #is_sharing_disabled_by_fop?)
Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FamilySharing
constructor
A new instance of FamilySharing.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ FamilySharing
Returns a new instance of FamilySharing.
3604 3605 3606 |
# File 'generated/google/apis/books_v1/classes.rb', line 3604 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
3587 3588 3589 |
# File 'generated/google/apis/books_v1/classes.rb', line 3587 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
3594 3595 3596 |
# File 'generated/google/apis/books_v1/classes.rb', line 3594 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
3601 3602 3603 |
# File 'generated/google/apis/books_v1/classes.rb', line 3601 def is_sharing_disabled_by_fop @is_sharing_disabled_by_fop end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3609 3610 3611 3612 3613 |
# File 'generated/google/apis/books_v1/classes.rb', line 3609 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 |