< Back to Package Overview

Configuring the Agent Features

Using the SharingServices Package, you can configure Avaya Co-Browsing features for the Agent website.

Enable Highlight

Use the enableHighlight() method to enable the Highlight feature. By default the Highlight feature is enabled.

    _cbinstance.enableHighlight();

Disable Highlight

Use the disableHighlight() method to disable the Highlight feature.

    _cbinstance.disableHighlight();

Set Highlight Color

Use the setHighlightColor() method to set the Highlight color. By default the Highlight color is yellow.

    _cbinstance.setHighlightColor(color);

Enable Element Highlight

Use the enableElementHighlight() method to enable the Highlight element feature. By default the Highlight element feature is enabled.

    _cbinstance.enableElementHighlight();

Disable Element Highlight

Use the disableElementHighlight() method to disable the Highlight element feature.

    _cbinstance.disableElementHighlight();

Note:Mouse double click for text selection to highlight selected text is not supported.

Connection Retry Attempts

To set connection retry attempts, you must provide the count. This specifies the number of attempts that the Agent service makes to connect to the Breeze server. The default value is 10.

    _cbinstance.setAgentConnectionRetryAttempts(retryAttempts);

Connection Retry Interval

To set connection retry attempts, you must provide the time in milliseconds. This specifies the interval after which the Agent service attempts to connect to the Breeze server. The default value is 10000.

    _cbinstance.setAgentConnectionRetryInterval(connectionRetryInterval);

Set CSS Path

To set css path, you must provide the css directory path. The default value is 'css/'.

    _cbinstance.setAgentCSSPath(AgentCSSPath);

Set Image Path

To set image path, you must provide the image directory path. The default value is 'img/'.

    _cbinstance.setAgentImagePath(AgentImagePath);

Set Mouse and Scroll Synchronization Interval

To set the mouse and scroll synchronization interval, you must provide the time in milliseconds. This specifies the interval after which the Agent synchronizes mouse trails and scroll position with the Customer.The default value is 1000.

    _cbinstance.setMouseScrollSyncInterval(mouseScrollSyncInterval);

Update inactivity timeout

To record inactivity timeout activities, you must provide the time in seconds.

    _cbinstance.updateIdleTime(_inactiveMessageCounter);

Making Configuration Changes at Runtime

Configuration data is critical for initializing the Avaya Co-Browsing Client SDK. Services are created and initialized according to their corresponding configuration data during initialization. After the Avaya Co-Browsing Client SDK is initialized, if you need to change any configuration options for any services or enable/disable certain services, the Avaya Co-Browsing Client SDK must be re-initialized with the updated configuration data. Dynamic changes of configuration options are not supported. Verify that if there is any changes made then they are reflected or not after reload.