public enum InteractionState extends java.lang.Enum<InteractionState>
InteractionState
enum defines the possible state that an InteractionI
object can be in.Enum Constant and Description |
---|
Active
Indicates that the
InteractionI object represents an active participant on the contact. |
Dialing
Indicates that an
InteractionI object with the ContactType.POM_Outbound is in the dialing state after
invocation of either InteractionI.previewDial(com.avaya.ccs.api.ContactNumberI) , InteractionI.previewDialFreeForm(java.lang.String) or
InteractionI.redial(com.avaya.ccs.api.ContactNumberI) |
Dropped
Indicates that the
InteractionI object has been dropped. |
Established
This state indicates that an endpoint has reached its final, active state in the call.
|
Held
Indicates that the
InteractionI object represents a participant that is held on the contact. |
Idle
This state is used internally by the API.
|
Initiated
Denotes a user-initiated Interaction.
|
Pending
Indicates that an
InteractionI object with ContactType.POM_Outbound is pending at the user. |
Preview
Indicates that an
InteractionI object with ContactType.POM_Outbound has been received from a preview
campaign and is currently being previewed by the user. |
Ringing
Indicates that the
InteractionI object is currently ringing at the address specified by
InteractionI.getAddress() . |
Unknown |
Wrapup
Indicates that an
InteractionI object with ContactType.POM_Outbound has ended and is currently in wrapup at
which point the user handling the interaction can wrapup |
Modifier and Type | Method and Description |
---|---|
static InteractionState |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static InteractionState[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final InteractionState Idle
public static final InteractionState Ringing
InteractionI
object is currently ringing at the address specified by
InteractionI.getAddress()
.public static final InteractionState Active
InteractionI
object represents an active participant on the contact. For an interaction with
ContactType.Voice
, this usually implies that there is active speech path with the remote party or parties on the
contact.public static final InteractionState Held
InteractionI
object represents a participant that is held on the contact.public static final InteractionState Dropped
InteractionI
object has been dropped. This will be received in a NotificationType.DELETE
notification and is the final state for an InteractionI
object.public static final InteractionState Dialing
InteractionI
object with the ContactType.POM_Outbound
is in the dialing state after
invocation of either InteractionI.previewDial(com.avaya.ccs.api.ContactNumberI)
, InteractionI.previewDialFreeForm(java.lang.String)
or
InteractionI.redial(com.avaya.ccs.api.ContactNumberI)
public static final InteractionState Preview
InteractionI
object with ContactType.POM_Outbound
has been received from a preview
campaign and is currently being previewed by the user.public static final InteractionState Wrapup
InteractionI
object with ContactType.POM_Outbound
has ended and is currently in wrapup at
which point the user handling the interaction can wrapuppublic static final InteractionState Pending
InteractionI
object with ContactType.POM_Outbound
is pending at the user. This occurs
when a logged in user is targeted by a consult operation and is currently busy processing an interaction.public static final InteractionState Established
public static final InteractionState Initiated
InteractionI
is sent from CCS in the Initiated
state.public static final InteractionState Unknown
public static InteractionState[] values()
for (InteractionState c : InteractionState.values()) System.out.println(c);
public static InteractionState valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null