Enum CallState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CallState>

    public enum CallState
    extends java.lang.Enum<CallState>
    Represents all types of call states.
    Since:
    11.27
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DELIVERED
      The call is being delivered to an agent device.
      ESTABLISHED
      The call has been accepted and connected to an agent device.
      FINISHED
      The call has been disconnected and finished.
      QUEUED
      The call is queued and waiting for distribution by the routing engine.
      RECEIVED
      The call has been received.
      REDIRECTED
      The call has been redirected to an external target which is not a connected agent device.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CallState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CallState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • RECEIVED

        public static final CallState RECEIVED
        The call has been received. The call will not be distributed automatically in this state.
        Since:
        11.27
      • QUEUED

        public static final CallState QUEUED
        The call is queued and waiting for distribution by the routing engine.
        Since:
        11.27
      • DELIVERED

        public static final CallState DELIVERED
        The call is being delivered to an agent device. The device is alerting, but the call is not connected yet.
        Since:
        11.27
      • ESTABLISHED

        public static final CallState ESTABLISHED
        The call has been accepted and connected to an agent device. The connection is established.
        Since:
        11.27
      • REDIRECTED

        public static final CallState REDIRECTED
        The call has been redirected to an external target which is not a connected agent device.
        Since:
        11.27
      • FINISHED

        public static final CallState FINISHED
        The call has been disconnected and finished. This may happen due to various use cases, e.g. the caller hangs up before being connected to an agent, or the agent hangs up after the call has been connected.
        Since:
        11.27
    • Method Detail

      • values

        public static CallState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (CallState c : CallState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CallState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null