Class: Google::Apis::DocsV1::Document

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 Google Docs document.

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

Returns a new instance of Document



807
808
809
 
# File 'generated/google/apis/docs_v1/classes.rb', line 807

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

Instance Attribute Details

#body ⇒ Google::Apis::DocsV1::Body

The document body. The body typically contains the full document contents except for headers, footers and footnotes. Corresponds to the JSON property body

Returns:



714
715
716
 
# File 'generated/google/apis/docs_v1/classes.rb', line 714

def body
  @body
end

#document_id ⇒ String

Output only. The ID of the document. Corresponds to the JSON property documentId

Returns:

  • (String) 


719
720
721
 
# File 'generated/google/apis/docs_v1/classes.rb', line 719

def document_id
  @document_id
end

#document_style ⇒ Google::Apis::DocsV1::DocumentStyle

The style of the document. Corresponds to the JSON property documentStyle

Returns:



724
725
726
 
# File 'generated/google/apis/docs_v1/classes.rb', line 724

def document_style
  @document_style
end

#footers ⇒ Hash<String,Google::Apis::DocsV1::Footer>

Output only. The footers in the document, keyed by footer ID. Corresponds to the JSON property footers

Returns:



729
730
731
 
# File 'generated/google/apis/docs_v1/classes.rb', line 729

def footers
  @footers
end

#footnotes ⇒ Hash<String,Google::Apis::DocsV1::Footnote>

Output only. The footnotes in the document, keyed by footnote ID. Corresponds to the JSON property footnotes

Returns:



734
735
736
 
# File 'generated/google/apis/docs_v1/classes.rb', line 734

def footnotes
  @footnotes
end

#headers ⇒ Hash<String,Google::Apis::DocsV1::Header>

Output only. The headers in the document, keyed by header ID. Corresponds to the JSON property headers

Returns:



739
740
741
 
# File 'generated/google/apis/docs_v1/classes.rb', line 739

def headers
  @headers
end

#inline_objects ⇒ Hash<String,Google::Apis::DocsV1::InlineObject>

Output only. The inline objects in the document, keyed by object ID. Corresponds to the JSON property inlineObjects

Returns:



744
745
746
 
# File 'generated/google/apis/docs_v1/classes.rb', line 744

def inline_objects
  @inline_objects
end

#lists ⇒ Hash<String,Google::Apis::DocsV1::List>

Output only. The lists in the document, keyed by list ID. Corresponds to the JSON property lists

Returns:



749
750
751
 
# File 'generated/google/apis/docs_v1/classes.rb', line 749

def lists
  @lists
end

#named_ranges ⇒ Hash<String,Google::Apis::DocsV1::NamedRanges>

Output only. The named ranges in the document, keyed by name. Corresponds to the JSON property namedRanges

Returns:



754
755
756
 
# File 'generated/google/apis/docs_v1/classes.rb', line 754

def named_ranges
  @named_ranges
end

#named_styles ⇒ Google::Apis::DocsV1::NamedStyles

The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. Corresponds to the JSON property namedStyles

Returns:



761
762
763
 
# File 'generated/google/apis/docs_v1/classes.rb', line 761

def named_styles
  @named_styles
end

#positioned_objects ⇒ Hash<String,Google::Apis::DocsV1::PositionedObject>

Output only. The positioned objects in the document, keyed by object ID. Corresponds to the JSON property positionedObjects

Returns:



766
767
768
 
# File 'generated/google/apis/docs_v1/classes.rb', line 766

def positioned_objects
  @positioned_objects
end

#revision_id ⇒ String

Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Corresponds to the JSON property revisionId

Returns:

  • (String) 


781
782
783
 
# File 'generated/google/apis/docs_v1/classes.rb', line 781

def revision_id
  @revision_id
end

#suggested_document_style_changes ⇒ Hash<String,Google::Apis::DocsV1::SuggestedDocumentStyle>

Output only. The suggested changes to the style of the document, keyed by suggestion ID. Corresponds to the JSON property suggestedDocumentStyleChanges

Returns:



787
788
789
 
# File 'generated/google/apis/docs_v1/classes.rb', line 787

def suggested_document_style_changes
  @suggested_document_style_changes
end

#suggested_named_styles_changes ⇒ Hash<String,Google::Apis::DocsV1::SuggestedNamedStyles>

Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Corresponds to the JSON property suggestedNamedStylesChanges

Returns:



793
794
795
 
# File 'generated/google/apis/docs_v1/classes.rb', line 793

def suggested_named_styles_changes
  @suggested_named_styles_changes
end

#suggestions_view_mode ⇒ String

Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. Corresponds to the JSON property suggestionsViewMode

Returns:

  • (String) 


800
801
802
 
# File 'generated/google/apis/docs_v1/classes.rb', line 800

def suggestions_view_mode
  @suggestions_view_mode
end

#title ⇒ String

The title of the document. Corresponds to the JSON property title

Returns:

  • (String) 


805
806
807
 
# File 'generated/google/apis/docs_v1/classes.rb', line 805

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'generated/google/apis/docs_v1/classes.rb', line 812

def update!(**args)
  @body = args[:body] if args.key?(:body)
  @document_id = args[:document_id] if args.key?(:document_id)
  @document_style = args[:document_style] if args.key?(:document_style)
  @footers = args[:footers] if args.key?(:footers)
  @footnotes = args[:footnotes] if args.key?(:footnotes)
  @headers = args[:headers] if args.key?(:headers)
  @inline_objects = args[:inline_objects] if args.key?(:inline_objects)
  @lists = args[:lists] if args.key?(:lists)
  @named_ranges = args[:named_ranges] if args.key?(:named_ranges)
  @named_styles = args[:named_styles] if args.key?(:named_styles)
  @positioned_objects = args[:positioned_objects] if args.key?(:positioned_objects)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @suggested_document_style_changes = args[:suggested_document_style_changes] if args.key?(:suggested_document_style_changes)
  @suggested_named_styles_changes = args[:suggested_named_styles_changes] if args.key?(:suggested_named_styles_changes)
  @suggestions_view_mode = args[:suggestions_view_mode] if args.key?(:suggestions_view_mode)
  @title = args[:title] if args.key?(:title)
end