[
  {
    "comment": "/**\n * @module\n * @name GroupsService\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n * @description\n *              This service manages groups which allow to create his own lists of contacts. <br>\n *              <br><br>\n *              The main methods proposed in that module allow to: <br>\n *              - Get all groups of the user <br>\n *              - Create a new group <br>\n *              - Delete an existing group <br>\n *              - Add a contact in a group <br>\n *              - Remove a contact from a group <br>\n */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 17,
      "columnno": 0,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {}
    },
    "kind": "module",
    "name": "GroupsService",
    "version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z",
    "access": "public",
    "description": "This service manages groups which allow to create his own lists of contacts. <br>\n             <br><br>\n             The main methods proposed in that module allow to: <br>\n             - Get all groups of the user <br>\n             - Create a new group <br>\n             - Delete an existing group <br>\n             - Add a contact in a group <br>\n             - Remove a contact from a group <br>",
    "longname": "module:GroupsService",
    "$longname": "GroupsService",
    "$kind": "module"
  },
  {
    "comment": "",
    "meta": {
      "range": [
        1844,
        2846
      ],
      "filename": "GroupsService.js",
      "lineno": 37,
      "columnno": 4,
      "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
      "code": {
        "id": "astnode100000218",
        "name": "GroupsService_1",
        "type": "MethodDefinition",
        "paramnames": [
          "_core",
          "_eventEmitter",
          "_logger",
          "_startConfig"
        ]
      },
      "vars": {
        "": null
      }
    },
    "undocumented": true,
    "name": "GroupsService_1",
    "longname": "module:GroupsService.GroupsService_1",
    "kind": "class",
    "memberof": "module:GroupsService",
    "scope": "static",
    "params": [],
    "$longname": "GroupsService.GroupsService_1",
    "$kind": "constructor"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method addUserInGroup\n     * @instance\n     * @async\n     * @category Groups USERS\n     * @param {Contact} contact The user to add in group\n     * @param {Object} group The group\n     * @description\n     *          Add a contact in a group <br>\n     * @return {Promise<Object, ErrorManager>} The result\n     *\n     *\n     * | Champ | Type | Description |\n     * | --- | --- | --- |\n     * | data | Object | Group Object. |\n     * | id  | String | Group unique identifier. |\n     * | name | String | Group name. |\n     * | comment | String | Group comment. |\n     * | isFavorite | Boolean | Is group flagged as favorite. |\n     * | owner | String | Rainbow Id of group owner. |\n     * | creationDate | Date-Time | Creation date of the group (read only, set automatically during group creation). |\n     * | users | String\\[\\] | List of Rainbow users being in the group. |\n     *\n     * @fulfil {Group} - Updated group with the new contact added or an error object depending on the result\n     * @category async\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 609,
      "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": "Groups USERS",
        "value": "Groups USERS"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Updated group with the new contact added or an error object depending on the result",
        "value": "{Group} - Updated group with the new contact added or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "addUserInGroup",
    "scope": "instance",
    "async": true,
    "params": [
      {
        "type": {
          "names": [
            "Contact"
          ]
        },
        "description": "The user to add in group",
        "name": "contact"
      },
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The group",
        "name": "group"
      }
    ],
    "description": "Add a contact in a group <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result\n\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| data | Object | Group Object. |\n| id  | String | Group unique identifier. |\n| name | String | Group name. |\n| comment | String | Group comment. |\n| isFavorite | Boolean | Is group flagged as favorite. |\n| owner | String | Rainbow Id of group owner. |\n| creationDate | Date-Time | Creation date of the group (read only, set automatically during group creation). |\n| users | String\\[\\] | List of Rainbow users being in the group. |"
      }
    ],
    "longname": "module:GroupsService#addUserInGroup",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#addUserInGroup",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method createGroup\n     * @instance\n     * @param {string} name The name of the group to create\n     * @param {string} comment The comment of the group to create\n     * @param {boolean} isFavorite If true, the group is flagged as favorite\n     * @description\n     *      Create a new group <br>\n     * @async\n     * @category Groups MANAGEMENT\n     * @return {Promise<Object, ErrorManager>} The result\n     * @fulfil {Group} - Created group object or an error object depending on the result\n     * @category async\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 126,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Created group object or an error object depending on the result",
        "value": "{Group} - Created group object or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "createGroup",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The name of the group to create",
        "name": "name"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The comment of the group to create",
        "name": "comment"
      },
      {
        "type": {
          "names": [
            "boolean"
          ]
        },
        "description": "If true, the group is flagged as favorite",
        "name": "isFavorite"
      }
    ],
    "description": "Create a new group <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result"
      }
    ],
    "longname": "module:GroupsService#createGroup",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#createGroup",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method deleteAllGroups\n     * @instance\n     * @async\n     * @category Groups MANAGEMENT\n     * @description\n     *    Delete all existing owned groups <br>\n     *    Return a promise <br>\n     * @return {Object} Nothing or an error object depending on the result\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 205,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      }
    ],
    "kind": "function",
    "name": "deleteAllGroups",
    "scope": "instance",
    "async": true,
    "description": "Delete all existing owned groups <br>\n   Return a promise <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "Nothing or an error object depending on the result"
      }
    ],
    "longname": "module:GroupsService#deleteAllGroups",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#deleteAllGroups",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method deleteGroup\n     * @instance\n     * @param {Object} group The group to delete\n     * @description\n     *    Delete an owned group <br>\n     * @async\n     * @category Groups MANAGEMENT\n     * @return {Promise<Object, ErrorManager>} The result\n     * @fulfil {Group} - Deleted group object or an error object depending on the result\n     * @category async\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 164,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Deleted group object or an error object depending on the result",
        "value": "{Group} - Deleted group object or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "deleteGroup",
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The group to delete",
        "name": "group"
      }
    ],
    "description": "Delete an owned group <br>",
    "async": true,
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result"
      }
    ],
    "longname": "module:GroupsService#deleteGroup",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#deleteGroup",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method getAll\n     * @category Groups MANAGEMENT\n     * @instance\n     * @return {Array} The list of existing groups with following fields: id, name, comment, isFavorite, owner, creationDate, array of users in the group\n     * @description\n     *  Return the list of existing groups <br>\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 458,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      }
    ],
    "kind": "function",
    "name": "getAll",
    "scope": "instance",
    "returns": [
      {
        "type": {
          "names": [
            "Array"
          ]
        },
        "description": "The list of existing groups with following fields: id, name, comment, isFavorite, owner, creationDate, array of users in the group"
      }
    ],
    "description": "Return the list of existing groups <br>",
    "longname": "module:GroupsService#getAll",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#getAll",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method getFavoriteGroups\n     * @category Groups MANAGEMENT\n     * @instance\n     * @return {Array} The list of favorite groups with following fields: id, name, comment, isFavorite, owner, creationDate, array of users in the group\n     * @description\n     *  Return the list of favorite groups <br>\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 473,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      }
    ],
    "kind": "function",
    "name": "getFavoriteGroups",
    "scope": "instance",
    "returns": [
      {
        "type": {
          "names": [
            "Array"
          ]
        },
        "description": "The list of favorite groups with following fields: id, name, comment, isFavorite, owner, creationDate, array of users in the group"
      }
    ],
    "description": "Return the list of favorite groups <br>",
    "longname": "module:GroupsService#getFavoriteGroups",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#getFavoriteGroups",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method getGroupById\n     * @category Groups MANAGEMENT\n     * @instance\n     * @async\n     * @param {String} id group Id of the group to found\n     * @return {Promise<any>} The group found if exist or undefined\n     * @description\n     *  Return a group by its id <br>\n     */",
    "meta": {
      "filename": "GroupsService.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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      }
    ],
    "kind": "function",
    "name": "getGroupById",
    "scope": "instance",
    "async": true,
    "params": [
      {
        "type": {
          "names": [
            "String"
          ]
        },
        "description": "group Id of the group to found",
        "name": "id"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<any>"
          ]
        },
        "description": "The group found if exist or undefined"
      }
    ],
    "description": "Return a group by its id <br>",
    "longname": "module:GroupsService#getGroupById",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#getGroupById",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method getGroupByName\n     * @category Groups MANAGEMENT\n     * @instance\n     * @async\n     * @param {String} name Name of the group to found\n     * @param {boolean} forceServerSearch=false force the update from server.\n     * @return {Promise<any>} The group found if exist or undefined\n     * @description\n     *  Return a group by its id <br>\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 548,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      }
    ],
    "kind": "function",
    "name": "getGroupByName",
    "scope": "instance",
    "async": true,
    "params": [
      {
        "type": {
          "names": [
            "String"
          ]
        },
        "description": "Name of the group to found",
        "name": "name"
      },
      {
        "type": {
          "names": [
            "boolean"
          ]
        },
        "defaultvalue": false,
        "description": "force the update from server.",
        "name": "forceServerSearch"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<any>"
          ]
        },
        "description": "The group found if exist or undefined"
      }
    ],
    "description": "Return a group by its id <br>",
    "longname": "module:GroupsService#getGroupByName",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#getGroupByName",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method removeUserFromGroup\n     * @instance\n     * @async\n     * @category Groups USERS\n     * @param {Contact} contact The user to remove from the group\n     * @param {Object} group The destination group\n     * @description\n     *          Remove a contact from a group <br>\n     * @return {Promise<Object, ErrorManager>} The result\n     * @fulfil {Group} - Updated group without the removed contact or an error object depending on the result\n     * @category async\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 674,
      "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": "Groups USERS",
        "value": "Groups USERS"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Updated group without the removed contact or an error object depending on the result",
        "value": "{Group} - Updated group without the removed contact or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "removeUserFromGroup",
    "scope": "instance",
    "async": true,
    "params": [
      {
        "type": {
          "names": [
            "Contact"
          ]
        },
        "description": "The user to remove from the group",
        "name": "contact"
      },
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The destination group",
        "name": "group"
      }
    ],
    "description": "Remove a contact from a group <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result"
      }
    ],
    "longname": "module:GroupsService#removeUserFromGroup",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#removeUserFromGroup",
    "$kind": "method"
  },
  {
    "comment": "/**\n    * @public\n     * @nodered true\n     * @method setGroupAsFavorite\n    * @since 1.67.0\n    * @async\n    * @category Groups MANAGEMENT\n    * @instance\n    * @param {Object} group The group\n    * @description\n    *          Set a group as a favorite one of the curent loggued in user. <br>\n    * @return {Promise<Object, ErrorManager>} The result\n    * @fulfil {Group} - Updated group or an error object depending on the result\n    * @category async\n    */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 388,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Updated group or an error object depending on the result",
        "value": "{Group} - Updated group or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "setGroupAsFavorite",
    "since": "1.67.0",
    "async": true,
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The group",
        "name": "group"
      }
    ],
    "description": "Set a group as a favorite one of the curent loggued in user. <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result"
      }
    ],
    "longname": "module:GroupsService#setGroupAsFavorite",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#setGroupAsFavorite",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method unsetGroupAsFavorite\n     * @since 1.67.0\n     * @category Groups MANAGEMENT\n     * @async\n     * @instance\n     * @param {Object} group The group\n     * @description\n     *          Remove the favorite state of a group of the curent loggued in user. <br>\n     * @return {Promise<Object, ErrorManager>} The result\n     * @fulfil {Group} - Updated group or an error object depending on the result\n     * @category async\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 423,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Updated group or an error object depending on the result",
        "value": "{Group} - Updated group or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "unsetGroupAsFavorite",
    "since": "1.67.0",
    "async": true,
    "scope": "instance",
    "params": [
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The group",
        "name": "group"
      }
    ],
    "description": "Remove the favorite state of a group of the curent loggued in user. <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result"
      }
    ],
    "longname": "module:GroupsService#unsetGroupAsFavorite",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#unsetGroupAsFavorite",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method updateGroupComment\n     * @instance\n     * @async\n     * @category Groups MANAGEMENT\n     * @param {Object} group The group to update\n     * @param {string} comment The new comment of the group\n     * @description\n     *          Update the comment of a group <br>\n     * @return {Promise<Object, ErrorManager>} The result\n     * @fulfil {Group} - Updated group object or an error object depending on the result\n     * @category async\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 300,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Updated group object or an error object depending on the result",
        "value": "{Group} - Updated group object or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "updateGroupComment",
    "scope": "instance",
    "async": true,
    "params": [
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The group to update",
        "name": "group"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The new comment of the group",
        "name": "comment"
      }
    ],
    "description": "Update the comment of a group <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result"
      }
    ],
    "longname": "module:GroupsService#updateGroupComment",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#updateGroupComment",
    "$kind": "method"
  },
  {
    "comment": "/**\n     * @public\n     * @nodered true\n     * @method updateGroupName\n     * @instance\n     * @async\n     * @category Groups MANAGEMENT\n     * @param {Object} group The group to update\n     * @param {string} name The new name of the group\n     * @description\n     *          Update the name of a group <br>\n     * @return {Promise<Object, ErrorManager>} The result\n     * @fulfil {Group} - Updated group object or an error object depending on the result\n     * @category async\n     */",
    "meta": {
      "filename": "GroupsService.js",
      "lineno": 246,
      "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": "Groups MANAGEMENT",
        "value": "Groups MANAGEMENT"
      },
      {
        "originalTitle": "fulfil",
        "title": "fulfil",
        "text": "{Group} - Updated group object or an error object depending on the result",
        "value": "{Group} - Updated group object or an error object depending on the result"
      },
      {
        "originalTitle": "category",
        "title": "category",
        "text": "async",
        "value": "async"
      }
    ],
    "kind": "function",
    "name": "updateGroupName",
    "scope": "instance",
    "async": true,
    "params": [
      {
        "type": {
          "names": [
            "Object"
          ]
        },
        "description": "The group to update",
        "name": "group"
      },
      {
        "type": {
          "names": [
            "string"
          ]
        },
        "description": "The new name of the group",
        "name": "name"
      }
    ],
    "description": "Update the name of a group <br>",
    "returns": [
      {
        "type": {
          "names": [
            "Promise.<Object, ErrorManager>"
          ]
        },
        "description": "The result"
      }
    ],
    "longname": "module:GroupsService#updateGroupName",
    "memberof": "module:GroupsService",
    "$longname": "GroupsService#updateGroupName",
    "$kind": "method"
  }
]