Skip to content

VideoBlock.md

Latest commit

 

History

History
188 lines (110 loc) · 3.55 KB

VideoBlock.md

File metadata and controls

188 lines (110 loc) · 3.55 KB

@slack/web-api / VideoBlock

Interface: VideoBlock

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:241

Description

Displays an embedded video player. A video block is designed to embed videos in all app surfaces (e.g. link unfurls, messages, modals, App Home) — anywhere you can put blocks! To use the video block within your app, you must have the `links.embed:write` scope.

See

Video block reference.

Extends

Properties

alt_text

alt_text: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:259

Description

A tooltip for the video. Required for accessibility.

author_name?

optional author_name: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:272

Description

Author name to be displayed. Must be less than 50 characters.

block_id?

optional block_id: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:15

Description

A string acting as a unique identifier for a block. If not specified, a block_id will be generated. You can use this block_id when you receive an interaction payload to identify the source of the action. Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.

Inherited from

Block.block_id

description?

optional description: PlainTextElement;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:284

Description

Description for video using a PlainTextElement object.

provider_icon_url?

optional provider_icon_url: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:280

Description

Icon for the video provider, e.g. YouTube icon.

provider_name?

optional provider_name: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:276

Description

The originating application or domain of the video, e.g. YouTube.

thumbnail_url

thumbnail_url: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:255

Description

The thumbnail image URL.

title

title: PlainTextElement;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:263

Description

Video title as a PlainTextElement object. text within must be less than 200 characters.

title_url?

optional title_url: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:268

Description

Hyperlink for the title text. Must correspond to the non-embeddable URL for the video. Must go to an HTTPS URL.

type

type: "video";

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:245

Description

The type of block. For a video block, type is always video.

Overrides

Block.type

video_url

video_url: string;

Defined in: node_modules/@slack/types/dist/block-kit/blocks.d.ts:251

Description

The URL to be embedded. Must match any existing unfurl domains within the app and point to a HTTPS URL.