Skip to main content

Interface: BookmarksAddArguments

Defined in: packages/web-api/src/types/request/bookmarks.ts:16

Extends​

  • ChannelID.BookmarkFields.TokenOverridable

Properties​

channel_id​

channel_id: string;

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

Description​

Encoded channel ID.

Inherited from​

ChannelID.channel_id

emoji?​

optional emoji: string;

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

Description​

Emoji tag to apply to the bookmark.

Inherited from​

BookmarkFields.emoji

entity_id?​

optional entity_id: string;

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

Description​

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

link: string;

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

Description​

Link to bookmark.

Inherited from​

BookmarkFields.link

parent_id?​

optional parent_id: string;

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

Description​

ID of this bookmark's parent.

title​

title: string;

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

Description​

Title for the bookmark.

Inherited from​

BookmarkFields.title

token?​

optional token: string;

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

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

type​

type: "link";

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

Description​

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