To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.
Api: Difference between revisions
m Add table styling |
Document QUERY command scopes |
||
Line 19: | Line 19: | ||
=== QUERY command === | === QUERY command === | ||
The <code>QUERY</code> command is organized into scopes. The scope specifies where to query for the information. Here are the available scopes: | |||
{| class="wikitable" | |||
| <code>ZNC</code> | |||
| Static, ZNC-wide readonly information about the ZNC binary. | |||
|- | |||
| <code>USER</code> | |||
| Information about the currently authenticated user. | |||
|} | |||
TODO document parameters | |||
== Types == | == Types == | ||
Line 48: | Line 60: | ||
== Errors == | == Errors == | ||
TODO |
Revision as of 11:01, 5 August 2021
Commands
PING
|
Unconditionally returns PONG. Exists primarily for testing things, or may be used to probe for API availability without making any calls. |
HELP
|
Returns informational text about the API's self-documentation. |
COMMANDS
|
Returns a list of available commands. |
QUERYSCOPES
|
Returns a list of available QUERY scopes. See below. |
QUERY
|
Used to query information. See below. |
QUERY command
The QUERY
command is organized into scopes. The scope specifies where to query for the information. Here are the available scopes:
ZNC
|
Static, ZNC-wide readonly information about the ZNC binary. |
USER
|
Information about the currently authenticated user. |
TODO document parameters
Types
Scalar types are returned without any special syntax.
Lists of scalar types are returned one element per IRC message, preceded by the string LIST
and ended by the string LISTEND
.
Lists of n-tuples are returned one tuple element per IRC message and in order, preceded by the string TUPLELIST <n>
and ended by the string TUPLELISTEND
where <n>
is the arity of the tuples in the list.
For example, here is a list of the numbers 1, 2, and 3:
LIST 1 2 3 LISTEND
And here is a list of the 2-tuples (A, 1)
, (B, 2)
, and (C, 3)
:
TUPLELIST 2 A 1 B 2 C 3 TUPLELISTEND
Errors
TODO