Class: Google::Apis::DocsV1::PositionedObject

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

An object that is tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PositionedObject

Returns a new instance of PositionedObject.



3546
3547
3548
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3546

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

Instance Attribute Details

#object_id_prop ⇒ String

The ID of this positioned object. Corresponds to the JSON property objectId

Returns:

  • (String) 


3522
3523
3524
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3522

def object_id_prop
  @object_id_prop
end

#positioned_object_properties ⇒ Google::Apis::DocsV1::PositionedObjectProperties

Properties of a PositionedObject. Corresponds to the JSON property positionedObjectProperties

Returns:



3527
3528
3529
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3527

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


3533
3534
3535
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3533

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) 


3538
3539
3540
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3538

def suggested_insertion_id
  @suggested_insertion_id
end

#suggested_positioned_object_properties_changes ⇒ Hash<String,Google::Apis::DocsV1::SuggestedPositionedObjectProperties>

The suggested changes to the positioned object properties, keyed by suggestion ID. Corresponds to the JSON property suggestedPositionedObjectPropertiesChanges

Returns:



3544
3545
3546
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3544

def suggested_positioned_object_properties_changes
  @suggested_positioned_object_properties_changes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3551
3552
3553
3554
3555
3556
3557
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3551

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