new VivochaConsoleInterface()
Internal constructor, not to be used directly.
Extends
- external:EventEmitter
Methods
(static) getApp(app) → {Promise}
Get a VivochaConsoleApp starting from the app id or type.
Parameters:
| Name | Type | Description |
|---|---|---|
app |
string | The app id or type for which is requested the function. |
Returns:
Resolves to a VivochaConsoleApp.
- Type
- Promise
(static) getTranscript(callback) → {Promise}
Get the contact transcript as defined in the ContactData transcript property.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
GenericCallback | Return the ContactData.transcript |
Returns:
transcript - If the callback parameter is not specified it resolves to a ContactData.transcript.
- Type
- Promise
(static) selectApp(app)
Select a ConsoleApp in the Vivocha console. This moves the ConsoleApp in the foreground of ConsoleApps.
Parameters:
| Name | Type | Description |
|---|---|---|
app |
string | The app id or type for which is requested the function. |
(static) unselectApp(app)
Unselect this ConsoleApp in the Vivocha console. This moves the ConsoleApp in the background of ConsoleApps and selects the first
Parameters:
| Name | Type | Description |
|---|---|---|
app |
string | The app id or type for which is requested the function. |
(static) sendMacro(shortcut)
Sends a shortcut message to the customer and prints it in the chat area.
Parameters:
| Name | Type | Description |
|---|---|---|
shortcut |
Shortcut | Shortcut object |
(static) commitMacro(shortcut)
Injects a shortcut message to the chat input area allowing the agent to edit the text before sending it to the customer.
Parameters:
| Name | Type | Description |
|---|---|---|
shortcut |
Shortcut | Shortcut object |
(static) sendText(text)
Sends a text message to the customer and prints it in the chat area.
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string | Chat message. |
(static) commitText(text)
Injects a text message to the chat input area allowing the agent to edit the text before sending it to the customer.
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string | Chat message. |
(static) disconnect()
Close all channels and disconnect from a contact.
Events
windowclose
The contact has been closed by the agent. This event is emitted when the Agent click the trash bin button in the console. From this moment the Embedded console container can destroy the iframe content.