de.starface.integration.uci.java.v30.messages.events
Interface UciQueueEvents


@UciService(value="ucp.v30.events.queue")
@RpcInterface(value="ucp.v30.events.queue")
@RpcValueTranslation(version=30)
public interface UciQueueEvents

This interface defines the Queue events that can be received by a UCI client implementation in order to handle Queue changes.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 void queueAgentChangedEvent(Integer groupAccountId)
          The queue has a new agent or an agent was removed.
 void queueAgentStateChanged(QueueAgentState agentState)
          One of the agents states has changed.
 void queueCallChangedIdEvent(String oldId, String newId)
          During a call, the id of the call can change (e.g. during a transfer).
 void queueCallEvent(UciQueueCall call)
          Updates the UCI client about a new queue call or a statechange of a queue call.
 void queueGroupChangedEvent(boolean newGroup, Integer groupAccountId)
          A new queue has been created (parameter newGroup = true) or a queue was deleted (parameter newGroup = false)
 void queueSettingChanged(Integer queueAccountId)
          This event allows the UCI client to get informed when the state or number of the queue setting changes.
 void queueSettingsChanged(List<QueueSetting> queueSetting)
          This event allows the UCI client to get informed when the state or number of the queue settings change.
 

Field Detail

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

queueSettingsChanged

void queueSettingsChanged(List<QueueSetting> queueSetting)
This event allows the UCI client to get informed when the state or number of the queue settings change.

Parameters:
queueSetting - the new state of the Queue setting with values for the properties defined in QueueSetting.

queueSettingChanged

void queueSettingChanged(Integer queueAccountId)
This event allows the UCI client to get informed when the state or number of the queue setting changes.

Parameters:
queueAccountId - the new state of the Queue setting with values for the properties defined in Integer.

queueAgentStateChanged

void queueAgentStateChanged(QueueAgentState agentState)
One of the agents states has changed. This can be the UserState or the loginstate at the queue, as well as a name change.

Parameters:
agentState -

queueAgentChangedEvent

void queueAgentChangedEvent(Integer groupAccountId)
The queue has a new agent or an agent was removed. Please reload the agent list for this queue.

Parameters:
groupAccountId -

queueGroupChangedEvent

void queueGroupChangedEvent(boolean newGroup,
                            Integer groupAccountId)
A new queue has been created (parameter newGroup = true) or a queue was deleted (parameter newGroup = false)

Parameters:
newGroup - true if a queuegroup was created, false if a queuegroup was deleted
groupAccountId - the accountid of the queuegroup

queueCallEvent

void queueCallEvent(UciQueueCall call)
Updates the UCI client about a new queue call or a statechange of a queue call.

Parameters:
call - contains all the new/updated information about this queue call.

queueCallChangedIdEvent

void queueCallChangedIdEvent(String oldId,
                             String newId)
During a call, the id of the call can change (e.g. during a transfer). If this happens, the existing call must be updated. Ignoring this event may lead to "visually frozen" calls in your client, because all new events will reference the new id.

Parameters:
oldId - the former id of the call
newId - the new id of the call


Copyright © 2012 STARFACE GmbH. All rights reserved.