summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2024-04-29 19:31:02 +0200
committerSébastien Helleu <flashcode@flashtux.org>2024-04-29 21:07:04 +0200
commit9cd7fd38a91dc2980e82be49185c1eb20d70c0f9 (patch)
treeaf8a880ae9cf2d4575dbf01ec013505a2c328af9 /doc/en
parentded599b272e94763a3f5477e43ec32bec7080f0d (diff)
downloadweechat-9cd7fd38a91dc2980e82be49185c1eb20d70c0f9.zip
api: allow to set nicklist group/nick id in functions nicklist_group_set and nicklist_nick_set (issue #2081)
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat_plugin_api.en.adoc32
1 files changed, 20 insertions, 12 deletions
diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc
index 27027a9e9..f98065fa3 100644
--- a/doc/en/weechat_plugin_api.en.adoc
+++ b/doc/en/weechat_plugin_api.en.adoc
@@ -15959,7 +15959,7 @@ parent = weechat.nicklist_group_get_pointer(buffer, group, "parent")
==== nicklist_group_set
-_WeeChat ≥ 0.3.4._
+_WeeChat ≥ 0.3.4, updated in 4.3.0._
Set string value of a group property.
@@ -15982,14 +15982,18 @@ Arguments:
Properties:
-[width="100%",cols="^2,4,8",options="header"]
+[width="100%",cols="^2,^1,4,8",options="header"]
|===
-| Name | Value | Description
+| Name | Min WeeChat | Value | Description
+
+| id | 4.3.0 | long long integer ≥ 0
+| New id for the group (it must be unique in the buffer). +
+ Note: it is not recommended to change this identifier.
-| color | WeeChat color option name
+| color | | WeeChat color option name
| See argument "color" of function <<_nicklist_add_group,nicklist_add_group>>.
-| visible | "0", "1"
+| visible | | "0", "1"
| "0" = hidden group, "1" = visible group.
|===
@@ -16164,7 +16168,7 @@ group = weechat.nicklist_nick_get_pointer(buffer, nick, "group")
==== nicklist_nick_set
-_WeeChat ≥ 0.3.4._
+_WeeChat ≥ 0.3.4, updated in 4.3.0._
Set string value of a nick property.
@@ -16187,20 +16191,24 @@ Arguments:
Properties:
-[width="100%",cols="^2,4,8",options="header"]
+[width="100%",cols="^2,^1,4,8",options="header"]
|===
-| Name | Value | Description
+| Name | Min WeeChat | Value | Description
+
+| id | 4.3.0 | long long integer ≥ 0
+| New id for the nick (it must be unique in the buffer). +
+ Note: it is not recommended to change this identifier.
-| color | WeeChat color option name
+| color | | WeeChat color option name
| See argument "color" of function <<_nicklist_add_nick,nicklist_add_nick>>.
-| prefix | any string
+| prefix | | any string
| Prefix of nick.
-| prefix_color | WeeChat color option name
+| prefix_color | | WeeChat color option name
| See argument "prefix_color" of function <<_nicklist_add_nick,nicklist_add_nick>>.
-| visible | "0", "1"
+| visible | | "0", "1"
| "0" = hidden nick, "1" = visible nick.
|===