Skip to main content

@slack/types / MultiConversationsSelect

Interface: MultiConversationsSelect

Defined in: block-kit/block-elements.ts:443

Description​

This multi-select menu will populate its options with a list of public and private channels, DMs, and MPIMs visible to the current user in the active workspace.

See​

Extends​

Properties​

action_id?​

optional action_id?: string;

Defined in: block-kit/extensions.ts:15

@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: block-kit/extensions.ts:25

Description​

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

Inherited from​

Confirmable.confirm

default_to_current_conversation?​

optional default_to_current_conversation?: boolean;

Defined in: block-kit/block-elements.ts:463

Description​

Pre-populates the select menu with the conversation that the user was viewing when they opened the modal, if available. Default is false.

filter?​

optional filter?: object;

Defined in: block-kit/block-elements.ts:467

exclude_bot_users?​

optional exclude_bot_users?: boolean;

exclude_external_shared_channels?​

optional exclude_external_shared_channels?: boolean;

include?​

optional include?: ("im" | "mpim" | "private" | "public")[];

Description​

A filter object that reduces the list of available conversations using the specified criteria.

focus_on_load?​

optional focus_on_load?: boolean;

Defined in: block-kit/extensions.ts:42

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_conversations?​

optional initial_conversations?: string[];

Defined in: block-kit/block-elements.ts:458

Description​

An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. If default_to_current_conversation is also supplied, initial_conversation will be ignored.

max_selected_items?​

optional max_selected_items?: number;

Defined in: block-kit/extensions.ts:49

Description​

Specifies the maximum number of items that can be selected. Minimum number is 1.

Inherited from​

MaxItemsSelectable.max_selected_items

placeholder?​

optional placeholder?: PlainTextElement;

Defined in: block-kit/extensions.ts:57

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

type​

type: "multi_conversations_select";

Defined in: block-kit/block-elements.ts:452

Description​

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

Overrides​

Actionable.type