Class finesse.restservices.Media

Extends finesse.restservices.RestBase.
A Media represents a non-voice channel, for example, a chat or a email.
Defined in: finesse.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	finesse.restservices.Media()

Field Summary
Field Attributes	Field Name and Description
	supportsRequests Media objects support GET REST requests.

Fields borrowed from class finesse.restservices.RestBase:: restResponseStatus

Method Summary
Method Attributes	Method Name and Description
	getDialogLogoutAction() Getter for the action to be taken in the event the agent logs out with dialogs associated with this media.
	getId() Getter for the id.
	getInterruptAction() Getter for the action to be taken in the event this media is interrupted.
	getInterruptible() Getter for whether or not this media is interruptible
	getMaxDialogLimit() Getter for maximum number of dialogs allowed on this Media
	getMediaDialogs(handlers) Getter for a MediaDialogs collection object that is associated with User on this Media.
	getMediaId() Getter for the Media id
	getName() Getter for the name.
	getReasonCodeId() Getter for the reason code id.
	getReasonCodeLabel() Getter for the reason code label.
	getRoutable() Getter for routable field on this Media
	getState() Getter for the state of the User on this Media.
	isInterruptible() Is the user interruptible on this Media.
	isInWorkState() Is the user in work state on this Media.
	isLoggedIn() Is the user in any state except LOGOUT on this Media.
	isRoutable() Is the user routable on this Media.
	login(options) Log the agent into this media.
	logout(reasonCode, handlers) Perform a logout for a user on this media.
	refresh(retries) Refresh this media object and optionally refresh the list of media dialogs associated with this object.
	refreshMediaDialogs() Refresh the dialog collection associated with this media.
	setMediaOptions(mediaOptions) Set the maxDialogLimit, interruptAction, and dialogLogoutAction settings that the application will use for this media.
	setRoutable(options)
	setState(newState, reasonCode, handlers) Set the state of the user on this Media.

Methods borrowed from class finesse.restservices.RestBase:: addHandler, getData, getProperty, hasProperty, isLoaded, removeHandler

Class Detail

finesse.restservices.Media()

Field Detail

supportsRequests

Media objects support GET REST requests.

Method Detail

{*|Object} getDialogLogoutAction()

Getter for the action to be taken in the event the agent logs out with dialogs associated with this media. The action will be one of the following:

CLOSE: the dialog will be closed.
TRANSFER: the dialog will be transferred to another agent.

Returns:: {*|Object}

{String} getId()

Getter for the id.

Returns:: {String} The id.

{*|Object} getInterruptAction()

Getter for the action to be taken in the event this media is interrupted. The action will be one of the following:

ACCEPT: the interrupt will be accepted and the agent will not work on tasks in this media until the media is no longer interrupted.
IGNORE: the interrupt will be ignored and the agent is allowed to work on the task while the media is interrupted.

Returns:: {*|Object}

{Boolean} getInterruptible()

Getter for whether or not this media is interruptible

Returns:: {Boolean} true if interruptible; false otherwise

{String} getMaxDialogLimit()

Getter for maximum number of dialogs allowed on this Media

Returns:: {String} The max number of Dialogs on this Media

{finesse.restservices.MediaDialogs} getMediaDialogs(handlers)

Getter for a MediaDialogs collection object that is associated with User on this Media.

Parameters:
{finesse.interfaces.RestObjectHandlers} handlers Optional: Object that sets callback handlers (only applicable when Object has not been previously created).

Returns:: {finesse.restservices.MediaDialogs} A MediaDialogs collection object.

{String} getMediaId()

Getter for the Media id

Returns:: {String} The Media id

{String} getName()

Getter for the name.

Returns:: {String} The name.

{String} getReasonCodeId()

Getter for the reason code id.

Returns:: {String} The reason code id.

{String} getReasonCodeLabel()

Getter for the reason code label.

Returns:: {String} The reason code label.

{Boolean} getRoutable()

Getter for routable field on this Media

Returns:: {Boolean} true if routable, false otherwise

{String} getState()

Getter for the state of the User on this Media.

Returns:: {String} The current (or last fetched) state of the User on this Media

See:: finesse.restservices.Media.States

{Boolean} isInterruptible()

Is the user interruptible on this Media.

Returns:: {Boolean} true if interruptible; false otherwise

{boolean} isInWorkState()

Is the user in work state on this Media.

Returns:: {boolean} returns true if the media is in work state; false otherwise

{boolean} isLoggedIn()

Is the user in any state except LOGOUT on this Media.

Returns:: {boolean} returns true if the agent is in any state except LOGOUT in this media

{Boolean} isRoutable()

Is the user routable on this Media.

Returns:: {Boolean} true if routable, false otherwise

{finesse.restservices.Media} login(options)

Log the agent into this media.

Parameters:

{Object} options

An object with the following properties:

maxDialogLimit: The id of the object being constructed
interruptAction: Accept or ignore interrupts
dialogLogoutAction: transfer or close the task at logout time
{finesse.interfaces.RequestHandlers} handlers: An object containing the handlers for the request

If maxDialogLimit, interruptAction, and dialogLogoutAction are not present, loginOptions specified in the call to finesse.restservices.MediaList.getMedia() will be used.

Returns:: {finesse.restservices.Media} This Media object, to allow cascading

See:: finesse.restservices.MediaList#getMedia

{finesse.restservices.Media} logout(reasonCode, handlers)

Perform a logout for a user on this media.

Parameters:
{String} reasonCode: The reason this user is logging out of this media. Pass null for no reason.
{finesse.interfaces.RequestHandlers} handlers: An object containing the handlers for the request

Returns:: {finesse.restservices.Media} This Media object, to allow cascading

refresh(retries)

Refresh this media object and optionally refresh the list of media dialogs associated with this object.

Parameters:
{Integer} retries: the number of times to retry synchronizing this media object.

refreshMediaDialogs()

Refresh the dialog collection associated with this media.

setMediaOptions(mediaOptions)

Set the maxDialogLimit, interruptAction, and dialogLogoutAction settings that the application will use for this media. In the event of a failure, these options will be set on the new Finesse server.

Parameters:

{Object} mediaOptions

an object with the following properties:

maxDialogLimit: The id of the object being constructed
interruptAction: Accept or ignore interrupts
dialogLogoutAction: transfer or close the task at logout time

{finesse.restservices.Media} setRoutable(options)

Parameters:

{Object} options

An object with the following properties:

routable: true if the agent is routable, false otherwise
{finesse.interfaces.RequestHandlers} handlers: An object containing the handlers for the request

Returns:: {finesse.restservices.Media} This Media object, to allow cascading

{finesse.restservices.Media} setState(newState, reasonCode, handlers)

Set the state of the user on this Media.

Parameters:
{String} newState: The state you are setting
{ReasonCode} reasonCode: The reason this user is changing state for this media. Pass null for no reason.
{finesse.interfaces.RequestHandlers} handlers: An object containing the handlers for the request

Returns:: {finesse.restservices.Media} This Media object, to allow cascading

See:: finesse.restservices.User.States

Classes

Class finesse.restservices.Media