Class: Google::Apis::DocsV1::RichLink

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 link to a Google resource (e.g., a file in Drive, a YouTube video, a Calendar event, etc.).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RichLink

Returns a new instance of RichLink.



4313
4314
4315
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4313

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

Instance Attribute Details

Output only. The ID of this link. Corresponds to the JSON property richLinkId

Returns:

  • (String) 


4272
4273
4274
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4272

def rich_link_id
  @rich_link_id
end

#rich_link_properties ⇒ Google::Apis::DocsV1::RichLinkProperties

Properties specific to a RichLink. Corresponds to the JSON property richLinkProperties

Returns:



4277
4278
4279
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4277

def rich_link_properties
  @rich_link_properties
end

#suggested_deletion_ids ⇒ Array<String>

IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest to delete it. If empty, then this person link isn't suggested for deletion. Corresponds to the JSON property suggestedDeletionIds

Returns:

  • (Array<String>) 


4284
4285
4286
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4284

def suggested_deletion_ids
  @suggested_deletion_ids
end

#suggested_insertion_ids ⇒ Array<String>

IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it is a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. Corresponds to the JSON property suggestedInsertionIds

Returns:

  • (Array<String>) 


4292
4293
4294
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4292

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

Returns:



4297
4298
4299
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4297

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:



4311
4312
4313
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4311

def text_style
  @text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4318
4319
4320
4321
4322
4323
4324
4325
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4318

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