Class: Google::Apis::DocsV1::Person

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/docs_v1/classes.rb,
lib/google/apis/docs_v1/representations.rb,
lib/google/apis/docs_v1/representations.rb

Overview

A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Person

Returns a new instance of Person.



3569
3570
3571
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3569

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

Instance Attribute Details

#person_id ⇒ String

Output only. The unique ID of this link. Corresponds to the JSON property personId

Returns:

  • (String) 


3528
3529
3530
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3528

def person_id
  @person_id
end

#person_properties ⇒ Google::Apis::DocsV1::PersonProperties

Properties specific to a linked Person. Corresponds to the JSON property personProperties

Returns:



3533
3534
3535
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3533

def person_properties
  @person_properties
end

#suggested_deletion_ids ⇒ Array<String>

IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest to delete it. If empty, then this person link isn't suggested for deletion. Corresponds to the JSON property suggestedDeletionIds

Returns:

  • (Array<String>) 


3540
3541
3542
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3540

def suggested_deletion_ids
  @suggested_deletion_ids
end

#suggested_insertion_ids ⇒ Array<String>

IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it is a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. Corresponds to the JSON property suggestedInsertionIds

Returns:

  • (Array<String>) 


3548
3549
3550
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3548

def suggested_insertion_ids
  @suggested_insertion_ids
end

#suggested_text_style_changes ⇒ Hash<String,Google::Apis::DocsV1::SuggestedTextStyle>

The suggested text style changes to this Person, keyed by suggestion ID. Corresponds to the JSON property suggestedTextStyleChanges

Returns:



3553
3554
3555
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3553

def suggested_text_style_changes
  @suggested_text_style_changes
end

#text_style ⇒ Google::Apis::DocsV1::TextStyle

Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that is contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. Corresponds to the JSON property textStyle

Returns:



3567
3568
3569
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3567

def text_style
  @text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3574
3575
3576
3577
3578
3579
3580
3581
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3574

def update!(**args)
  @person_id = args[:person_id] if args.key?(:person_id)
  @person_properties = args[:person_properties] if args.key?(:person_properties)
  @suggested_deletion_ids = args[:suggested_deletion_ids] if args.key?(:suggested_deletion_ids)
  @suggested_insertion_ids = args[:suggested_insertion_ids] if args.key?(:suggested_insertion_ids)
  @suggested_text_style_changes = args[:suggested_text_style_changes] if args.key?(:suggested_text_style_changes)
  @text_style = args[:text_style] if args.key?(:text_style)
end