Interface: ConversationsSelect
Description
This 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
- 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:341
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:345
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_conversation?
optional initial_conversation: string;
Description
The ID of any valid conversation to be pre-selected when the menu loads. If
default_to_current_conversation is also supplied, initial_conversation will take precedence.
Defined in
block-kit/block-elements.ts:336
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
response_url_enabled?
optional response_url_enabled: boolean;
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
Defined in
type
type: "conversations_select";
Description
The type of element. In this case type is always conversations_select.