Class: Google::Apis::DocsV1::SectionBreak

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 StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SectionBreak

Returns a new instance of SectionBreak.



4183
4184
4185
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4183

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

Instance Attribute Details

#section_style ⇒ Google::Apis::DocsV1::SectionStyle

The styling that applies to a section. Corresponds to the JSON property sectionStyle

Returns:



4168
4169
4170
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4168

def section_style
  @section_style
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>) 


4174
4175
4176
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4174

def suggested_deletion_ids
  @suggested_deletion_ids
end

#suggested_insertion_ids ⇒ Array<String>

The suggested insertion IDs. A SectionBreak 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>) 


4181
4182
4183
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4181

def suggested_insertion_ids
  @suggested_insertion_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4188
4189
4190
4191
4192
 
# File 'generated/google/apis/docs_v1/classes.rb', line 4188

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