Skip to main content

Interface: BookmarksAddArguments

Extends

  • ChannelID.BookmarkFields.TokenOverridable

Properties

channel_id

channel_id: string;

Description

Encoded channel ID.

Inherited from

ChannelID.channel_id

Defined in

packages/web-api/src/types/request/common.ts:85


emoji?

optional emoji: string;

Description

Emoji tag to apply to the bookmark.

Inherited from

BookmarkFields.emoji

Defined in

packages/web-api/src/types/request/bookmarks.ts:12


entity_id?

optional entity_id: string;

Description

ID of the entity being bookmarked. Only applies to message and file types.

Defined in

packages/web-api/src/types/request/bookmarks.ts:20


link: string;

Description

Link to bookmark.

Inherited from

BookmarkFields.link

Defined in

packages/web-api/src/types/request/bookmarks.ts:10


parent_id?

optional parent_id: string;

Description

ID of this bookmark's parent.

Defined in

packages/web-api/src/types/request/bookmarks.ts:22


title

title: string;

Description

Title for the bookmark.

Inherited from

BookmarkFields.title

Defined in

packages/web-api/src/types/request/bookmarks.ts:8


token?

optional token: string;

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token

Defined in

packages/web-api/src/types/request/common.ts:43


type

type: "link";

Description

Type of the bookmark. Only link is supported at the moment.

Defined in

packages/web-api/src/types/request/bookmarks.ts:18