Class InstantMessagingEvent

java.lang.Object
java.util.EventObject
altitude.integrationServer.events.ISEvent
altitude.integrationServer.events.ServerEvent
altitude.integrationServer.events.AgentEvent
altitude.integrationServer.events.SessionEvent
altitude.integrationServer.events.InstantMessagingEvent
All Implemented Interfaces:
Serializable
public class InstantMessagingEvent extends SessionEvent
Represents an instant messaging event of a session.
See Also:

  • Constructor Details

    • InstantMessagingEvent

      public InstantMessagingEvent()

  • Method Details

    • getInteractionId

      public int getInteractionId()
      Identifier of the data interaction.

    • setInteractionId

      public void setInteractionId(int value)
      Identifier of the data interaction.

    • getEventType

      public InstantMessagingEventType getEventType()
      The type of the instant messaging event event.

    • setEventType

      public void setEventType(InstantMessagingEventType value)
      The type of the instant messaging event event.

    • getState

      public InstantMessagingInteractionState getState()
      The current state of the instant messaging interaction.

    • setState

      public void setState(InstantMessagingInteractionState value)
      The current state of the instant messaging interaction.

    • getJoinUrl

      public String getJoinUrl()
      URL of the HTTP server of the instant messaging gateway.

    • setJoinUrl

      public void setJoinUrl(String value)
      URL of the HTTP server of the instant messaging gateway.

    • getRecordingDocumentId

      public int getRecordingDocumentId()
      Identifier of the document that contains the recording of the instant messaging.

    • setRecordingDocumentId

      public void setRecordingDocumentId(int value)
      Identifier of the document that contains the recording of the instant messaging.

    • getDestinationAgent

      public String getDestinationAgent()
      Name of the agent, if the remote instant messaging party talking to the agent is also an agent.

    • setDestinationAgent

      public void setDestinationAgent(String value)
      Name of the agent, if the remote instant messaging party talking to the agent is also an agent.

    • getDestinationAddress

      public String getDestinationAddress()
      Destination address of the interaction.

    • setDestinationAddress

      public void setDestinationAddress(String value)
      Destination address of the interaction.

    • getDestinationCampaign

      public String getDestinationCampaign()
      Campaign associated to the instant messaging.

    • setDestinationCampaign

      public void setDestinationCampaign(String value)
      Campaign associated to the instant messaging.

    • getIsEnqueued

      public boolean getIsEnqueued()
      If true, the instant messaging is in a campaign queue.

    • setIsEnqueued

      public void setIsEnqueued(boolean value)
      If true, the instant messaging is in a campaign queue.

    • getIsRecording

      public boolean getIsRecording()
      If true, the instant messaging is being recorded.

    • setIsRecording

      public void setIsRecording(boolean value)
      If true, the instant messaging is being recorded.

    • getDequeuedReason

      public DequeuedEventReason getDequeuedReason()
      The reason to dequeue the instant messaging.

    • setDequeuedReason

      public void setDequeuedReason(DequeuedEventReason value)
      The reason to dequeue the instant messaging.

    • getRecordingTerminationReason

      public RecordingTerminationReason getRecordingTerminationReason()
      The reason for the last recording termination.

    • setRecordingTerminationReason

      public void setRecordingTerminationReason(RecordingTerminationReason value)
      The reason for the last recording termination.

    • getRecordingInitiatorType

      public RecordingInitiatorType getRecordingInitiatorType()
      The type of the recording initiator.

    • setRecordingInitiatorType

      public void setRecordingInitiatorType(RecordingInitiatorType value)
      The type of the recording initiator.

    • getAllowedOperations

      public InstantMessagingMediaCanDo getAllowedOperations()
      Allowed operations.

    • setAllowedOperations

      public void setAllowedOperations(InstantMessagingMediaCanDo value)
      Allowed operations.

    • getClearedByRotateOnNoAnswer

      public boolean getClearedByRotateOnNoAnswer()
      If true, the instant messaging is cleared by rotate on no answer.

    • setClearedByRotateOnNoAnswer

      public void setClearedByRotateOnNoAnswer(boolean value)
      If true, the instant messaging is cleared by rotate on no answer.

    • getInteractionKey

      public String getInteractionKey()
      Global identifier of the interaction.

    • setInteractionKey

      public void setInteractionKey(String value)
      Global identifier of the interaction.

    • getRecordingKey

      public String getRecordingKey()
      Recording Key.

    • setRecordingKey

      public void setRecordingKey(String value)
      Recording Key.

    • toString

      public String toString()
      Converts the value of this event to a string representation.
      Overrides:
      toString in class AgentEvent
      Returns:
      The string representation of the event.