pegasus/anope
1
0
Fork 0
mirror of https://github.com/anope/anope.git synced 2026-06-25 03:46:36 +02:00
Code Activity

Document the required RPC modules in the JavaScript library.

Browse Source
This commit is contained in:
Sadie Powell
2025-03-13 15:24:48 +00:00
parent 82371dc279
commit 23d548336a
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/RPC/jsonrpc.js
+25
View File
@@ -47,6 +47,8 @@ class AnopeRPC {
/**
* Retrieves a list of channels.
*
* Requires the rpc_data module to be loaded.
*
* @returns {array} An array of channel names.
*/
listChannels() {
@@ -56,6 +58,8 @@ class AnopeRPC {
/**
* Retrieves information about the specified channel.
*
* Requires the rpc_data module to be loaded.
*
* @param {string} name The name of the channel.
* @returns {object} An object containing information about the channel.
*/
@@ -66,6 +70,8 @@ class AnopeRPC {
/**
* Retrieves a list of services operators.
*
* Requires the rpc_data module to be loaded.
*
* @returns {array} An array of channel names.
*/
listOpers() {
@@ -75,6 +81,8 @@ class AnopeRPC {
/**
* Retrieves information about the specified services operator.
*
* Requires the rpc_data module to be loaded.
*
* @param {string} name The name of the services operator.
* @returns {object} An object containing information about the services operator.
*/
@@ -85,6 +93,8 @@ class AnopeRPC {
/**
* Retrieves a list of servers.
*
* Requires the rpc_data module to be loaded.
*
* @returns {array} An array of servers names.
*/
listServers() {
@@ -94,6 +104,8 @@ class AnopeRPC {
/**
* Retrieves information about the specified server.
*
* Requires the rpc_data module to be loaded.
*
* @param {string} name The name of the server.
* @returns {object} An object containing information about the server.
*/
@@ -104,6 +116,8 @@ class AnopeRPC {
/**
* Retrieves a list of users.
*
* Requires the rpc_data module to be loaded.
*
* @returns {array} An array of channel names.
*/
listUsers() {
@@ -113,6 +127,8 @@ class AnopeRPC {
/**
* Retrieves information about the specified user.
*
* Requires the rpc_data module to be loaded.
*
* @param {string} nick The nick of the user.
* @returns {object} An object containing information about the user.
*/
@@ -122,6 +138,9 @@ class AnopeRPC {
/**
* Sends a message to every user on the network.
*
* Requires the rpc_message module to be loaded.
*
* @param {...*} messages One or more messages to send.
*/
messageNetwork(...messages) {
@@ -130,6 +149,9 @@ class AnopeRPC {
/**
* Sends a message to every user on the specified server.
*
* Requires the rpc_message module to be loaded.
*
* @param {string} name The name of the server.
* @param {...*} messages One or more messages to send.
*/
@@ -139,6 +161,9 @@ class AnopeRPC {
/**
* Sends a message to the specified user.
*
* Requires the rpc_message module to be loaded.
*
* @param {string} source The source pseudoclient to send the message from.
* @param {string} target The target user to send the message to.
* @param {...*} messages One or more messages to send.