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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Document

Returns a new instance of Document.



1068
1069
1070
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1068

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:



936
937
938
 
# File 'lib/google/apis/docs_v1/classes.rb', line 936

def body
  @body
end

#document_id ⇒ String

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

Returns:

  • (String) 


941
942
943
 
# File 'lib/google/apis/docs_v1/classes.rb', line 941

def document_id
  @document_id
end

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

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

Returns:



946
947
948
 
# File 'lib/google/apis/docs_v1/classes.rb', line 946

def document_style
  @document_style
end

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

Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property footers

Returns:



955
956
957
 
# File 'lib/google/apis/docs_v1/classes.rb', line 955

def footers
  @footers
end

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

Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property footnotes

Returns:



964
965
966
 
# File 'lib/google/apis/docs_v1/classes.rb', line 964

def footnotes
  @footnotes
end

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

Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property headers

Returns:



973
974
975
 
# File 'lib/google/apis/docs_v1/classes.rb', line 973

def headers
  @headers
end

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

Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property inlineObjects

Returns:



982
983
984
 
# File 'lib/google/apis/docs_v1/classes.rb', line 982

def inline_objects
  @inline_objects
end

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

Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property lists

Returns:



991
992
993
 
# File 'lib/google/apis/docs_v1/classes.rb', line 991

def lists
  @lists
end

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

Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property namedRanges

Returns:



1000
1001
1002
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1000

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:



1006
1007
1008
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1006

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. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property positionedObjects

Returns:



1015
1016
1017
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1015

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 revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. 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) 


1030
1031
1032
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1030

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. Legacy field: Instead, use Document.tabs.documentTab. suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property suggestedDocumentStyleChanges

Returns:



1039
1040
1041
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1039

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. Legacy field: Instead, use Document.tabs.documentTab. suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to true. If false or unset, this field contains information about the first tab in the document. Corresponds to the JSON property suggestedNamedStylesChanges

Returns:



1048
1049
1050
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1048

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) 


1055
1056
1057
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1055

def suggestions_view_mode
  @suggestions_view_mode
end

#tabs ⇒ Array<Google::Apis::DocsV1::Tab>

Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. Corresponds to the JSON property tabs

Returns:



1061
1062
1063
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1061

def tabs
  @tabs
end

#title ⇒ String

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

Returns:

  • (String) 


1066
1067
1068
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1066

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1073

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)
  @tabs = args[:tabs] if args.key?(:tabs)
  @title = args[:title] if args.key?(:title)
end