Class: Google::Apis::DocsV1::Link

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 reference to another portion of a document or an external URL resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Link

Returns a new instance of Link.



2642
2643
2644
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2642

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

Instance Attribute Details

#bookmark ⇒ Google::Apis::DocsV1::BookmarkLink

A reference to a bookmark in this document. Corresponds to the JSON property bookmark

Returns:



2601
2602
2603
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2601

def bookmark
  @bookmark
end

#bookmark_id ⇒ String

The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to true and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to false in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. Corresponds to the JSON property bookmarkId

Returns:

  • (String) 


2613
2614
2615
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2613

def bookmark_id
  @bookmark_id
end

#heading ⇒ Google::Apis::DocsV1::HeadingLink

A reference to a heading in this document. Corresponds to the JSON property heading

Returns:



2618
2619
2620
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2618

def heading
  @heading
end

#heading_id ⇒ String

The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to true and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to false in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. Corresponds to the JSON property headingId

Returns:

  • (String) 


2630
2631
2632
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2630

def heading_id
  @heading_id
end

#tab_id ⇒ String

The ID of a tab in this document. Corresponds to the JSON property tabId

Returns:

  • (String) 


2635
2636
2637
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2635

def tab_id
  @tab_id
end

#url ⇒ String

An external URL. Corresponds to the JSON property url

Returns:

  • (String) 


2640
2641
2642
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2640

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2647
2648
2649
2650
2651
2652
2653
2654
 
# File 'lib/google/apis/docs_v1/classes.rb', line 2647

def update!(**args)
  @bookmark = args[:bookmark] if args.key?(:bookmark)
  @bookmark_id = args[:bookmark_id] if args.key?(:bookmark_id)
  @heading = args[:heading] if args.key?(:heading)
  @heading_id = args[:heading_id] if args.key?(:heading_id)
  @tab_id = args[:tab_id] if args.key?(:tab_id)
  @url = args[:url] if args.key?(:url)
end