Interface: MultiConversationsSelect
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
- Multi-select menu of conversations reference.
- This is an interactive component - see our guide to enabling interactivity.
Extends
Properties
action_id?
optional action_id: string;
@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
Defined in
confirm?
optional confirm: ConfirmationDialog;
Description
A Confirm object that defines an optional confirmation dialog after the element is interacted with.
Inherited from
Defined in
default_to_current_conversation?
optional default_to_current_conversation: boolean;
Description
Pre-populates the select menu with the conversation that the user was viewing when they opened the
modal, if available. Default is false.
Defined in
block-kit/block-elements.ts:381
filter?
optional filter: object;
exclude_bot_users?
optional exclude_bot_users: boolean;
exclude_external_shared_channels?
optional exclude_external_shared_channels: boolean;
include?
optional include: ("im" | "mpim" | "public" | "private")[];
Description
A filter object that reduces the list of available conversations using the specified criteria.
Defined in
block-kit/block-elements.ts:385
focus_on_load?
optional focus_on_load: boolean;
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
Defined in
initial_conversations?
optional initial_conversations: string[];
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.
Defined in
block-kit/block-elements.ts:376
max_selected_items?
optional max_selected_items: number;
Description
Specifies the maximum number of items that can be selected. Minimum number is 1.
Inherited from
MaxItemsSelectable.max_selected_items
Defined in
placeholder?
optional placeholder: PlainTextElement;
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
Defined in
type
type: "multi_conversations_select";
Description
The type of element. In this case type is always conversations_select.