Link

import type { Link } from "https://googleapis.deno.dev/v1/docs:v1.ts";

A reference to another portion of a document or an external URL resource.

interface Link {

bookmark?: BookmarkLink;

bookmarkId?: string;

heading?: HeadingLink;

headingId?: string;

tabId?: string;

url?: string;

}

§Properties

bookmark?: BookmarkLink

[src]

A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to false or unset. Otherwise, this field is returned.

bookmarkId?: string

[src]

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.

heading?: HeadingLink

[src]

A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to false or unset. Otherwise, this field is returned.

headingId?: string

[src]

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.

tabId?: string

[src]

The ID of a tab in this document.

url?: string

[src]

An external URL.