@ale-rainbow/web-sdk 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -0
- package/lib/index.d.ts +8 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +501 -0
- package/lib/index.js.map +7 -0
- package/lib/libs/index.d.ts +3 -0
- package/lib/libs/index.d.ts.map +1 -0
- package/lib/libs/strophe/strophe-plugin.d.ts +13 -0
- package/lib/libs/strophe/strophe-plugin.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.d.ts +35 -0
- package/lib/libs/strophe/strophe.jingle.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.sdp.d.ts +44 -0
- package/lib/libs/strophe/strophe.jingle.sdp.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.session.d.ts +624 -0
- package/lib/libs/strophe/strophe.jingle.session.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.jingle.session.stats.d.ts +791 -0
- package/lib/libs/strophe/strophe.jingle.session.stats.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.lastactivity.d.ts +9 -0
- package/lib/libs/strophe/strophe.lastactivity.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.mam.d.ts +11 -0
- package/lib/libs/strophe/strophe.mam.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.ping.d.ts +39 -0
- package/lib/libs/strophe/strophe.ping.d.ts.map +1 -0
- package/lib/libs/strophe/strophe.rsm.d.ts +24 -0
- package/lib/libs/strophe/strophe.rsm.d.ts.map +1 -0
- package/lib/libs/strophe/types.d.ts +23 -0
- package/lib/libs/strophe/types.d.ts.map +1 -0
- package/lib/models/authSettings.model.d.ts +38 -0
- package/lib/models/authSettings.model.d.ts.map +1 -0
- package/lib/models/bubble.model.d.ts +1114 -0
- package/lib/models/bubble.model.d.ts.map +1 -0
- package/lib/models/bubbleConferenceRecap.model.d.ts +532 -0
- package/lib/models/bubbleConferenceRecap.model.d.ts.map +1 -0
- package/lib/models/call.model.d.ts +1271 -0
- package/lib/models/call.model.d.ts.map +1 -0
- package/lib/models/callLog.model.d.ts +361 -0
- package/lib/models/callLog.model.d.ts.map +1 -0
- package/lib/models/channel.model.d.ts +692 -0
- package/lib/models/channel.model.d.ts.map +1 -0
- package/lib/models/channelMessage.model.d.ts +300 -0
- package/lib/models/channelMessage.model.d.ts.map +1 -0
- package/lib/models/cli.model.d.ts +59 -0
- package/lib/models/cli.model.d.ts.map +1 -0
- package/lib/models/common/context.d.ts +37 -0
- package/lib/models/common/context.d.ts.map +1 -0
- package/lib/models/common/error.d.ts +26 -0
- package/lib/models/common/error.d.ts.map +1 -0
- package/lib/models/common/fileDescriptor.d.ts +317 -0
- package/lib/models/common/fileDescriptor.d.ts.map +1 -0
- package/lib/models/common/filePublicDownload.d.ts +26 -0
- package/lib/models/common/filePublicDownload.d.ts.map +1 -0
- package/lib/models/common/fileViewer.d.ts +20 -0
- package/lib/models/common/fileViewer.d.ts.map +1 -0
- package/lib/models/common/index.d.ts +9 -0
- package/lib/models/common/index.d.ts.map +1 -0
- package/lib/models/common/theme.d.ts +185 -0
- package/lib/models/common/theme.d.ts.map +1 -0
- package/lib/models/common/themeColor.d.ts +47 -0
- package/lib/models/common/themeColor.d.ts.map +1 -0
- package/lib/models/common/userTheme.d.ts +42 -0
- package/lib/models/common/userTheme.d.ts.map +1 -0
- package/lib/models/company-invitation.model.d.ts +42 -0
- package/lib/models/company-invitation.model.d.ts.map +1 -0
- package/lib/models/company.model.d.ts +639 -0
- package/lib/models/company.model.d.ts.map +1 -0
- package/lib/models/contact.model.d.ts +1208 -0
- package/lib/models/contact.model.d.ts.map +1 -0
- package/lib/models/conversation.model.d.ts +768 -0
- package/lib/models/conversation.model.d.ts.map +1 -0
- package/lib/models/customManifest.model.d.ts +82 -0
- package/lib/models/customManifest.model.d.ts.map +1 -0
- package/lib/models/dataChannel.model.d.ts +178 -0
- package/lib/models/dataChannel.model.d.ts.map +1 -0
- package/lib/models/dial-in-phone-numbers.model.d.ts +18 -0
- package/lib/models/dial-in-phone-numbers.model.d.ts.map +1 -0
- package/lib/models/directoryContact.model.d.ts +205 -0
- package/lib/models/directoryContact.model.d.ts.map +1 -0
- package/lib/models/event.model.d.ts +14 -0
- package/lib/models/event.model.d.ts.map +1 -0
- package/lib/models/favorite.model.d.ts +94 -0
- package/lib/models/favorite.model.d.ts.map +1 -0
- package/lib/models/fileDocument.model.d.ts +345 -0
- package/lib/models/fileDocument.model.d.ts.map +1 -0
- package/lib/models/geoLoc.model.d.ts +6 -0
- package/lib/models/geoLoc.model.d.ts.map +1 -0
- package/lib/models/index.d.ts +46 -0
- package/lib/models/index.d.ts.map +1 -0
- package/lib/models/invitation.model.d.ts +88 -0
- package/lib/models/invitation.model.d.ts.map +1 -0
- package/lib/models/invoices.model.d.ts +76 -0
- package/lib/models/invoices.model.d.ts.map +1 -0
- package/lib/models/logEntry.model.d.ts +23 -0
- package/lib/models/logEntry.model.d.ts.map +1 -0
- package/lib/models/message.model.d.ts +400 -0
- package/lib/models/message.model.d.ts.map +1 -0
- package/lib/models/messageAdditionalContent.parsers.d.ts +32 -0
- package/lib/models/messageAdditionalContent.parsers.d.ts.map +1 -0
- package/lib/models/offer.model.d.ts +16 -0
- package/lib/models/offer.model.d.ts.map +1 -0
- package/lib/models/p2pRecap.model.d.ts +372 -0
- package/lib/models/p2pRecap.model.d.ts.map +1 -0
- package/lib/models/paymentMethods.model.d.ts +98 -0
- package/lib/models/paymentMethods.model.d.ts.map +1 -0
- package/lib/models/personalRoutine.model.d.ts +173 -0
- package/lib/models/personalRoutine.model.d.ts.map +1 -0
- package/lib/models/poll.model.d.ts +139 -0
- package/lib/models/poll.model.d.ts.map +1 -0
- package/lib/models/rainbow-auth.model.d.ts +137 -0
- package/lib/models/rainbow-auth.model.d.ts.map +1 -0
- package/lib/models/searchTextConvResults.model.d.ts +30 -0
- package/lib/models/searchTextConvResults.model.d.ts.map +1 -0
- package/lib/models/site.model.d.ts +165 -0
- package/lib/models/site.model.d.ts.map +1 -0
- package/lib/models/subscription.model.d.ts +592 -0
- package/lib/models/subscription.model.d.ts.map +1 -0
- package/lib/models/telephonyConfig.model.d.ts +144 -0
- package/lib/models/telephonyConfig.model.d.ts.map +1 -0
- package/lib/models/telephonyForward.model.d.ts +47 -0
- package/lib/models/telephonyForward.model.d.ts.map +1 -0
- package/lib/models/todo.model.d.ts +103 -0
- package/lib/models/todo.model.d.ts.map +1 -0
- package/lib/models/transcription.model.d.ts +59 -0
- package/lib/models/transcription.model.d.ts.map +1 -0
- package/lib/models/user.model.d.ts +1008 -0
- package/lib/models/user.model.d.ts.map +1 -0
- package/lib/models/userProfileTemplate.model.d.ts +735 -0
- package/lib/models/userProfileTemplate.model.d.ts.map +1 -0
- package/lib/models/usersList.model.d.ts +117 -0
- package/lib/models/usersList.model.d.ts.map +1 -0
- package/lib/models/webConferenceParticipant.model.d.ts +135 -0
- package/lib/models/webConferenceParticipant.model.d.ts.map +1 -0
- package/lib/models/webConferenceSession.model.d.ts +658 -0
- package/lib/models/webConferenceSession.model.d.ts.map +1 -0
- package/lib/models/webinar.model.d.ts +738 -0
- package/lib/models/webinar.model.d.ts.map +1 -0
- package/lib/models/webinarRecap.model.d.ts +118 -0
- package/lib/models/webinarRecap.model.d.ts.map +1 -0
- package/lib/node.d.ts +3 -0
- package/lib/node.d.ts.map +1 -0
- package/lib/node.js +423 -0
- package/lib/node.js.map +7 -0
- package/lib/node.sdk.d.ts +41 -0
- package/lib/node.sdk.d.ts.map +1 -0
- package/lib/plugins/admin.plugin.d.ts +6 -0
- package/lib/plugins/admin.plugin.d.ts.map +1 -0
- package/lib/plugins/bubbleConference.plugin.d.ts +6 -0
- package/lib/plugins/bubbleConference.plugin.d.ts.map +1 -0
- package/lib/plugins/bubbleTag.plugin.d.ts +6 -0
- package/lib/plugins/bubbleTag.plugin.d.ts.map +1 -0
- package/lib/plugins/bubbles.plugin.d.ts +6 -0
- package/lib/plugins/bubbles.plugin.d.ts.map +1 -0
- package/lib/plugins/businessDirectory.plugin.d.ts +6 -0
- package/lib/plugins/businessDirectory.plugin.d.ts.map +1 -0
- package/lib/plugins/callRecorder.plugin.d.ts +6 -0
- package/lib/plugins/callRecorder.plugin.d.ts.map +1 -0
- package/lib/plugins/calllog.plugin.d.ts +6 -0
- package/lib/plugins/calllog.plugin.d.ts.map +1 -0
- package/lib/plugins/calls.plugin.d.ts +6 -0
- package/lib/plugins/calls.plugin.d.ts.map +1 -0
- package/lib/plugins/channels.plugin.d.ts +6 -0
- package/lib/plugins/channels.plugin.d.ts.map +1 -0
- package/lib/plugins/dataChannel.plugin.d.ts +6 -0
- package/lib/plugins/dataChannel.plugin.d.ts.map +1 -0
- package/lib/plugins/deviceManagement.plugin.d.ts +6 -0
- package/lib/plugins/deviceManagement.plugin.d.ts.map +1 -0
- package/lib/plugins/favorites.plugin.d.ts +6 -0
- package/lib/plugins/favorites.plugin.d.ts.map +1 -0
- package/lib/plugins/fileDocument.plugin.d.ts +6 -0
- package/lib/plugins/fileDocument.plugin.d.ts.map +1 -0
- package/lib/plugins/helpCenter.plugin.d.ts +6 -0
- package/lib/plugins/helpCenter.plugin.d.ts.map +1 -0
- package/lib/plugins/index.d.ts +27 -0
- package/lib/plugins/index.d.ts.map +1 -0
- package/lib/plugins/microsoft0365Ad.plugin.d.ts +6 -0
- package/lib/plugins/microsoft0365Ad.plugin.d.ts.map +1 -0
- package/lib/plugins/pbxUsers.plugin.d.ts +6 -0
- package/lib/plugins/pbxUsers.plugin.d.ts.map +1 -0
- package/lib/plugins/personalDirectory.plugin.d.ts +6 -0
- package/lib/plugins/personalDirectory.plugin.d.ts.map +1 -0
- package/lib/plugins/plugin.d.ts +8 -0
- package/lib/plugins/plugin.d.ts.map +1 -0
- package/lib/plugins/polls.plugin.d.ts +6 -0
- package/lib/plugins/polls.plugin.d.ts.map +1 -0
- package/lib/plugins/rpc.plugin.d.ts +6 -0
- package/lib/plugins/rpc.plugin.d.ts.map +1 -0
- package/lib/plugins/telemetry.plugin.d.ts +6 -0
- package/lib/plugins/telemetry.plugin.d.ts.map +1 -0
- package/lib/plugins/telephony.plugin.d.ts +6 -0
- package/lib/plugins/telephony.plugin.d.ts.map +1 -0
- package/lib/plugins/telephonyConfig.plugin.d.ts +6 -0
- package/lib/plugins/telephonyConfig.plugin.d.ts.map +1 -0
- package/lib/plugins/transcription.plugin.d.ts +6 -0
- package/lib/plugins/transcription.plugin.d.ts.map +1 -0
- package/lib/plugins/usersList.plugin.d.ts +6 -0
- package/lib/plugins/usersList.plugin.d.ts.map +1 -0
- package/lib/plugins/virtualBackground.plugin.d.ts +6 -0
- package/lib/plugins/virtualBackground.plugin.d.ts.map +1 -0
- package/lib/plugins/webinar.plugin.d.ts +6 -0
- package/lib/plugins/webinar.plugin.d.ts.map +1 -0
- package/lib/rainbow.sdk.d.ts +309 -0
- package/lib/rainbow.sdk.d.ts.map +1 -0
- package/lib/services/admin/admin-alarm.service.d.ts +42 -0
- package/lib/services/admin/admin-alarm.service.d.ts.map +1 -0
- package/lib/services/admin/admin-company.service.d.ts +167 -0
- package/lib/services/admin/admin-company.service.d.ts.map +1 -0
- package/lib/services/admin/admin-department.service.d.ts +39 -0
- package/lib/services/admin/admin-department.service.d.ts.map +1 -0
- package/lib/services/admin/admin-invitation.service.d.ts +114 -0
- package/lib/services/admin/admin-invitation.service.d.ts.map +1 -0
- package/lib/services/admin/admin-management.service.d.ts +100 -0
- package/lib/services/admin/admin-management.service.d.ts.map +1 -0
- package/lib/services/admin/admin-rvcp.service.d.ts +43 -0
- package/lib/services/admin/admin-rvcp.service.d.ts.map +1 -0
- package/lib/services/admin/admin-site.service.d.ts +64 -0
- package/lib/services/admin/admin-site.service.d.ts.map +1 -0
- package/lib/services/admin/admin-subscription.service.d.ts +135 -0
- package/lib/services/admin/admin-subscription.service.d.ts.map +1 -0
- package/lib/services/admin/admin-tag.service.d.ts +79 -0
- package/lib/services/admin/admin-tag.service.d.ts.map +1 -0
- package/lib/services/admin/admin-user-profile.service.d.ts +76 -0
- package/lib/services/admin/admin-user-profile.service.d.ts.map +1 -0
- package/lib/services/admin/admin-user.service.d.ts +338 -0
- package/lib/services/admin/admin-user.service.d.ts.map +1 -0
- package/lib/services/admin/admin.common.d.ts +40 -0
- package/lib/services/admin/admin.common.d.ts.map +1 -0
- package/lib/services/admin/admin.service.d.ts +138 -0
- package/lib/services/admin/admin.service.d.ts.map +1 -0
- package/lib/services/admin/index.d.ts +14 -0
- package/lib/services/admin/index.d.ts.map +1 -0
- package/lib/services/bot/bot.service.d.ts +121 -0
- package/lib/services/bot/bot.service.d.ts.map +1 -0
- package/lib/services/bubbles/bubble.service.d.ts +889 -0
- package/lib/services/bubbles/bubble.service.d.ts.map +1 -0
- package/lib/services/bubbles/bubbleTag.service.d.ts +132 -0
- package/lib/services/bubbles/bubbleTag.service.d.ts.map +1 -0
- package/lib/services/bubbles/index.d.ts +3 -0
- package/lib/services/bubbles/index.d.ts.map +1 -0
- package/lib/services/call/call.service.d.ts +297 -0
- package/lib/services/call/call.service.d.ts.map +1 -0
- package/lib/services/call/callRecorder.service.d.ts +358 -0
- package/lib/services/call/callRecorder.service.d.ts.map +1 -0
- package/lib/services/call/index.d.ts +3 -0
- package/lib/services/call/index.d.ts.map +1 -0
- package/lib/services/callLog/callLog.service.d.ts +563 -0
- package/lib/services/callLog/callLog.service.d.ts.map +1 -0
- package/lib/services/callLog/index.d.ts +5 -0
- package/lib/services/callLog/index.d.ts.map +1 -0
- package/lib/services/callLog/p2pRecap.service.d.ts +206 -0
- package/lib/services/callLog/p2pRecap.service.d.ts.map +1 -0
- package/lib/services/channels/channel.service.d.ts +626 -0
- package/lib/services/channels/channel.service.d.ts.map +1 -0
- package/lib/services/channels/index.d.ts +3 -0
- package/lib/services/channels/index.d.ts.map +1 -0
- package/lib/services/citrix/citrix.service.d.ts +30 -0
- package/lib/services/citrix/citrix.service.d.ts.map +1 -0
- package/lib/services/citrix/index.d.ts +3 -0
- package/lib/services/citrix/index.d.ts.map +1 -0
- package/lib/services/company/company-directory.service.d.ts +222 -0
- package/lib/services/company/company-directory.service.d.ts.map +1 -0
- package/lib/services/conference/bubbleConference.service.d.ts +1237 -0
- package/lib/services/conference/bubbleConference.service.d.ts.map +1 -0
- package/lib/services/conference/bubbleConferenceRecap.service.d.ts +159 -0
- package/lib/services/conference/bubbleConferenceRecap.service.d.ts.map +1 -0
- package/lib/services/conference/index.d.ts +5 -0
- package/lib/services/conference/index.d.ts.map +1 -0
- package/lib/services/conference/webConferenceHelper.d.ts +25 -0
- package/lib/services/conference/webConferenceHelper.d.ts.map +1 -0
- package/lib/services/conversation/conversation.service.d.ts +723 -0
- package/lib/services/conversation/conversation.service.d.ts.map +1 -0
- package/lib/services/conversation/conversationServiceBulkHistoryHandler.d.ts +39 -0
- package/lib/services/conversation/conversationServiceBulkHistoryHandler.d.ts.map +1 -0
- package/lib/services/conversation/conversationServiceEventHandler.d.ts +78 -0
- package/lib/services/conversation/conversationServiceEventHandler.d.ts.map +1 -0
- package/lib/services/conversation/index.d.ts +3 -0
- package/lib/services/conversation/index.d.ts.map +1 -0
- package/lib/services/core/account.service.d.ts +98 -0
- package/lib/services/core/account.service.d.ts.map +1 -0
- package/lib/services/core/auth.service.d.ts +303 -0
- package/lib/services/core/auth.service.d.ts.map +1 -0
- package/lib/services/core/company.service.d.ts +30 -0
- package/lib/services/core/company.service.d.ts.map +1 -0
- package/lib/services/core/connection.service.d.ts +209 -0
- package/lib/services/core/connection.service.d.ts.map +1 -0
- package/lib/services/core/contact.service.d.ts +617 -0
- package/lib/services/core/contact.service.d.ts.map +1 -0
- package/lib/services/core/country.service.d.ts +66 -0
- package/lib/services/core/country.service.d.ts.map +1 -0
- package/lib/services/core/directorySearch.service.d.ts +305 -0
- package/lib/services/core/directorySearch.service.d.ts.map +1 -0
- package/lib/services/core/event.service.d.ts +31 -0
- package/lib/services/core/event.service.d.ts.map +1 -0
- package/lib/services/core/i18n.service.d.ts +19 -0
- package/lib/services/core/i18n.service.d.ts.map +1 -0
- package/lib/services/core/imageUtils.service.d.ts +15 -0
- package/lib/services/core/imageUtils.service.d.ts.map +1 -0
- package/lib/services/core/index.d.ts +19 -0
- package/lib/services/core/index.d.ts.map +1 -0
- package/lib/services/core/logger.service.d.ts +143 -0
- package/lib/services/core/logger.service.d.ts.map +1 -0
- package/lib/services/core/logging.service.d.ts +51 -0
- package/lib/services/core/logging.service.d.ts.map +1 -0
- package/lib/services/core/main.service.d.ts +124 -0
- package/lib/services/core/main.service.d.ts.map +1 -0
- package/lib/services/core/presenceHelper.service.d.ts +73 -0
- package/lib/services/core/presenceHelper.service.d.ts.map +1 -0
- package/lib/services/core/profile.service.d.ts +453 -0
- package/lib/services/core/profile.service.d.ts.map +1 -0
- package/lib/services/core/settings.service.d.ts +82 -0
- package/lib/services/core/settings.service.d.ts.map +1 -0
- package/lib/services/core/userInfo.service.d.ts +25 -0
- package/lib/services/core/userInfo.service.d.ts.map +1 -0
- package/lib/services/core/userNetwork.service.d.ts +171 -0
- package/lib/services/core/userNetwork.service.d.ts.map +1 -0
- package/lib/services/core/xmpp.service.d.ts +99 -0
- package/lib/services/core/xmpp.service.d.ts.map +1 -0
- package/lib/services/dataChannel/dataChannel.service.d.ts +102 -0
- package/lib/services/dataChannel/dataChannel.service.d.ts.map +1 -0
- package/lib/services/dataChannel/index.d.ts +3 -0
- package/lib/services/dataChannel/index.d.ts.map +1 -0
- package/lib/services/deviceManagement/deviceEchoFilter.d.ts +86 -0
- package/lib/services/deviceManagement/deviceEchoFilter.d.ts.map +1 -0
- package/lib/services/deviceManagement/deviceManagement.service.d.ts +290 -0
- package/lib/services/deviceManagement/deviceManagement.service.d.ts.map +1 -0
- package/lib/services/deviceManagement/index.d.ts +2 -0
- package/lib/services/deviceManagement/index.d.ts.map +1 -0
- package/lib/services/deviceManagement/webHidManager.service.d.ts +616 -0
- package/lib/services/deviceManagement/webHidManager.service.d.ts.map +1 -0
- package/lib/services/directory/directory.service.d.ts +108 -0
- package/lib/services/directory/directory.service.d.ts.map +1 -0
- package/lib/services/directory/index.d.ts +3 -0
- package/lib/services/directory/index.d.ts.map +1 -0
- package/lib/services/directory/office365ad.service.d.ts +74 -0
- package/lib/services/directory/office365ad.service.d.ts.map +1 -0
- package/lib/services/directory/personal-directory.service.d.ts +425 -0
- package/lib/services/directory/personal-directory.service.d.ts.map +1 -0
- package/lib/services/directory/phonebook.service.d.ts +43 -0
- package/lib/services/directory/phonebook.service.d.ts.map +1 -0
- package/lib/services/event-mixin.d.ts +75 -0
- package/lib/services/event-mixin.d.ts.map +1 -0
- package/lib/services/favorites/favorites.service.d.ts +313 -0
- package/lib/services/favorites/favorites.service.d.ts.map +1 -0
- package/lib/services/favorites/index.d.ts +3 -0
- package/lib/services/favorites/index.d.ts.map +1 -0
- package/lib/services/fileDocument/fileDocument.service.d.ts +229 -0
- package/lib/services/fileDocument/fileDocument.service.d.ts.map +1 -0
- package/lib/services/fileDocument/index.d.ts +5 -0
- package/lib/services/fileDocument/index.d.ts.map +1 -0
- package/lib/services/files/fileDescriptorEventHandler.service.d.ts +18 -0
- package/lib/services/files/fileDescriptorEventHandler.service.d.ts.map +1 -0
- package/lib/services/files/fileServer.service.d.ts +268 -0
- package/lib/services/files/fileServer.service.d.ts.map +1 -0
- package/lib/services/files/fileStorage.service.d.ts +426 -0
- package/lib/services/files/fileStorage.service.d.ts.map +1 -0
- package/lib/services/helpcenter/helpCenter.service.d.ts +207 -0
- package/lib/services/helpcenter/helpCenter.service.d.ts.map +1 -0
- package/lib/services/helpcenter/index.d.ts +4 -0
- package/lib/services/helpcenter/index.d.ts.map +1 -0
- package/lib/services/helpcenter/whatsNew.service.d.ts +47 -0
- package/lib/services/helpcenter/whatsNew.service.d.ts.map +1 -0
- package/lib/services/horizon/horizon.service.d.ts +31 -0
- package/lib/services/horizon/horizon.service.d.ts.map +1 -0
- package/lib/services/horizon/index.d.ts +3 -0
- package/lib/services/horizon/index.d.ts.map +1 -0
- package/lib/services/index.d.ts +35 -0
- package/lib/services/index.d.ts.map +1 -0
- package/lib/services/launcher/config/sdkLaunchConfig.d.ts +8 -0
- package/lib/services/launcher/config/sdkLaunchConfig.d.ts.map +1 -0
- package/lib/services/localTranslation/chromeTranslation.engine.d.ts +79 -0
- package/lib/services/localTranslation/chromeTranslation.engine.d.ts.map +1 -0
- package/lib/services/localTranslation/index.d.ts +6 -0
- package/lib/services/localTranslation/index.d.ts.map +1 -0
- package/lib/services/localTranslation/localTranslation.service.d.ts +129 -0
- package/lib/services/localTranslation/localTranslation.service.d.ts.map +1 -0
- package/lib/services/localTranslation/translationEngine.d.ts +81 -0
- package/lib/services/localTranslation/translationEngine.d.ts.map +1 -0
- package/lib/services/metrics/analytics.service.d.ts +63 -0
- package/lib/services/metrics/analytics.service.d.ts.map +1 -0
- package/lib/services/metrics/index.d.ts +2 -0
- package/lib/services/metrics/index.d.ts.map +1 -0
- package/lib/services/notifications/index.d.ts +2 -0
- package/lib/services/notifications/index.d.ts.map +1 -0
- package/lib/services/notifications/notificationCenter.service.d.ts +178 -0
- package/lib/services/notifications/notificationCenter.service.d.ts.map +1 -0
- package/lib/services/notifications/notificationsViewer.service.d.ts +46 -0
- package/lib/services/notifications/notificationsViewer.service.d.ts.map +1 -0
- package/lib/services/personalRoutines/personal-routines.service.d.ts +159 -0
- package/lib/services/personalRoutines/personal-routines.service.d.ts.map +1 -0
- package/lib/services/polls/index.d.ts +2 -0
- package/lib/services/polls/index.d.ts.map +1 -0
- package/lib/services/polls/polls.service.d.ts +139 -0
- package/lib/services/polls/polls.service.d.ts.map +1 -0
- package/lib/services/ringing/index.d.ts +2 -0
- package/lib/services/ringing/index.d.ts.map +1 -0
- package/lib/services/ringing/ringing.service.d.ts +535 -0
- package/lib/services/ringing/ringing.service.d.ts.map +1 -0
- package/lib/services/rpc/index.d.ts +2 -0
- package/lib/services/rpc/index.d.ts.map +1 -0
- package/lib/services/rpc/rpc.service.d.ts +75 -0
- package/lib/services/rpc/rpc.service.d.ts.map +1 -0
- package/lib/services/service.d.ts +9 -0
- package/lib/services/service.d.ts.map +1 -0
- package/lib/services/speechRecognitionService/speechRecognition.service.d.ts +87 -0
- package/lib/services/speechRecognitionService/speechRecognition.service.d.ts.map +1 -0
- package/lib/services/subscription/index.d.ts +4 -0
- package/lib/services/subscription/index.d.ts.map +1 -0
- package/lib/services/subscription/invoices.service.d.ts +78 -0
- package/lib/services/subscription/invoices.service.d.ts.map +1 -0
- package/lib/services/subscription/paymentMethods.service.d.ts +164 -0
- package/lib/services/subscription/paymentMethods.service.d.ts.map +1 -0
- package/lib/services/subscription/subscription.service.d.ts +510 -0
- package/lib/services/subscription/subscription.service.d.ts.map +1 -0
- package/lib/services/support/index.d.ts +2 -0
- package/lib/services/support/index.d.ts.map +1 -0
- package/lib/services/support/support.model.d.ts +143 -0
- package/lib/services/support/support.model.d.ts.map +1 -0
- package/lib/services/support/support.service.d.ts +162 -0
- package/lib/services/support/support.service.d.ts.map +1 -0
- package/lib/services/telemetry/index.d.ts +3 -0
- package/lib/services/telemetry/index.d.ts.map +1 -0
- package/lib/services/telemetry/jsonRPC.service.d.ts +25 -0
- package/lib/services/telemetry/jsonRPC.service.d.ts.map +1 -0
- package/lib/services/telemetry/telemetry.service.d.ts +22 -0
- package/lib/services/telemetry/telemetry.service.d.ts.map +1 -0
- package/lib/services/telephony/index.d.ts +4 -0
- package/lib/services/telephony/index.d.ts.map +1 -0
- package/lib/services/telephony/supervision.service.d.ts +277 -0
- package/lib/services/telephony/supervision.service.d.ts.map +1 -0
- package/lib/services/telephony/telephony.service.d.ts +1476 -0
- package/lib/services/telephony/telephony.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonyCcdAgent.service.d.ts +63 -0
- package/lib/services/telephony/telephonyCcdAgent.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonyHybridEventHandler.d.ts +360 -0
- package/lib/services/telephony/telephonyHybridEventHandler.d.ts.map +1 -0
- package/lib/services/telephony/telephonyKeys.service.d.ts +86 -0
- package/lib/services/telephony/telephonyKeys.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonySipWise.service.d.ts +543 -0
- package/lib/services/telephony/telephonySipWise.service.d.ts.map +1 -0
- package/lib/services/telephony/telephonySipWiseEventHandler.d.ts +462 -0
- package/lib/services/telephony/telephonySipWiseEventHandler.d.ts.map +1 -0
- package/lib/services/telephonyConfig/index.d.ts +3 -0
- package/lib/services/telephonyConfig/index.d.ts.map +1 -0
- package/lib/services/telephonyConfig/telephonyConfig.service.d.ts +150 -0
- package/lib/services/telephonyConfig/telephonyConfig.service.d.ts.map +1 -0
- package/lib/services/todo/todo.service.d.ts +358 -0
- package/lib/services/todo/todo.service.d.ts.map +1 -0
- package/lib/services/transcription/index.d.ts +2 -0
- package/lib/services/transcription/index.d.ts.map +1 -0
- package/lib/services/transcription/liveTranscription.service.d.ts +94 -0
- package/lib/services/transcription/liveTranscription.service.d.ts.map +1 -0
- package/lib/services/ulrMetadata/urlMetadata.service.d.ts +51 -0
- package/lib/services/ulrMetadata/urlMetadata.service.d.ts.map +1 -0
- package/lib/services/users/index.d.ts +3 -0
- package/lib/services/users/index.d.ts.map +1 -0
- package/lib/services/users/user.service.d.ts +146 -0
- package/lib/services/users/user.service.d.ts.map +1 -0
- package/lib/services/users/usersLists.service.d.ts +239 -0
- package/lib/services/users/usersLists.service.d.ts.map +1 -0
- package/lib/services/utilities/browserDatabase.service.d.ts +69 -0
- package/lib/services/utilities/browserDatabase.service.d.ts.map +1 -0
- package/lib/services/utilities/errorHelper.service.d.ts +24 -0
- package/lib/services/utilities/errorHelper.service.d.ts.map +1 -0
- package/lib/services/utilities/index.d.ts +4 -0
- package/lib/services/utilities/index.d.ts.map +1 -0
- package/lib/services/utilities/utilities.service.d.ts +74 -0
- package/lib/services/utilities/utilities.service.d.ts.map +1 -0
- package/lib/services/virtualBackground/RBVirtualBackground.service.d.ts +228 -0
- package/lib/services/virtualBackground/RBVirtualBackground.service.d.ts.map +1 -0
- package/lib/services/virtualBackground/index.d.ts +4 -0
- package/lib/services/virtualBackground/index.d.ts.map +1 -0
- package/lib/services/virtualBackground/personalVideoBackground.d.ts +190 -0
- package/lib/services/virtualBackground/personalVideoBackground.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/canvas2D/canvas2DPipeline.d.ts +66 -0
- package/lib/services/virtualBackground/pipeline/canvas2D/canvas2DPipeline.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/blurStage.d.ts +88 -0
- package/lib/services/virtualBackground/pipeline/webgl2/blurStage.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/imageStage.d.ts +69 -0
- package/lib/services/virtualBackground/pipeline/webgl2/imageStage.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/jointBilateralFilter.d.ts +55 -0
- package/lib/services/virtualBackground/pipeline/webgl2/jointBilateralFilter.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/resizingStage.d.ts +59 -0
- package/lib/services/virtualBackground/pipeline/webgl2/resizingStage.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/softMax.d.ts +34 -0
- package/lib/services/virtualBackground/pipeline/webgl2/softMax.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webgl2Pipeline.d.ts +62 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webgl2Pipeline.d.ts.map +1 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webglHelper.d.ts +56 -0
- package/lib/services/virtualBackground/pipeline/webgl2/webglHelper.d.ts.map +1 -0
- package/lib/services/virtualBackground/virtualBackground.service.d.ts +399 -0
- package/lib/services/virtualBackground/virtualBackground.service.d.ts.map +1 -0
- package/lib/services/webinars/index.d.ts +10 -0
- package/lib/services/webinars/index.d.ts.map +1 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.model.d.ts +71 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.model.d.ts.map +1 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.service.d.ts +86 -0
- package/lib/services/webinars/telemetry/webinarTelemetry.service.d.ts.map +1 -0
- package/lib/services/webinars/telemetry/webinarTelemetryDatabase.d.ts +31 -0
- package/lib/services/webinars/telemetry/webinarTelemetryDatabase.d.ts.map +1 -0
- package/lib/services/webinars/webinarAudioMixer.d.ts +45 -0
- package/lib/services/webinars/webinarAudioMixer.d.ts.map +1 -0
- package/lib/services/webinars/webinarConference.service.d.ts +323 -0
- package/lib/services/webinars/webinarConference.service.d.ts.map +1 -0
- package/lib/services/webinars/webinarConference.utils.d.ts +24 -0
- package/lib/services/webinars/webinarConference.utils.d.ts.map +1 -0
- package/lib/services/webinars/webinarParticipants.service.d.ts +43 -0
- package/lib/services/webinars/webinarParticipants.service.d.ts.map +1 -0
- package/lib/services/webinars/webinarSpeakers.service.d.ts +25 -0
- package/lib/services/webinars/webinarSpeakers.service.d.ts.map +1 -0
- package/lib/services/webinars/webinarStoryLine.service.d.ts +117 -0
- package/lib/services/webinars/webinarStoryLine.service.d.ts.map +1 -0
- package/lib/services/webinars/webinars.service.d.ts +600 -0
- package/lib/services/webinars/webinars.service.d.ts.map +1 -0
- package/lib/services/webrtc/index.d.ts +5 -0
- package/lib/services/webrtc/index.d.ts.map +1 -0
- package/lib/services/webrtc/webrtcConfigAndUtils.d.ts +170 -0
- package/lib/services/webrtc/webrtcConfigAndUtils.d.ts.map +1 -0
- package/lib/services/webrtc/webrtcP2P.service.d.ts +521 -0
- package/lib/services/webrtc/webrtcP2P.service.d.ts.map +1 -0
- package/lib/services/webrtc/webrtcP2PEventHandler.d.ts +55 -0
- package/lib/services/webrtc/webrtcP2PEventHandler.d.ts.map +1 -0
- package/lib/services/webrtcGateway/webrtcGateway.service.d.ts +605 -0
- package/lib/services/webrtcGateway/webrtcGateway.service.d.ts.map +1 -0
- package/lib/strophejs.d.ts +3 -0
- package/lib/strophejs.d.ts.map +1 -0
- package/lib/typings/helpers.d.ts +3 -0
- package/lib/typings/helpers.d.ts.map +1 -0
- package/lib/utils/allSettled.d.ts +2 -0
- package/lib/utils/allSettled.d.ts.map +1 -0
- package/lib/utils/anonymizer.d.ts +28 -0
- package/lib/utils/anonymizer.d.ts.map +1 -0
- package/lib/utils/branded.d.ts +4 -0
- package/lib/utils/branded.d.ts.map +1 -0
- package/lib/utils/browser.d.ts +231 -0
- package/lib/utils/browser.d.ts.map +1 -0
- package/lib/utils/index.d.ts +12 -0
- package/lib/utils/index.d.ts.map +1 -0
- package/lib/utils/mediaPermissionError.d.ts +2 -0
- package/lib/utils/mediaPermissionError.d.ts.map +1 -0
- package/lib/utils/promiseQueue.d.ts +10 -0
- package/lib/utils/promiseQueue.d.ts.map +1 -0
- package/lib/utils/randomString.d.ts +3 -0
- package/lib/utils/randomString.d.ts.map +1 -0
- package/lib/utils/recordingArchiveName.d.ts +13 -0
- package/lib/utils/recordingArchiveName.d.ts.map +1 -0
- package/lib/utils/serverTimestamp.d.ts +15 -0
- package/lib/utils/serverTimestamp.d.ts.map +1 -0
- package/lib/utils/stringifyError.d.ts +2 -0
- package/lib/utils/stringifyError.d.ts.map +1 -0
- package/lib/utils/video.d.ts +27 -0
- package/lib/utils/video.d.ts.map +1 -0
- package/lib/utils/wait.d.ts +2 -0
- package/lib/utils/wait.d.ts.map +1 -0
- package/lib/utils/xmlParser.d.ts +102 -0
- package/lib/utils/xmlParser.d.ts.map +1 -0
- package/lib/utils/xmlValidation.d.ts +119 -0
- package/lib/utils/xmlValidation.d.ts.map +1 -0
- package/package.json +58 -0
|
@@ -0,0 +1,1208 @@
|
|
|
1
|
+
import type { Subscription } from "rxjs";
|
|
2
|
+
import { BehaviorSubject, Subject } from "rxjs";
|
|
3
|
+
import type { CompanyInfo, CompanyTrialType } from "../models/company.model";
|
|
4
|
+
import { Company } from "../models/company.model";
|
|
5
|
+
import { PersonalRoutine } from "../models/personalRoutine.model";
|
|
6
|
+
import { TelephonyForward } from "../models/telephonyForward.model";
|
|
7
|
+
import type { NetworkInvitation } from "../models/invitation.model";
|
|
8
|
+
import type { MultiFactorAuthStatus, MultiFactorAuthType } from "./rainbow-auth.model";
|
|
9
|
+
import type { ConnectedUserOxeTrunk, DisplayOrder, PostalAddress, Resource, User, UserAvatar, UserCustomStatus, UserEmailAddress, UserEvents, UserNotes, UserOwnFeatureCapabilities, UserPeerFeatureCapabilities, UserPhoneNumber } from "../models/user.model";
|
|
10
|
+
import type { Conversation } from "./conversation.model";
|
|
11
|
+
import type { ContactService } from "../services/core/contact.service";
|
|
12
|
+
import type { PresenceHelperService } from "../services/core/presenceHelper.service";
|
|
13
|
+
/**
|
|
14
|
+
* List of different types of users.
|
|
15
|
+
*/
|
|
16
|
+
export declare enum UserType {
|
|
17
|
+
/** Rainbow User */
|
|
18
|
+
USER = "User",
|
|
19
|
+
/** Microsoft Azure Directory contact */
|
|
20
|
+
O365_CONTACT = "O365Contact",
|
|
21
|
+
/** Outlook contact (Desktop only) */
|
|
22
|
+
OUTLOOK_CONTACT = "OutlookContact",
|
|
23
|
+
/** Business Directory contact */
|
|
24
|
+
BUSINESS_CONTACT = "BusinessContact",
|
|
25
|
+
/** Personal Directory contact */
|
|
26
|
+
PERSONAL_CONTACT = "PersonalContact",
|
|
27
|
+
/** PBX phonebook contact */
|
|
28
|
+
PHONEBOOK_CONTACT = "PhonebookContact",
|
|
29
|
+
/** BOT */
|
|
30
|
+
BOT = "Bot",
|
|
31
|
+
/** MCU BOT */
|
|
32
|
+
MCUBOT = "McuBot",
|
|
33
|
+
/** Rainbow Room */
|
|
34
|
+
RAINBOW_ROOM = "RainbowRoom",
|
|
35
|
+
/** Temporary contact used for internal purpose */
|
|
36
|
+
TEMP = "TemporaryInternal"
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* List of different email types a User can have.
|
|
40
|
+
*/
|
|
41
|
+
export declare enum EmailType {
|
|
42
|
+
/** Business email */
|
|
43
|
+
BUSINESS = "Business",
|
|
44
|
+
/** Personal email */
|
|
45
|
+
PERSONAL = "Personal"
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* List of different phone number types a User can have.
|
|
49
|
+
* Several telephone numbers can be defined for a user. This number depends on the type of user and his configuration:
|
|
50
|
+
* - The phone numbers the user specified in his profile or contact card.
|
|
51
|
+
* - The phone numbers defined by the administrator of his company.
|
|
52
|
+
* This applies in particular to the business number and the internal number associated with the telephony service.
|
|
53
|
+
* These numbers cannot be changed by an end-user.
|
|
54
|
+
* For a user, it is only possible to define one type of phone number.
|
|
55
|
+
*/
|
|
56
|
+
export declare enum PhoneNumberType {
|
|
57
|
+
/** Business landline phone number */
|
|
58
|
+
BUSINESS = "Business",
|
|
59
|
+
/** Business mobile phone number */
|
|
60
|
+
BUSINESS_MOBILE = "BusinessMobile",
|
|
61
|
+
/** Business internal phone number */
|
|
62
|
+
BUSINESS_INTERNAL = "BusinessInternal",
|
|
63
|
+
/** Personal phone number */
|
|
64
|
+
PERSONAL = "Personal",
|
|
65
|
+
/** Personal phone number */
|
|
66
|
+
PERSONAL_MOBILE = "PersonalMobile",
|
|
67
|
+
/** Other type of phone number */
|
|
68
|
+
OTHER = "Other"
|
|
69
|
+
}
|
|
70
|
+
export declare enum ReceivedFileCustomisationValue {
|
|
71
|
+
ENABLED = "enabled",
|
|
72
|
+
DISABLED = "disabled",
|
|
73
|
+
INTERNAL_ONLY = "internalOnly"
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* @internal
|
|
77
|
+
*/
|
|
78
|
+
export declare enum ccdModes {
|
|
79
|
+
DEFAULT = "default",
|
|
80
|
+
MIXED = "mixed",
|
|
81
|
+
FIXED = "fixed"
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* This interface is used to define the list of admin subcategories for user with the 'admin' role.
|
|
85
|
+
*/
|
|
86
|
+
export declare enum AdminType {
|
|
87
|
+
ORGANIZATION_ADMIN = "organization_admin",
|
|
88
|
+
COMPANY_ADMIN = "company_admin",
|
|
89
|
+
SITE_ADMIN = "site_admin",
|
|
90
|
+
COMPANY_SUPPORT = "company_support",
|
|
91
|
+
UNDEFINED = "undefined"
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* @internal
|
|
95
|
+
* State of the Office365 subscription of Rainbow user.
|
|
96
|
+
* Available only for the connected user and when Office365 is configured on admin side.
|
|
97
|
+
*/
|
|
98
|
+
export declare enum O365SubscriptionState {
|
|
99
|
+
/** No Calendar events / Teams presence synchronization activated */
|
|
100
|
+
INACTIVE = "inactive",
|
|
101
|
+
/** */
|
|
102
|
+
PENDING = "pending",
|
|
103
|
+
/** Synchronization of Calendar events + Teams presence activated*/
|
|
104
|
+
ACTIVE = "active",
|
|
105
|
+
/** Only Calendar events synchronization is activated */
|
|
106
|
+
ACTIVE_CALENDAR = "active_calendar",
|
|
107
|
+
/** Only Teams presence synchronization is activated */
|
|
108
|
+
ACTIVE_TEAMS = "active_teams",
|
|
109
|
+
/** */
|
|
110
|
+
ERROR = "error"
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* This interface is used to define the list of roles a user can have.
|
|
114
|
+
*/
|
|
115
|
+
export declare enum UserRole {
|
|
116
|
+
USER = "user",
|
|
117
|
+
GUEST = "guest",
|
|
118
|
+
SUPERADMIN = "superadmin",
|
|
119
|
+
SUPPORT = "support",
|
|
120
|
+
BUSINESS_ADMIN = "business_admin",
|
|
121
|
+
CUSTOMER_SUCCESS_ADMIN = "customer_success_admin",
|
|
122
|
+
ADMIN = "admin",
|
|
123
|
+
BP_ADMIN_OPERATIONS = "bp_admin",
|
|
124
|
+
BP_ADMIN_FINANCE = "bp_finance",
|
|
125
|
+
BP_ADMIN_ANALYTICS = "bp_analytics",
|
|
126
|
+
EC_ADMIN_ANALYTICS = "ec_analytics",
|
|
127
|
+
DIRECTORY_ADMIN = "directory_admin",
|
|
128
|
+
/**
|
|
129
|
+
* Right to create a channel with a visibility for all users (users of my company and other companies).
|
|
130
|
+
*/
|
|
131
|
+
PUBLIC_CHANNELS_ADMIN = "public_channels_admin",
|
|
132
|
+
/**
|
|
133
|
+
* Right to create a channel with a visibility limited to my company and a "closed" confidentiality.
|
|
134
|
+
* Selected or all users of my company will automatically be subscribed to the channel. They will not be able to unsubscribe.
|
|
135
|
+
*/
|
|
136
|
+
CLOSED_CHANNELS_ADMIN = "closed_channels_admin",
|
|
137
|
+
/**
|
|
138
|
+
* Right to create a channel with a visibility limited to my company and a "closed" confidentiality
|
|
139
|
+
* All users of my company will automatically be subscribed to the channel. They will not be able to unsubscribe.
|
|
140
|
+
*/
|
|
141
|
+
ALL_COMPANY_CHANNELS_ADMIN = "all_company_channels_admin",
|
|
142
|
+
SALES_ANALYTICS = "sales_analytics",
|
|
143
|
+
/** User allowed to get privacy data for any user within his company */
|
|
144
|
+
PRIVACY_OPERATIONS = "privacy_operations",
|
|
145
|
+
/** User allowed to create/update/launch webinars */
|
|
146
|
+
WEBINAR_HOST = "webinar_host",
|
|
147
|
+
/** User allowed to administer rooms (bubbles) for the company. */
|
|
148
|
+
ROOM_ADMIN = "room_admin",
|
|
149
|
+
/** User is supervisor of a supervision group. */
|
|
150
|
+
GROUP_SUPERVISOR = "supervisor",
|
|
151
|
+
/** Role allowing multiline softphone for Attendant Console features */
|
|
152
|
+
ATTENDANT_CONSOLE = "attendant",// attendant console role
|
|
153
|
+
/** User is running a time-limited webinar trial. Named "freemium" by the backend. */
|
|
154
|
+
WEBINAR_TRIAL = "webinar_trial",
|
|
155
|
+
/** User is running a time-limited collaboration trial. Named "freemium" by the backend. */
|
|
156
|
+
COLLABORATION_TRIAL = "collaboration_trial"
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Interface used only by UCaaS (Web Client) to manage the user connection wizard (1st connection).
|
|
160
|
+
* This interface must not be exposed to SDKv2, as properties manipulate data with names and values that are strongly correlated with the server
|
|
161
|
+
* Note that this data may be exposed to SDKv2 under another name and/or format, or not at all.
|
|
162
|
+
* Subscription profile as returned in the `profiles` array of the user payload. Only the fields
|
|
163
|
+
* needed to tell a running trial offer from a terminated one are declared here.
|
|
164
|
+
*
|
|
165
|
+
* @internal
|
|
166
|
+
*/
|
|
167
|
+
export interface UserSubscriptionProfile {
|
|
168
|
+
/** True when the offer is a freemium (trial) offer. */
|
|
169
|
+
isFreemium?: boolean;
|
|
170
|
+
/** Which trial the offer grants, e.g. "webinar" or "collaboration". Only set when `isFreemium` is true. */
|
|
171
|
+
freemiumType?: string;
|
|
172
|
+
/** Subscription status. A running trial is "active"; a superseded one is "terminated". */
|
|
173
|
+
status?: string;
|
|
174
|
+
/**
|
|
175
|
+
* True for the company's base offer — the Essential tier, which carries no licence.
|
|
176
|
+
* Mirrors {@link Offer.isEssential}, which is defined as this very flag.
|
|
177
|
+
*/
|
|
178
|
+
isDefault?: boolean;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* @internal
|
|
182
|
+
*/
|
|
183
|
+
export interface ConnectedUserInit {
|
|
184
|
+
/**
|
|
185
|
+
* This data must be set to 'true' as soon as the user is considered initialized, i.e.
|
|
186
|
+
* when he enters his firstname and lastname on his first connection.
|
|
187
|
+
*/
|
|
188
|
+
isInitialized?: boolean;
|
|
189
|
+
/**
|
|
190
|
+
* User visibility
|
|
191
|
+
* Specify whether the user can be searched by users in other companies and whether the user can search for users in other companies.
|
|
192
|
+
*/
|
|
193
|
+
visibility?: string;
|
|
194
|
+
/**
|
|
195
|
+
* Defines the user as a guest
|
|
196
|
+
* This allows someone who doesn't have a Rainbow user account to join a bubble and participate in the conversation thanks to an e-mail invitation.
|
|
197
|
+
*/
|
|
198
|
+
guestMode?: boolean;
|
|
199
|
+
/**
|
|
200
|
+
* The guest user's company name
|
|
201
|
+
*/
|
|
202
|
+
companyNameOfGuest?: string;
|
|
203
|
+
}
|
|
204
|
+
export interface CcdAgent {
|
|
205
|
+
mode: ccdModes;
|
|
206
|
+
agentPhoneNumber: string;
|
|
207
|
+
isCCDAgentLogged?: boolean;
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Interface used only by UCaaS (Web Client) to manage user communication information such as emails and phone numbers.
|
|
211
|
+
* This interface must not be exposed to SDKv2, as the properties (typed 'any') manipulate data with names and values
|
|
212
|
+
* that are strongly correlated with the server.
|
|
213
|
+
* Note that this data may be exposed to SDKv2 under another name and/or format, or not at all.
|
|
214
|
+
* @internal
|
|
215
|
+
*/
|
|
216
|
+
export interface ConnectedUserMedia {
|
|
217
|
+
/**
|
|
218
|
+
* Array of user emails addresses, each address entry represented by an JSON object in the format
|
|
219
|
+
* \{email: ..., type: ... \}
|
|
220
|
+
*/
|
|
221
|
+
emails?: any[];
|
|
222
|
+
/**
|
|
223
|
+
* Array of user phone numbers, each number entry represented as an JSON object
|
|
224
|
+
* \{ number: ..., type:...,, deviceType: ...,, isVisibleByOthers: ... \}
|
|
225
|
+
*/
|
|
226
|
+
phoneNumbers?: any[];
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Interface used (only for hub case) to store all secondary Ddi phone numbers.
|
|
230
|
+
* @internal
|
|
231
|
+
*/
|
|
232
|
+
export interface SecondaryDdiNumber {
|
|
233
|
+
phonePro: string;
|
|
234
|
+
phoneProCan: string;
|
|
235
|
+
secondaryDdiOrder: number;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* This class is used to represent a contact or the connected user.
|
|
239
|
+
* A contact is defined by a set of public information (name, firstname, avatar...) and a set of private information that are only shared with contacts that are in the user's network or in the same company (email, phone numbers...)
|
|
240
|
+
* @internal
|
|
241
|
+
*/
|
|
242
|
+
export declare class Contact implements User {
|
|
243
|
+
static SIPWISE_RVCP: string;
|
|
244
|
+
static NameUpdatePrio: {
|
|
245
|
+
NO_UPDATE_PRIO: number;
|
|
246
|
+
OUTLOOK_UPDATE_PRIO: number;
|
|
247
|
+
SERVER_UPDATE_PRIO: number;
|
|
248
|
+
MAX_UPDATE_PRIO: number;
|
|
249
|
+
};
|
|
250
|
+
static textAvatarColor: string[];
|
|
251
|
+
static textAvatarName: string[];
|
|
252
|
+
/** Weak reference on contactService */
|
|
253
|
+
/** Weak reference on contactService */
|
|
254
|
+
protected contactService?: ContactService;
|
|
255
|
+
protected presenceHelperService?: PresenceHelperService;
|
|
256
|
+
/** The contact IDentifier */
|
|
257
|
+
id: string;
|
|
258
|
+
/** The contact internal id */
|
|
259
|
+
dbId: string;
|
|
260
|
+
/** The contact XMPP bare jid */
|
|
261
|
+
jid: string;
|
|
262
|
+
/** The contact XMPP full jid */
|
|
263
|
+
fullJid: string;
|
|
264
|
+
/** The contact telephony XMPP jid */
|
|
265
|
+
jidtel: string;
|
|
266
|
+
/** The User main email adress which can also be used for login */
|
|
267
|
+
loginEmail: string;
|
|
268
|
+
/** Authentication/login via phone number */
|
|
269
|
+
loginPhone: string;
|
|
270
|
+
/** The contact title */
|
|
271
|
+
title: string;
|
|
272
|
+
/** The contact lastname */
|
|
273
|
+
lastname: string;
|
|
274
|
+
/** The contact firstname */
|
|
275
|
+
firstname: string;
|
|
276
|
+
/** The contact nickname */
|
|
277
|
+
nickname: string;
|
|
278
|
+
/** The contact initials */
|
|
279
|
+
initials: string;
|
|
280
|
+
/** Display format for users' full names (first and last names) data. */
|
|
281
|
+
displayOrder: DisplayOrder;
|
|
282
|
+
/** The job title of the contact */
|
|
283
|
+
jobTitle: string;
|
|
284
|
+
/** The contact language */
|
|
285
|
+
language: string;
|
|
286
|
+
/** The Country of the contact */
|
|
287
|
+
country: string;
|
|
288
|
+
/** The timezone of the contact*/
|
|
289
|
+
timezone: string;
|
|
290
|
+
/** The user avatar object */
|
|
291
|
+
set avatar(avatar: UserAvatar);
|
|
292
|
+
get avatar(): UserAvatar;
|
|
293
|
+
/** The user avatar last modification date */
|
|
294
|
+
lastAvatarUpdateDate: any;
|
|
295
|
+
/** Presence status of the user*/
|
|
296
|
+
status: "online" | "away" | "offline" | "unknown" | string;
|
|
297
|
+
get statusInfo(): string;
|
|
298
|
+
set statusInfo(info: string);
|
|
299
|
+
/** Indicates whether the contact is fully initialized */
|
|
300
|
+
initialized: boolean;
|
|
301
|
+
/** Indicates whether the user has been deleted */
|
|
302
|
+
isTerminated: boolean;
|
|
303
|
+
get terminated(): boolean;
|
|
304
|
+
lastSeenDate?: Date;
|
|
305
|
+
lastLoginDate?: Date;
|
|
306
|
+
subscriptionNames?: string[];
|
|
307
|
+
/** Set from `freemiumTypes`, which the backend fills for the trial funnel only. Kept after a purchase. */
|
|
308
|
+
private trialFunnelOrigin;
|
|
309
|
+
/**
|
|
310
|
+
* True when the only offers still running on the account are the Essential base tier — i.e. the
|
|
311
|
+
* user holds no paid licence. Derived from the running (`active`) entries of `profiles` only:
|
|
312
|
+
* the backend keeps terminated offers in that array, so an account downgraded back to Essential
|
|
313
|
+
* would otherwise never be recognised as one.
|
|
314
|
+
*/
|
|
315
|
+
private hasEssentialOfferOnly;
|
|
316
|
+
/**
|
|
317
|
+
* Sticky once a subscription goes through, because the tier below is recomputed from `profiles`
|
|
318
|
+
* on every payload read — including the XMPP contact events that keep arriving afterwards.
|
|
319
|
+
*
|
|
320
|
+
* ⚠️ TECH DEBT — the backend still serves the pre-subscription `profiles` for a few seconds,
|
|
321
|
+
* so a plain reset would be undone by the next event. Drop this once it answers in time.
|
|
322
|
+
*/
|
|
323
|
+
private leftEssentialTier;
|
|
324
|
+
get phoneNumbers(): UserPhoneNumber[];
|
|
325
|
+
get emails(): UserEmailAddress[];
|
|
326
|
+
get notes(): UserNotes;
|
|
327
|
+
/** Data aggregating all properties related to a postal address. */
|
|
328
|
+
get postalAddress(): PostalAddress;
|
|
329
|
+
/** Data aggregating flags already defined to characterise a contact. */
|
|
330
|
+
get userType(): UserType;
|
|
331
|
+
get guest(): boolean;
|
|
332
|
+
companyNameOfGuest: string;
|
|
333
|
+
/** Data aggregating all the User feature capabilities */
|
|
334
|
+
get ownFeatureCapabilities(): UserOwnFeatureCapabilities;
|
|
335
|
+
/** Data aggregating all the User feature capabilities */
|
|
336
|
+
get peerFeatureCapabilities(): UserPeerFeatureCapabilities;
|
|
337
|
+
/** The different roles assigned to the connected user */
|
|
338
|
+
roles: UserRole[];
|
|
339
|
+
/** If the connected user has the ‘admin’ role, specify the sub-category of this role. */
|
|
340
|
+
adminType: AdminType;
|
|
341
|
+
/** Indicates whether the user's company has the ALERT_NOTIFICATIONS_ALLOWED feature available via the ALERT offer. */
|
|
342
|
+
alertNotificationEnabledForMyCompany: boolean;
|
|
343
|
+
voicemailNumber: string;
|
|
344
|
+
private _customStatus;
|
|
345
|
+
get customStatus(): UserCustomStatus;
|
|
346
|
+
set customStatus(value: UserCustomStatus);
|
|
347
|
+
/** Getter for building some company information based on contact type */
|
|
348
|
+
get companyInfo(): CompanyInfo;
|
|
349
|
+
/** Indicates whether or not the contact belongs to the default company */
|
|
350
|
+
isInDefaultCompany: boolean;
|
|
351
|
+
rxSubject: Subject<any>;
|
|
352
|
+
/** The subscription state for this contact (none or both) */
|
|
353
|
+
subscription: string;
|
|
354
|
+
/** The subscription progress. Only applies to USER contacts */
|
|
355
|
+
ask: string;
|
|
356
|
+
/** Indicates whether or not the contact is part of the favorized contact's list of the connected user */
|
|
357
|
+
roster: boolean;
|
|
358
|
+
/**
|
|
359
|
+
* Information about the invitation sent by a contact to the connected user.
|
|
360
|
+
* (So not relevant for the connected user itself)
|
|
361
|
+
* Data managed by the userNetwork service.
|
|
362
|
+
*/
|
|
363
|
+
invitation: NetworkInvitation;
|
|
364
|
+
/** The associated conference identifier */
|
|
365
|
+
confId: string;
|
|
366
|
+
/** The conversation if exists with this contact. Only applies to USER contacts. */
|
|
367
|
+
conversation: Conversation;
|
|
368
|
+
/**
|
|
369
|
+
* The communication capabilities or the contact, ie the list of communication actions that are currently supported by the contact.
|
|
370
|
+
* This only applies to contacts of the USER type.
|
|
371
|
+
* These capabilities are stored as a JSON object; each key is associated to a flag capability and its value indicates
|
|
372
|
+
* whether it is possible (If 'true') or not to try to add this media.
|
|
373
|
+
* - telephony
|
|
374
|
+
* - webRTC
|
|
375
|
+
* - sharedDesktop
|
|
376
|
+
* - mediaAvailable (means telephony || webRTC)
|
|
377
|
+
* - addMedia (true if user is already in call and has an active fullJid)
|
|
378
|
+
*/
|
|
379
|
+
capabilities: any;
|
|
380
|
+
isConfiguringSettings: boolean;
|
|
381
|
+
displayShortName: string;
|
|
382
|
+
/** The display name of the contact, based on the '_displayName' property */
|
|
383
|
+
name: any;
|
|
384
|
+
private _displayName;
|
|
385
|
+
get displayName(): string;
|
|
386
|
+
set displayName(displayName: string);
|
|
387
|
+
/**
|
|
388
|
+
* Indicates which service has priority for updating the contact name, based on the name resolution performed by this service.
|
|
389
|
+
* Possible service options:
|
|
390
|
+
* - NO_UPDATE_PRIO: No update priority then could be updated
|
|
391
|
+
* - OUTLOOK_UPDATE_PRIO: Priority associated to outlook name resolution update
|
|
392
|
+
* - SERVER_UPDATE_PRIO: Priority associated to server name resolution (phonebook or office365AD ...) update
|
|
393
|
+
* - MAX_UPDATE_PRIO: No update could overwrite
|
|
394
|
+
*/
|
|
395
|
+
nameUpdatePrio: any;
|
|
396
|
+
/** Obscured name of user for logs */
|
|
397
|
+
nameForLogs: string;
|
|
398
|
+
/** Array of the user tags*/
|
|
399
|
+
tags: string[];
|
|
400
|
+
/** User-specific custom data in the form of an Object with a free keys/values structure. */
|
|
401
|
+
customData: any;
|
|
402
|
+
/** General information attached to the user, can be modified by admin. */
|
|
403
|
+
userInfo1: any;
|
|
404
|
+
/** General information attached to the user, can be modified by admin. */
|
|
405
|
+
userInfo2: any;
|
|
406
|
+
/** internal avatar storage variable */
|
|
407
|
+
private _avatar;
|
|
408
|
+
/** The avatar if any */
|
|
409
|
+
defaultAvatar: any;
|
|
410
|
+
/** The avatar URL if any, null if none */
|
|
411
|
+
avatarSrc: string;
|
|
412
|
+
color: string;
|
|
413
|
+
colorIndex: number;
|
|
414
|
+
colorName: string;
|
|
415
|
+
avatarServerURL: string;
|
|
416
|
+
/** The contact status message */
|
|
417
|
+
message: string;
|
|
418
|
+
/** The telephony status of the contact.*/
|
|
419
|
+
telStatus: string;
|
|
420
|
+
/** The IM status of the contact.*/
|
|
421
|
+
imStatus: string;
|
|
422
|
+
/** The old status before making a call/*/
|
|
423
|
+
oldImStatus: string;
|
|
424
|
+
/** An object containing the list of all resources used by the connected user.*/
|
|
425
|
+
resources: Record<string, Resource>;
|
|
426
|
+
/** The first mobile resource detected.*/
|
|
427
|
+
mobileResource: string;
|
|
428
|
+
/** The contact last activity date.*/
|
|
429
|
+
lastActivityDate: BehaviorSubject<Date | null>;
|
|
430
|
+
private _guestMode;
|
|
431
|
+
guestModeSubject: BehaviorSubject<boolean>;
|
|
432
|
+
get guestMode(): boolean;
|
|
433
|
+
set guestMode(value: boolean);
|
|
434
|
+
/** The right for a guest to join the company by completing the creation of his user account. */
|
|
435
|
+
denySelfRegister: boolean;
|
|
436
|
+
/** The professional email of a USER contact */
|
|
437
|
+
emailPro: string;
|
|
438
|
+
/** The personal email of a USER contact */
|
|
439
|
+
emailPerso: string;
|
|
440
|
+
/** The email of a directory contact (from Business, Personal, O365 directories */
|
|
441
|
+
email: string;
|
|
442
|
+
/** The professional phone number of the contact (landline, work) */
|
|
443
|
+
phonePro: string;
|
|
444
|
+
/** The professional phone number of the contact (canonical format) */
|
|
445
|
+
phoneProCan: string;
|
|
446
|
+
/** A table of secondary Ddi (for hub case only): */ secondaryDdiNumbers: SecondaryDdiNumber[];
|
|
447
|
+
/** The professional mobile phone of the contact (mobile, work) */
|
|
448
|
+
mobilePro: string;
|
|
449
|
+
/** The professional mobile phone of the contact (canonical format) */
|
|
450
|
+
mobileProCan: string;
|
|
451
|
+
/** Indicates if the professional mobile phone of the contact is visible by other users */
|
|
452
|
+
isMobileProShared: boolean;
|
|
453
|
+
/** The personal phone of the contact (landline, home) */
|
|
454
|
+
phonePerso: string;
|
|
455
|
+
/** The personal phone of the contact (canonical format)*/
|
|
456
|
+
phonePersoCan: string;
|
|
457
|
+
/** Indicates if the personal landline phone of the contact is visible by other users */
|
|
458
|
+
isPhonePersoShared: boolean;
|
|
459
|
+
/** The personal mobile phone of the contact (mobile, home) */
|
|
460
|
+
mobilePerso: string;
|
|
461
|
+
/** The personal mobile phone of the contact (canonical format) */
|
|
462
|
+
mobilePersoCan: string;
|
|
463
|
+
/** Indicates if the personal mobile phone of the contact is visible by other users */
|
|
464
|
+
isMobilePersoShared: boolean;
|
|
465
|
+
/** The phone number if exists associated to the user and monitored by Rainbow */
|
|
466
|
+
phonePbx: string;
|
|
467
|
+
/** Business number from Directories (Business, Personal, O365, Outlook) */
|
|
468
|
+
businessPhones: string[];
|
|
469
|
+
/** Business mobile phone number from Directories (Business, Personal, O365, Outlook) */
|
|
470
|
+
mobilePhones: string[];
|
|
471
|
+
/** OTHER numbers (Personal + Business Directory contact only) */
|
|
472
|
+
otherPhoneNumbers: string[];
|
|
473
|
+
/** ALIAS internal numbers (Business Directory contact only) */
|
|
474
|
+
aliasesPhones: any[];
|
|
475
|
+
/** The internal number if exists associated to the user and monitored by Rainbow */
|
|
476
|
+
phoneInternalNumber: string;
|
|
477
|
+
/** Flag indicating whether at least one telephone number has been defined for the user */
|
|
478
|
+
hasPhoneNumber: boolean;
|
|
479
|
+
/** Great internal mystery to determine whether the user has a PBX DDI or not */
|
|
480
|
+
hasPhoneProDdiNumber: boolean;
|
|
481
|
+
/** Flag indicating whether all the phone numbers associated with a contact have been retrieve from the server */
|
|
482
|
+
phoneNumbersInitialized: boolean;
|
|
483
|
+
/** Hybrid Telephony, On busy routine: User redirect phone number (as entered by user) */
|
|
484
|
+
redirectNumber: string;
|
|
485
|
+
/** Hybrid Telephony, On busy routine: Indicates if the redirect phone number is editable by a user */
|
|
486
|
+
isRedirectNumberEditable: boolean;
|
|
487
|
+
/** The department of the contact (Directory contact only) */
|
|
488
|
+
department: string;
|
|
489
|
+
/** The postal code of the contact (Directory contact only) */
|
|
490
|
+
postalCode: string;
|
|
491
|
+
/** The state of the business contact (Directory contact only) */
|
|
492
|
+
state: string;
|
|
493
|
+
/** The street of the business contact (Directory contact only) */
|
|
494
|
+
street: string;
|
|
495
|
+
/** The city of the business contact */
|
|
496
|
+
city: string;
|
|
497
|
+
/** The note1 of a personal or business directory contact */
|
|
498
|
+
note1: string;
|
|
499
|
+
/** The note2 of a personal or business directory contact */
|
|
500
|
+
note2: string;
|
|
501
|
+
/**
|
|
502
|
+
* EXPERIMENTAL (this property will likely change in the future version)
|
|
503
|
+
* Object containing all the calendar informations related to user
|
|
504
|
+
* The object contains the current meeting / incoming calendar meetings, but also it contains the Out Of Office informations:
|
|
505
|
+
* The structure of the object (by default it's empty if no calendar presence) :
|
|
506
|
+
* calendarInformation = \{
|
|
507
|
+
* status: string //calendar status (one of "online", "dnd")
|
|
508
|
+
* mdate: date //the date of the end / next meeting
|
|
509
|
+
* autoReplyOn: boolean //if true, the user has activated Out Of Office)
|
|
510
|
+
* autoReplyInfos: \{ //if autoReplyOn is true, then this object contains the informations related to the Out Of Office)
|
|
511
|
+
* message: string //out of office message
|
|
512
|
+
* mdate: date //until when the OoO is activated (if known)
|
|
513
|
+
* \}
|
|
514
|
+
* \}
|
|
515
|
+
*
|
|
516
|
+
* NB: The Out of Office is not automatic, so it's updated every 15min for each conversation that the user has;
|
|
517
|
+
*/
|
|
518
|
+
calendarState: any;
|
|
519
|
+
/** The object containing the calendar presence of the user (if available) as retrieved from server */
|
|
520
|
+
calendarStateRaw: any;
|
|
521
|
+
/** Specify if the Contact is associated to an Microsoft Azure Directory contact */
|
|
522
|
+
o365Flag: boolean;
|
|
523
|
+
/** Specify if the Contact is associated to an Outlook contact */
|
|
524
|
+
outlookFlag: boolean;
|
|
525
|
+
/**
|
|
526
|
+
* Specify if the Contact is associated to an Outlook contact BUT found locally by Rainbow Desktop Application
|
|
527
|
+
* via 'centralizedService.outlook' service.
|
|
528
|
+
* Information that provides further details about property 'outlookFlag'.
|
|
529
|
+
*/
|
|
530
|
+
outlookDesktopFlag: boolean;
|
|
531
|
+
/** Specify if the Contact is associated to a Company Directory contact */
|
|
532
|
+
companyDirectoryFlag: boolean;
|
|
533
|
+
/** Specify if the Contact is associated to a Personal Directory contact */
|
|
534
|
+
personalDirectoryFlag: boolean;
|
|
535
|
+
/** Specify if the Contact is associated to a PBX phonebook entry */
|
|
536
|
+
phonebookDirectoryFlag: boolean;
|
|
537
|
+
/** Specify if the User ia a BOT */
|
|
538
|
+
isBot: boolean;
|
|
539
|
+
/** Specify if the User ia a Rainbow Room ( Rainbow TV) */
|
|
540
|
+
isTv: boolean;
|
|
541
|
+
/**
|
|
542
|
+
* Specify if the User is a Temporary contact.
|
|
543
|
+
* Example: Call log contat for unidentified call (only external number provided)
|
|
544
|
+
*/
|
|
545
|
+
temp: boolean;
|
|
546
|
+
botDetails: string;
|
|
547
|
+
isBotSharing: boolean;
|
|
548
|
+
/** The data related to the Rainbow TV */
|
|
549
|
+
rainbowTvData: any;
|
|
550
|
+
/**
|
|
551
|
+
* The id of the Company related to the business contact.
|
|
552
|
+
* Only relevant for contacts from the Business directory.
|
|
553
|
+
*/
|
|
554
|
+
businessCompanyId: string;
|
|
555
|
+
/**
|
|
556
|
+
* The ID of the user associated with the personal contact
|
|
557
|
+
* Only relevant for contacts from the Personal directory.
|
|
558
|
+
*/
|
|
559
|
+
userId: string;
|
|
560
|
+
fileStorageEnabledSubject: BehaviorSubject<any>;
|
|
561
|
+
/** Rainbow storage usage "enabled", "disabled", "same_as_company" */
|
|
562
|
+
useRainbowStorage?: string;
|
|
563
|
+
/** External storage usage "enabled", "disabled", "same_as_company" */
|
|
564
|
+
useExternalStorage?: string;
|
|
565
|
+
/** External storage identifier */
|
|
566
|
+
mainStorage?: string;
|
|
567
|
+
/** The name of the user's company or the company name of a personal/business contact */
|
|
568
|
+
companyName: string;
|
|
569
|
+
companyFeatures: any;
|
|
570
|
+
/** A Company objet reprensenting the information of the company associated to the contact */
|
|
571
|
+
company: Company;
|
|
572
|
+
/** Hide or not the offline/away presence duration (Company-level setting, User Profile) */
|
|
573
|
+
isPresenceDurationHidden: boolean;
|
|
574
|
+
/** if Rainbow is used as RB + Teams app */
|
|
575
|
+
isRainbowForTeamsUser: boolean;
|
|
576
|
+
/** The current presence shared from MS Teams (if the integration is activated for this user) */
|
|
577
|
+
msTeamsPresence: string;
|
|
578
|
+
/**
|
|
579
|
+
* State of the Office365 subscription of the connected user only.
|
|
580
|
+
* Forces initialisation if the server does not send any data "msGraph": { subscriptionState "..." } on start-up.
|
|
581
|
+
*/
|
|
582
|
+
o365SubscriptionState: O365SubscriptionState;
|
|
583
|
+
/** Specifies if user should use the new interface for softphone */
|
|
584
|
+
softphoneModeActivated: boolean;
|
|
585
|
+
userCanModifySoftphoneMode: boolean;
|
|
586
|
+
get isSoftphoneTelMode(): boolean;
|
|
587
|
+
get isSoftphoneUCMode(): boolean;
|
|
588
|
+
get useSoftphoneTelPopout(): boolean;
|
|
589
|
+
get useSoftphoneUCPopout(): boolean;
|
|
590
|
+
/** Specifies if DND fullscreen mode is activated (enabled/disabled/forced) */
|
|
591
|
+
changeDNDFullScreenActivated: boolean;
|
|
592
|
+
userCanModifyChangeDNDFullScreen: boolean;
|
|
593
|
+
/** Specifies if auto-accept from external app is activated (enabled/disabled/forced) */
|
|
594
|
+
autoAcceptExternalAppActivated: boolean;
|
|
595
|
+
userCanModifyAutoAcceptExternalApp: boolean;
|
|
596
|
+
/** Specifies if DND on calendar appointment is activated (enabled/disabled/forced) */
|
|
597
|
+
setDNDAppointmentActivated: boolean;
|
|
598
|
+
userCanModifySetDNDAppointment: boolean;
|
|
599
|
+
/** Specifies if VoIP calls should be ignored in DND mode (enabled/disabled/forced) */
|
|
600
|
+
ignoreVoipCallInDNDActivated: boolean;
|
|
601
|
+
userCanModifyIgnoreVoipCallInDND: boolean;
|
|
602
|
+
/** Specifies if user can manage customization file (enabled/disabled)
|
|
603
|
+
* If disabled, user can no longer access the configuration (import / export) of the customization files
|
|
604
|
+
*/
|
|
605
|
+
manageCustomizationFileEnabled: boolean;
|
|
606
|
+
/** Specifies if user can set personal access tokens (enabled/disabled)
|
|
607
|
+
* If disabled, user can no longer access the personnal tokens inside the security component in the settings
|
|
608
|
+
*/
|
|
609
|
+
setPersonalAccessTokensEnabled: boolean;
|
|
610
|
+
/** The ID of the PBX monitored by Rainbow where the user's phone is associated */
|
|
611
|
+
pbxId: string;
|
|
612
|
+
organisationId: string;
|
|
613
|
+
siteId: string;
|
|
614
|
+
systemId: string;
|
|
615
|
+
phoneNumberId: string;
|
|
616
|
+
private _customMarkdownInfos;
|
|
617
|
+
get customMarkdownInfos(): string;
|
|
618
|
+
set customMarkdownInfos(value: string);
|
|
619
|
+
/** 3rd party external infos for contact */
|
|
620
|
+
thirdPartyMarkdownInfos: string;
|
|
621
|
+
/** The ability for a user to set the presence status to 'Invisible'. */
|
|
622
|
+
canSetInvisiblePresenceCustomisation: boolean;
|
|
623
|
+
/** The ability for a user to change manually his presence status. */
|
|
624
|
+
private _changePresenceEnabled;
|
|
625
|
+
set changePresenceEnabled(changePresenceEnabled: boolean);
|
|
626
|
+
get changePresenceEnabled(): boolean;
|
|
627
|
+
/** Right for a user to use instant messages (IM), to start a chat, send and receive IMs and notifications in a P2P or bubble conversation. */
|
|
628
|
+
private _instantMessagesEnabled;
|
|
629
|
+
/**
|
|
630
|
+
* The ability for the user to receive emergency message.
|
|
631
|
+
* A subscription to ALERT offer is required.
|
|
632
|
+
*/
|
|
633
|
+
isAlertNotificationEnabled: boolean;
|
|
634
|
+
set instantMessagesEnabled(instantMessagesEnabled: boolean);
|
|
635
|
+
get instantMessagesEnabled(): boolean;
|
|
636
|
+
/** The ability for the user to check if an IM message has been read by the peer. */
|
|
637
|
+
private _readReceiptsCustomisation;
|
|
638
|
+
set readReceiptsCustomisation(readReceiptsCustomisation: boolean);
|
|
639
|
+
get readReceiptsCustomisation(): boolean;
|
|
640
|
+
/** Right to access the Rainbow file storage to upload/download/copy/share documents. */
|
|
641
|
+
private _fileStorageEnabled;
|
|
642
|
+
set fileStorageEnabled(fileStorageEnabled: boolean);
|
|
643
|
+
get fileStorageEnabled(): boolean;
|
|
644
|
+
/** Right to share document (download and share documents). */
|
|
645
|
+
private _fileSharingEnabled;
|
|
646
|
+
set fileSharingEnabled(fileSharingEnabled: boolean);
|
|
647
|
+
get fileSharingEnabled(): boolean;
|
|
648
|
+
/** Right to transfer a document from one conversation (P2P or bubble) to another. */
|
|
649
|
+
private _fileTransferEnabled;
|
|
650
|
+
set fileTransferEnabled(fileTransferEnabled: boolean);
|
|
651
|
+
get fileTransferEnabled(): boolean;
|
|
652
|
+
/** The ability for the user to receive files with possibly restricted source. */
|
|
653
|
+
private _receivedFileCustomisation;
|
|
654
|
+
set receivedFileCustomisation(receivedFileCustomisation: ReceivedFileCustomisationValue);
|
|
655
|
+
get receivedFileCustomisation(): ReceivedFileCustomisationValue;
|
|
656
|
+
/** The ability for the user to use the 'Channels' feature, i.e. to create or be a member of channels. */
|
|
657
|
+
private _channelsEnabled;
|
|
658
|
+
set channelsEnabled(channelsEnabled: boolean);
|
|
659
|
+
get channelsEnabled(): boolean;
|
|
660
|
+
/** The ability for the user to create a channel. */
|
|
661
|
+
private _channelCreateEnabled;
|
|
662
|
+
set channelCreateEnabled(channelCreateEnabled: boolean);
|
|
663
|
+
get channelCreateEnabled(): boolean;
|
|
664
|
+
/** The ability for the user to use the 'Bubbles' feature, i.e. to create bubbles or join bubbles (chat and bubble conference). */
|
|
665
|
+
private _roomsEnabled;
|
|
666
|
+
set roomsEnabled(roomsEnabled: boolean);
|
|
667
|
+
get roomsEnabled(): boolean;
|
|
668
|
+
/** The ability for the user to view the speaking time for each participant in a bubble conference. */
|
|
669
|
+
private _useSpeakingTimeStatistics;
|
|
670
|
+
set useSpeakingTimeStatistics(useSpeakingTimeStatistics: boolean);
|
|
671
|
+
get useSpeakingTimeStatistics(): boolean;
|
|
672
|
+
/** The ability for the user to record a conversation of a P2P call. */
|
|
673
|
+
recordConversationEnabled: boolean;
|
|
674
|
+
/**
|
|
675
|
+
* The ability for the user to use Web RTC audio conversation (P2P/Bubble conference call).
|
|
676
|
+
* This includes the ability to make WebRTC P2P audio call, start a bubble conference call and to be joined via Web RTC audio call.
|
|
677
|
+
*/
|
|
678
|
+
private _webrtcAudioEnabled;
|
|
679
|
+
set webrtcAudioEnabled(webrtcAudioEnabled: boolean);
|
|
680
|
+
get webrtcAudioEnabled(): boolean;
|
|
681
|
+
/**
|
|
682
|
+
* The ability for the user to use Web RTC video conversation (P2P/Bubble conference call).
|
|
683
|
+
* This includes the ability to make WebRTC P2P video call, to add video in a bubble conference call and to be joined via Web RTC video call.
|
|
684
|
+
*/
|
|
685
|
+
private _webrtcVideoEnabled;
|
|
686
|
+
set webrtcVideoEnabled(webrtcVideoEnabled: boolean);
|
|
687
|
+
get webrtcVideoEnabled(): boolean;
|
|
688
|
+
/** The ability for the user to share his screen. */
|
|
689
|
+
private _webrtcSharingEnabled;
|
|
690
|
+
set webrtcSharingEnabled(webrtcSharingEnabled: boolean);
|
|
691
|
+
get webrtcSharingEnabled(): boolean;
|
|
692
|
+
changeSettingsEnabled: boolean;
|
|
693
|
+
/** The ability for the user to modify certain data relating to its name (title, firstName, lastName) in its profile. */
|
|
694
|
+
userTitleNameEnabled: boolean;
|
|
695
|
+
/** The ability for the user to customize his/her avatar */
|
|
696
|
+
userAvatarCustomizationEnabled: boolean;
|
|
697
|
+
/** The ability for the user to modify his entire profile. */
|
|
698
|
+
private _modifyProfileEnabled;
|
|
699
|
+
set modifyProfileEnabled(modifyProfileEnabled: boolean);
|
|
700
|
+
get modifyProfileEnabled(): boolean;
|
|
701
|
+
/** The right to use the giphy extension */
|
|
702
|
+
giphyEnabled: boolean;
|
|
703
|
+
/**
|
|
704
|
+
* Ability for a user to add a participant by phone in an active conference.
|
|
705
|
+
* The conference must be established before the participant's call can be made.
|
|
706
|
+
*/
|
|
707
|
+
dialOutCapability: boolean;
|
|
708
|
+
/** Ability for a user to join by phone an active conference from an office phone. */
|
|
709
|
+
joinByPhoneCapability: boolean;
|
|
710
|
+
/**
|
|
711
|
+
* Ability for a user to call a participant using a PBX number via PSTN.
|
|
712
|
+
* The conference must be established before the participant's call can be made.
|
|
713
|
+
*/
|
|
714
|
+
canCallParticipantPbxNumberEnabled?: boolean;
|
|
715
|
+
/** Ability for a user to modify some telephony settings such as the forward activation... */
|
|
716
|
+
telephonySettingsEnabled: boolean;
|
|
717
|
+
/** Indicates if the OXE PBX has the call busy capability */
|
|
718
|
+
oxeBusyCapability: boolean;
|
|
719
|
+
/** Indicates if the OXE PBX has overflow capability */
|
|
720
|
+
oxePBXOverflowCapability: boolean;
|
|
721
|
+
/** Specify whether the connected user has an attendant profile */
|
|
722
|
+
attendantConsoleEnabled: boolean;
|
|
723
|
+
/** Specify whether the user has the console supervision group role. */
|
|
724
|
+
supervisorConsoleEnabled: boolean;
|
|
725
|
+
/** Capability for a user to use the computer mode. */
|
|
726
|
+
useComputerMode?: boolean;
|
|
727
|
+
/** Capability for a user to use the other phone mode.*/
|
|
728
|
+
useOtherPhoneMode?: boolean;
|
|
729
|
+
/** Capability for a user to change the order of calls in telephony phone numbers menu.*/
|
|
730
|
+
showFirstPhoneCalls?: boolean;
|
|
731
|
+
/** Capability for a user to not be rung (audio) when a bubble conference starts, visual notification still shown.*/
|
|
732
|
+
noRingingConferenceStartCustomisation?: boolean;
|
|
733
|
+
/** Specify whether the user can interact when message content - RQRAINB-14289 */
|
|
734
|
+
protectedContentCustomisation: boolean;
|
|
735
|
+
private _supervisionCapabilities;
|
|
736
|
+
set supervisionCapabilities(supervisionCapabilities: any);
|
|
737
|
+
get supervisionCapabilities(): any;
|
|
738
|
+
private _supervisionCallCapabilities;
|
|
739
|
+
set supervisionCallCapabilities(callCapabilities: any);
|
|
740
|
+
get supervisionCallCapabilities(): any;
|
|
741
|
+
/** Ability for a user to download Rainbow application. */
|
|
742
|
+
canDownloadAppCustomisation: boolean;
|
|
743
|
+
/** Ability for a user to access to Rainbow store. */
|
|
744
|
+
canAccessStoreCustomisation: boolean;
|
|
745
|
+
/** Ability for a user to record a bubble conference. */
|
|
746
|
+
conferenceRecordingEnabled: boolean;
|
|
747
|
+
/** Whether the user must explicitly give consent before being recorded in a bubble conference. */
|
|
748
|
+
recordingConsentModeCustomisation: boolean;
|
|
749
|
+
/** Ability for a user to access to Rainbow help center. */
|
|
750
|
+
canAccessHelpCenterCustomisation: boolean;
|
|
751
|
+
/** Ability for a user to access to the FAQ. */
|
|
752
|
+
canAccessFaqCustomisation: boolean;
|
|
753
|
+
/** Ability for a user to use "What's new" feature.*/
|
|
754
|
+
canAccessWhatsNew: boolean;
|
|
755
|
+
/** Ability for a user to use "Tasks" feature.*/
|
|
756
|
+
canUseTaskCustomisation: boolean;
|
|
757
|
+
/** Ability for a user to use "Calendar" feature.*/
|
|
758
|
+
canSynchCalendar: boolean;
|
|
759
|
+
/** Ability for a user to use "Transcription" feature.*/
|
|
760
|
+
canUseTranscriptionCustomisation: boolean;
|
|
761
|
+
/** Ability for a user to send report about a problem.*/
|
|
762
|
+
canUseSendReportCustomisation: boolean;
|
|
763
|
+
/** Ability for a user to test its configuration (connectivity and audio quality).*/
|
|
764
|
+
canUseTestConfigCustomisation: boolean;
|
|
765
|
+
/**
|
|
766
|
+
* RQRAINB-13455 [TECHNICAL] Keep the customization useRoomCustomisation as disabled for Rainbow Voice users
|
|
767
|
+
* For Rainbow Voice users only, indicates that a user has the right to use Bubbles for telephony.
|
|
768
|
+
*/
|
|
769
|
+
roomsAsVoiceEnabled: boolean;
|
|
770
|
+
/** The right to access elearning section */
|
|
771
|
+
eLearningCustomisation: boolean;
|
|
772
|
+
/** The right to earn badges in elearning section */
|
|
773
|
+
eLearningGamificationCustomisation: boolean;
|
|
774
|
+
private _forwards;
|
|
775
|
+
set forwards(forwards: TelephonyForward[]);
|
|
776
|
+
get forwards(): TelephonyForward[];
|
|
777
|
+
/**
|
|
778
|
+
* updateCustomStatus
|
|
779
|
+
*/
|
|
780
|
+
updateCustomStatus(status: any): void;
|
|
781
|
+
private _personalRoutines;
|
|
782
|
+
set personalRoutines(personalRoutines: PersonalRoutine[]);
|
|
783
|
+
get personalRoutines(): PersonalRoutine[];
|
|
784
|
+
private _outOfOffice;
|
|
785
|
+
get outOfOffice(): {
|
|
786
|
+
active: boolean;
|
|
787
|
+
message: string;
|
|
788
|
+
};
|
|
789
|
+
set outOfOffice(value: {
|
|
790
|
+
active: boolean;
|
|
791
|
+
message: string;
|
|
792
|
+
});
|
|
793
|
+
private _supervisionDevices;
|
|
794
|
+
private _supervisionState;
|
|
795
|
+
set supervisionState(supervisionState: any);
|
|
796
|
+
get supervisionState(): any;
|
|
797
|
+
private _supervisionDeskphoneMode;
|
|
798
|
+
get supervisionDeskphoneMode(): boolean | null;
|
|
799
|
+
set supervisionDeskphoneMode(supervisionDeskphoneMode: boolean | null);
|
|
800
|
+
private _supervisionCallInfos;
|
|
801
|
+
get supervisionCallInfos(): any[];
|
|
802
|
+
set supervisionCallInfos(supervisionCallInfos: any[]);
|
|
803
|
+
ccdPolicy: {
|
|
804
|
+
onBusyWithdraw: boolean;
|
|
805
|
+
onDndWithdraw: boolean;
|
|
806
|
+
onDndIgnoreVoipCalls: boolean;
|
|
807
|
+
withdrawReason: string;
|
|
808
|
+
};
|
|
809
|
+
ccdAgent: CcdAgent;
|
|
810
|
+
/**
|
|
811
|
+
* Phone type name for an extension behind an Rainbow Hybrid PBX
|
|
812
|
+
* Standard device name for an extension behind a Rainbow Hub PBX (SipWise subscriber)
|
|
813
|
+
*/
|
|
814
|
+
systDeviceName: string;
|
|
815
|
+
/**
|
|
816
|
+
* The telephone user is connected to a virtual device (isMonoDevice) on the PBX side (REX, any device).
|
|
817
|
+
* Useful only for the connected user.
|
|
818
|
+
*/
|
|
819
|
+
isVirtualTerm: boolean;
|
|
820
|
+
/** Mute ringing on incoming calls to the office extension (OXE PBX only)*/
|
|
821
|
+
silentRinging: boolean;
|
|
822
|
+
/**
|
|
823
|
+
* Allows WebRTC calls only if the user has a mobile presence.
|
|
824
|
+
* Use case: COBRI user
|
|
825
|
+
*/
|
|
826
|
+
useWebRTCOnlyIfMobileLogged: boolean;
|
|
827
|
+
oxeTrunks: ConnectedUserOxeTrunk[];
|
|
828
|
+
oxePreferredTrunk: number;
|
|
829
|
+
/** duration of the IM set by the company admin */
|
|
830
|
+
imPopupDuration: any;
|
|
831
|
+
/** The right to use the new UI */
|
|
832
|
+
newUiEnabled: boolean;
|
|
833
|
+
generalizedAttendantLookForUsers: boolean;
|
|
834
|
+
selectedManifestId: any;
|
|
835
|
+
mfaRainbowAuth: {
|
|
836
|
+
mfaStatus: MultiFactorAuthStatus;
|
|
837
|
+
mfaTrustedApps: any[];
|
|
838
|
+
mfaType: MultiFactorAuthType;
|
|
839
|
+
};
|
|
840
|
+
getMfaStatus(): MultiFactorAuthStatus;
|
|
841
|
+
setMfaStatus(newStatus: MultiFactorAuthStatus): void;
|
|
842
|
+
/** Specifies what the user can do using AI in RB */
|
|
843
|
+
recordingTranscription: boolean;
|
|
844
|
+
liveTranscription: boolean;
|
|
845
|
+
translateDoc: boolean;
|
|
846
|
+
/** Right to transcribe/summarize P2P call recordings. */
|
|
847
|
+
callTranscript: boolean;
|
|
848
|
+
translationDocLanguages?: {
|
|
849
|
+
iso: string;
|
|
850
|
+
native: string;
|
|
851
|
+
translated: string;
|
|
852
|
+
inverted: boolean;
|
|
853
|
+
}[];
|
|
854
|
+
translationDocFormats?: string[];
|
|
855
|
+
recordingLanguages?: {
|
|
856
|
+
iso: string;
|
|
857
|
+
native: string;
|
|
858
|
+
translated: string;
|
|
859
|
+
inverted: boolean;
|
|
860
|
+
}[];
|
|
861
|
+
liveLanguages?: {
|
|
862
|
+
iso: string;
|
|
863
|
+
native: string;
|
|
864
|
+
translated: string;
|
|
865
|
+
inverted: boolean;
|
|
866
|
+
}[];
|
|
867
|
+
get canRecordingTranscription(): boolean;
|
|
868
|
+
get canCallTranscript(): boolean;
|
|
869
|
+
get canLiveTranscription(): boolean;
|
|
870
|
+
get canTranslateDoc(): boolean;
|
|
871
|
+
get getTranslationDocLanguages(): {
|
|
872
|
+
iso: string;
|
|
873
|
+
native: string;
|
|
874
|
+
translated: string;
|
|
875
|
+
inverted: boolean;
|
|
876
|
+
}[];
|
|
877
|
+
get getTranslationDocFormats(): string[];
|
|
878
|
+
get getRecordingLanguages(): {
|
|
879
|
+
iso: string;
|
|
880
|
+
native: string;
|
|
881
|
+
translated: string;
|
|
882
|
+
inverted: boolean;
|
|
883
|
+
}[];
|
|
884
|
+
get getLiveLanguages(): {
|
|
885
|
+
iso: string;
|
|
886
|
+
native: string;
|
|
887
|
+
translated: string;
|
|
888
|
+
inverted: boolean;
|
|
889
|
+
}[];
|
|
890
|
+
/**
|
|
891
|
+
* Subscribe to updates on the current contact (all events are of RBEvent type \{name: string, data:any \});
|
|
892
|
+
* Here's a list of events received :
|
|
893
|
+
* name: 'update' means... update of any information of the contact (settings, personnal information, network/roster status, etc)
|
|
894
|
+
* name: 'calendar' means... update of the user's calendar information
|
|
895
|
+
* name: 'presence' means... update of the user's presence status
|
|
896
|
+
* name: 'outOfOffice' means... update of the user's out of office status
|
|
897
|
+
* name: 'roster' means... update of the user's roster change
|
|
898
|
+
* NB There might be some events that are not documented here, they're send on updates of different properties of the contact.
|
|
899
|
+
* @param handler - The call-back function that will be subscribed to the RxJS subject
|
|
900
|
+
* @param eventNames - Array of event(s) to listen
|
|
901
|
+
*/
|
|
902
|
+
subscribe(handler: any, eventNames?: string[]): Subscription;
|
|
903
|
+
sendEvent(name: UserEvents, data?: any): void;
|
|
904
|
+
isConnectedUser(): boolean;
|
|
905
|
+
isDirectoryContact(): boolean;
|
|
906
|
+
isUserTypeOf(userType: UserType): boolean;
|
|
907
|
+
hasRole(userRole: UserRole): boolean;
|
|
908
|
+
/**
|
|
909
|
+
* Indicates wether the user is a telephony user or not.
|
|
910
|
+
* A telephony user is a user with an extension number allocated on a PBX, i.e. a Rainbow Hub or Rainbow Hybrid (OXO or OXE) telephone system.
|
|
911
|
+
*/
|
|
912
|
+
isTelephonyUser(): boolean;
|
|
913
|
+
/**
|
|
914
|
+
* Indicates wether the user is a Rainbow Hub user or not.
|
|
915
|
+
* A Rainbow Hub user is a user with a Voice licence and an extension number allocated on a Cloud PBX.
|
|
916
|
+
*/
|
|
917
|
+
isRainbowHubUser(): boolean;
|
|
918
|
+
/**
|
|
919
|
+
* Indicates wether the user is an Rainbow Hybrid user or not.
|
|
920
|
+
* An Rainbow Hybrid user is a user with an extension number allocated on a Hybrid PBX (OXE/OXO/Third party)
|
|
921
|
+
*/
|
|
922
|
+
isRainbowHybridUser(): boolean;
|
|
923
|
+
/**
|
|
924
|
+
* CONTACT INSTANCE CONSTRUCTOR
|
|
925
|
+
* WARNING: Not all properties available in the Contact class are initialized in this method.
|
|
926
|
+
*/
|
|
927
|
+
constructor(jid?: string, name?: string, company?: Company);
|
|
928
|
+
/**
|
|
929
|
+
* CONTACT INSTANCE GLOBAL UPDATE
|
|
930
|
+
* Update of some properties of a user instance following reception of new data from the server.
|
|
931
|
+
* @param userData - Partial set of user properties as received from the server
|
|
932
|
+
*/
|
|
933
|
+
updateFromUserData(userData: any): void;
|
|
934
|
+
getAvatarInBase64(): Promise<unknown>;
|
|
935
|
+
dateEncode(date: string): string;
|
|
936
|
+
updateAvatar(size?: number, forced?: boolean): void;
|
|
937
|
+
createTextAvatarImage(): void;
|
|
938
|
+
/**
|
|
939
|
+
* Set the 'avatar' with the current value of the default avatar
|
|
940
|
+
* This is mainly useful for personal and business contacts for which no avatar can be defined at the moment.
|
|
941
|
+
* Only the default avatar is available for them, based on the initials of lastname/firstname or company name
|
|
942
|
+
* To take into account that the default avatar data can be changed later by the phone in a call situation,
|
|
943
|
+
* (following an update of the display name), the default avatar also becomes the real avatar (until we can specify one)
|
|
944
|
+
*/
|
|
945
|
+
setAvatarFromDefault(): void;
|
|
946
|
+
updateName(firstName: string, lastName: string): void;
|
|
947
|
+
computeDisplayName(): void;
|
|
948
|
+
/**
|
|
949
|
+
* Return true if user is a CPaaS guest, otherwise false.
|
|
950
|
+
*/
|
|
951
|
+
isCPaaSGuest(): boolean;
|
|
952
|
+
/**
|
|
953
|
+
* Return true if user is an UCaaS guest, otherwise false.
|
|
954
|
+
*/
|
|
955
|
+
isGuest(): boolean;
|
|
956
|
+
isAnonymousGuest(): boolean;
|
|
957
|
+
isBadGuest(): boolean;
|
|
958
|
+
isGuestInitialized(): boolean;
|
|
959
|
+
/**
|
|
960
|
+
* Return true if user has some administration rights, otherwise false.
|
|
961
|
+
*/
|
|
962
|
+
hasAdminRights(): boolean;
|
|
963
|
+
/**
|
|
964
|
+
* Return true if user has superadmin rights, otherwise false.
|
|
965
|
+
*/
|
|
966
|
+
isSuperadmin(): boolean;
|
|
967
|
+
/**
|
|
968
|
+
* Return true if user has platform support rights, otherwise false.
|
|
969
|
+
* The role borne by the support staff of the platform itself, told apart from
|
|
970
|
+
* {@link isSupportAdmin}, which is the `company_support` administration type of an ordinary
|
|
971
|
+
* company admin.
|
|
972
|
+
*/
|
|
973
|
+
isSupport(): boolean;
|
|
974
|
+
/**
|
|
975
|
+
* Return true if user has business responsabilities within its company, otherwise false.
|
|
976
|
+
*/
|
|
977
|
+
isBusinessAdmin(): boolean;
|
|
978
|
+
/**
|
|
979
|
+
* Return true if user has customer success responsabilities within its company, otherwise false.
|
|
980
|
+
*/
|
|
981
|
+
isCustomerSuccessAdmin(): boolean;
|
|
982
|
+
/**
|
|
983
|
+
* Return true if user has role sales_analytics, otherwise false.
|
|
984
|
+
*/
|
|
985
|
+
isSalesAnalyticsAdmin(): boolean;
|
|
986
|
+
/**
|
|
987
|
+
* Return true if user has role sales_analytics, otherwise false.
|
|
988
|
+
*/
|
|
989
|
+
isPrivacyOperationAdmin(): boolean;
|
|
990
|
+
/**
|
|
991
|
+
* Return true if user has the rights to manage all companies within its organization, otherwise false.
|
|
992
|
+
*/
|
|
993
|
+
isOrganizationAdmin(): boolean;
|
|
994
|
+
/**
|
|
995
|
+
* Return true if user has the rights to manage support companies within its organization, otherwise false.
|
|
996
|
+
*/
|
|
997
|
+
isSupportAdmin(): boolean;
|
|
998
|
+
/**
|
|
999
|
+
* Return true if user has the rights to manage its company, otherwise false.
|
|
1000
|
+
*/
|
|
1001
|
+
isCompanyAdmin(): boolean;
|
|
1002
|
+
/**
|
|
1003
|
+
* Return true if user has the rights to manage only the sites of its company, otherwise false.
|
|
1004
|
+
*/
|
|
1005
|
+
isSiteAdmin(): boolean;
|
|
1006
|
+
/**
|
|
1007
|
+
* Return true if user has the rights to manage its company, otherwise false.
|
|
1008
|
+
*/
|
|
1009
|
+
isAdmin(): boolean;
|
|
1010
|
+
/**
|
|
1011
|
+
* Return true if user is an administrator of a End Customer (EC) company, otherwise false.
|
|
1012
|
+
*/
|
|
1013
|
+
isECAdmin(): boolean;
|
|
1014
|
+
/**
|
|
1015
|
+
* Return true if user has operations or financial rights within a Business Partner (BP) company, otherwise false.
|
|
1016
|
+
*/
|
|
1017
|
+
isBPAdmin(): boolean;
|
|
1018
|
+
/**
|
|
1019
|
+
* Return true if user has operations rights within a Business Partner (BP) company, otherwise false.
|
|
1020
|
+
*/
|
|
1021
|
+
isBPAdminOperations(): boolean;
|
|
1022
|
+
/**
|
|
1023
|
+
* Return true if user has finance rights within a Business Partner (BP) company, otherwise false.
|
|
1024
|
+
*/
|
|
1025
|
+
isBPAdminFinance(): boolean;
|
|
1026
|
+
/**
|
|
1027
|
+
* Return true if user has operations or financial rights within a Direct Reseller (DR) company, otherwise false.
|
|
1028
|
+
*/
|
|
1029
|
+
isBPAdminDR(): boolean;
|
|
1030
|
+
/**
|
|
1031
|
+
* Return true if user has operations or financial rights within a Value Added Distributor (VAD) company, otherwise false.
|
|
1032
|
+
*/
|
|
1033
|
+
isBPAdminVAD(): boolean;
|
|
1034
|
+
/**
|
|
1035
|
+
* Return true if user has operations or financial rights within an Indirect Reseller (IR) company, otherwise false.
|
|
1036
|
+
*/
|
|
1037
|
+
isBPAdminIR(): boolean;
|
|
1038
|
+
/**
|
|
1039
|
+
* Return true if user has the rights to manage the business directory of its company, otherwise false.
|
|
1040
|
+
*/
|
|
1041
|
+
isDirectoryAdmin(): boolean;
|
|
1042
|
+
/**
|
|
1043
|
+
* Return true if user has customer analytics rights within a Business Partner (BP) company, otherwise false.
|
|
1044
|
+
*/
|
|
1045
|
+
isBPAnalytics(): boolean;
|
|
1046
|
+
/**
|
|
1047
|
+
* Return true if user has analytics rights within a Business Partner (BP) or End Customer (EC) company, otherwise false.
|
|
1048
|
+
*/
|
|
1049
|
+
isECAnalytics(): boolean;
|
|
1050
|
+
/**
|
|
1051
|
+
* Return true if user has the rights to manage webinars of its company, otherwise false.
|
|
1052
|
+
*/
|
|
1053
|
+
isWebinarHost(): boolean;
|
|
1054
|
+
/**
|
|
1055
|
+
* Return true if user is on a time-limited webinar trial offer, otherwise false.
|
|
1056
|
+
*/
|
|
1057
|
+
isWebinarTrial(): boolean;
|
|
1058
|
+
/**
|
|
1059
|
+
* Return true if user has the room_admin role, otherwise false.
|
|
1060
|
+
*/
|
|
1061
|
+
isRoomAdmin(): boolean;
|
|
1062
|
+
/**
|
|
1063
|
+
* Return true if user is on a time-limited collaboration trial offer, otherwise false.
|
|
1064
|
+
*/
|
|
1065
|
+
isCollaborationTrial(): boolean;
|
|
1066
|
+
/**
|
|
1067
|
+
* Return true if user was granted a time-limited trial offer, webinar or collaboration, otherwise false.
|
|
1068
|
+
* Says nothing of its end: the roles are rebuilt from the never-cleared `freemiumTypes`, so this
|
|
1069
|
+
* stays true once the trial ran out or was superseded by a purchase. Current state:
|
|
1070
|
+
* `SubscriptionService.getTrialStatus()`.
|
|
1071
|
+
*/
|
|
1072
|
+
isTrialOffer(): boolean;
|
|
1073
|
+
/**
|
|
1074
|
+
* Return true if the account was created through the trial funnel, otherwise false.
|
|
1075
|
+
* That funnel only — accounts from the historical self sign-up answer false.
|
|
1076
|
+
* An origin, not a current state: stays true after the trial ends. Current offer: {@link isTrialOffer}.
|
|
1077
|
+
*/
|
|
1078
|
+
hasTrialFunnelOrigin(): boolean;
|
|
1079
|
+
/**
|
|
1080
|
+
* Drops the Essential-only tier, which is derived from `profiles` when the payload is read.
|
|
1081
|
+
*
|
|
1082
|
+
* ⚠️ TECH DEBT — same patch as the roles one in SubscriptionService: right after a
|
|
1083
|
+
* subscription the backend still answers with the old `profiles`, so re-reading the user
|
|
1084
|
+
* leaves the tier stale and the app keeps treating a fresh subscriber as an Essential.
|
|
1085
|
+
* Remove once the backend returns the new offer straight away.
|
|
1086
|
+
*/
|
|
1087
|
+
clearEssentialOfferOnly(): void;
|
|
1088
|
+
/**
|
|
1089
|
+
* Return true if a trial offer may be proposed to this Essential user, otherwise false.
|
|
1090
|
+
*/
|
|
1091
|
+
isEssentialTrialEligible(): boolean;
|
|
1092
|
+
/**
|
|
1093
|
+
* Return true if the user is an Essential with no company of their own, otherwise false.
|
|
1094
|
+
* Nothing to administer, so no admin at all: they are sold an offer instead — see
|
|
1095
|
+
* {@link hasInAppAdministration}, which excludes them.
|
|
1096
|
+
*/
|
|
1097
|
+
isStandaloneEssential(): boolean;
|
|
1098
|
+
/**
|
|
1099
|
+
* Return true if the account administers itself from inside the app, otherwise false.
|
|
1100
|
+
* Those accounts run a shorter rail carrying an administration entry of its own, rather than the
|
|
1101
|
+
* full one and the separate administration screen.
|
|
1102
|
+
*
|
|
1103
|
+
* Two populations, asked of two different things:
|
|
1104
|
+
* - the members of a company that came in without a Business Partner — `Company.hasGuidedOnboarding`.
|
|
1105
|
+
* Asked of the **company**, so a member invited into one administers themselves like the admin
|
|
1106
|
+
* who invited them. {@link hasTrialFunnelOrigin} cannot answer this: it reads what the *user*
|
|
1107
|
+
* was created through, and an invited member never went through that funnel.
|
|
1108
|
+
* - the Essentials a trial may be sold to — {@link isEssentialTrialEligible}. The in-app
|
|
1109
|
+
* administration covers what the older one did for those who created a company of their own.
|
|
1110
|
+
*
|
|
1111
|
+
* Minus the standalone Essentials of {@link isStandaloneEssential}, who have no company behind
|
|
1112
|
+
* them to administer at all.
|
|
1113
|
+
*/
|
|
1114
|
+
hasInAppAdministration(): boolean;
|
|
1115
|
+
/**
|
|
1116
|
+
* Return true if this user can host a webinar right now, otherwise false.
|
|
1117
|
+
*
|
|
1118
|
+
* Two independent conditions: the company subscribes a webinar offer, and this user holds the
|
|
1119
|
+
* host role. Read from the current subscription, not from {@link isWebinarTrial} which is
|
|
1120
|
+
* rebuilt at login and stays false for an offer subscribed since. False when the company
|
|
1121
|
+
* cannot be reached.
|
|
1122
|
+
*/
|
|
1123
|
+
canHostWebinars(): Promise<boolean>;
|
|
1124
|
+
/**
|
|
1125
|
+
* Return true if this user's company subscribes a webinar offer right now, otherwise false.
|
|
1126
|
+
* Free trial included.
|
|
1127
|
+
*
|
|
1128
|
+
* The symmetric of {@link hasCollaborationAccess}: the two together answer "is this a
|
|
1129
|
+
* webinar-only account?". Read off the company features loaded at login, so it costs nothing
|
|
1130
|
+
* and answers for this user's own company only — for a company being administered, ask
|
|
1131
|
+
* `Company.hasWebinarAccess()` instead, which fetches.
|
|
1132
|
+
*
|
|
1133
|
+
* Says what the company was sold, not what this user may do: {@link canHostWebinars} adds the
|
|
1134
|
+
* per-member host role on top.
|
|
1135
|
+
*/
|
|
1136
|
+
companyHasWebinarAccess(): boolean;
|
|
1137
|
+
/**
|
|
1138
|
+
* Return true if this user's company runs a collaboration offer right now, otherwise false.
|
|
1139
|
+
* Free trial included — a trial grants the product just as a purchase does.
|
|
1140
|
+
*
|
|
1141
|
+
* The answer to "is this a webinar-only account?", which no capability flag gives: those stay
|
|
1142
|
+
* on for a webinar-only company, saying what this member may do rather than what the company
|
|
1143
|
+
* was sold. Asked of the current subscription rather than of {@link isCollaborationTrial},
|
|
1144
|
+
* which is rebuilt from the payload read at login. Answers false when the company cannot be
|
|
1145
|
+
* reached.
|
|
1146
|
+
*
|
|
1147
|
+
* Synchronous: the subscriptions are read off an in-memory cache filled before any screen runs.
|
|
1148
|
+
*/
|
|
1149
|
+
hasCollaborationAccess(): boolean;
|
|
1150
|
+
/**
|
|
1151
|
+
* Return true if this user's company was ever granted the free trial of one product, otherwise
|
|
1152
|
+
* false. Whatever became of it: the backend never clears those, so this survives the trial's end
|
|
1153
|
+
* and a purchase.
|
|
1154
|
+
*
|
|
1155
|
+
* Answers for the company, so every member reads the same thing — use it to name what the company
|
|
1156
|
+
* came in with. {@link isWebinarTrial} / {@link isCollaborationTrial} answer the other question,
|
|
1157
|
+
* what this user's own login payload carried.
|
|
1158
|
+
*/
|
|
1159
|
+
companyUsedTrialOfType(type: CompanyTrialType): boolean;
|
|
1160
|
+
/**
|
|
1161
|
+
* Return true if user has the role of supervisor : this means that he's got a supervvisor role in at least one supervision group
|
|
1162
|
+
*/
|
|
1163
|
+
isSupervisor(): boolean;
|
|
1164
|
+
/**
|
|
1165
|
+
* Return the admin type
|
|
1166
|
+
*/
|
|
1167
|
+
getAdminType(): string;
|
|
1168
|
+
/**
|
|
1169
|
+
* Indicates wether the user belongs to a Business Partner (BP) company or not.
|
|
1170
|
+
*/
|
|
1171
|
+
isBPUser(): boolean;
|
|
1172
|
+
/**
|
|
1173
|
+
* Indicates wether the connected user is an hybrid user and is on an hybrid system with the capability
|
|
1174
|
+
* 'DialOut' in order to call a pstn number and add it in web conference
|
|
1175
|
+
*/
|
|
1176
|
+
isHybridDialOutCapability(): boolean;
|
|
1177
|
+
/**
|
|
1178
|
+
* Indicates wether the connected user is an hybrid oxe user and is on an oxe system with the capability
|
|
1179
|
+
* 'oxePBXOverflowCapability' in order to redirect incoming voip calls when user is unreachable
|
|
1180
|
+
*/
|
|
1181
|
+
isOxeOverflowCapability(): boolean;
|
|
1182
|
+
/**
|
|
1183
|
+
* Indicates wether the connected user is an hybrid user and is on an hybrid system with the capability
|
|
1184
|
+
* 'Join by phone' in order to join by phone a web conference
|
|
1185
|
+
*/
|
|
1186
|
+
isHybridJoinByPhoneCapability(): boolean;
|
|
1187
|
+
getSupervisionDevices(): string[];
|
|
1188
|
+
getSupervisionDeviceState(device: string): any;
|
|
1189
|
+
setSupervisionDeviceState(device: string, state: string): void;
|
|
1190
|
+
resetSupervisionState(): void;
|
|
1191
|
+
resetSupervisionCallinfos(): void;
|
|
1192
|
+
updateSupervisionCallInfo(supervisionCallInfo: any): void;
|
|
1193
|
+
/**
|
|
1194
|
+
* Returns a string representing the complete Contact object.
|
|
1195
|
+
*/
|
|
1196
|
+
toString(): string;
|
|
1197
|
+
containsEmail(email: string): boolean;
|
|
1198
|
+
containsPhoneNumber(phoneNumber: string): boolean;
|
|
1199
|
+
containsDirectoryPhoneNumber(phoneNumber: string): boolean;
|
|
1200
|
+
matchesSearchCriteria(criteria: string): boolean;
|
|
1201
|
+
/**
|
|
1202
|
+
* Check if the given string corresponds to a phone number (canonical format or not).
|
|
1203
|
+
* @param phoneNumber - The string to check
|
|
1204
|
+
*/
|
|
1205
|
+
startAsPhoneNumber(phoneNumber: string): boolean;
|
|
1206
|
+
toJSON(): any;
|
|
1207
|
+
}
|
|
1208
|
+
//# sourceMappingURL=contact.model.d.ts.map
|