summaryrefslogtreecommitdiff
path: root/doc/it/weechat_user.it.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2019-04-13 13:53:16 +0200
committerSébastien Helleu <flashcode@flashtux.org>2019-04-13 13:53:16 +0200
commit30768d4d24a6a9047dabd473cdbce434439d48c2 (patch)
tree1864c8f39bd8111d3053da6013f3c366036af029 /doc/it/weechat_user.it.adoc
parent8bc06ea101ad05466e420e63b46bdc7039991a2e (diff)
downloadweechat-30768d4d24a6a9047dabd473cdbce434439d48c2.zip
trigger: add hook "info_hashtable"
Diffstat (limited to 'doc/it/weechat_user.it.adoc')
-rw-r--r--doc/it/weechat_user.it.adoc54
1 files changed, 38 insertions, 16 deletions
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index 73d57f312..c9f7562e1 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -3851,7 +3851,7 @@ A trigger has the following options (names are
any more.
| hook | `signal`, `hsignal`, `modifier`, `line`, `print`, `command`,
- `command_run`, `timer`, `config`, `focus`, `info` |
+ `command_run`, `timer`, `config`, `focus`, `info`, `info_hashtable` |
The hook used in trigger. For more information, see
link:weechat_plugin_api.it.html#hooks[WeeChat plugin API reference / Hooks].
@@ -3902,8 +3902,8 @@ order, if triggers are globally enabled and if the trigger itself is enabled:
. check trigger conditions: if false, exit
. replace text in trigger using regular expression(s)
. execute command(s)
-. exit with a return code (except for hooks _modifier_, _line_, _focus_ and
- _info_)
+. exit with a return code (except for hooks _modifier_, _line_, _focus_,
+ _info_ and _info_hashtable_)
. perform post action (if different from `none`).
[[trigger_hook_arguments]]
@@ -4005,7 +4005,14 @@ The arguments depend on the hook used. They are separated by semicolons.
2. info name (priority allowed) +
3. ... |
`+my_info+` |
- link:weechat_plugin_api.en.html#_hook_info[hook_info]
+ link:weechat_plugin_api.it.html#_hook_info[hook_info]
+
+| info_hashtable |
+ 1. info name (priority allowed) (required) +
+ 2. info name (priority allowed) +
+ 3. ... |
+ `+my_info+` |
+ link:weechat_plugin_api.it.html#_hook_info_hashtable[hook_info_hashtable]
|===
[[trigger_conditions]]
@@ -4041,18 +4048,19 @@ type:
[width="100%",cols="2,3,7",options="header"]
|===
-| Hook | Default variable | Update allowed ^(1)^
-| signal | tg_signal_data |
-| hsignal | |
-| modifier | tg_string | tg_string
-| line | message | buffer, buffer_name, y, date, date_printed, str_time, tags, notify_level, highlight, prefix, message
-| print | tg_message |
-| command | tg_argv_eol1 |
-| command_run | tg_command |
-| timer | tg_remaining_calls |
-| config | tg_value |
-| focus | |
-| info | tg_info | tg_info
+| Hook | Default variable | Update allowed ^(1)^
+| signal | tg_signal_data |
+| hsignal | |
+| modifier | tg_string | tg_string
+| line | message | buffer, buffer_name, y, date, date_printed, str_time, tags, notify_level, highlight, prefix, message
+| print | tg_message |
+| command | tg_argv_eol1 |
+| command_run | tg_command |
+| timer | tg_remaining_calls |
+| config | tg_value |
+| focus | |
+| info | tg_info | tg_info
+| info_hashtable | | all variables received in hashtable
|===
[NOTE]
@@ -4362,6 +4370,20 @@ The "info" callback sets following variables in hashtable:
| tg_info | string | Empty string (the info to return).
|===
+[[trigger_data_info_hashtable]]
+===== Info_hashtable
+
+The "info_hashtable" callback sets following variables in hashtable:
+
+[width="100%",cols="3m,2,14",options="header"]
+|===
+| Variable | Type | Description
+| tg_info_name | string | Name of info.
+|===
+
+The hashtable contains all keys/values from hashtable received (type:
+string/string).
+
[[trigger_examples]]
==== Examples