@unblu/embedded-app-component 8.8.2 → 8.9.2

package/dist/lib/web-types.json

@@ -1 +1 @@
-{"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@unblu/embedded-app-component","version":"8.8.2","js-types-syntax":"typescript","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"unblu-embedded-app","description":"Unblu Embedded App Component allows to integrate Unblu into a website using a web component","attributes":[{"name":"server-url","description":"The URL to the collaboration server.\n\nIf not specified it is assumed that the server is reachable on the domain of the current webpage at the defined {@link UnbluEmbeddedAppElement.entryPath}\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.serverUrl} to set or get this via a property\n"},{"name":"entry-path","description":"The path pointing to the root of the Unblu collaboration server.\n\n@default \"/unblu\".\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.entryPath} to set or get this via a property\n"},{"name":"api-key","description":"The API Key to connect this app with a specific Unblu account\nThis is the minimum configuration that has to be done to trigger the initialization of Unblu.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.apiKey} to set or get this via a property\n"},{"name":"locale","description":"The locale (language) used for all Unblu UIs.\nIf not specified this is derived from the webpage or the browser.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see [https://www.unblu.com/en/docs/4.3/articles/installation-and-operation/selecting-the-language.html | Setting the Language / Locale] for more information on the detection.\n@see {@link UnbluEmbeddedAppElement.locale} to set or get this via a property\n"},{"name":"named-area","description":"The named area for which the configuration should be loaded and with which new queue requests will be labeled.\nIf not specified this can be derived from the corresponding meta tag on the webpage or the domain.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\nIf this is not desired it can be prevented by changing the named area via a meta tag, however in this case this will only effect the queue routing and not the configuration.\nAlternatively you can disable the automatic initialization.\n\n@see {@link https://www.unblu.com/en/docs/latest/knowledge-base/named-areas.html | Named Area} for further details.\n@see {@link UnbluEmbeddedAppElement.namedArea} to set or get this via a property\n"},{"name":"access-token","description":"The access token used to log the user in before initializing Unblu.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.accessToken} to set or get this via a property\n"},{"name":"conversation-id","description":"Opens the conversation with the specified ID.\nIf Unblu is not initialized yet, it will wait for the initialization and then automatically open the specified conversation.\nIf Unblu is already initialized, the conversation will be opened directly.\n\nIf the conversation doesn't exist or the user doesn't have the right to access it, a dialog will be displayed with the respective error message.\n\n@see {@link UnbluEmbeddedAppElement.openConversation} to set this value and also retrieve a promise to know, when the conversation was opened.\n@see {@link UnbluEmbeddedAppElement.conversationId} to read the value as property. This will always represent the currently opened conversation.\n"},{"name":"view-mode","description":"Sets the view mode of the embedded app element.\n\nDepending on the view mode the UI is displayed the following way:\n- {@link ViewMode.SPLIT}: The UI will be divided into two parts.\nThe list of conversations is displayed on the left and the active conversation on the right side.\n\n- {@link ViewMode.SINGLE}: Both the conversation list and the active conversation will be displayed in the same view using UI navigation to switch between them.\n\n- {@link ViewMode.AUTO}: The UI will automatically switch back and forth between the two other modes depending on the available width.\nThe trigger point when to switch between the two modes can be configured on the Unblu collaboration server.\n\nThis value can be set even if the API is not initialized yet.\nThe value will then be applied on initialization.\n\n@see {@link UnbluEmbeddedAppElement.viewMode} to set or get this via a property\n@default {@link ViewMode.AUTO}\n"},{"name":"fullscreen","description":"When this attribute is set to true, the embedded app will ignore the position and size set to its element and will used fixed positioning to display itself to cover the whole website.\n\nThis is useful when the user is currently in a call.\n\nThis can be set even if the API is not initialized yet.\nThe value will then be applied on initialization.\n\n**Note**: The user itself can also toggle this inside the UI.\n\n@see {@link UnbluEmbeddedAppElement.fullscreen} to set or get this via a property\n@default false\n"},{"name":"init-timeout","description":"The timeout im milliseconds that should be waited for the Unblu integration to load.\n\n@default 30'000 (30 seconds).\n\n@see {@link UnbluEmbeddedAppElement.initTimeout} to set or get this via a property\n"},{"name":"auto-init","description":"Defines if Unblu automatically tries to (re-)initialize as soon as an attribute or property changes that triggers (re-)initialization.\n\nTo trigger a initialization at least the attribute {@link ATTR_API_KEY} or property {@link UnbluEmbeddedAppElement.apiKey}.\n\n@default true.\n\n@see {@link UnbluEmbeddedAppElement.autoInit} to set or get this via a property\n"}],"js":{"events":[{"name":"stateChange","description":"Event emitted whenever the API state changes\n\n@see {@link StateChangeEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n"},{"name":"ready","description":"Event emitted as soon as the API is initialized.\n\nIt usually makes sense to use this event to wait for APIs on this element to be ready. E.g. the {@link UnbluEmbeddedAppElement.personInfo} or {@link UnbluEmbeddedAppElement.agentAvailable}.\nYou will find a note in the documentation of the properties when they are only available after initialization.\n\n@see {@link ReadyEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n"},{"name":"error","description":"Event emitted if the API initialization fails.\n\nIt usually makes sense to use this event if there is some general action that has to be triggered when the API initialization fails.\n\n@see {@link ErrorEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n"},{"name":"deinitializing","description":"Event emitted when the de-initialization of the API is started..\n\nIt usually makes sense to use this event to clean up resources and/or unregistering of listeners so they don't try to use the API again until it is initialized again.\n\n@see {@link DeinitializationStartedEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n@see {@link UnbluEmbeddedApi.DEINITIALIZING} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"deinitialized","description":"Event emitted when the de-initialization of the API has finished.\n\nIt usually makes sense to use this event if a re-initialization is required after de-init.\n\n@see {@link DeinitializationFinishedEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n@see {@link UnbluEmbeddedApi.DEINITIALIZED} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"activeConversationChange","description":"Event emitted every time one of the conversations accessible to the current user changes or one is added or removed.\n\n@see {@link ActiveConversationChangeEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n@see {@link UnbluEmbeddedApi.ACTIVE_CONVERSATION_CHANGE} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"fullscreenChange","description":"Event emitted every time the embedded app switches to fullscreen mode or back.\n\n@see {@link UnbluEmbeddedAppElement.FULLSCREEN_CHANGE}\n@see {@link UnbluEmbeddedAppElement.addEventListener}\n@see {@link UnbluEmbeddedAppElement.removeEventListener}\n@see {@link UnbluEmbeddedApi.FULLSCREEN_CHANGE} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"viewModeChange","description":"Event emitted every time the view mode changes.\n\n@see {@link UnbluEmbeddedAppElement.VIEW_MODE_CHANGE}\n@see {@link UnbluEmbeddedAppElement.addEventListener}\n@see {@link UnbluEmbeddedAppElement.removeEventListener}\n@see {@link UnbluEmbeddedApi.VIEW_MODE_CHANGE} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"}]}}]}}}
+{"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@unblu/embedded-app-component","version":"8.9.2","js-types-syntax":"typescript","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"unblu-embedded-app","description":"Unblu Embedded App Component allows to integrate Unblu into a website using a web component","attributes":[{"name":"server-url","description":"The URL to the collaboration server.\n\nIf not specified it is assumed that the server is reachable on the domain of the current webpage at the defined {@link UnbluEmbeddedAppElement.entryPath}\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.serverUrl} to set or get this via a property\n"},{"name":"entry-path","description":"The path pointing to the root of the Unblu collaboration server.\n\n@default \"/unblu\".\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.entryPath} to set or get this via a property\n"},{"name":"api-key","description":"The API Key to connect this app with a specific Unblu account\nThis is the minimum configuration that has to be done to trigger the initialization of Unblu.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.apiKey} to set or get this via a property\n"},{"name":"locale","description":"The locale (language) used for all Unblu UIs.\nIf not specified this is derived from the webpage or the browser.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see [https://www.unblu.com/en/docs/4.3/articles/installation-and-operation/selecting-the-language.html | Setting the Language / Locale] for more information on the detection.\n@see {@link UnbluEmbeddedAppElement.locale} to set or get this via a property\n"},{"name":"named-area","description":"The named area for which the configuration should be loaded and with which new queue requests will be labeled.\nIf not specified this can be derived from the corresponding meta tag on the webpage or the domain.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\nIf this is not desired it can be prevented by changing the named area via a meta tag, however in this case this will only effect the queue routing and not the configuration.\nAlternatively you can disable the automatic initialization.\n\n@see {@link https://www.unblu.com/en/docs/latest/knowledge-base/named-areas.html | Named Area} for further details.\n@see {@link UnbluEmbeddedAppElement.namedArea} to set or get this via a property\n"},{"name":"access-token","description":"The access token used to log the user in before initializing Unblu.\n\n**Note**: Changes to this attribute trigger a reinitialization of Unblu if {@link UnbluEmbeddedAppElement.ATTR_AUTO_INIT} is true.\n\n@see {@link UnbluEmbeddedAppElement.accessToken} to set or get this via a property\n"},{"name":"conversation-id","description":"Opens the conversation with the specified ID.\nIf Unblu is not initialized yet, it will wait for the initialization and then automatically open the specified conversation.\nIf Unblu is already initialized, the conversation will be opened directly.\n\nIf the conversation doesn't exist or the user doesn't have the right to access it, a dialog will be displayed with the respective error message.\n\n@see {@link UnbluEmbeddedAppElement.openConversation} to set this value and also retrieve a promise to know, when the conversation was opened.\n@see {@link UnbluEmbeddedAppElement.conversationId} to read the value as property. This will always represent the currently opened conversation.\n"},{"name":"view-mode","description":"Sets the view mode of the embedded app element.\n\nDepending on the view mode the UI is displayed the following way:\n- {@link ViewMode.SPLIT}: The UI will be divided into two parts.\nThe list of conversations is displayed on the left and the active conversation on the right side.\n\n- {@link ViewMode.SINGLE}: Both the conversation list and the active conversation will be displayed in the same view using UI navigation to switch between them.\n\n- {@link ViewMode.AUTO}: The UI will automatically switch back and forth between the two other modes depending on the available width.\nThe trigger point when to switch between the two modes can be configured on the Unblu collaboration server.\n\nThis value can be set even if the API is not initialized yet.\nThe value will then be applied on initialization.\n\n@see {@link UnbluEmbeddedAppElement.viewMode} to set or get this via a property\n@default {@link ViewMode.AUTO}\n"},{"name":"fullscreen","description":"When this attribute is set to true, the embedded app will ignore the position and size set to its element and will used fixed positioning to display itself to cover the whole website.\n\nThis is useful when the user is currently in a call.\n\nThis can be set even if the API is not initialized yet.\nThe value will then be applied on initialization.\n\n**Note**: The user itself can also toggle this inside the UI.\n\n@see {@link UnbluEmbeddedAppElement.fullscreen} to set or get this via a property\n@default false\n"},{"name":"init-timeout","description":"The timeout im milliseconds that should be waited for the Unblu integration to load.\n\n@default 30'000 (30 seconds).\n\n@see {@link UnbluEmbeddedAppElement.initTimeout} to set or get this via a property\n"},{"name":"auto-init","description":"Defines if Unblu automatically tries to (re-)initialize as soon as an attribute or property changes that triggers (re-)initialization.\n\nTo trigger a initialization at least the attribute {@link ATTR_API_KEY} or property {@link UnbluEmbeddedAppElement.apiKey}.\n\n@default true.\n\n@see {@link UnbluEmbeddedAppElement.autoInit} to set or get this via a property\n"}],"js":{"events":[{"name":"stateChange","description":"Event emitted whenever the API state changes\n\n@see {@link StateChangeEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n"},{"name":"ready","description":"Event emitted as soon as the API is initialized.\n\nIt usually makes sense to use this event to wait for APIs on this element to be ready. E.g. the {@link UnbluEmbeddedAppElement.personInfo} or {@link UnbluEmbeddedAppElement.agentAvailable}.\nYou will find a note in the documentation of the properties when they are only available after initialization.\n\n@see {@link ReadyEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n"},{"name":"error","description":"Event emitted if the API initialization fails.\n\nIt usually makes sense to use this event if there is some general action that has to be triggered when the API initialization fails.\n\n@see {@link ErrorEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n"},{"name":"deinitializing","description":"Event emitted when the de-initialization of the API is started..\n\nIt usually makes sense to use this event to clean up resources and/or unregistering of listeners so they don't try to use the API again until it is initialized again.\n\n@see {@link DeinitializationStartedEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n@see {@link UnbluEmbeddedApi.DEINITIALIZING} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"deinitialized","description":"Event emitted when the de-initialization of the API has finished.\n\nIt usually makes sense to use this event if a re-initialization is required after de-init.\n\n@see {@link DeinitializationFinishedEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n@see {@link UnbluEmbeddedApi.DEINITIALIZED} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"activeConversationChange","description":"Event emitted every time one of the conversations accessible to the current user changes or one is added or removed.\n\n@see {@link ActiveConversationChangeEvent} for the event type\n@see {@link UnbluEmbeddedAppElement.addEventListener} for listener registration\n@see {@link UnbluEmbeddedAppElement.removeEventListener} to remove a listener\n@see {@link UnbluEmbeddedApi.ACTIVE_CONVERSATION_CHANGE} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"fullscreenChange","description":"Event emitted every time the embedded app switches to fullscreen mode or back.\n\n@see {@link UnbluEmbeddedAppElement.FULLSCREEN_CHANGE}\n@see {@link UnbluEmbeddedAppElement.addEventListener}\n@see {@link UnbluEmbeddedAppElement.removeEventListener}\n@see {@link UnbluEmbeddedApi.FULLSCREEN_CHANGE} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"},{"name":"viewModeChange","description":"Event emitted every time the view mode changes.\n\n@see {@link UnbluEmbeddedAppElement.VIEW_MODE_CHANGE}\n@see {@link UnbluEmbeddedAppElement.addEventListener}\n@see {@link UnbluEmbeddedAppElement.removeEventListener}\n@see {@link UnbluEmbeddedApi.VIEW_MODE_CHANGE} for the event on the initialized {@link UnbluEmbeddedApi} instance\n"}]}}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unblu/embedded-app-component",
-  "version": "8.8.2",
+  "version": "8.9.2",
   "description": "Unblu Embedded App Component allows to integrate Unblu into a website using a web component",
   "homepage": "https://www.unblu.com/en/docs/latest/reference/unblu-embedded-js-api/",
   "author": "Denis Trueby",