Interface AgentActionHandler
public interface AgentActionHandler
This handler provides information about the agent's state
and functions to perform specific actions for the agent.
This handler is only available in the novomind iAGENT routing process
and also in the novomind iAGENT Desk process.
- Since:
- 11.16
-
Method Summary
Modifier and TypeMethodDescriptiongetAgentAvailability
(User user) This method returns theModifiableAgentAvailability
for an agent.getAgentAvailability
(User user, AgentGroup agentGroup) This method returns theModifiableAgentAvailability
for an Agent and an AgentGroup.getAgentPauseState
(User user) This method returns theModifiableAgentPauseState
for an agent.This method returns theModifiableAgentPostProcessingState
for an agent.This method returns theAgentQuickCaseOperationBuilder
for an agent.This method returns theUserNotificationOperationBuilder
for an agent.
-
Method Details
-
getAgentAvailability
This method returns theModifiableAgentAvailability
for an agent. TheModifiableAgentAvailability
allows to retrieve and modify the availability state for an agent generally or alternatively for each module (Mail, Chat, Call) separately.- Parameters:
user
- The agent to get theModifiableAgentAvailability
.- Returns:
- The
ModifiableAgentAvailability
for the given agent - Throws:
WrongArgumentException
- if the given user is not an agent- Since:
- 11.16
-
getAgentAvailability
ModifiableAgentAvailability getAgentAvailability(User user, AgentGroup agentGroup) throws WrongArgumentException This method returns theModifiableAgentAvailability
for an Agent and an AgentGroup. TheModifiableAgentAvailability
allows to retrieve and modify the agent's availability state only for the specifiedAgentGroup
membership generally or alternatively for each module (Mail, Chat, Call) separately.- Parameters:
user
- The agent to get theModifiableAgentAvailability
.agentGroup
- The agent group to get theModifiableAgentAvailability
.- Returns:
- The
ModifiableAgentAvailability
for the given agent and agent group - Throws:
WrongArgumentException
- if the given user is not an agent or the agentGroup is not assigned to the agent- Since:
- 12.10
-
getAgentPauseState
This method returns theModifiableAgentPauseState
for an agent. TheModifiableAgentPauseState
allows to retrieve and modify the pause state for an agent.- Parameters:
user
- The agent to get theModifiableAgentPauseState
.- Returns:
- The
ModifiableAgentPauseState
for the given agent - Throws:
WrongArgumentException
- if the given user is not an agent- Since:
- 11.16
-
getAgentPostProcessingState
ModifiableAgentPostProcessingState getAgentPostProcessingState(User user) throws WrongArgumentException This method returns theModifiableAgentPostProcessingState
for an agent. TheModifiableAgentPostProcessingState
allows to retrieve and modify the post processing state for an agent.- Parameters:
user
- The agent to get theModifiableAgentPostProcessingState
.- Returns:
- The
ModifiableAgentPostProcessingState
for the given agent - Throws:
WrongArgumentException
- if the given user is not an agent- Since:
- 11.18
-
getAgentQuickCaseOperationBuilder
AgentQuickCaseOperationBuilder getAgentQuickCaseOperationBuilder(User user) throws WrongArgumentException This method returns theAgentQuickCaseOperationBuilder
for an agent. TheAgentQuickCaseOperationBuilder
allows to build a quick case operation for an agent.- Parameters:
user
- The agent to get theAgentQuickCaseOperationBuilder
for.- Returns:
- The
AgentQuickCaseOperationBuilder
for the given agent - Throws:
WrongArgumentException
- if the given user is not an agent- Since:
- 11.18
-
getUserNotificationOperationBuilder
UserNotificationOperationBuilder getUserNotificationOperationBuilder(User user) throws WrongArgumentException This method returns theUserNotificationOperationBuilder
for an agent. TheUserNotificationOperationBuilder
allows to build a user notification operation for an agent.- Parameters:
user
- The agent to get theUserNotificationOperationBuilder
for.- Returns:
- The
UserNotificationOperationBuilder
for the given agent - Throws:
WrongArgumentException
- if the given user is not an agent- Since:
- 12.13
-