message
Displays a message to the user. Supports simple text, numbers, objects, arrays, or rich block content.
Usage
await io.message({
title: 'Success',
message: 'Your order has been processed successfully!',
})Props
| Prop | Description | Type | Required | Default |
|---|---|---|---|---|
| title | Optional title for the message | string | No | undefined |
| description | Optional description for the message | string | No | undefined |
| message | The message content. Can be JavaScript primitives or complex objects, or BlockOutput for rich content | string | number | object | array | BlockOutput | Yes | — |
Returns
Returns Promise<void>.
Examples
Structured data message
await io.message({
title: 'Order Summary',
description: 'Review your order details',
message: {
orderId: '12345',
items: 3,
total: 99.99,
status: 'confirmed',
},
})Rich content with blocks
await io.message({
title: 'Analysis Complete',
message: {
type: 'table',
data: result,
},
})