[ { "comment": "/**\n * @module\n * @name PresenceService\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n * @description\n * This module manages the presence of the connected user.
\n *

\n * The main methods proposed in that module allow to:
\n * - Change the connected user presence
\n */", "meta": { "filename": "PresenceService.js", "lineno": 23, "columnno": 0, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": {} }, "kind": "module", "name": "PresenceService", "version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z", "access": "public", "description": "This module manages the presence of the connected user.
\n

\n The main methods proposed in that module allow to:
\n - Change the connected user presence
", "longname": "module:PresenceService", "$longname": "PresenceService", "$kind": "module" }, { "comment": "", "meta": { "range": [ 1962, 3346 ], "filename": "PresenceService.js", "lineno": 39, "columnno": 4, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": { "id": "astnode100000254", "name": "PresenceService_1", "type": "MethodDefinition", "paramnames": [ "_core", "_eventEmitter", "_logger", "_startConfig" ] }, "vars": { "": null } }, "undocumented": true, "name": "PresenceService_1", "longname": "module:PresenceService.PresenceService_1", "kind": "class", "memberof": "module:PresenceService", "scope": "static", "params": [], "$longname": "PresenceService.PresenceService_1", "$kind": "constructor" }, { "comment": "/**\n * @public\n * @nodered true\n * @method activateMsteamsPresence\n * @since 2.20.0\n * @instance\n * @category Manage Presence MSTeams\n * @async\n * @description\n * activate a MS Teams presence sharing.
\n * A message stanza is sent to the user for multi-devices constraints.
\n * @return {Promise}

\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | Status | String | Operation status |\n *\n * */", "meta": { "filename": "PresenceService.js", "lineno": 1090, "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": "Manage Presence MSTeams", "value": "Manage Presence MSTeams" } ], "kind": "function", "name": "activateMsteamsPresence", "since": "2.20.0", "scope": "instance", "async": true, "description": "activate a MS Teams presence sharing.
\n A message stanza is sent to the user for multi-devices constraints.
", "returns": [ { "type": { "names": [ "Promise." ] }, "description": "

\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| Status | String | Operation status |" } ], "longname": "module:PresenceService#activateMsteamsPresence", "memberof": "module:PresenceService", "$longname": "PresenceService#activateMsteamsPresence", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method controlCalendarOrIgnoreAnEntry\n * @instance\n * @category Presence CALENDAR\n * @param {boolean} disable disable calendar, true to re-enable\n * @param {string} ignore ignore the current calendar entry, false resumes the entry. Possible values : current, false\n * @description\n * Enable/disable a calendar sharing or ignore a calendar entry.
\n * return promise with {
\n * Status : string // Operation status (\"enabled\" or \"disabled\")
\n * }
\n *
\n * @async\n * @return {Promise< {\n * Status : string\n * }, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 856, "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": "Presence CALENDAR", "value": "Presence CALENDAR" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "kind": "function", "name": "controlCalendarOrIgnoreAnEntry", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ] }, "description": "disable calendar, true to re-enable", "name": "disable" }, { "type": { "names": [ "string" ] }, "description": "ignore the current calendar entry, false resumes the entry. Possible values : current, false", "name": "ignore" } ], "description": "Enable/disable a calendar sharing or ignore a calendar entry.
\n return promise with {
\n Status : string // Operation status (\"enabled\" or \"disabled\")
\n }
\n
", "async": true, "returns": [ { "type": { "names": [ "Promise.<{Status: string}, ErrorManager>" ] } } ], "longname": "module:PresenceService#controlCalendarOrIgnoreAnEntry", "memberof": "module:PresenceService", "$longname": "PresenceService#controlCalendarOrIgnoreAnEntry", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method controlMsteamsPresence\n * @since 2.20.0\n * @instance\n * @category Manage Presence MSTeams\n * @param {boolean} disable disable presence, true to re-enable\n * @param {string} ignore ignore the current rainbow presence sharing\n * @async\n * @description\n * Enable/disable a presence sharing or ignore rainbow presence sharing.
\n * When disabled or enabled, a message stanza is sent to the user for multi-devices constraints.
\n * @return {Promise}\n */", "meta": { "filename": "PresenceService.js", "lineno": 932, "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": "Manage Presence MSTeams", "value": "Manage Presence MSTeams" } ], "kind": "function", "name": "controlMsteamsPresence", "since": "2.20.0", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ] }, "description": "disable presence, true to re-enable", "name": "disable" }, { "type": { "names": [ "string" ] }, "description": "ignore the current rainbow presence sharing", "name": "ignore" } ], "async": true, "description": "Enable/disable a presence sharing or ignore rainbow presence sharing.
\n When disabled or enabled, a message stanza is sent to the user for multi-devices constraints.
", "returns": [ { "type": { "names": [ "Promise." ] } } ], "longname": "module:PresenceService#controlMsteamsPresence", "memberof": "module:PresenceService", "$longname": "PresenceService#controlMsteamsPresence", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method deactivateMsteamsPresence\n * @since 2.20.0\n * @instance\n * @category Manage Presence MSTeams\n * @async\n * @description\n * desactivate a MS Teams presence sharing.
\n * A message stanza is sent to the user for multi-devices constraints.
\n * @return {Promise}

