Class: Google::Apis::DocsV1::FootnoteReference

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

Overview

A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote.

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

Returns a new instance of FootnoteReference.



1755
1756
1757
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1755

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

Instance Attribute Details

#footnote_id ⇒ String

The ID of the footnote that contains the content of this footnote reference. Corresponds to the JSON property footnoteId

Returns:

  • (String) 


1710
1711
1712
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1710

def footnote_id
  @footnote_id
end

#footnote_number ⇒ String

The rendered number of this footnote. Corresponds to the JSON property footnoteNumber

Returns:

  • (String) 


1715
1716
1717
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1715

def footnote_number
  @footnote_number
end

#suggested_deletion_ids ⇒ Array<String>

The suggested deletion IDs. If empty, then there are no suggested deletions of this content. Corresponds to the JSON property suggestedDeletionIds

Returns:

  • (Array<String>) 


1721
1722
1723
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1721

def suggested_deletion_ids
  @suggested_deletion_ids
end

#suggested_insertion_ids ⇒ Array<String>

The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. Corresponds to the JSON property suggestedInsertionIds

Returns:

  • (Array<String>) 


1729
1730
1731
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1729

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 FootnoteReference, keyed by suggestion ID. Corresponds to the JSON property suggestedTextStyleChanges

Returns:



1735
1736
1737
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1735

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:



1753
1754
1755
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1753

def text_style
  @text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1760
1761
1762
1763
1764
1765
1766
1767
 
# File 'generated/google/apis/docs_v1/classes.rb', line 1760

def update!(**args)
  @footnote_id = args[:footnote_id] if args.key?(:footnote_id)
  @footnote_number = args[:footnote_number] if args.key?(:footnote_number)
  @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