Skip to main content

@slack/web-api / ChannelsSelect

Interface: ChannelsSelect

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:332

Description​

This select menu will populate its options with a list of public channels visible to the current user in the active workspace.

See​

Extends​

Properties​

action_id?​

optional action_id: string;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:12

@description: An identifier for this action. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids in the containing block. Maximum length for this field is 255 characters.

Inherited from​

Actionable.action_id

confirm?​

optional confirm: ConfirmationDialog;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:21

Description​

A Confirm object that defines an optional confirmation dialog after the element is interacted with.

Inherited from​

Confirmable.confirm

focus_on_load?​

optional focus_on_load: boolean;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:36

Description​

Indicates whether the element will be set to auto focus within the `view` object. Only one element can be set to true. Defaults to false.

Inherited from​

Focusable.focus_on_load

initial_channel?​

optional initial_channel: string;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:340

Description​

The ID of any valid public channel to be pre-selected when the menu loads.

placeholder?​

optional placeholder: PlainTextElement;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:49

Description​

A PlainTextElement object that defines the placeholder text shown on the element. Maximum length for the text field in this object is 150 characters.

Inherited from​

Placeholdable.placeholder

response_url_enabled?​

optional response_url_enabled: boolean;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:58

Description​

When set to true, the `view_submission` payload from the menu's parent view will contain a response_url. This response_url can be used for message responses. The target conversation for the message will be determined by the value of this select menu.

Inherited from​

URLRespondable.response_url_enabled

type​

type: "channels_select";

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:336

Description​

The type of element. In this case type is always channels_select.

Overrides​

Actionable.type