\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | Status | String | Operation status |\n *\n * */", "meta": { "filename": "PresenceService.js", "lineno": 1113, "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": "Manage Presence MSTeams", "value": "Manage Presence MSTeams" } ], "kind": "function", "name": "deactivateMsteamsPresence", "since": "2.20.0", "scope": "instance", "async": true, "description": "desactivate a MS Teams presence sharing.
\n A message stanza is sent to the user for multi-devices constraints.
", "returns": [ { "type": { "names": [ "Promise." ] }, "description": "

\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| Status | String | Operation status |" } ], "longname": "module:PresenceService#deactivateMsteamsPresence", "memberof": "module:PresenceService", "$longname": "PresenceService#deactivateMsteamsPresence", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getCalendarAutomaticReplyStatus\n * @instance\n * @category Presence CALENDAR\n * @param {string} userId The id of user to retrieve the calendar automatic reply status.\n * @description\n * Allow to retrieve the calendar automatic reply status
\n * return promise with {
\n * enabled : string, // its status
\n * start : string, // its start date
\n * end : string, // its end date
\n * message_text : string, // its message as plain text
\n * message_thtml : string // its message as html
\n * }
\n *
\n * @async\n * @return {Promise<{\n * enabled : string,\n * status : string,\n * start : string,\n * end : string,\n * message_text : string,\n * message_thtml : string\n * }, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 731, "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": "Presence CALENDAR", "value": "Presence CALENDAR" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "kind": "function", "name": "getCalendarAutomaticReplyStatus", "scope": "instance", "params": [ { "type": { "names": [ "string" ] }, "description": "The id of user to retrieve the calendar automatic reply status.", "name": "userId" } ], "description": "Allow to retrieve the calendar automatic reply status
\n return promise with {
\n enabled : string, // its status
\n start : string, // its start date
\n end : string, // its end date
\n message_text : string, // its message as plain text
\n message_thtml : string // its message as html
\n }
\n
", "async": true, "returns": [ { "type": { "names": [ "Promise.<{enabled: string, status: string, start: string, end: string, message_text: string, message_thtml: string}, ErrorManager>" ] } } ], "longname": "module:PresenceService#getCalendarAutomaticReplyStatus", "memberof": "module:PresenceService", "$longname": "PresenceService#getCalendarAutomaticReplyStatus", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getCalendarState\n * @instance\n * @category Presence CALENDAR\n * @description\n * Allow to get the calendar presence of the connected user
\n * return promise with {
\n * busy: boolean, // Does the connected user is busy ?
\n * status: string, // The status of the connected user (one of \"free\", \"busy\" or \"out_of_office\")
\n * subject: string, // The meeting subject.
\n * since: string, // The meeting since date.
\n * until: string // Date until the current presence is valid
\n * }
\n *
\n * Note : \"applyCalendarPresence\" boolean is not return by this api, so you can not know if the presence should be used in general calculated presence.
\n * @async\n * @return {Promise<{\n * busy: boolean,\n * status: string,\n * subject: string,\n * since: string,\n * until: string\n * }, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n \n */", "meta": { "filename": "PresenceService.js", "lineno": 599, "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": "Presence CALENDAR", "value": "Presence CALENDAR" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "kind": "function", "name": "getCalendarState", "scope": "instance", "description": "Allow to get the calendar presence of the connected user
\n return promise with {
\n busy: boolean, // Does the connected user is busy ?
\n status: string, // The status of the connected user (one of \"free\", \"busy\" or \"out_of_office\")
\n subject: string, // The meeting subject.
\n since: string, // The meeting since date.
\n until: string // Date until the current presence is valid
\n }
\n
\n Note : \"applyCalendarPresence\" boolean is not return by this api, so you can not know if the presence should be used in general calculated presence.
", "async": true, "returns": [ { "type": { "names": [ "Promise.<{busy: boolean, status: string, subject: string, since: string, until: string}, ErrorManager>" ] } } ], "longname": "module:PresenceService#getCalendarState", "memberof": "module:PresenceService", "$longname": "PresenceService#getCalendarState", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getCalendarStates\n * @instance\n * @category Presence CALENDAR\n * @param {Array} users The list of the Rainbow user's references - id or logins (Contact::loginEmail) - to retrieve the calendar presence.\n * @description\n * Allow to get the calendar presence of severals users
\n * return promise with {\n * usersIdentifier : { // List of calendar user states.
\n * busy: boolean, // Does the connected user is busy ?
\n * status: string, // The status of the connected user (one of \"free\", \"busy\" or \"out_of_office\")
\n * subject: string, // The meeting subject.
\n * since: string, // The meeting since date.
\n * until: string // Date until the current presence is valid
\n * }
\n *
\n * Note : \"applyCalendarPresence\" boolean is not return by this api, so you can not know if the presence should be used in general calculated presence.
\n * @async\n * @return {Promise< {\n * busy: boolean,\n * status: string,\n * subject: string,\n * since: string,\n * until: string\n * }, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 646, "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": "Presence CALENDAR", "value": "Presence CALENDAR" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "kind": "function", "name": "getCalendarStates", "scope": "instance", "params": [ { "type": { "names": [ "Array." ] }, "description": "The list of the Rainbow user's references - id or logins (Contact::loginEmail) - to retrieve the calendar presence.", "name": "users" } ], "description": "Allow to get the calendar presence of severals users
\n return promise with {\n usersIdentifier : { // List of calendar user states.
\n busy: boolean, // Does the connected user is busy ?
\n status: string, // The status of the connected user (one of \"free\", \"busy\" or \"out_of_office\")
\n subject: string, // The meeting subject.
\n since: string, // The meeting since date.
\n until: string // Date until the current presence is valid
\n }
\n
\n Note : \"applyCalendarPresence\" boolean is not return by this api, so you can not know if the presence should be used in general calculated presence.
", "async": true, "returns": [ { "type": { "names": [ "Promise.<{busy: boolean, status: string, subject: string, since: string, until: string}, ErrorManager>" ] } } ], "longname": "module:PresenceService#getCalendarStates", "memberof": "module:PresenceService", "$longname": "PresenceService#getCalendarStates", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getMsteamsPresenceState\n * @since 2.20.0\n * @instance\n * @category Manage Presence MSTeams\n * @param {string} userId The Rainbow user id, his jid or the email of his attached Microsoft teams presence. Default value is the current connected user's id\n * @async\n * @description\n * Get a MS-teams presence state
\n * @return {Promise}

\n *\n * enabled\n * -------\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | busy | Boolean | presence busy flag. |\n * | status | String | presence status (one of \"chat\", \"busy\" or \"dnd\") |\n *\n * disabled\n * --------\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | presence sharing is disabled (status = 'disabled') |\n *\n * subscription_error\n * ------------------\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | presence sharing with a expired subscription |\n *\n * none\n * ----\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | presence sharing is not defined (status = 'none') |\n *\n *\n * */", "meta": { "filename": "PresenceService.js", "lineno": 952, "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": "Manage Presence MSTeams", "value": "Manage Presence MSTeams" } ], "kind": "function", "name": "getMsteamsPresenceState", "since": "2.20.0", "scope": "instance", "params": [ { "type": { "names": [ "string" ] }, "description": "The Rainbow user id, his jid or the email of his attached Microsoft teams presence. Default value is the current connected user's id", "name": "userId" } ], "async": true, "description": "Get a MS-teams presence state
", "returns": [ { "type": { "names": [ "Promise." ] }, "description": "

\n\nenabled\n-------\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | busy | Boolean | presence busy flag. |\n | status | String | presence status (one of \"chat\", \"busy\" or \"dnd\") |\n\n disabled\n --------\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | presence sharing is disabled (status = 'disabled') |\n\n subscription_error\n ------------------\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | presence sharing with a expired subscription |\n\n none\n ----\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | presence sharing is not defined (status = 'none') |" } ], "longname": "module:PresenceService#getMsteamsPresenceState", "memberof": "module:PresenceService", "$longname": "PresenceService#getMsteamsPresenceState", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getMsteamsPresenceStates\n * @since 2.20.0\n * @instance\n * @category Manage Presence MSTeams\n * @param {Array} users The Rainbow user references (can be email or id). Default value is an Array with the current connected user's id.\n * @async\n * @description\n * Get a MS-teams presence states of several users
\n * @return {Promise}

\n *\n * enabled\n * -------\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | users | Object\\[\\] | list of presence user states. |\n * | busy | Boolean | presence busy flag. |\n * | status | String | presence status (one of \"chat\", \"busy\" or \"dnd\"). |\n *\n * others\n * ------\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | users | Object\\[\\] | list of presence user states. |\n * | status | String | presence status (one of \"disabled\", \"subscription_error\", \"none\"). |\n *\n */", "meta": { "filename": "PresenceService.js", "lineno": 1004, "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": "Manage Presence MSTeams", "value": "Manage Presence MSTeams" } ], "kind": "function", "name": "getMsteamsPresenceStates", "since": "2.20.0", "scope": "instance", "params": [ { "type": { "names": [ "Array." ] }, "description": "The Rainbow user references (can be email or id). Default value is an Array with the current connected user's id.", "name": "users" } ], "async": true, "description": "Get a MS-teams presence states of several users
", "returns": [ { "type": { "names": [ "Promise." ] }, "description": "

\n\nenabled\n-------\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | users | Object\\[\\] | list of presence user states. |\n | busy | Boolean | presence busy flag. |\n | status | String | presence status (one of \"chat\", \"busy\" or \"dnd\"). |\n\n others\n ------\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | users | Object\\[\\] | list of presence user states. |\n | status | String | presence status (one of \"disabled\", \"subscription_error\", \"none\"). |" } ], "longname": "module:PresenceService#getMsteamsPresenceStates", "memberof": "module:PresenceService", "$longname": "PresenceService#getMsteamsPresenceStates", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getMyPresenceInformation\n * @since 2.16.0\n * @instance\n * @category Presence CONNECTED USER\n * @description\n * Get user's resources presences information from server.
\n */", "meta": { "filename": "PresenceService.js", "lineno": 332, "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": "Presence CONNECTED USER", "value": "Presence CONNECTED USER" } ], "kind": "function", "name": "getMyPresenceInformation", "since": "2.16.0", "scope": "instance", "description": "Get user's resources presences information from server.
", "longname": "module:PresenceService#getMyPresenceInformation", "memberof": "module:PresenceService", "$longname": "PresenceService#getMyPresenceInformation", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method getUserConnectedPresence\n * @instance\n * @category Presence CONNECTED USER\n * @description\n * Get user presence status calculated from events.
\n */", "meta": { "filename": "PresenceService.js", "lineno": 217, "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": "Presence CONNECTED USER", "value": "Presence CONNECTED USER" } ], "kind": "function", "name": "getUserConnectedPresence", "scope": "instance", "description": "Get user presence status calculated from events.
", "longname": "module:PresenceService#getUserConnectedPresence", "memberof": "module:PresenceService", "$longname": "PresenceService#getUserConnectedPresence", "$kind": "method" }, { "comment": "/**\n * @public\n * @method notifyCalendarProvider\n * @instance\n * @category Presence Contact\n * @async\n * @description\n * Allows to subscribe users to EWS using a webhook in Rainbow.
\n * EWS cnx opens an event session for each subscribed user.
\n * EWS cnx notify to Rainbow each new appointment changes.
\n *\n * For each event, a IQ GetEvent request will be sent to retrieve a potential event that will occur in current time frame window.\n * @param {Array} ids The ids specified in field value of body request are the Rainbow user id for which a new calendar event has been created.\n * @param {Object} headers Allow to define specifics headers to the request.\n * @param {boolean} forceNotify Allow to to force the refresh of xmpp status as a comparaison is done between old and new presence status.\n * @return {Promise< any, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 1173, "columnno": 4, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": {} }, "access": "public", "kind": "function", "name": "notifyCalendarProvider", "scope": "instance", "tags": [ { "originalTitle": "category", "title": "category", "text": "Presence Contact", "value": "Presence Contact" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "async": true, "description": "Allows to subscribe users to EWS using a webhook in Rainbow.
\nEWS cnx opens an event session for each subscribed user.
\nEWS cnx notify to Rainbow each new appointment changes.
\n\nFor each event, a IQ GetEvent request will be sent to retrieve a potential event that will occur in current time frame window.", "params": [ { "type": { "names": [ "Array." ] }, "description": "The ids specified in field value of body request are the Rainbow user id for which a new calendar event has been created.", "name": "ids" }, { "type": { "names": [ "Object" ] }, "description": "Allow to define specifics headers to the request.", "name": "headers" }, { "type": { "names": [ "boolean" ] }, "description": "Allow to to force the refresh of xmpp status as a comparaison is done between old and new presence status.", "name": "forceNotify" } ], "returns": [ { "type": { "names": [ "Promise." ] } } ], "longname": "module:PresenceService#notifyCalendarProvider", "memberof": "module:PresenceService", "$longname": "PresenceService#notifyCalendarProvider", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method registerMsteamsPresenceSharing\n * @since 2.20.0\n * @instance\n * @category Manage Presence MSTeams\n * @param {boolean} redirect Immediately redirect to login page (OAuth2) or generate an HTML page.\n * @param {string} callback Redirect URL to the requesting client.\n * @async\n * @description\n * The requesting client get a redirection URL or could be redirected immediately to the provider login page to gather user consent.
\n * @return {Promise}

\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | url | String | Microsoft Teams Presence OAuth URL |\n *\n * */", "meta": { "filename": "PresenceService.js", "lineno": 1043, "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": "Manage Presence MSTeams", "value": "Manage Presence MSTeams" } ], "kind": "function", "name": "registerMsteamsPresenceSharing", "since": "2.20.0", "scope": "instance", "params": [ { "type": { "names": [ "boolean" ] }, "description": "Immediately redirect to login page (OAuth2) or generate an HTML page.", "name": "redirect" }, { "type": { "names": [ "string" ] }, "description": "Redirect URL to the requesting client.", "name": "callback" } ], "async": true, "description": "The requesting client get a redirection URL or could be redirected immediately to the provider login page to gather user consent.
", "returns": [ { "type": { "names": [ "Promise." ] }, "description": "

\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| url | String | Microsoft Teams Presence OAuth URL |" } ], "longname": "module:PresenceService#registerMsteamsPresenceSharing", "memberof": "module:PresenceService", "$longname": "PresenceService#registerMsteamsPresenceSharing", "$kind": "method" }, { "comment": "/**\n * @public\n * @method sendAutoReplyEvents\n * @instance\n * @category Presence Contact\n * @async\n * @description\n * Allows to send result of a get auto reply events iq request from Rainbow.
\n *\n * Note: To be used when a \"rainbow_onEWSgetevents\" event is received to send events response.\n *\n * @example\n *\n * rainbowSDK.events.on(\"rainbow_onEWSgetautoreply\", (data) => {\n * _logger.log(\"debug\", \"MAIN - (rainbow_onEWSgetautoreply) - rainbow event received.\", data);\n *\n * let autoReplyManager = new RainbowSDK.AutoReplyManager({\n * id: data.id,\n * to: data.from,\n * state: \"scheduled\",\n * email: data.email,\n * startDate: { value: \"2025-08-20T09:00:00Z\", timezone: \"Europe/Paris\" },\n * endDate: { value: \"2025-08-25T18:00:00Z\", timezone: \"Europe/Paris\" },\n * internalReplyMessage: \"Je suis absent du bureau, merci de contacter mon collègue.\",\n * externalReplyMessage: {\n * value: \"Je suis actuellement en congés.\",\n * audience: \"known\"\n * }\n * });\n *\n * rainbowSDK.presence.sendAutoReplyEvents(autoReplyManager);\n * });\n * @param {AutoReplyManager} autoReplyManager Allow to define get auto reply events iq.\n * @return {Promise< any, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 1269, "columnno": 4, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": {} }, "access": "public", "kind": "function", "name": "sendAutoReplyEvents", "scope": "instance", "tags": [ { "originalTitle": "category", "title": "category", "text": "Presence Contact", "value": "Presence Contact" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "async": true, "description": "Allows to send result of a get auto reply events iq request from Rainbow.
\n\nNote: To be used when a \"rainbow_onEWSgetevents\" event is received to send events response.", "examples": [ "rainbowSDK.events.on(\"rainbow_onEWSgetautoreply\", (data) => {\n _logger.log(\"debug\", \"MAIN - (rainbow_onEWSgetautoreply) - rainbow event received.\", data);\n\n let autoReplyManager = new RainbowSDK.AutoReplyManager({\n id: data.id,\n to: data.from,\n state: \"scheduled\",\n email: data.email,\n startDate: { value: \"2025-08-20T09:00:00Z\", timezone: \"Europe/Paris\" },\n endDate: { value: \"2025-08-25T18:00:00Z\", timezone: \"Europe/Paris\" },\n internalReplyMessage: \"Je suis absent du bureau, merci de contacter mon collègue.\",\n externalReplyMessage: {\n value: \"Je suis actuellement en congés.\",\n audience: \"known\"\n }\n });\n\n rainbowSDK.presence.sendAutoReplyEvents(autoReplyManager);\n });" ], "params": [ { "type": { "names": [ "AutoReplyManager" ] }, "description": "Allow to define get auto reply events iq.", "name": "autoReplyManager" } ], "returns": [ { "type": { "names": [ "Promise." ] } } ], "longname": "module:PresenceService#sendAutoReplyEvents", "memberof": "module:PresenceService", "$longname": "PresenceService#sendAutoReplyEvents", "$kind": "method" }, { "comment": "/**\n * @public\n * @method sendResultCalendarEvents\n * @instance\n * @category Presence Contact\n * @async\n * @description\n * Allows to send result of a get events iq request from Rainbow.
\n *\n * Note: To be used when a \"rainbow_onEWSgetevents\" event is received to send events response.\n *\n * @example\n *\n * rainbowSDK.events.on(\"rainbow_onEWSgetevents\", (data) => {\n * _logger.log(\"debug\", \"MAIN - (rainbow_onEWSgetevents) - rainbow event received.\", data);\n * let calendarManager = new RainbowSDK.CalendarManager(data.id, data.from, data.email);\n * calendarManager.addEvent(\n * {\n * \"id\": \"evt-001\",\n * \"subject\": \"Réunion projet\",\n * \"type\": \"singleInstance\",\n * \"showAs\": \"busy\",\n * startDate: {\n * \"value\": \"2025-08-14T09:00:00Z\",\n * \"timezone\": \"Europe/Paris\"\n * },\n * \"endDate\": {\n * \"value\": \"2025-08-14T10:30:00Z\",\n * timezone: \"Europe/Paris\"\n * }\n * });\n * calendarManager.addEvent(\n * {\n * \"id\": \"evt-002\",\n * \"subject\": \"Pause café\",\n * \"type\": \"occurrence\",\n * \"showAs\": \"free\",\n * \"startDate\": {\n * \"value\": \"2025-08-14T10:30:00Z\"\n * },\n * \"endDate\": {\n * \"value\": \"2025-08-14T10:45:00Z\"\n * }\n * });\n *\n * rainbowSDK.presence.sendResultCalendarEvents(calendarManager);\n * });\n *\n * @param {CalendarManager} calendarManager Allow to define the result of a get events iq request from Rainbow.\n * @return {Promise< any, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 1196, "columnno": 4, "path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services", "code": {} }, "access": "public", "kind": "function", "name": "sendResultCalendarEvents", "scope": "instance", "tags": [ { "originalTitle": "category", "title": "category", "text": "Presence Contact", "value": "Presence Contact" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "async": true, "description": "Allows to send result of a get events iq request from Rainbow.
\n\nNote: To be used when a \"rainbow_onEWSgetevents\" event is received to send events response.", "examples": [ "rainbowSDK.events.on(\"rainbow_onEWSgetevents\", (data) => {\n _logger.log(\"debug\", \"MAIN - (rainbow_onEWSgetevents) - rainbow event received.\", data);\n let calendarManager = new RainbowSDK.CalendarManager(data.id, data.from, data.email);\n calendarManager.addEvent(\n {\n \"id\": \"evt-001\",\n \"subject\": \"Réunion projet\",\n \"type\": \"singleInstance\",\n \"showAs\": \"busy\",\n startDate: {\n \"value\": \"2025-08-14T09:00:00Z\",\n \"timezone\": \"Europe/Paris\"\n },\n \"endDate\": {\n \"value\": \"2025-08-14T10:30:00Z\",\n timezone: \"Europe/Paris\"\n }\n });\n calendarManager.addEvent(\n {\n \"id\": \"evt-002\",\n \"subject\": \"Pause café\",\n \"type\": \"occurrence\",\n \"showAs\": \"free\",\n \"startDate\": {\n \"value\": \"2025-08-14T10:30:00Z\"\n },\n \"endDate\": {\n \"value\": \"2025-08-14T10:45:00Z\"\n }\n });\n\n rainbowSDK.presence.sendResultCalendarEvents(calendarManager);\n });" ], "params": [ { "type": { "names": [ "CalendarManager" ] }, "description": "Allow to define the result of a get events iq request from Rainbow.", "name": "calendarManager" } ], "returns": [ { "type": { "names": [ "Promise." ] } } ], "longname": "module:PresenceService#sendResultCalendarEvents", "memberof": "module:PresenceService", "$longname": "PresenceService#sendResultCalendarEvents", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method setApplyMsTeamsPresenceSettings\n * @instance\n * @async\n * @category Presence CONNECTED USER\n * @description\n * Allow to activate the exchange of presence of the connected user between rainbow and MS Teams on UI side.
\n * @param {boolean} connectTeams=false The boolean to activate or not the feature.\n * @return {Promise}\n */", "meta": { "filename": "PresenceService.js", "lineno": 359, "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": "Presence CONNECTED USER", "value": "Presence CONNECTED USER" } ], "kind": "function", "name": "setApplyMsTeamsPresenceSettings", "scope": "instance", "async": true, "description": "Allow to activate the exchange of presence of the connected user between rainbow and MS Teams on UI side.
", "params": [ { "type": { "names": [ "boolean" ] }, "defaultvalue": false, "description": "The boolean to activate or not the feature.", "name": "connectTeams" } ], "returns": [ { "type": { "names": [ "Promise." ] } } ], "longname": "module:PresenceService#setApplyMsTeamsPresenceSettings", "memberof": "module:PresenceService", "$longname": "PresenceService#setApplyMsTeamsPresenceSettings", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method setCalendarRegister\n * @instance\n * @category Presence CALENDAR\n * @param {string} type Calendar type. Default : office365, Authorized values : office365, google\n * @param {boolean} redirect Immediately redirect to login page (OAuth2) or generate an HTML page. Default : false.\n * @param {string} callback Redirect URL to the requesting client.\n * @description\n * Register a new calendar.
\n * return promise with {\n * \"url\" : string // Calendar provider's OAuth URL
\n * }
\n * @async\n * @return {Promise<{\n * \"url\" : string\n * }, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 693, "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": "Presence CALENDAR", "value": "Presence CALENDAR" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "kind": "function", "name": "setCalendarRegister", "scope": "instance", "params": [ { "type": { "names": [ "string" ] }, "description": "Calendar type. Default : office365, Authorized values : office365, google", "name": "type" }, { "type": { "names": [ "boolean" ] }, "description": "Immediately redirect to login page (OAuth2) or generate an HTML page. Default : false.", "name": "redirect" }, { "type": { "names": [ "string" ] }, "description": "Redirect URL to the requesting client.", "name": "callback" } ], "description": "Register a new calendar.
\n return promise with {\n \"url\" : string // Calendar provider's OAuth URL
\n }
", "async": true, "returns": [ { "type": { "names": [ "Promise.<{\"url\": string}, ErrorManager>" ] } } ], "longname": "module:PresenceService#setCalendarRegister", "memberof": "module:PresenceService", "$longname": "PresenceService#setCalendarRegister", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method setPresenceTo\n * @instance\n * @async\n * @category Presence CONNECTED USER\n * @description\n * Allow to change the presence of the connected user
\n * Only the following values are authorized: 'dnd', 'away', 'invisible' or 'online'
\n * @param {String} presence The presence value to set i.e: 'dnd', 'away', 'invisible' ('xa' on server side) or 'online'\n * @return {Promise}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result (ErrorManager.getErrorManager().OK in case of success)\n \n */", "meta": { "filename": "PresenceService.js", "lineno": 154, "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": "Presence CONNECTED USER", "value": "Presence CONNECTED USER" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result (ErrorManager.getErrorManager().OK in case of success)", "value": "{ErrorManager} - ErrorManager object depending on the result (ErrorManager.getErrorManager().OK in case of success)" } ], "kind": "function", "name": "setPresenceTo", "scope": "instance", "async": true, "description": "Allow to change the presence of the connected user
\n Only the following values are authorized: 'dnd', 'away', 'invisible' or 'online'
", "params": [ { "type": { "names": [ "String" ] }, "description": "The presence value to set i.e: 'dnd', 'away', 'invisible' ('xa' on server side) or 'online'", "name": "presence" } ], "returns": [ { "type": { "names": [ "Promise." ] } } ], "longname": "module:PresenceService#setPresenceTo", "memberof": "module:PresenceService", "$longname": "PresenceService#setPresenceTo", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method unregisterCalendar\n * @instance\n * @category Presence CALENDAR\n * @description\n * Delete a calendar sharing.
\n * return promise with {
\n * Status : string // Operation status (\"deleted\")
\n * }
\n *
\n * @async\n * @return {Promise< {\n * Status : string\n * }, ErrorManager>}\n * @fulfil {ErrorManager} - ErrorManager object depending on the result.\n */", "meta": { "filename": "PresenceService.js", "lineno": 894, "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": "Presence CALENDAR", "value": "Presence CALENDAR" }, { "originalTitle": "fulfil", "title": "fulfil", "text": "{ErrorManager} - ErrorManager object depending on the result.", "value": "{ErrorManager} - ErrorManager object depending on the result." } ], "kind": "function", "name": "unregisterCalendar", "scope": "instance", "description": "Delete a calendar sharing.
\n return promise with {
\n Status : string // Operation status (\"deleted\")
\n }
\n
", "async": true, "returns": [ { "type": { "names": [ "Promise.<{Status: string}, ErrorManager>" ] } } ], "longname": "module:PresenceService#unregisterCalendar", "memberof": "module:PresenceService", "$longname": "PresenceService#unregisterCalendar", "$kind": "method" }, { "comment": "/**\n * @public\n * @nodered true\n * @method unregisterMsteamsPresenceSharing\n * @since 2.20.0\n * @instance\n * @category Manage Presence MSTeams\n * @async\n * @description\n * Delete a MS Teams presence sharing.
\n * A message stanza is sent to the user for multi-devices constraints.
\n * @return {Promise}

\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | Status | String | Operation status |\n *\n * */", "meta": { "filename": "PresenceService.js", "lineno": 1067, "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": "Manage Presence MSTeams", "value": "Manage Presence MSTeams" } ], "kind": "function", "name": "unregisterMsteamsPresenceSharing", "since": "2.20.0", "scope": "instance", "async": true, "description": "Delete a MS Teams presence sharing.
\n A message stanza is sent to the user for multi-devices constraints.
", "returns": [ { "type": { "names": [ "Promise." ] }, "description": "

\n\n| Champ | Type | Description |\n| --- | --- | --- |\n| Status | String | Operation status |" } ], "longname": "module:PresenceService#unregisterMsteamsPresenceSharing", "memberof": "module:PresenceService", "$longname": "PresenceService#unregisterMsteamsPresenceSharing", "$kind": "method" } ]