From 5db2ef6f3071861466a0de9511a4c7965373ba52 Mon Sep 17 00:00:00 2001 From: "Kay Marquardt (Gnadelwartz)" Date: Mon, 7 Dec 2020 18:29:37 +0100 Subject: [PATCH] add BOTSENT[ID] to documentation --- doc/2_usage.md | 13 ++++++++++++- doc/3_advanced.md | 5 +++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/doc/2_usage.md b/doc/2_usage.md index d4ed03c..561f8fd 100644 --- a/doc/2_usage.md +++ b/doc/2_usage.md @@ -205,6 +205,17 @@ they contain the following variables only: * ```${iQUERY[FIRST_NAME]}```: User's first name * ```${iQUERY[LAST_NAME]}```: User's last name + +### Send Message Results + +BOTSWEND is set on every send_xxx action and only valid until next send action. For more on message results see. +[Advanced Usage](3_advanced.md) + +* ```$BOTSENT```: This array contains the parsed results from the last transmission to telegram. + * ```${BOTSENT[OK]}```: contains the string ```true```: after a successful transmission + * ```${BOTSENT[ID]}```: Message ID of sent message, image, file etc., if OK is true + + ## Usage of bashbot functions #### sending messages @@ -283,5 +294,5 @@ send_action "${CHAT[ID]}" "action" #### [Prev Create Bot](1_firstbot.md) #### [Next Advanced Usage](3_advanced.md) -#### $$VERSION$$ v1.2-0-gc50499c +#### $$VERSION$$ v1.2-10-g10c104d diff --git a/doc/3_advanced.md b/doc/3_advanced.md index a499036..3876730 100644 --- a/doc/3_advanced.md +++ b/doc/3_advanced.md @@ -227,7 +227,7 @@ answer_inline_query "${iQUERY[ID]}" "cached_sticker" "identifier for the sticker See also [answer_inline_multi, answer_inline_compose](6_reference.md#answer_inline_multi) and [mycommands.sh](../mycommands.sh) for more information. -### Handle send message errors +### Send message results Our examples usually do not care about errors happening while sending a message, this is OK as long your bot does not send an massive aoumnt of messages. By default bashbot detects if a message is not sent and try to recover when possible, @@ -244,6 +244,7 @@ every send action will overwrite them! * ```$BOTSENT```: This array contains the parsed results from the last transmission to telegram. * ```${BOTSENT[OK]}```: contains the string ```true```: after a successful transmission + * ```${BOTSENT[ID]}```: Message ID if OK is true * ```${BOTSENT[ERROR]}```: Error code if an error occurred * ```${BOTSENT[DESC]}```: Description text for error * ```${BOTSENT[RETRY]}```: Seconds to wait if telegram requests throtteling. @@ -297,5 +298,5 @@ Note: If you disable automatic retry, se above, you disable also connection prob #### [Prev Getting started](2_usage.md) #### [Next Expert Use](4_expert.md) -#### $$VERSION$$ v1.2-0-gc50499c +#### $$VERSION$$ v1.2-10-g10c104d