MediaPropertiesLayout

Class finesse.restservices.MediaPropertiesLayout

Represents the appearance of media properties in the call control gadget on the agent or supervisor desktop. Media properties are carried in Dialog objects. Administrators can create and customize multiple layouts for media properties.

Copy_mediaPropLayout = new finesse.restservices.MediaPropertiesLayouts({
"onLoad": _onLoadHandler,
"onError": _onErrorHandler,
"onChange": _onChangeHandler
});

For additional parameters and methods, see RestBase Common Parameters.

Methods

get()

Retrieves the media properties layout. This call re-queries the server and refreshes the layout object.

Returns

{finesse.restservices.MediaPropertiesLayout} The MediaPropertiesLayout object.

getData()

Retrieves the data for the object. Performs safe conversion from raw API data to ensure the returned layout. The object has a header with correct entry fields and exactly two columns with lists of entries.

Returns

{finesse.restservices.MediaPropertiesLayout.Object} The data in columns (unless only one defined).

getDescription()

Retrieves the description.

Returns

{String} The description.

getName()

Retrieves the name.

Returns

{String} The name.

getType()

Retrieves the layout type DEFAULT or CUSTOM.

Returns

{String} The layout type DEFAULT or CUSTOM.