mirror of
https://github.com/discourse/discourse.git
synced 2024-12-13 00:13:52 +08:00
582de0ffe3
Blocks allow BOTS to augment the capacities of a chat message. At the moment only one block is available: `actions`, accepting only one type of element: `button`. <img width="708" alt="Screenshot 2024-11-15 at 19 14 02" src="https://github.com/user-attachments/assets/63f32a29-05b1-4f32-9edd-8d8e1007d705"> # Usage ```ruby Chat::CreateMessage.call( params: { message: "Welcome!", chat_channel_id: 2, blocks: [ { type: "actions", elements: [ { value: "foo", type: "button", text: { text: "How can I install themes?", type: "plain_text" } } ] } ] }, guardian: Discourse.system_user.guardian ) ``` # Documentation ## Blocks ### Actions Holds interactive elements: button. #### Fields | Field | Type | Description | Required? | |--------|--------|--------|--------| | type | string | For an actions block, type is always `actions` | Yes | | elements | array | An array of interactive elements, maximum 10 elements | Yes | | block_id | string | An unique identifier for the block, will be generated if not specified. It has to be unique per message | No | #### Example ```json { "type": "actions", "block_id": "actions_1", "elements": [...] } ``` ## Elements ### Button #### Fields | Field | Type | Description | Required? | |--------|--------|--------|--------| | type | string | For a button, type is always `button` | Yes | | text | object | A text object holding the type and text. Max 75 characters | Yes | | value | string | The value returned after the interaction has been validated. Maximum length is 2000 characters | No | | style | string | Can be `primary` , `success` or `danger` | No | | action_id | string | An unique identifier for the action, will be generated if not specified. It has to be unique per message | No | #### Example ```json { "type": "actions", "block_id": "actions_1", "elements": [ { "type": "button", "text": { "type": "plain_text", "text": "Ok" }, "value": "ok", "action_id": "button_1" } ] } ``` ## Interactions When a user interactions with a button the following flow will happen: - We send an interaction request to the server - Server checks if the user can make this interaction - If the user can make this interaction, the server will: * `DiscourseEvent.trigger(:chat_message_interaction, interaction)` * return a JSON document ```json { "interaction": { "user": { "id": 1, "username": "j.jaffeux" }, "channel": { "id": 1, "title": "Staff" }, "message": { "id": 1, "text": "test", "user_id": -1 }, "action": { "text": { "text": "How to install themes?", "type": "plain_text" }, "type": "button", "value": "click_me_123", "action_id": "bf4f30b9-de99-4959-b3f5-632a6a1add04" } } } ``` * Fire a `appEvents.trigger("chat:message_interaction", interaction)` |
||
|---|---|---|
| .. | ||
| base-common.scss | ||
| chat-audio-upload.scss | ||
| chat-browse.scss | ||
| chat-channel-card.scss | ||
| chat-channel-icon.scss | ||
| chat-channel-info.scss | ||
| chat-channel-members.scss | ||
| chat-channel-name.scss | ||
| chat-channel-preview-card.scss | ||
| chat-channel-row.scss | ||
| chat-channel-settings.scss | ||
| chat-channel-title.scss | ||
| chat-channel.scss | ||
| chat-composer-button.scss | ||
| chat-composer-dropdown.scss | ||
| chat-composer-separator.scss | ||
| chat-composer-upload.scss | ||
| chat-composer-uploads.scss | ||
| chat-composer.scss | ||
| chat-drawer-routes.scss | ||
| chat-drawer.scss | ||
| chat-emoji-picker.scss | ||
| chat-footer.scss | ||
| chat-form.scss | ||
| chat-height-mixin.scss | ||
| chat-index.scss | ||
| chat-mention-warnings.scss | ||
| chat-message-actions.scss | ||
| chat-message-blocks.scss | ||
| chat-message-collapser.scss | ||
| chat-message-creator.scss | ||
| chat-message-error.scss | ||
| chat-message-images.scss | ||
| chat-message-info.scss | ||
| chat-message-left-gutter.scss | ||
| chat-message-separator.scss | ||
| chat-message-text.scss | ||
| chat-message-thread-indicator.scss | ||
| chat-message.scss | ||
| chat-messages-scroller.scss | ||
| chat-modal-archive-channel.scss | ||
| chat-modal-channel-summary.scss | ||
| chat-modal-create-channel.scss | ||
| chat-modal-edit-channel-description.scss | ||
| chat-modal-move-message-to-channel.scss | ||
| chat-modal-new-message.scss | ||
| chat-navbar.scss | ||
| chat-notices.scss | ||
| chat-onebox.scss | ||
| chat-reply.scss | ||
| chat-replying-indicator.scss | ||
| chat-scroll-to-bottom.scss | ||
| chat-section.scss | ||
| chat-selection-manager.scss | ||
| chat-side-panel-resizer.scss | ||
| chat-skeleton.scss | ||
| chat-thread-header.scss | ||
| chat-thread-list-header.scss | ||
| chat-thread-list-item.scss | ||
| chat-thread-participants.scss | ||
| chat-thread-title.scss | ||
| chat-thread-unread-indicator.scss | ||
| chat-thread.scss | ||
| chat-threads-list.scss | ||
| chat-transcript.scss | ||
| chat-unread-indicator.scss | ||
| chat-upload-drop-zone.scss | ||
| chat-user-avatar.scss | ||
| chat-user-threads.scss | ||
| core-extensions.scss | ||
| dc-filter-input.scss | ||
| direct-message-creator.scss | ||
| incoming-chat-webhooks.scss | ||
| index.scss | ||
| reviewable-chat-message.scss | ||
| sidebar-extensions.scss | ||