Class: Google::Apis::DocsV1::List

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 List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that is part of a list has a reference to the list's ID in its bullet.

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

Returns a new instance of List.



2523
2524
2525
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2523

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

Instance Attribute Details

#list_properties ⇒ Google::Apis::DocsV1::ListProperties

The properties of a list which describe the look and feel of bullets belonging to paragraphs associated with a list. Corresponds to the JSON property listProperties

Returns:



2503
2504
2505
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2503

def list_properties
  @list_properties
end

#suggested_deletion_ids ⇒ Array<String>

The suggested deletion IDs. If empty, then there are no suggested deletions of this list. Corresponds to the JSON property suggestedDeletionIds

Returns:

  • (Array<String>) 


2509
2510
2511
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2509

def suggested_deletion_ids
  @suggested_deletion_ids
end

#suggested_insertion_id ⇒ String

The suggested insertion ID. If empty, then this is not a suggested insertion. Corresponds to the JSON property suggestedInsertionId

Returns:

  • (String) 


2515
2516
2517
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2515

def suggested_insertion_id
  @suggested_insertion_id
end

#suggested_list_properties_changes ⇒ Hash<String,Google::Apis::DocsV1::SuggestedListProperties>

The suggested changes to the list properties, keyed by suggestion ID. Corresponds to the JSON property suggestedListPropertiesChanges

Returns:



2521
2522
2523
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2521

def suggested_list_properties_changes
  @suggested_list_properties_changes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2528
2529
2530
2531
2532
2533
 
# File 'generated/google/apis/docs_v1/classes.rb', line 2528

def update!(**args)
  @list_properties = args[:list_properties] if args.key?(:list_properties)
  @suggested_deletion_ids = args[:suggested_deletion_ids] if args.key?(:suggested_deletion_ids)
  @suggested_insertion_id = args[:suggested_insertion_id] if args.key?(:suggested_insertion_id)
  @suggested_list_properties_changes = args[:suggested_list_properties_changes] if args.key?(:suggested_list_properties_changes)
end