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.



4328
4329
4330
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4328

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

Instance Attribute Details

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

Returns:

  • (String) 


4287
4288
4289
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4287

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:



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

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


4299
4300
4301
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4299

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


4307
4308
4309
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4307

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:



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

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:



4326
4327
4328
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4326

def text_style
  @text_style
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4333
4334
4335
4336
4337
4338
4339
4340
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4333

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