Communication Services API Reference (JavaScript) Class: DataSet

Class: DataSet

Constructor

new DataSet()

These API is internal to the SDK library and their use by third party applications could result in unpredictable behavior of the resulting application. No support will be provided by Avaya related to the use of any internal APIs.

Methods

Managing callbacks

addOnDataSetChangedCallback(callback) → {void}

Add new onDataSetChangedCallback.

Parameters:

Name	Type	Description
`callback`	AvayaClientServices.Base.DataSet#onDataSetChangedCallback

Returns:

{ void }

addOnDataSetInvalidatedCallback(callback) → {void}

Add new onDataSetChangedCallback.

Parameters:

Name	Type	Description
`callback`	AvayaClientServices.Base.DataSet#onDataSetInvalidatedCallback

Returns:

{ void }

removeOnDataSetChangedCallback(callback) → {void}

Remove existing onDataSetChangedCallback.

Parameters:

Name	Type	Description
`callback`	AvayaClientServices.Base.DataSet#onDataSetChangedCallback

Returns:

{ void }

removeOnDataSetInvalidatedCallback(callback) → {void}

Parameters:

Name	Type	Description
`callback`	AvayaClientServices.Base.DataSet#onDataSetInvalidatedCallback

Returns:

{ void }

Type Definitions

onDataSetChangedCallback(elementsChanged, changeType) → {void}

Interface for callback function to be invoked when attachment's name changes.

Parameters:

Name	Type	Description
`elementsChanged`	Array.<object>	An array of objects that has been changed.
`changeType`	AvayaClientServices.Base.DataSetChangeTypes	Type of change

Returns:

{ void }

onDataSetChangedCallback(data, type) → {void}

Interface for callback function to be invoked when DataSet changes.

Parameters:

Name	Type	Description
`data`	Array	Array of data that was changed
`type`	AvayaClientServices.Base.DataSetChangeTypes	Type of data set change

Returns:

{ void }

onDataSetInvalidatedCallback(dataSet) → {void}

Interface for callback function to be invoked when DataSet is invalidated.

Parameters:

Name	Type	Description
`dataSet`	AvayaClientServices.Base.DataSet	instance of DataSet that has been invalidated

Returns:

{ void }