[
  {
    "comment": "/**\n * @module\n * @name RPCoverXMPPService\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n * @description\n *      This service manages and use an RPC over XMPP requests system.<br>\n */",
    "meta": {
      "filename": "RPCoverXMPPService.js",
      "lineno": 19,
      "columnno": 0,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "kind": "module",
    "name": "RPCoverXMPPService",
    "version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z",
    "access": "public",
    "description": "This service manages and use an RPC over XMPP requests system.<br>",
    "longname": "module:RPCoverXMPPService",
    "$longname": "RPCoverXMPPService",
    "$kind": "module"
  },
  {
    "comment": "",
    "meta": {
      "range": [
        1635,
        2741
      ],
      "filename": "RPCoverXMPPService.js",
      "lineno": 32,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {
        "id": "astnode100000230",
        "name": "RPCoverXMPPService_1",
        "type": "MethodDefinition",
        "paramnames": [
          "_core",
          "_eventEmitter",
          "_http",
          "_logger",
          "_startConfig"
        ]
      },
      "vars": {
        "": null
      }
    },
    "undocumented": true,
    "name": "RPCoverXMPPService_1",
    "longname": "module:RPCoverXMPPService.RPCoverXMPPService_1",
    "kind": "class",
    "memberof": "module:RPCoverXMPPService",
    "scope": "static",
    "params": [],
    "$longname": "RPCoverXMPPService.RPCoverXMPPService_1",
    "$kind": "constructor"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method addRPCMethod\n     * @since 2.22.0\n     * @instance\n     * @async\n     * @category Rainbow RPCoverXMPP RPC Server\n     * @description\n     *    This API allows to expose an RPC method to requests from an XMPP party. <br>\n     * @param {string} methodName The name of the method to be added in RPC server. This is the name used by the RPC Client to call it.\n     * @param {string} methodCallback The callback of the method to be added in RPC server. </BR>It is this method which is called when the SDK receives an RPC request for the linked methodName.</BR> The method signature is built from this parameter.\n     * @param {string} methodDescription The description of the method to be added in RPC server\n     * @param {string} methodHelp The help of the method to be added in RPC server\n     * @return {Promise<any>} An object of the result\n     */",
    "meta": {
      "filename": "RPCoverXMPPService.js",
      "lineno": 142,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Rainbow RPCoverXMPP RPC Server",
        "value": "Rainbow RPCoverXMPP RPC Server"
      }
    ],
    "kind": "function",
    "name": "addRPCMethod",
    "since": "2.22.0",
    "scope": "instance",
    "async": true,
    "description": "This API allows to expose an RPC method to requests from an XMPP party. <br>",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The name of the method to be added in RPC server. This is the name used by the RPC Client to call it.",
        "name": "methodName"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The callback of the method to be added in RPC server. </BR>It is this method which is called when the SDK receives an RPC request for the linked methodName.</BR> The method signature is built from this parameter.",
        "name": "methodCallback"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The description of the method to be added in RPC server",
        "name": "methodDescription"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The help of the method to be added in RPC server",
        "name": "methodHelp"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<any>"
          ]
        },
        "description": "An object of the result"
      }
    ],
    "longname": "module:RPCoverXMPPService#addRPCMethod",
    "memberof": "module:RPCoverXMPPService",
    "$longname": "RPCoverXMPPService#addRPCMethod",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method callRPCMethod\n     * @since 2.22.0\n     * @instance\n     * @async\n     * @category Rainbow RPCoverXMPP RPC Client\n     * @description\n     *    This API allows to send a request to call a rpc method to a bare jid. The result is the result of the method called on RPC server.<br>\n     * @param {string} rpcoverxmppserver_jid the jid of the rpc server used to retrieve the request. default value is the jid of the account running the SDK.</BR> **Note :** only a full JID (with resource) is possible to used.\n     * @param {string} methodName=\"system.listMethods\" method name of the rpc shared method on server used to retrieve the request. </BR> default value is `system.listMethods` for listing the available methods on RPC server. </BR> use `system.methodHelp` with the name of a method as parameter to get informations about it. </BR> Use `system.methodSignature`   with the name of a method as parameter to get it's signature.\n     * @param {Array<any>} params Array with the parameters for the RPC request. This Array will be splitted in each parameters to the method shared on RPC Server when it is ran.\n     * @return {Promise<any>} An object of the result\n     */",
    "meta": {
      "filename": "RPCoverXMPPService.js",
      "lineno": 254,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Rainbow RPCoverXMPP RPC Client",
        "value": "Rainbow RPCoverXMPP RPC Client"
      }
    ],
    "kind": "function",
    "name": "callRPCMethod",
    "since": "2.22.0",
    "scope": "instance",
    "async": true,
    "description": "This API allows to send a request to call a rpc method to a bare jid. The result is the result of the method called on RPC server.<br>",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "the jid of the rpc server used to retrieve the request. default value is the jid of the account running the SDK.</BR> **Note :** only a full JID (with resource) is possible to used.",
        "name": "rpcoverxmppserver_jid"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "defaultvalue": "\"system.listMethods\"",
        "description": "method name of the rpc shared method on server used to retrieve the request. </BR> default value is `system.listMethods` for listing the available methods on RPC server. </BR> use `system.methodHelp` with the name of a method as parameter to get informations about it. </BR> Use `system.methodSignature`   with the name of a method as parameter to get it's signature.",
        "name": "methodName"
      },
      {
        "type": {
          "names": [
            "Array.<any>"
          ]
        },
        "description": "Array with the parameters for the RPC request. This Array will be splitted in each parameters to the method shared on RPC Server when it is ran.",
        "name": "params"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<any>"
          ]
        },
        "description": "An object of the result"
      }
    ],
    "longname": "module:RPCoverXMPPService#callRPCMethod",
    "memberof": "module:RPCoverXMPPService",
    "$longname": "RPCoverXMPPService#callRPCMethod",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method discoverRPCoverXMPP\n     * @since 2.22.0\n     * @instance\n     * @async\n     * @category Rainbow RPCoverXMPP RPC Client\n     * @description\n     *    This API allows to send a discover presence to a bare jid to find the resources availables. <br>\n     * @param {Object} headers The Http Headers used to web request.\n     * @param {string} rpcoverxmppserver_jid the jid of the http over xmpp server used to retrieve the HTTP web request. default value is the jid of the account running the SDK.\n     * @return {Promise<any>} An object of the result\n     */",
    "meta": {
      "filename": "RPCoverXMPPService.js",
      "lineno": 218,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Rainbow RPCoverXMPP RPC Client",
        "value": "Rainbow RPCoverXMPP RPC Client"
      }
    ],
    "kind": "function",
    "name": "discoverRPCoverXMPP",
    "since": "2.22.0",
    "scope": "instance",
    "async": true,
    "description": "This API allows to send a discover presence to a bare jid to find the resources availables. <br>",
    "params": [
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The Http Headers used to web request.",
        "name": "headers"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "the jid of the http over xmpp server used to retrieve the HTTP web request. default value is the jid of the account running the SDK.",
        "name": "rpcoverxmppserver_jid"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<any>"
          ]
        },
        "description": "An object of the result"
      }
    ],
    "longname": "module:RPCoverXMPPService#discoverRPCoverXMPP",
    "memberof": "module:RPCoverXMPPService",
    "$longname": "RPCoverXMPPService#discoverRPCoverXMPP",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method removeRPCMethod\n     * @since 2.22.0\n     * @instance\n     * @async\n     * @category Rainbow RPCoverXMPP RPC Server\n     * @description\n     *    This API allows to remove an RPC method from RPC Server. <br>\n     * @param {string} methodName The name of the method to be removed from RPC server\n     * @return {Promise<any>} An object of the result\n     */",
    "meta": {
      "filename": "RPCoverXMPPService.js",
      "lineno": 183,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Rainbow RPCoverXMPP RPC Server",
        "value": "Rainbow RPCoverXMPP RPC Server"
      }
    ],
    "kind": "function",
    "name": "removeRPCMethod",
    "since": "2.22.0",
    "scope": "instance",
    "async": true,
    "description": "This API allows to remove an RPC method from RPC Server. <br>",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The name of the method to be removed from RPC server",
        "name": "methodName"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<any>"
          ]
        },
        "description": "An object of the result"
      }
    ],
    "longname": "module:RPCoverXMPPService#removeRPCMethod",
    "memberof": "module:RPCoverXMPPService",
    "$longname": "RPCoverXMPPService#removeRPCMethod",
    "$kind": "method"
  }
]