AgentPauseState (ecom-api-iagent 12.27.2 API)

All Known Subinterfaces:

ModifiableAgentPauseState
```
public interface AgentPauseState
```
This interface provides information about the agent pause state and also provides the optional PauseReason when an agent is paused.

Since:

11.16

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Optional<PauseReason>`	`getPauseReason()`	The method returns the optional `PauseReason` if the agent currently is in pause state.
`boolean`	`isPaused()`	The method returns true if the agent currently is in pause state.
`boolean`	`isPauseRequested()`	The method returns true if the agent requested the pause state, but is currently not able to be paused e.g.

- Method Detail
  - isPaused
```
boolean isPaused()
```
    The method returns true if the agent currently is in pause state.
    
    Returns:
    
    true if the agent currently is paused, otherwise false.
    
    Since:
    
    11.16
  - isPauseRequested
```
boolean isPauseRequested()
```
    The method returns true if the agent requested the pause state, but is currently not able to be paused e.g. due to an active call or chat. If the pause state has been requested, the agent will be set to pause state automatically after finishing the call or chat. If the agent is configured to receive an automatic post processing time after the call or chat, the requested pause state will be applied after the end of the post processing time.
    
    Returns:
    
    true if the agent requested the pause state, otherwise false.
    
    Since:
    
    11.19
  - getPauseReason
```
java.util.Optional<PauseReason> getPauseReason()
```
    The method returns the optional PauseReason if the agent currently is in pause state.
    
    Returns:
    
    the optional PauseReason while the agent is paused.
    
    Since:
    
    11.16