Skip to content

Commit 221376e

Browse files
committed
functions: document is_components_v2 complexMessage flag
Signed-off-by: Luca Zeuch <[email protected]>
1 parent e2878ed commit 221376e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

content/docs/reference/templates/functions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,7 +1184,7 @@ Note that a message sent via [sendMessage](#sendmessage) is not the response---u
11841184
#### complexMessageEdit
11851185

11861186
```yag
1187-
{{ $message := complexMessageEdit [allowed_mentions] [content] [embed] [silent] [suppress_embeds] }}
1187+
{{ $message := complexMessageEdit [allowed_mentions] [content] [embed] [silent] [suppress_embeds] [is_components_v2] }}
11881188
```
11891189

11901190
Creates a complex message object for use in [editMessage](#editmessage) or [editMessageNoEscape](#editmessagenoescape).
@@ -1198,6 +1198,7 @@ Creates a complex message object for use in [editMessage](#editmessage) or [edit
11981198
- `embed`: an embed object or a slice of up to 10 embed objects.
11991199
- `silent`: whether to suppress push and desktop notifications.
12001200
- `suppress_embeds`: whether to suppress embeds in the message.
1201+
- `is_components_v2`: whether the message uses components v2. Irreversibly switches the message to use components v2.
12011202

12021203
All of these keys are optional, but providing none of them will have no effect. See [complexMessage](#complexmessage)
12031204
for an example.
@@ -1207,7 +1208,7 @@ Setting `suppress_embeds` to `false` on a message with already suppressed embeds
12071208
#### complexMessage
12081209

12091210
```yag
1210-
{{ $message := complexMessage [allowed_mentions] [content] [embed] [file] [filename] [reply] [silent] [menus] [buttons] [sticker] [forward] [suppress_embeds] }}
1211+
{{ $message := complexMessage [allowed_mentions] [content] [embed] [file] [filename] [reply] [silent] [menus] [buttons] [sticker] [forward] [suppress_embeds] [is_components_v2] }}
12111212
```
12121213

12131214
Creates a complex message object for use in [sendMessage](#sendmessage) functions.
@@ -1228,6 +1229,7 @@ Creates a complex message object for use in [sendMessage](#sendmessage) function
12281229
- `sticker`: single sticker ID or a slice of sticker IDs
12291230
- `forward`: an sdict containing `channel` and `message` keys specifying the message to forward
12301231
- `suppress_embeds`: whether to suppress embeds in the message.
1232+
- `is_components_v2`: whether the message uses components v2. Irreversibly switches the message to use components v2.
12311233

12321234
All of these keys are optional, but providing an empty content, file, or no embeds will result in no message being sent.
12331235

0 commit comments

Comments
 (0)