[
  {
    "comment": "/**\n * @module\n * @name s2s\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n * @description\n *      This module handles the s2s API's methods to Rainbow. <br>\n *      <br><br>\n *      The main methods proposed in that module allow to: <br>\n *      - Signin in s2s mode <br>\n *      - List the user's connections in s2s mode <br>\n *      - Manage presence <br>\n *      - Send presence in bubble <br>\n *      - Send messages <br>\n *      - ... <br>\n */",
    "meta": {
      "filename": "S2SService.js",
      "lineno": 20,
      "columnno": 0,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "kind": "module",
    "name": "s2s",
    "version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z",
    "access": "public",
    "description": "This module handles the s2s API's methods to Rainbow. <br>\n     <br><br>\n     The main methods proposed in that module allow to: <br>\n     - Signin in s2s mode <br>\n     - List the user's connections in s2s mode <br>\n     - Manage presence <br>\n     - Send presence in bubble <br>\n     - Send messages <br>\n     - ... <br>",
    "longname": "module:s2s",
    "$longname": "s2s",
    "$kind": "module"
  },
  {
    "comment": "",
    "meta": {
      "range": [
        1931,
        4011
      ],
      "filename": "S2SService.js",
      "lineno": 41,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {
        "id": "astnode100000244",
        "name": "S2SService_1",
        "type": "MethodDefinition",
        "paramnames": [
          "_core",
          "_s2s",
          "_im",
          "_application",
          "_eventEmitter",
          "_logger",
          "_proxy",
          "_startConfig"
        ]
      },
      "vars": {
        "": null
      }
    },
    "undocumented": true,
    "name": "S2SService_1",
    "longname": "module:s2s.S2SService_1",
    "kind": "class",
    "memberof": "module:s2s",
    "scope": "static",
    "params": [],
    "$longname": "s2s.S2SService_1",
    "$kind": "constructor"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method checkS2Sconnection\n     * @instance\n     * @category S2S Management\n     * @description\n     *      check the S2S connection with a head request. <br>\n     * @async\n     * @return {Promise<Object, ErrorManager>}\n     * @fulfil {Object} - List of connexions or an error object depending on the result\n     \n     */",
    "meta": {
      "filename": "S2SService.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": "S2S Management",
        "value": "S2S Management"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Object} - List of connexions or an error object depending on the result",
        "value": "{Object} - List of connexions or an error object depending on the result"
      }
    ],
    "kind": "function",
    "name": "checkS2Sconnection",
    "scope": "instance",
    "description": "check the S2S connection with a head request. <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        }
      }
    ],
    "longname": "module:s2s#checkS2Sconnection",
    "memberof": "module:s2s",
    "$longname": "s2s#checkS2Sconnection",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method deleteAllConnectionsS2S\n     * @instance\n     * @category S2S Management\n     * @description\n     *      Delete all the connected user's S2S connexions. <br>\n     * @async\n     * @return {Promise<Object, ErrorManager>}\n     * @fulfil {Object} - List of connexions or an error object depending on the result\n     \n     */",
    "meta": {
      "filename": "S2SService.js",
      "lineno": 312,
      "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": "S2S Management",
        "value": "S2S Management"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Object} - List of connexions or an error object depending on the result",
        "value": "{Object} - List of connexions or an error object depending on the result"
      }
    ],
    "kind": "function",
    "name": "deleteAllConnectionsS2S",
    "scope": "instance",
    "description": "Delete all the connected user's S2S connexions. <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        }
      }
    ],
    "longname": "module:s2s#deleteAllConnectionsS2S",
    "memberof": "module:s2s",
    "$longname": "s2s#deleteAllConnectionsS2S",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method infoS2S\n     * @instance\n     * @category S2S Management\n     * @param {string} s2sConnectionId The id of the S2S conneexion to retrieve information about.\n     * @description\n     *      Get information about a S2S connexions. <br>\n     * @async\n     * @return {Promise<Object, ErrorManager>}\n     * @fulfil {Object} - List of connexions or an error object depending on the result\n     \n     */",
    "meta": {
      "filename": "S2SService.js",
      "lineno": 361,
      "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": "S2S Management",
        "value": "S2S Management"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Object} - List of connexions or an error object depending on the result",
        "value": "{Object} - List of connexions or an error object depending on the result"
      }
    ],
    "kind": "function",
    "name": "infoS2S",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The id of the S2S conneexion to retrieve information about.",
        "name": "s2sConnectionId"
      }
    ],
    "description": "Get information about a S2S connexions. <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        }
      }
    ],
    "longname": "module:s2s#infoS2S",
    "memberof": "module:s2s",
    "$longname": "s2s#infoS2S",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method listConnectionsS2S\n     * @instance\n     * @category S2S Management\n     * @description\n     *      List all the connected user's connexions. <br>\n     * @async\n     * @return {Promise<Object, ErrorManager>}\n     * @fulfil {Object} - List of connexions or an error object depending on the result\n     \n     */",
    "meta": {
      "filename": "S2SService.js",
      "lineno": 229,
      "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": "S2S Management",
        "value": "S2S Management"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Object} - List of connexions or an error object depending on the result",
        "value": "{Object} - List of connexions or an error object depending on the result"
      }
    ],
    "kind": "function",
    "name": "listConnectionsS2S",
    "scope": "instance",
    "description": "List all the connected user's connexions. <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        }
      }
    ],
    "longname": "module:s2s#listConnectionsS2S",
    "memberof": "module:s2s",
    "$longname": "s2s#listConnectionsS2S",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method sendCorrectedChatMessage\n     * @instance\n     * @category S2S Methods\n     * @param {string} conversationId id of the conversation\n     * @param {string} origMsgId id of the original message\n     * @param {any} msg The message object update. <br>\n     * { <br>\n     *   \"message\": { <br>\n     *   \"subject\": \"Greeting\", <br>\n     *   \"lang\": \"en\", <br>\n     *   \"contents\": [ <br>\n     *     { <br>\n     *       \"type\": \"text/markdown\", <br>\n     *       \"data\": \"## Hello Bob\" <br>\n     *     } <br>\n     *   ], <br>\n     *   \"body\": \"Hello world\" <br>\n     *   } <br>\n     * } <br>\n     * @description\n     *      Send a corrected message in a conversation.  <br>\n     * @async\n     * @return {Promise<Object, ErrorManager>}\n     * @fulfil {Object} - result or an error object depending on the result\n     */",
    "meta": {
      "filename": "S2SService.js",
      "lineno": 490,
      "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": "S2S Methods",
        "value": "S2S Methods"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Object} - result or an error object depending on the result",
        "value": "{Object} - result or an error object depending on the result"
      }
    ],
    "kind": "function",
    "name": "sendCorrectedChatMessage",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "id of the conversation",
        "name": "conversationId"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "id of the original message",
        "name": "origMsgId"
      },
      {
        "type": {
          "names": [
            "any"
          ]
        },
        "description": "The message object update. <br>\n{ <br>\n  \"message\": { <br>\n  \"subject\": \"Greeting\", <br>\n  \"lang\": \"en\", <br>\n  \"contents\": [ <br>\n    { <br>\n      \"type\": \"text/markdown\", <br>\n      \"data\": \"## Hello Bob\" <br>\n    } <br>\n  ], <br>\n  \"body\": \"Hello world\" <br>\n  } <br>\n} <br>",
        "name": "msg"
      }
    ],
    "description": "Send a corrected message in a conversation.  <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        }
      }
    ],
    "longname": "module:s2s#sendCorrectedChatMessage",
    "memberof": "module:s2s",
    "$longname": "s2s#sendCorrectedChatMessage",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method sendForwardChatMessage\n     * @instance\n     * @category S2S Methods\n     * @param {string} conversationId id of the conversation.\n     * @param {string} msgId Message id.\n     * @param {string} msg The message object to send. <br>\n     * { <br>\n     *   \"message\": { <br>\n     *   \"subject\": \"Greeting\", <br>\n     *   \"lang\": \"en\", <br>\n     *   \"contents\": [ <br>\n     *     { <br>\n     *       \"type\": \"text/markdown\", <br>\n     *       \"data\": \"## Hello Bob\" <br>\n     *     } <br>\n     *   ], <br>\n     *   \"body\": \"Hello world\" <br>\n     *   } <br>\n     * } <br>\n     * @param {string} conversationDestId the id of the destination conversation\n     *\n     *\n     * Destination conversation id\n     * @description\n     *      Forward a message from a conversation to another one. <br>\n     * @async\n     * @return {Promise<Object, ErrorManager>}\n     * @fulfil {Object} - result or an error object depending on the result\n     */",
    "meta": {
      "filename": "S2SService.js",
      "lineno": 530,
      "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": "S2S Methods",
        "value": "S2S Methods"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Object} - result or an error object depending on the result",
        "value": "{Object} - result or an error object depending on the result"
      }
    ],
    "kind": "function",
    "name": "sendForwardChatMessage",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "id of the conversation.",
        "name": "conversationId"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "Message id.",
        "name": "msgId"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The message object to send. <br>\n{ <br>\n  \"message\": { <br>\n  \"subject\": \"Greeting\", <br>\n  \"lang\": \"en\", <br>\n  \"contents\": [ <br>\n    { <br>\n      \"type\": \"text/markdown\", <br>\n      \"data\": \"## Hello Bob\" <br>\n    } <br>\n  ], <br>\n  \"body\": \"Hello world\" <br>\n  } <br>\n} <br>",
        "name": "msg"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "the id of the destination conversation\n\n\nDestination conversation id",
        "name": "conversationDestId"
      }
    ],
    "description": "Forward a message from a conversation to another one. <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        }
      }
    ],
    "longname": "module:s2s#sendForwardChatMessage",
    "memberof": "module:s2s",
    "$longname": "s2s#sendForwardChatMessage",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method sendMessageInConversation\n     * @instance\n     * @category S2S Methods\n     * @param {string} conversationId\n     * @param {any} msg The message object to send. <br>\n     * { <br>\n     *   \"message\": { <br>\n     *   \"subject\": \"Greeting\", <br>\n     *   \"lang\": \"en\", <br>\n     *   \"contents\": [ <br>\n     *     { <br>\n     *       \"type\": \"text/markdown\", <br>\n     *       \"data\": \"## Hello Bob\" <br>\n     *     } <br>\n     *   ], <br>\n     *   \"body\": \"Hello world\" <br>\n     *   } <br>\n     * } <br>\n     * @description\n     *      Send a message in a conversation. Note, corrected message is not yet supported. <br>\n     * @async\n     * @return {Promise<Object, ErrorManager>}\n     * @fulfil {Object} - result or an error object depending on the result\n     \n     */",
    "meta": {
      "filename": "S2SService.js",
      "lineno": 429,
      "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": "S2S Methods",
        "value": "S2S Methods"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Object} - result or an error object depending on the result",
        "value": "{Object} - result or an error object depending on the result"
      }
    ],
    "kind": "function",
    "name": "sendMessageInConversation",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "name": "conversationId"
      },
      {
        "type": {
          "names": [
            "any"
          ]
        },
        "description": "The message object to send. <br>\n{ <br>\n  \"message\": { <br>\n  \"subject\": \"Greeting\", <br>\n  \"lang\": \"en\", <br>\n  \"contents\": [ <br>\n    { <br>\n      \"type\": \"text/markdown\", <br>\n      \"data\": \"## Hello Bob\" <br>\n    } <br>\n  ], <br>\n  \"body\": \"Hello world\" <br>\n  } <br>\n} <br>",
        "name": "msg"
      }
    ],
    "description": "Send a message in a conversation. Note, corrected message is not yet supported. <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        }
      }
    ],
    "longname": "module:s2s#sendMessageInConversation",
    "memberof": "module:s2s",
    "$longname": "s2s#sendMessageInConversation",
    "$kind": "method"
  },
  {
    "comment": "/**\n * The state of the Chat in the conversation.\n * @public\n * @enum {string}\n * @readonly\n */",
    "meta": {
      "range": [
        28961,
        28970
      ],
      "filename": "S2SService.js",
      "lineno": 639,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {
        "id": "astnode100002280",
        "name": "CHATSTATE"
      }
    },
    "description": "The state of the Chat in the conversation.",
    "access": "public",
    "kind": "member",
    "isEnum": true,
    "type": {
      "names": [
        "string"
      ]
    },
    "readonly": true,
    "name": "CHATSTATE",
    "longname": "module:s2s~CHATSTATE",
    "scope": "inner",
    "memberof": "module:s2s",
    "params": [],
    "$longname": "s2s~CHATSTATE",
    "$kind": "enum"
  },
  {
    "comment": "/**\n * The role of the Contact in the Bubble.\n * @public\n * @enum {string}\n * @readonly\n */",
    "meta": {
      "range": [
        28700,
        28708
      ],
      "filename": "S2SService.js",
      "lineno": 628,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {
        "id": "astnode100002251",
        "name": "ROOMROLE"
      }
    },
    "description": "The role of the Contact in the Bubble.",
    "access": "public",
    "kind": "member",
    "isEnum": true,
    "type": {
      "names": [
        "string"
      ]
    },
    "readonly": true,
    "name": "ROOMROLE",
    "longname": "module:s2s~ROOMROLE",
    "scope": "inner",
    "memberof": "module:s2s",
    "params": [],
    "$longname": "s2s~ROOMROLE",
    "$kind": "enum"
  }
]