### SDK for Node.JS 2.4.0 - STS Version - September 2021
3-Release SDK Breaking Changes
- Warning: Starting 2019, the LTS active version of Node.js migrated to version 12.x. This version of SDK Node.js is only compliant with this LTS version up to 10.x.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- Fix typo in methods
AdminService::retrieveAllSubscribtionsOfCompanyByIdtoAdminService::retrieveAllSubscriptionsOfCompanyByIdandAdminService::getSubscribtionsOfCompanyByOfferIdtoAdminService::getSubscriptionsOfCompanyByOfferId
API Changes
- Update
ContactsService::getContactByLoginEmailmethod with a new parameterforceServerSearchboolean to force the search of the _contacts informations on the server. - Update
ImsService::sendMessageToConversationwith a new 'content' parameter to update message with a typed message.
Others Changes
- Update typescript lib
es2017toes2019 - Fix
ConversationsService::_onReceiptcallback to not failed even if the conversation is empty. - Fix pendingMessages treatment between Array and Object methods mixed in ConversationsService.
- Add method API
AlertsService::getAlertFeedbackSentForANotificationMessage. This API allows to list the feedback sent by the devices for a given notification message (identified by its notification history's id). - Add method API
AlertsService::getAlertFeedbackSentForAnAlert. This API allows to list the feedback sent by the devices for a given notification. - Add method API
AlertsService::getAlertStatsFeedbackSentForANotificationMessage. This API can be used to list all distinct feedback data submitted by the devices for a given notification message (identified by its notification history's id), with the number of devices for each distinct submitted feedback data. - Add method API
AlertsService::getReportComplete. Allows to get the fileDescriptor storing the detailed CSV report of the notification. - Add method API
AlertsService::getAlertFeedbackSentForANotificationMessage. - Add support of oauth tokens provided by application at
startof the SDK and also the api to set the renewed tokensetRenewedToken. There is a sample using the oauth and sdk at https://github.com/Rainbow-CPaaS/passport-rainbow-oauth2-with-rainbow-node-sdk-example - Fix
alternativeContentinMessageobject constructor. - Fix
emailsproperty inContactobject. - Add in
Contactobject properties isActive, accountType, systemId, isInitialized, initializationDate, createdBySelfRegister, createdByAppId, firstLoginDate, lastLoginDate, loggedSince, failedLoginAttempts, lastLoginFailureDate, lastExpiredTokenRenewedDate, lastPasswordUpdateDate, timeToLive, timeToLiveDate, terminatedDate, fileSharingCustomisation, userTitleNameCustomisation, softphoneOnlyCustomisation, useRoomCustomisation, phoneMeetingCustomisation, useChannelCustomisation, useScreenSharingCustomisation, useWebRTCAudioCustomisation, useWebRTCVideoCustomisation, instantMessagesCustomisation, userProfileCustomisation, fileStorageCustomisation, overridePresenceCustomisation, changeTelephonyCustomisation, changeSettingsCustomisation, recordingConversationCustomisation, useGifCustomisation, useDialOutCustomisation, fileCopyCustomisation, fileTransferCustomisation, forbidFileOwnerChangeCustomisation, readReceiptsCustomisation, useSpeakingTimeStatistics, selectedAppCustomisationTemplate, alertNotificationReception, selectedDeviceFirmware, visibility, jid_password, creationDate, profiles, activationDate, lastOfflineMailReceivedDate, state, authenticationType, department, isADSearchAvailable, isTv, calendars, openInvites. - Add support of
Oauth tokenprovided atstartof the SDK. In this use case application MUST implement the refresh token and send it back to SDK withsetRenewedTokenAPI, while following event are raised :
* Events rainbow_onusertokenrenewfailed : fired when an oauth token is expired.
* Events rainbow_onusertokenwillexpire : fired when the duration of the current user token reaches half of the maximum time. - Remove the "Authorization" property from http headers when openning the XMPP socket.
- Add
ContactsService::getMyInformationsAPI to Get informations about the connected user. - Update stop of logger to stop winston library.
- Fix the XMPPService (handleXMPPConnection) when ERROR_EVENT happenned to stop the ping timer only when the error is a fatal one.
- Change to keep DEBUG with "logs.system-dev.*" in STS delivery. Do not forget that when properties of this section are setted then personnal datas are displayed in logs, so it is not RGPD compatible.is Do not activate it in production systems.