Class: Google::Apis::DocsV1::AutoText

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 more...

Overview

A ParagraphElement representing a spot in the text that is dynamically replaced with content that can change over time, like a page number.

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

Returns a new instance of AutoText

[View source]

72
73
74
 
# File 'generated/google/apis/docs_v1/classes.rb', line 72

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

Instance Attribute Details

#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>) 

35
36
37
 
# File 'generated/google/apis/docs_v1/classes.rb', line 35

def suggested_deletion_ids
  @suggested_deletion_ids
end

#suggested_insertion_ids ⇒ Array<String>

The suggested insertion IDs. An AutoText 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>) 

42
43
44
 
# File 'generated/google/apis/docs_v1/classes.rb', line 42

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

Returns:


47
48
49
 
# File 'generated/google/apis/docs_v1/classes.rb', line 47

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:


65
66
67
 
# File 'generated/google/apis/docs_v1/classes.rb', line 65

def text_style
  @text_style
end

#type ⇒ String

The type of this auto text. Corresponds to the JSON property type

Returns:

  • (String) 

70
71
72
 
# File 'generated/google/apis/docs_v1/classes.rb', line 70

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

77
78
79
80
81
82
83
 
# File 'generated/google/apis/docs_v1/classes.rb', line 77

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