GramIO API Reference / @gramio/prompt/dist / PromptFunctionParams
Interface: PromptFunctionParams<Event, Data, ActionReturn>
Defined in: prompt/index.d.ts:95
Make some keys optional
Extends
Optional<SendMessageParams,"chat_id"|"text">
Type Parameters
| Type Parameter | Default type |
|---|---|
Event extends EventsUnion | - |
Data | - |
ActionReturn | never |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
allow_paid_broadcast? | boolean | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance | SendMessageParams.allow_paid_broadcast | @gramio/types/out/params.d.ts:135 |
business_connection_id? | string | Unique identifier of the business connection on behalf of which the message will be sent | SendMessageParams.business_connection_id | @gramio/types/out/params.d.ts:95 |
chat_id? | string | number | Unique identifier for the target chat or username of the target channel (in the format @channelusername) | SendMessageParams.chat_id | @gramio/types/out/params.d.ts:99 |
direct_messages_topic_id? | number | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | SendMessageParams.direct_messages_topic_id | @gramio/types/out/params.d.ts:107 |
disable_notification? | boolean | Sends the message silently. Users will receive a notification with no sound. | SendMessageParams.disable_notification | @gramio/types/out/params.d.ts:127 |
entities? | TelegramMessageEntity[] | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | SendMessageParams.entities | @gramio/types/out/params.d.ts:119 |
link_preview_options? | TelegramLinkPreviewOptions | Link preview generation options for the message | SendMessageParams.link_preview_options | @gramio/types/out/params.d.ts:123 |
message_effect_id? | string | Unique identifier of the message effect to be added to the message; for private chats only | SendMessageParams.message_effect_id | @gramio/types/out/params.d.ts:139 |
message_thread_id? | number | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | SendMessageParams.message_thread_id | @gramio/types/out/params.d.ts:103 |
onValidateError? | string & object | OnValidateErrorFunction<Event, Data, ActionReturn> | - | - | prompt/index.d.ts:98 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Mode for parsing entities in the message text. See formatting options for more details. | SendMessageParams.parse_mode | @gramio/types/out/params.d.ts:115 |
protect_content? | boolean | Protects the contents of the sent message from forwarding and saving | SendMessageParams.protect_content | @gramio/types/out/params.d.ts:131 |
reply_markup? | TelegramInlineKeyboardMarkup | { toJSON: TelegramInlineKeyboardMarkup; } | TelegramReplyKeyboardMarkup | { toJSON: TelegramReplyKeyboardMarkup; } | TelegramReplyKeyboardRemove | { toJSON: TelegramReplyKeyboardRemove; } | TelegramForceReply | { toJSON: TelegramForceReply; } | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user | SendMessageParams.reply_markup | @gramio/types/out/params.d.ts:151 |
reply_parameters? | TelegramReplyParameters | Description of the message to reply to | SendMessageParams.reply_parameters | @gramio/types/out/params.d.ts:147 |
suggested_post_parameters? | TelegramSuggestedPostParameters | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | SendMessageParams.suggested_post_parameters | @gramio/types/out/params.d.ts:143 |
text? | string | { toString: string; } | Text of the message to be sent, 1-4096 characters after entities parsing | SendMessageParams.text | @gramio/types/out/params.d.ts:111 |
timeout? | number | - | - | prompt/index.d.ts:99 |
transform? | TransformFunction<Event, Data> | - | - | prompt/index.d.ts:97 |
validate? | ValidateFunction<Event> | - | - | prompt/index.d.ts:96 |