[
  {
    "comment": "/**\n* @module\n* @name FavoritesService\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n* @description\n*      This module is the basic module for handling Favorites in Rainbow. In Rainbow, Favorites are the way to list a most frequent, most used or the most important conversations, bubbles and bots. <br>\n*      The main methods and events proposed in that service allow to: <br>\n*      - Create or delete a Rainbow Favorite (one-to-one, bubble or bot), <br>\n*      - Retrieve all information linked to that Favorite, <br>\n*/",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 21,
      "columnno": 0,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "kind": "module",
    "name": "FavoritesService",
    "version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z",
    "access": "public",
    "description": "This module is the basic module for handling Favorites in Rainbow. In Rainbow, Favorites are the way to list a most frequent, most used or the most important conversations, bubbles and bots. <br>\n     The main methods and events proposed in that service allow to: <br>\n     - Create or delete a Rainbow Favorite (one-to-one, bubble or bot), <br>\n     - Retrieve all information linked to that Favorite, <br>",
    "longname": "module:FavoritesService",
    "$longname": "FavoritesService",
    "$kind": "module"
  },
  {
    "comment": "",
    "meta": {
      "range": [
        2089,
        3272
      ],
      "filename": "FavoritesService.js",
      "lineno": 37,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {
        "id": "astnode100000242",
        "name": "FavoritesService_1",
        "type": "MethodDefinition",
        "paramnames": [
          "_core",
          "_eventEmitter",
          "_logger",
          "_startConfig"
        ]
      },
      "vars": {
        "": null
      }
    },
    "undocumented": true,
    "name": "FavoritesService_1",
    "longname": "module:FavoritesService.FavoritesService_1",
    "kind": "class",
    "memberof": "module:FavoritesService",
    "scope": "static",
    "params": [],
    "$longname": "FavoritesService.FavoritesService_1",
    "$kind": "constructor"
  },
  {
    "comment": "/**\n     * @public\n     * @since 2.21.0\n     * @nodered true\n     * @method checkIsPeerSettedAsFavorite\n     * @category Favorites GET\n     * @instance\n     * @param {string} peerId peerId unique identifier\n     * @description\n     *   This API can be used to check if a given peerId is in user's favorites. <br>\n     * @return {Array<Favorite>} The result\n     *\n     *\n     * | Champ | Type | Description |\n     * | --- | --- | --- |\n     * | isFavorite | Boolean | true if the requested peerId is in user's favorites, false otherwise. |\n     *\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 404,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "since": "2.21.0",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Favorites GET",
        "value": "Favorites GET"
      }
    ],
    "kind": "function",
    "name": "checkIsPeerSettedAsFavorite",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "peerId unique identifier",
        "name": "peerId"
      }
    ],
    "description": "This API can be used to check if a given peerId is in user's favorites. <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Array.<Favorite>"
          ]
        },
        "description": "The result\n\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| isFavorite | Boolean | true if the requested peerId is in user's favorites, false otherwise. |"
      }
    ],
    "longname": "module:FavoritesService#checkIsPeerSettedAsFavorite",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#checkIsPeerSettedAsFavorite",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @since 1.56\n     * @method createFavorite()\n     * @category Favorites MANAGEMENT\n     * @instance\n     * @description\n     *   Add conversation/bubble/bot to Favorites Array <br>\n     * @param {string} id of the conversation/bubble\n     * @param {string} type of Favorite (can be 'user' or 'bubble')\n     * @return {Promise<Favorite>} A Favorite object\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 279,
      "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": "Favorites MANAGEMENT",
        "value": "Favorites MANAGEMENT"
      }
    ],
    "since": "1.56",
    "kind": "function",
    "name": "createFavorite()",
    "scope": "instance",
    "description": "Add conversation/bubble/bot to Favorites Array <br>",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "of the conversation/bubble",
        "name": "id"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "of Favorite (can be 'user' or 'bubble')",
        "name": "type"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Favorite>"
          ]
        },
        "description": "A Favorite object"
      }
    ],
    "longname": "module:FavoritesService#createFavorite()",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#createFavorite()",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @since 1.56\n     * @nodered true\n     * @method deleteFavorite()\n     * @category Favorites MANAGEMENT\n     * @instance\n     * @description\n     *   Delete conversation/bubble/bot from Favorites Array <br>\n     * @param {string} id of the Favorite item\n     * @return {Favorite[]} A Favorite object\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 322,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "since": "1.56",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Favorites MANAGEMENT",
        "value": "Favorites MANAGEMENT"
      }
    ],
    "kind": "function",
    "name": "deleteFavorite()",
    "scope": "instance",
    "description": "Delete conversation/bubble/bot from Favorites Array <br>",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "of the Favorite item",
        "name": "id"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Array.<Favorite>"
          ]
        },
        "description": "A Favorite object"
      }
    ],
    "longname": "module:FavoritesService#deleteFavorite()",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#deleteFavorite()",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @since 1.56\n     * @nodered true\n     * @method fetchAllFavorites\n     * @category Favorites GET\n     * @instance\n     * @param {string} peerId Allows to retrieve only the requested peerId(s) from user's favorites\n     * @description\n     *   Fetch all the Favorites from the server in a form of an Array <br>\n     * @return {Array<Favorite>} An array of Favorite objects\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 374,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "since": "1.56",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Favorites GET",
        "value": "Favorites GET"
      }
    ],
    "kind": "function",
    "name": "fetchAllFavorites",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "Allows to retrieve only the requested peerId(s) from user's favorites",
        "name": "peerId"
      }
    ],
    "description": "Fetch all the Favorites from the server in a form of an Array <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Array.<Favorite>"
          ]
        },
        "description": "An array of Favorite objects"
      }
    ],
    "longname": "module:FavoritesService#fetchAllFavorites",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#fetchAllFavorites",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @since 2.21.0\n     * @method getAllUserFavoriteList\n     * @category Favorites GET\n     * @instance\n     * @param {string} peerId Allows to retrieve only the requested peerId(s) from user's favorites.\n     * @description\n     *   This API can be used to retrieve the list of user's favorites. <br>\n     * @return {Array<Favorite>} The result\n     *\n     *\n     *  Array of Favorites.\n     *\n     * | Champ | Type | Description |\n     * | --- | --- | --- |\n     * | id  | String | Id of the favorite. |\n     * | peerId | String | userId, roomId, botId, directoryId or office365Id of the favorite. |\n     * | position | Integer | position of the favorite in favorite list (first position is 0). |\n     * | type | string | Type of the favorite peer:<br><br>* `user` for User to User favorite type,<br>* `room` for User to Room favorite type.<br>* `bot` for User to Bot service favorite type.<br>* `directory` for User to Directory service favorite type.<br>* `office365` for User to Office365 service favorite type.<br><br>Possibles values : `\"user\"`, `\"room\"`, `\"bot\"`, `\"directory\"`, `\"office365\"` |\n     *\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 477,
      "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": "Favorites GET",
        "value": "Favorites GET"
      }
    ],
    "since": "2.21.0",
    "kind": "function",
    "name": "getAllUserFavoriteList",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "Allows to retrieve only the requested peerId(s) from user's favorites.",
        "name": "peerId"
      }
    ],
    "description": "This API can be used to retrieve the list of user's favorites. <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Array.<Favorite>"
          ]
        },
        "description": "The result\n\n\n Array of Favorites.\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| id  | String | Id of the favorite. |\n| peerId | String | userId, roomId, botId, directoryId or office365Id of the favorite. |\n| position | Integer | position of the favorite in favorite list (first position is 0). |\n| type | string | Type of the favorite peer:<br><br>* `user` for User to User favorite type,<br>* `room` for User to Room favorite type.<br>* `bot` for User to Bot service favorite type.<br>* `directory` for User to Directory service favorite type.<br>* `office365` for User to Office365 service favorite type.<br><br>Possibles values : `\"user\"`, `\"room\"`, `\"bot\"`, `\"directory\"`, `\"office365\"` |"
      }
    ],
    "longname": "module:FavoritesService#getAllUserFavoriteList",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#getAllUserFavoriteList",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method getFavorite\n     * @category Favorites GET\n     * @instance\n     * @description\n     * get favorite from cache by Id.\n     * @param {string} peerId The id of the favorite.\n     * @return {Promise<Favorite>} The favorite corresponding to the peerId\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 355,
      "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": "Favorites GET",
        "value": "Favorites GET"
      }
    ],
    "kind": "function",
    "name": "getFavorite",
    "scope": "instance",
    "description": "get favorite from cache by Id.",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The id of the favorite.",
        "name": "peerId"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Favorite>"
          ]
        },
        "description": "The favorite corresponding to the peerId"
      }
    ],
    "longname": "module:FavoritesService#getFavorite",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#getFavorite",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @since 2.21.0\n     * @nodered true\n     * @method getFavoriteById\n     * @category Favorites GET\n     * @instance\n     * @param {string} favoriteId Favorite unique identifier\n     * @description\n     *   This API can be used to retrieve a specific user's favorite by Id. <br>\n     * @return {Array<Favorite>} The result\n     *\n     *\n     * | Champ | Type | Description |\n     * | --- | --- | --- |\n     * | id  | String | Id of the favorite. |\n     * | peerId | String | userId, roomId, botId, directoryId or office365Id of the favorite. |\n     * | position | Integer | position of the favorite in favorite list (first position is 0). |\n     * | type | string | Type of the favorite peer:<br><br>* `user` for User to User favorite type,<br>* `room` for User to Room favorite type.<br>* `bot` for User to Bot service favorite type.<br>* `directory` for User to Directory service favorite type.<br>* `office365` for User to Office365 service favorite type.<br><br>Possibles values : `\"user\"`, `\"room\"`, `\"bot\"`, `\"directory\"`, `\"office365\"` |\n     *\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 439,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "since": "2.21.0",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Favorites GET",
        "value": "Favorites GET"
      }
    ],
    "kind": "function",
    "name": "getFavoriteById",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "Favorite unique identifier",
        "name": "favoriteId"
      }
    ],
    "description": "This API can be used to retrieve a specific user's favorite by Id. <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Array.<Favorite>"
          ]
        },
        "description": "The result\n\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| id  | String | Id of the favorite. |\n| peerId | String | userId, roomId, botId, directoryId or office365Id of the favorite. |\n| position | Integer | position of the favorite in favorite list (first position is 0). |\n| type | string | Type of the favorite peer:<br><br>* `user` for User to User favorite type,<br>* `room` for User to Room favorite type.<br>* `bot` for User to Bot service favorite type.<br>* `directory` for User to Directory service favorite type.<br>* `office365` for User to Office365 service favorite type.<br><br>Possibles values : `\"user\"`, `\"room\"`, `\"bot\"`, `\"directory\"`, `\"office365\"` |"
      }
    ],
    "longname": "module:FavoritesService#getFavoriteById",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#getFavoriteById",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @since 2.21.0\n     * @nodered true\n     * @method moveFavoriteToPosition\n     * @category Favorites GET\n     * @instance\n     * @description\n     *   This API can be used to update a favorite's position in favorite list. <br>\n     * @return {Array<Favorite>} The result\n     *\n     *\n     * | Champ | Type | Description |\n     * | --- | --- | --- |\n     * | id  | String | Id of the favorite. |\n     * | peerId | String | userId, roomId, botId, directoryId or office365Id of the favorite. |\n     * | position | Integer | position of the favorite in favorite list (first position is 0). |\n     * | type | string | Type of the favorite peer:<br><br>* `user` for User to User favorite type,<br>* `room` for User to Room favorite type.<br>* `bot` for User to Bot service favorite type.<br>* `directory` for User to Directory service favorite type.<br>* `office365` for User to Office365 service favorite type.<br><br>Possibles values : `\"user\"`, `\"room\"`, `\"bot\"`, `\"directory\"`, `\"office365\"` |\n     *\n     * @param {string} favoriteId Favorite unique identifier\n     * @param {number} position=1 new position in list. If position exceed favorites list size the favorite is moved to the end of the list\n     */",
    "meta": {
      "filename": "FavoritesService.js",
      "lineno": 517,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "access": "public",
    "since": "2.21.0",
    "tags": [
      {
        "originalTitle": "nodered",
        "title": "nodered",
        "text": "true",
        "value": "true"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "Favorites GET",
        "value": "Favorites GET"
      }
    ],
    "kind": "function",
    "name": "moveFavoriteToPosition",
    "scope": "instance",
    "description": "This API can be used to update a favorite's position in favorite list. <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Array.<Favorite>"
          ]
        },
        "description": "The result\n\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| id  | String | Id of the favorite. |\n| peerId | String | userId, roomId, botId, directoryId or office365Id of the favorite. |\n| position | Integer | position of the favorite in favorite list (first position is 0). |\n| type | string | Type of the favorite peer:<br><br>* `user` for User to User favorite type,<br>* `room` for User to Room favorite type.<br>* `bot` for User to Bot service favorite type.<br>* `directory` for User to Directory service favorite type.<br>* `office365` for User to Office365 service favorite type.<br><br>Possibles values : `\"user\"`, `\"room\"`, `\"bot\"`, `\"directory\"`, `\"office365\"` |"
      }
    ],
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "Favorite unique identifier",
        "name": "favoriteId"
      },
      {
        "type": {
          "names": [
            "number"
          ]
        },
        "defaultvalue": 1,
        "description": "new position in list. If position exceed favorites list size the favorite is moved to the end of the list",
        "name": "position"
      }
    ],
    "longname": "module:FavoritesService#moveFavoriteToPosition",
    "memberof": "module:FavoritesService",
    "$longname": "FavoritesService#moveFavoriteToPosition",
    "$kind": "method"
  }
]