Class: Google::Apis::DocsV1::Footnote

Inherits:

Object

• Object
• Google::Apis::DocsV1::Footnote

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 document footnote.

Instance Attribute Summary

• #content ⇒ Array<Google::Apis::DocsV1::StructuralElement>

  The contents of the footnote.

• #footnote_id ⇒ String

  The ID of the footnote.

Instance Method Summary

• #initialize(**args) ⇒ Footnote constructor

  A new instance of Footnote.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Footnote

Returns a new instance of Footnote.

# File 'lib/google/apis/docs_v1/classes.rb', line 1838

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

Instance Attribute Details

#content ⇒ Array<Google::Apis::DocsV1::StructuralElement>

The contents of the footnote. The indexes for a footnote's content begin at zero. Corresponds to the JSON property content

Returns:

• (Array<Google::Apis::DocsV1::StructuralElement>)

# File 'lib/google/apis/docs_v1/classes.rb', line 1831

def content
  @content
end

#footnote_id ⇒ String

The ID of the footnote. Corresponds to the JSON property footnoteId

Returns:

• (String)

# File 'lib/google/apis/docs_v1/classes.rb', line 1836

def footnote_id
  @footnote_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/docs_v1/classes.rb', line 1843

def update!(**args)
  @content = args[:content] if args.key?(:content)
  @footnote_id = args[:footnote_id] if args.key?(:footnote_id)
end