[ { "comment": "/**\n * @module\n * @name ChannelsService\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n * @description\n * This service manages ChannelsService. This service is in Beta.
\n *

\n * The main methods proposed in that module allow to:
\n * - Create a new channel
\n * - Manage a channel: update, delete
\n * - Manage users in a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 22, "columnno": 0, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": {} }, "kind": "module", "name": "ChannelsService", "version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z", "access": "public", "description": "This service manages ChannelsService. This service is in Beta.
\n

\n The main methods proposed in that module allow to:
\n - Create a new channel
\n - Manage a channel: update, delete
\n - Manage users in a channel
", "longname": "module:ChannelsService", "$longname": "ChannelsService", "$kind": "module" }, { "comment": "", "meta": { "range": [ 1966, 4375 ], "filename": "ChannelsService.js", "lineno": 40, "columnno": 4, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": { "id": "astnode100000248", "name": "ChannelsService_1", "type": "MethodDefinition", "paramnames": [ "_core", "_eventEmitter", "_logger", "_startConfig" ] }, "vars": { "": null } }, "undocumented": true, "name": "ChannelsService_1", "longname": "module:ChannelsService.ChannelsService_1", "kind": "class", "memberof": "module:ChannelsService", "scope": "static", "params": [], "$longname": "ChannelsService.ChannelsService_1", "$kind": "constructor" }, { "comment": "/**\n * @public\n * @nodered true\n * @method addMembersToChannel\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} members array of users to add\n * @return {Promise} The updated channel\n * @description\n * Add a list of members to the channel by loginEmail
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1904, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "addMembersToChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "array of users to add", "name": "members" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "Add a list of members to the channel by loginEmail
", "longname": "module:ChannelsService#addMembersToChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#addMembersToChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method addMembersToChannelByLoginEmails\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} members array of users loginEmail to add\n * collection of owners loginEmails\n * [\n * {\n * loginEmail : string, // Rainbow user loginEmail.\n * }\n * ]\n *\n * @return {Promise} The updated channel\n * @description\n * Add a list of members to the channel by loginEmail
\n *\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1944, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "addMembersToChannelByLoginEmails", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "array of users loginEmail to add\ncollection of owners loginEmails\n[\n {\n loginEmail : string, // Rainbow user loginEmail.\n }\n]", "name": "members" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "Add a list of members to the channel by loginEmail
", "longname": "module:ChannelsService#addMembersToChannelByLoginEmails", "memberof": "module:ChannelsService", "$longname": "ChannelsService#addMembersToChannelByLoginEmails", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method addOwnersToChannel\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array}owners Array of owners to add.\n * @return {Promise} The updated channel\n * @description\n * Add a list of owners to the channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1730, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "addOwnersToChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "Array of owners to add.", "name": "owners" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "Add a list of owners to the channel
", "longname": "module:ChannelsService#addOwnersToChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#addOwnersToChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method addOwnersToChannelByLoginEmails\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} owners Array of loginEmail of owners.\n * collection of owners loginEmails\n * [\n * {\n * loginEmail : string, // Rainbow user loginEmail.\n * }\n * ]\n *\n * @return {Promise} The updated channel\n * @description\n * Add a list of owners to the channel by loginEmail
\n *\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1762, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "addOwnersToChannelByLoginEmails", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "Array of loginEmail of owners.\ncollection of owners loginEmails\n[\n {\n loginEmail : string, // Rainbow user loginEmail.\n }\n]", "name": "owners" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "Add a list of owners to the channel by loginEmail
", "longname": "module:ChannelsService#addOwnersToChannelByLoginEmails", "memberof": "module:ChannelsService", "$longname": "ChannelsService#addOwnersToChannelByLoginEmails", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method addPublishersToChannel\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} publishers The list of Contacts to add as publisher to channel.\n * @return {Promise} The updated channel\n * @description\n * Add a list of publishers to the channel
\n *\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1817, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "addPublishersToChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "The list of Contacts to add as publisher to channel.", "name": "publishers" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "Add a list of publishers to the channel
", "longname": "module:ChannelsService#addPublishersToChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#addPublishersToChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method addPublishersToChannelByLoginEmails\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} publishers The list of Contacts loginEmails to add as publisher to channel.\n * collection of owners loginEmails\n * [\n * {\n * loginEmail : string, // Rainbow user loginEmail.\n * }\n * ]\n *\n * @return {Promise} The updated channel\n * @description\n * Add a list of publishers to the channel by loginEmail
\n *\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1850, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "addPublishersToChannelByLoginEmails", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "The list of Contacts loginEmails to add as publisher to channel.\ncollection of owners loginEmails\n[\n {\n loginEmail : string, // Rainbow user loginEmail.\n }\n]", "name": "publishers" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "Add a list of publishers to the channel by loginEmail
", "longname": "module:ChannelsService#addPublishersToChannelByLoginEmails", "memberof": "module:ChannelsService", "$longname": "ChannelsService#addPublishersToChannelByLoginEmails", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method createChannel\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {string} name The name of the channel to create (max-length=255)\n * @param {string} channelTopic The description of the channel to create (max-length=255)\n * @return {Promise} New Channel\n * @description\n * Create a new public channel with a visibility limited to my company
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 160, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "createChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "string" ] }, "description": "The name of the channel to create (max-length=255)", "name": "name" }, { "type": { "names": [ "string" ] }, "description": "The description of the channel to create (max-length=255)", "name": "channelTopic" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "New Channel" } ], "description": "Create a new public channel with a visibility limited to my company
", "longname": "module:ChannelsService#createChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#createChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method createClosedChannel (ex: createPrivateChannel)\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {string} name The name of the channel to create (max-length=255)\n * @param {string} description The description of the channel to create (max-length=255)\n * @param {string} category=\"\" The category of the channel\n * @return {Promise} New Channel\n * @description\n * (old createPrivateChannel)\n * Create a new closed channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 213, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "createClosedChannel ", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "string" ] }, "description": "The name of the channel to create (max-length=255)", "name": "name" }, { "type": { "names": [ "string" ] }, "description": "The description of the channel to create (max-length=255)", "name": "description" }, { "type": { "names": [ "string" ] }, "defaultvalue": "\"\"", "description": "The category of the channel", "name": "category" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "New Channel" } ], "description": "(old createPrivateChannel)\n Create a new closed channel
", "longname": "createClosedChannel (ex: createPrivateChannel)", "variation": "ex: createPrivateChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#createClosedChannel (ex: createPrivateChannel)", "$kind": "method" }, { "comment": "/**\n * @public\n * @method createItem\n * @instance\n * @async\n * @category Channels MESSAGES/ITEMS\n * @param {Channel} channel The channel where to publish the message\n * @param {string} message Message content\n * @param {string} title=\"\" Message title, limit=256.\n * @param {string} url=\"\" An URL\n * @param {any} imagesIds An Array of ids of the files stored in Rainbow\n * @param {string} type=\"basic\" An optional message content type (could be basic, markdown, html or data)\n * @param {Object} customDatas={} A JSON object with custom datas merged to the payload send to server.\n * @return {Promise} OK if successfull\n * @description\n * Publish to a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1101, "columnno": 4, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": {} }, "access": "public", "kind": "function", "name": "createItem", "scope": "instance", "async": true, "tags": [ { "originalTitle": "category", "title": "category", "text": "Channels MESSAGES/ITEMS", "value": "Channels MESSAGES/ITEMS" } ], "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel where to publish the message", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "Message content", "name": "message" }, { "type": { "names": [ "string" ] }, "defaultvalue": "\"\"", "description": "Message title, limit=256.", "name": "title" }, { "type": { "names": [ "string" ] }, "defaultvalue": "\"\"", "description": "An URL", "name": "url" }, { "type": { "names": [ "any" ] }, "description": "An Array of ids of the files stored in Rainbow", "name": "imagesIds" }, { "type": { "names": [ "string" ] }, "defaultvalue": "\"basic\"", "description": "An optional message content type (could be basic, markdown, html or data)", "name": "type" }, { "type": { "names": [ "Object" ] }, "defaultvalue": "{}", "description": "A JSON object with custom datas merged to the payload send to server.", "name": "customDatas" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "OK if successfull" } ], "description": "Publish to a channel
", "longname": "module:ChannelsService#createItem", "memberof": "module:ChannelsService", "$longname": "ChannelsService#createItem", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method createPublicChannel\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {string} name The name of the channel to create (max-length=255)\n * @param {string} channelTopic The description of the channel to create (max-length=255)\n * @param {string} category=\"\" The category of the channel\n * @return {Promise} New Channel\n * @description\n * Create a new public channel with a visibility limited to my company
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 177, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "createPublicChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "string" ] }, "description": "The name of the channel to create (max-length=255)", "name": "name" }, { "type": { "names": [ "string" ] }, "description": "The description of the channel to create (max-length=255)", "name": "channelTopic" }, { "type": { "names": [ "string" ] }, "defaultvalue": "\"\"", "description": "The category of the channel", "name": "category" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "New Channel" } ], "description": "Create a new public channel with a visibility limited to my company
", "longname": "module:ChannelsService#createPublicChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#createPublicChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method deleteAllUsersFromChannel\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @return {Promise} The channel updated\n * @description\n * (old removeAllUsersFromChannel)\n * Remove all users from a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1571, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "deleteAllUsersFromChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The channel updated" } ], "description": "(old removeAllUsersFromChannel)\n Remove all users from a channel
", "longname": "module:ChannelsService#deleteAllUsersFromChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#deleteAllUsersFromChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method deleteChannel\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {Channel} channel The channel to delete\n * @return {Promise} Promise object represents The channel deleted\n * @description\n * Delete an owned channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 250, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "deleteChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to delete", "name": "channel" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "Promise object represents The channel deleted" } ], "description": "Delete an owned channel
", "longname": "module:ChannelsService#deleteChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#deleteChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method deleteChannelAvatar\n * @since 1.43\n * @instance\n * @category Channels MANAGEMENT\n * @description\n * Delete a channel avatar
\n * Return a promise.
\n * @param {Channel} channel The channel to update\n * @return {Channel} Return the channel updated or an error\n */", "meta": { "filename": "ChannelsService.js", "lineno": 930, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "deleteChannelAvatar", "since": "1.43", "scope": "instance", "description": "Delete a channel avatar
\n Return a promise.
", "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to update", "name": "channel" } ], "returns": [ { "type": { "names": [ "Channel" ] }, "description": "Return the channel updated or an error" } ], "longname": "module:ChannelsService#deleteChannelAvatar", "memberof": "module:ChannelsService", "$longname": "ChannelsService#deleteChannelAvatar", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method deleteItemFromChannel\n * @instance\n * @async\n * @category Channels MESSAGES/ITEMS\n * @param {string} channelId The Id of the channel\n * @param {string} itemId The Id of the item\n * @return {Promise} The channel updated\n * @description\n * (old deleteMessageFromChannel)\n * Delete a message from a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1220, "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": "Channels MESSAGES/ITEMS", "value": "Channels MESSAGES/ITEMS" } ], "kind": "function", "name": "deleteItemFromChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "string" ] }, "description": "The Id of the channel", "name": "channelId" }, { "type": { "names": [ "string" ] }, "description": "The Id of the item", "name": "itemId" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The channel updated" } ], "description": "(old deleteMessageFromChannel)\n Delete a message from a channel
", "longname": "module:ChannelsService#deleteItemFromChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#deleteItemFromChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method deleteUsersFromChannel\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} users An array of users to remove\n * @return {Promise} The updated channel\n * @description\n * (old removeUsersFromChannel1)\n * Remove a list of users from a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 2007, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "deleteUsersFromChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "An array of users to remove", "name": "users" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "(old removeUsersFromChannel1)\n Remove a list of users from a channel
", "longname": "module:ChannelsService#deleteUsersFromChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#deleteUsersFromChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method deleteUsersFromChannelByLoginEmails\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} users An array of loginEmail of users to remove\n * collection of owners loginEmails\n * [\n * {\n * loginEmail : string, // Rainbow user loginEmail.\n * }\n * ]\n *\n * @return {Promise} The updated channel\n * @description\n * (old removeUsersFromChannel1)\n * Remove a list of users from a channel by loginEmail
\n *\n */", "meta": { "filename": "ChannelsService.js", "lineno": 2040, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "deleteUsersFromChannelByLoginEmails", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "An array of loginEmail of users to remove\ncollection of owners loginEmails\n[\n {\n loginEmail : string, // Rainbow user loginEmail.\n }\n]", "name": "users" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The updated channel" } ], "description": "(old removeUsersFromChannel1)\n Remove a list of users from a channel by loginEmail
", "longname": "module:ChannelsService#deleteUsersFromChannelByLoginEmails", "memberof": "module:ChannelsService", "$longname": "ChannelsService#deleteUsersFromChannelByLoginEmails", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method fetchChannel\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {string} id The id of the channel)\n * @param {boolean} force=false True to force a request to the server\n * @return {Promise} The channel found\n * @description\n * (old getChannelById)\n * Find a channel by its id (locally if exists or by sending a request to Rainbow)
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 375, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "fetchChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "string" ] }, "description": "The id of the channel)", "name": "id" }, { "type": { "names": [ "boolean" ] }, "defaultvalue": false, "description": "True to force a request to the server", "name": "force" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The channel found" } ], "description": "(old getChannelById)\nFind a channel by its id (locally if exists or by sending a request to Rainbow)
", "longname": "module:ChannelsService#fetchChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#fetchChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method fetchChannelItems\n * @instance\n * @async\n * @category Channels MESSAGES/ITEMS\n * @param {Channel} channel The channel\n * @param {number} maxMessages=100 [optional] number of messages to get, 100 by default\n * @param {Date} beforeDate [optional] - show items before a specific timestamp (ISO 8601 format)\n * @param {Date} afterDate [optional] - show items after a specific timestamp (ISO 8601 format)\n * @return {Promise} The list of messages received\n * @description\n * (old getChannels)\n * Retrieve the last maxMessages messages from a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1153, "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": "Channels MESSAGES/ITEMS", "value": "Channels MESSAGES/ITEMS" } ], "kind": "function", "name": "fetchChannelItems", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "number" ] }, "defaultvalue": 100, "description": "[optional] number of messages to get, 100 by default", "name": "maxMessages" }, { "type": { "names": [ "Date" ] }, "description": "[optional] - show items before a specific timestamp (ISO 8601 format)", "name": "beforeDate" }, { "type": { "names": [ "Date" ] }, "description": "[optional] - show items after a specific timestamp (ISO 8601 format)", "name": "afterDate" } ], "returns": [ { "type": { "names": [ "Promise.>" ] }, "description": "The list of messages received" } ], "description": "(old getChannels)\n Retrieve the last maxMessages messages from a channel
", "longname": "module:ChannelsService#fetchChannelItems", "memberof": "module:ChannelsService", "$longname": "ChannelsService#fetchChannelItems", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method fetchChannelsByFilter\n * @since 1.55\n * @instance\n * @category Channels MANAGEMENT\n * @description\n * Find channels using a filter (on name, topic)
\n * Result may be filtered with result limit, offet and sortField or SortOrder
\n * Return a promise.
\n * @param {Object} filter The filter with at least [filter.name] or [filter.topic] defined
\n * {string} [filter.name] search by channel names (case insensitive substring).
\n * {string} [filter.topic] search by channel topics (case insensitive substring).
\n * {Number} [filter.limit=100] allow to specify the number of channels to retrieve.
\n * {Number} [filter.offset] allow to specify the position of first channel to retrieve (first channel if not specified). Warning: if offset > total, no results are returned.
\n * {string} [filter.sortField=\"name\"] sort channel list based on the given field.
\n * {Number} [filter.sortOrder=\"1\"] specify order ascending/descending. 1 for ascending, -1 for descending.
\n * @return {Promise} Result of the find with
\n * {Array} found channels informations with an array of { id, name, topic, creatorId, visibility, users_count }
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 420, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "fetchChannelsByFilter", "since": "1.55", "scope": "instance", "description": "Find channels using a filter (on name, topic)
\n Result may be filtered with result limit, offet and sortField or SortOrder
\n Return a promise.
", "params": [ { "type": { "names": [ "Object" ] }, "description": "The filter with at least [filter.name] or [filter.topic] defined
\n {string} [filter.name] search by channel names (case insensitive substring).
\n {string} [filter.topic] search by channel topics (case insensitive substring).
\n {Number} [filter.limit=100] allow to specify the number of channels to retrieve.
\n {Number} [filter.offset] allow to specify the position of first channel to retrieve (first channel if not specified). Warning: if offset > total, no results are returned.
\n {string} [filter.sortField=\"name\"] sort channel list based on the given field.
\n {Number} [filter.sortOrder=\"1\"] specify order ascending/descending. 1 for ascending, -1 for descending.
", "name": "filter" } ], "returns": [ { "type": { "names": [ "Promise.>" ] }, "description": "Result of the find with
\n {Array} found channels informations with an array of { id, name, topic, creatorId, visibility, users_count }
" } ], "longname": "module:ChannelsService#fetchChannelsByFilter", "memberof": "module:ChannelsService", "$longname": "ChannelsService#fetchChannelsByFilter", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method fetchChannelUsers\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Object} options A filter parameter\n * @param {Number} options.page=0 Display a specific page of results\n * @param {Number} options.limit=100 Number of results per page (max 1000)\n * @param {Boolean} options.onlyPublishers=false Filter to publishers only\n * @param {Boolean} options.onlyOwners=false Filter to owners only\n * @return {Promise>} An array of users who belong to this channel\n * @description\n * (old getUsersFromChannel)\n * Get a pagined list of users who belongs to a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1514, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "fetchChannelUsers", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Object" ] }, "description": "A filter parameter", "name": "options" }, { "type": { "names": [ "Number" ] }, "defaultvalue": 0, "description": "Display a specific page of results", "name": "options.page" }, { "type": { "names": [ "Number" ] }, "defaultvalue": 100, "description": "Number of results per page (max 1000)", "name": "options.limit" }, { "type": { "names": [ "Boolean" ] }, "defaultvalue": false, "description": "Filter to publishers only", "name": "options.onlyPublishers" }, { "type": { "names": [ "Boolean" ] }, "defaultvalue": false, "description": "Filter to owners only", "name": "options.onlyOwners" } ], "returns": [ { "type": { "names": [ "Promise.>" ] }, "description": "An array of users who belong to this channel" } ], "description": "(old getUsersFromChannel)\n Get a pagined list of users who belongs to a channel
", "longname": "module:ChannelsService#fetchChannelUsers", "memberof": "module:ChannelsService", "$longname": "ChannelsService#fetchChannelUsers", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method fetchMyChannels\n * @since 1.38\n * @instance\n * @category Channels MANAGEMENT\n * @param {boolean} force=false Boolean to force the get of channels's informations from server.\n * @description\n * (old getChannels)\n * Get the channels you own, are subscribed to, are publisher
\n * Return a promise.
\n * @return {Promise} Return Promise with a list of channels or an empty array if no channel has been found\n */", "meta": { "filename": "ChannelsService.js", "lineno": 479, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "fetchMyChannels", "since": "1.38", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ] }, "defaultvalue": false, "description": "Boolean to force the get of channels's informations from server.", "name": "force" } ], "description": "(old getChannels)\n Get the channels you own, are subscribed to, are publisher
\n Return a promise.
", "returns": [ { "type": { "names": [ "Promise.>" ] }, "description": "Return Promise with a list of channels or an empty array if no channel has been found" } ], "longname": "module:ChannelsService#fetchMyChannels", "memberof": "module:ChannelsService", "$longname": "ChannelsService#fetchMyChannels", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method findChannelsByName\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {string} name Search this provided substring in the channel name (case insensitive).\n * @return {Promise>} ChannelsService found\n * @description\n * Find channels by name. Only channels with visibility equals to 'company' can be found. First 100 results are returned.
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 294, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "findChannelsByName", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "string" ] }, "description": "Search this provided substring in the channel name (case insensitive).", "name": "name" } ], "returns": [ { "type": { "names": [ "Promise.>" ] }, "description": "ChannelsService found" } ], "description": "Find channels by name. Only channels with visibility equals to 'company' can be found. First 100 results are returned.
", "longname": "module:ChannelsService#findChannelsByName", "memberof": "module:ChannelsService", "$longname": "ChannelsService#findChannelsByName", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method findChannelsByTopic\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {string} topic Search this provided substring in the channel topic (case insensitive).\n * @return {Promise>} ChannelsService found\n * @description\n * Find channels by topic. Only channels with visibility equals to 'company' can be found. First 100 results are returned.
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 316, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "findChannelsByTopic", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "string" ] }, "description": "Search this provided substring in the channel topic (case insensitive).", "name": "topic" } ], "returns": [ { "type": { "names": [ "Promise.>" ] }, "description": "ChannelsService found" } ], "description": "Find channels by topic. Only channels with visibility equals to 'company' can be found. First 100 results are returned.
", "longname": "module:ChannelsService#findChannelsByTopic", "memberof": "module:ChannelsService", "$longname": "ChannelsService#findChannelsByTopic", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getAllChannels\n * @category Channels MANAGEMENT\n * @instance\n * @return {Channel[]} An array of channels (owned, invited, subscribed)\n * @description\n * Return the list of channels (owned, invited, subscribed)
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 554, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "getAllChannels", "scope": "instance", "returns": [ { "type": { "names": [ "Array." ] }, "description": "An array of channels (owned, invited, subscribed)" } ], "description": "Return the list of channels (owned, invited, subscribed)
", "longname": "module:ChannelsService#getAllChannels", "memberof": "module:ChannelsService", "$longname": "ChannelsService#getAllChannels", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getAllOwnedChannels\n * @category Channels MANAGEMENT\n * @instance\n * @return {Channel[]} An array of channels (owned only)\n * @description\n * (old getAllOwnedChannel)\n * Return the list of owned channels only
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 569, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "getAllOwnedChannels", "scope": "instance", "returns": [ { "type": { "names": [ "Array." ] }, "description": "An array of channels (owned only)" } ], "description": "(old getAllOwnedChannel)\n Return the list of owned channels only
", "longname": "module:ChannelsService#getAllOwnedChannels", "memberof": "module:ChannelsService", "$longname": "ChannelsService#getAllOwnedChannels", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getAllPendingChannels\n * @category Channels MANAGEMENT\n * @instance\n * @return {Channel[]} An array of channels (invited only)\n * @description\n * Return the list of invited channels only
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 587, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "getAllPendingChannels", "scope": "instance", "returns": [ { "type": { "names": [ "Array." ] }, "description": "An array of channels (invited only)" } ], "description": "Return the list of invited channels only
", "longname": "module:ChannelsService#getAllPendingChannels", "memberof": "module:ChannelsService", "$longname": "ChannelsService#getAllPendingChannels", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getAllSubscribedChannels\n * @instance\n * @category Channels SUBSCRIPTION\n * @return {Channel[]} An array of channels (subscribed only)\n * @description\n * (old getAllSubscribedChannel)\n * Return the list of subscribed channels only
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1368, "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": "Channels SUBSCRIPTION", "value": "Channels SUBSCRIPTION" } ], "kind": "function", "name": "getAllSubscribedChannels", "scope": "instance", "returns": [ { "type": { "names": [ "Array." ] }, "description": "An array of channels (subscribed only)" } ], "description": "(old getAllSubscribedChannel)\n Return the list of subscribed channels only
", "longname": "module:ChannelsService#getAllSubscribedChannels", "memberof": "module:ChannelsService", "$longname": "ChannelsService#getAllSubscribedChannels", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getDetailedAppreciations\n * @instance\n * @async\n * @category Channels MESSAGES/ITEMS\n * @param {Channel} channel The channel where the item appreciations must be retrieved.\n * @param {string} itemId The Id of the item\n * @return {Promise}\n * @description\n * To know in details apprecations given on a channel item (by userId the apprecation given)
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1318, "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": "Channels MESSAGES/ITEMS", "value": "Channels MESSAGES/ITEMS" } ], "kind": "function", "name": "getDetailedAppreciations", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel where the item appreciations must be retrieved.", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "The Id of the item", "name": "itemId" } ], "returns": [ { "type": { "names": [ "Promise." ] } } ], "description": "To know in details apprecations given on a channel item (by userId the apprecation given)
", "longname": "module:ChannelsService#getDetailedAppreciations", "memberof": "module:ChannelsService", "$longname": "ChannelsService#getDetailedAppreciations", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method likeItem\n * @instance\n * @async\n * @category Channels MESSAGES/ITEMS\n * @param {Channel} channel The channel where the item must be liked.\n * @param {string} itemId The Id of the item\n * @param {Appreciation} appreciation Appreciation value - must be one of the value specified in Appreciation object.\n * @return {Promise}\n * @description\n * To like a Channel Item with the specified appreciation
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1271, "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": "Channels MESSAGES/ITEMS", "value": "Channels MESSAGES/ITEMS" } ], "kind": "function", "name": "likeItem", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel where the item must be liked.", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "The Id of the item", "name": "itemId" }, { "type": { "names": [ "Appreciation" ] }, "description": "Appreciation value - must be one of the value specified in Appreciation object.", "name": "appreciation" } ], "returns": [ { "type": { "names": [ "Promise." ] } } ], "description": "To like a Channel Item with the specified appreciation
", "longname": "module:ChannelsService#likeItem", "memberof": "module:ChannelsService", "$longname": "ChannelsService#likeItem", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method publishMessageToChannel\n * @instance\n * @async\n * @category Channels MESSAGES/ITEMS\n * @param {Channel} channel The channel where to publish the message\n * @param {string} message Message content\n * @param {string} title Message title, limit=256.\n * @param {string} url An URL\n * @param {any} imagesIds=null An Array of ids of the files stored in Rainbow\n * @param {string} type=\"basic\" An optional message content type (could be basic, markdown, html or data)\n * @param {Object} customDatas={} A JSON object with custom datas merged to the payload send to server.\n * @return {Promise} OK if successfull\n * @description\n * Publish to a channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1078, "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": "Channels MESSAGES/ITEMS", "value": "Channels MESSAGES/ITEMS" } ], "kind": "function", "name": "publishMessageToChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel where to publish the message", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "Message content", "name": "message" }, { "type": { "names": [ "string" ] }, "description": "Message title, limit=256.", "name": "title" }, { "type": { "names": [ "string" ] }, "description": "An URL", "name": "url" }, { "type": { "names": [ "any" ] }, "defaultvalue": null, "description": "An Array of ids of the files stored in Rainbow", "name": "imagesIds" }, { "type": { "names": [ "string" ] }, "defaultvalue": "\"basic\"", "description": "An optional message content type (could be basic, markdown, html or data)", "name": "type" }, { "type": { "names": [ "Object" ] }, "defaultvalue": "{}", "description": "A JSON object with custom datas merged to the payload send to server.", "name": "customDatas" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "OK if successfull" } ], "description": "Publish to a channel
", "longname": "module:ChannelsService#publishMessageToChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#publishMessageToChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method subscribeToChannel\n * @instance\n * @async\n * @category Channels SUBSCRIPTION\n * @param {Channel} channel The channel to subscribe\n * @return {Promise} The channel updated with the new subscription\n * @description\n * Subscribe to a public channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1386, "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": "Channels SUBSCRIPTION", "value": "Channels SUBSCRIPTION" } ], "kind": "function", "name": "subscribeToChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to subscribe", "name": "channel" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The channel updated with the new subscription" } ], "description": "Subscribe to a public channel
", "longname": "module:ChannelsService#subscribeToChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#subscribeToChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method subscribeToChannelById\n * @since 1.47\n * @instance\n * @category Channels SUBSCRIPTION\n * @description\n * Subscribe to a channel using its id
\n * Return a promise.
\n * @param {string} id The id of the channel\n * @return {Object} Nothing or an error object depending on the result\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1419, "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": "Channels SUBSCRIPTION", "value": "Channels SUBSCRIPTION" } ], "kind": "function", "name": "subscribeToChannelById", "since": "1.47", "scope": "instance", "description": "Subscribe to a channel using its id
\n Return a promise.
", "params": [ { "type": { "names": [ "string" ] }, "description": "The id of the channel", "name": "id" } ], "returns": [ { "type": { "names": [ "Object" ] }, "description": "Nothing or an error object depending on the result" } ], "longname": "module:ChannelsService#subscribeToChannelById", "memberof": "module:ChannelsService", "$longname": "ChannelsService#subscribeToChannelById", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method unsubscribeFromChannel\n * @instance\n * @async\n * @category Channels SUBSCRIPTION\n * @param {Channel} channel The channel to unsubscribe\n * @return {Promise} The status of the unsubscribe.\n * @description\n * Unsubscribe from a public channel
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1481, "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": "Channels SUBSCRIPTION", "value": "Channels SUBSCRIPTION" } ], "kind": "function", "name": "unsubscribeFromChannel", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to unsubscribe", "name": "channel" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "The status of the unsubscribe." } ], "description": "Unsubscribe from a public channel
", "longname": "module:ChannelsService#unsubscribeFromChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#unsubscribeFromChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannel\n * @since 1.38\n * @category Channels MANAGEMENT\n * @instance\n * @description\n * Update a channel
\n * May be updated: name, topic, visibility, max_items and max_payload
\n * Please put null to not update a property.
\n * Return a promise.
\n * @param {string} id The id of the channel\n * @param {string} channelTopic The topic of the channel\n * @param {string} visibility=public public/company/closed group visibility for search\n * @param {Number} max_items=30 max # of items to persist in the channel\n * @param {Number} max_payload_size=60000 max # of items to persist in the channel\n * @param {string} channelName The name of the channel\n * @param {string} category The category of the channel\n * @return {Promise} Return the channel created or an error\n */", "meta": { "filename": "ChannelsService.js", "lineno": 719, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannel", "since": "1.38", "scope": "instance", "description": "Update a channel
\n May be updated: name, topic, visibility, max_items and max_payload
\n Please put null to not update a property.
\n Return a promise.
", "params": [ { "type": { "names": [ "string" ] }, "description": "The id of the channel", "name": "id" }, { "type": { "names": [ "string" ] }, "description": "The topic of the channel", "name": "channelTopic" }, { "type": { "names": [ "string" ] }, "defaultvalue": "public", "description": "public/company/closed group visibility for search", "name": "visibility" }, { "type": { "names": [ "Number" ] }, "defaultvalue": 30, "description": "max # of items to persist in the channel", "name": "max_items" }, { "type": { "names": [ "Number" ] }, "defaultvalue": 60000, "description": "max # of items to persist in the channel", "name": "max_payload_size" }, { "type": { "names": [ "string" ] }, "description": "The name of the channel", "name": "channelName" }, { "type": { "names": [ "string" ] }, "description": "The category of the channel", "name": "category" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "Return the channel created or an error" } ], "longname": "module:ChannelsService#updateChannel", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannel", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelAvatar\n * @since 1.43\n * @instance\n * @category Channels MANAGEMENT\n * @description\n * Update a channel avatar
\n * Return a promise.
\n * @param {Channel} channel The Channel to update\n * @param {string} urlAvatar The avatar Url. It must be resized to 512 pixels before calling this API.\n * @return {Channel} Return the channel updated or an error\n */", "meta": { "filename": "ChannelsService.js", "lineno": 872, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannelAvatar", "since": "1.43", "scope": "instance", "description": "Update a channel avatar
\n Return a promise.
", "params": [ { "type": { "names": [ "Channel" ] }, "description": "The Channel to update", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "The avatar Url. It must be resized to 512 pixels before calling this API.", "name": "urlAvatar" } ], "returns": [ { "type": { "names": [ "Channel" ] }, "description": "Return the channel updated or an error" } ], "longname": "module:ChannelsService#updateChannelAvatar", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelAvatar", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelDescription\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {Channel} channel The channel to update\n * @param {string} description The description of the channel to update (max-length=255)\n * @return {Promise} Updated channel\n * @description\n * Update the description of a channel.
\n *\n */", "meta": { "filename": "ChannelsService.js", "lineno": 622, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannelDescription", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to update", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "The description of the channel to update (max-length=255)", "name": "description" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "Updated channel" } ], "description": "Update the description of a channel.
", "longname": "module:ChannelsService#updateChannelDescription", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelDescription", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelName\n * @since 1.46\n * @instance\n * @category Channels MANAGEMENT\n * @description\n * Update a channel name
\n * Return a promise.
\n * @param {Channel} channel The channel to update\n * @param {string} channelName The name of the channel\n * @return {Channel} Return the channel updated or an error\n */", "meta": { "filename": "ChannelsService.js", "lineno": 670, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannelName", "since": "1.46", "scope": "instance", "description": "Update a channel name
\n Return a promise.
", "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to update", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "The name of the channel", "name": "channelName" } ], "returns": [ { "type": { "names": [ "Channel" ] }, "description": "Return the channel updated or an error" } ], "longname": "module:ChannelsService#updateChannelName", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelName", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelTopic\n * @instance\n * @async\n * @category Channels MANAGEMENT\n * @param {Channel} channel The channel to update\n * @param {string} description The description of the channel to update (max-length=255)\n * @return {Promise} Updated channel\n * @description\n * Update the description of a channel.
\n */", "meta": { "filename": "ChannelsService.js", "lineno": 604, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannelTopic", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to update", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "The description of the channel to update (max-length=255)", "name": "description" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "Updated channel" } ], "description": "Update the description of a channel.
", "longname": "module:ChannelsService#updateChannelTopic", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelTopic", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelUsers\n * @instance\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} users The users of the channel.\n * collection of users to update\n * [\n * {\n * id : string, // Rainbow user Id\n * type : string // user channel affiliation. Possibles values : none, owner, publisher, member\n * }\n * ]\n *\n * @return {Promise} Update Channel Users status\n * @description\n * Update a collection of channel users\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1612, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "updateChannelUsers", "scope": "instance", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "The users of the channel.\ncollection of users to update\n[\n {\n id : string, // Rainbow user Id\n type : string // user channel affiliation. Possibles values : none, owner, publisher, member\n }\n ]", "name": "users" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "Update Channel Users status" } ], "description": "Update a collection of channel users", "longname": "module:ChannelsService#updateChannelUsers", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelUsers", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelUsersByLoginEmails\n * @instance\n * @since 2.23.0\n * @async\n * @category Channels USERS\n * @param {Channel} channel The channel\n * @param {Array} users Array of users loginEmail of the channel.\n * collection of users to update\n * [\n * {\n * loginEmail : string, // Rainbow user loginEmail.\n * type : string // user channel affiliation. Possibles values : none, owner, publisher, member\n * }\n * ]\n *\n * @return {Promise} Update Channel Users status\n * @description\n * Update a collection of channel users by loginEmail\n *\n */", "meta": { "filename": "ChannelsService.js", "lineno": 1664, "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": "Channels USERS", "value": "Channels USERS" } ], "kind": "function", "name": "updateChannelUsersByLoginEmails", "scope": "instance", "since": "2.23.0", "async": true, "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel", "name": "channel" }, { "type": { "names": [ "Array." ] }, "description": "Array of users loginEmail of the channel.\ncollection of users to update\n[\n {\n loginEmail : string, // Rainbow user loginEmail.\n type : string // user channel affiliation. Possibles values : none, owner, publisher, member\n }\n ]", "name": "users" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "Update Channel Users status" } ], "description": "Update a collection of channel users by loginEmail", "longname": "module:ChannelsService#updateChannelUsersByLoginEmails", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelUsersByLoginEmails", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelVisibility\n * @since 1.55\n * @category Channels MANAGEMENT\n * @instance\n * @description\n * Update a channel visibility
\n * Return a promise.
\n * @param {Channel} channel The channel to update\n * @param {string} visibility The new channel visibility (closed or company)\n * @return {Promise} Return the channel updated or an error\n */", "meta": { "filename": "ChannelsService.js", "lineno": 783, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannelVisibility", "since": "1.55", "scope": "instance", "description": "Update a channel visibility
\n Return a promise.
", "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to update", "name": "channel" }, { "type": { "names": [ "string" ] }, "description": "The new channel visibility (closed or company)", "name": "visibility" } ], "returns": [ { "type": { "names": [ "Promise." ] }, "description": "Return the channel updated or an error" } ], "longname": "module:ChannelsService#updateChannelVisibility", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelVisibility", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelVisibilityToClosed\n * @since 1.55\n * @instance\n * @category Channels MANAGEMENT\n * @description\n * Set the channel visibility to closed (not visible by users)
\n * Return a promise.
\n * @param {Channel} channel The channel to update\n * @return {Channel} Return the channel updated or an error\n */", "meta": { "filename": "ChannelsService.js", "lineno": 853, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannelVisibilityToClosed", "since": "1.55", "scope": "instance", "description": "Set the channel visibility to closed (not visible by users)
\n Return a promise.
", "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to update", "name": "channel" } ], "returns": [ { "type": { "names": [ "Channel" ] }, "description": "Return the channel updated or an error" } ], "longname": "module:ChannelsService#updateChannelVisibilityToClosed", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelVisibilityToClosed", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method updateChannelVisibilityToPublic\n * @since 1.55\n * @category Channels MANAGEMENT\n * @instance\n * @description\n * Set the channel visibility to company (visible for users in that company)
\n * Return a promise.
\n * @param {Channel} channel The channel to update\n * @return {Channel} Return the channel updated or an error\n */", "meta": { "filename": "ChannelsService.js", "lineno": 835, "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": "Channels MANAGEMENT", "value": "Channels MANAGEMENT" } ], "kind": "function", "name": "updateChannelVisibilityToPublic", "since": "1.55", "scope": "instance", "description": "Set the channel visibility to company (visible for users in that company)
\n Return a promise.
", "params": [ { "type": { "names": [ "Channel" ] }, "description": "The channel to update", "name": "channel" } ], "returns": [ { "type": { "names": [ "Channel" ] }, "description": "Return the channel updated or an error" } ], "longname": "module:ChannelsService#updateChannelVisibilityToPublic", "memberof": "module:ChannelsService", "$longname": "ChannelsService#updateChannelVisibilityToPublic", "$kind": "method" } ]