Interface IIMCustomInteraction

All Superinterfaces:

ICustomInteraction, IDisposable, IEntity

public interface IIMCustomInteraction
extends ICustomInteraction

Represents an instant messaging custom interaction.

Method Summary

Modifier and Type	Method	Description
void	addIMCustomInteractionErrorListener(IMCustomInteractionErrorListener listener)	Registers the IMCustomInteractionErrorListener.
void	addIMCustomInteractionListener(IMCustomInteractionListener listener)	Registers the IMCustomInteractionListener.
void	addIMCustomInteractionMessageListener(IMCustomInteractionMessageListener listener)	Registers the IMCustomInteractionMessageListener.
void	addIMCustomInteractionProgressListener(IMCustomInteractionProgressListener listener)	Registers the IMCustomInteractionProgressListener.
void	disconnect()	Disconnects the interaction.
IMCustomInteractionCanDo	getAllowedOperations()	Allowed operations.
IMCustomInteractionData	getData()	Data of the instant messaging interaction.
String	getDnis()	Number dialed by the customer.
String	getFromAddress()	ANI of the remote party talking to the agent.
InteractionParties	getParties()	interaction parties.
IMCustomInteractionState	getState()	State of the instant messaging interaction.
void	removeIMCustomInteractionErrorListener(IMCustomInteractionErrorListener listener)	Unregisters the IMCustomInteractionErrorListener.
void	removeIMCustomInteractionListener(IMCustomInteractionListener listener)	Unregisters the IMCustomInteractionListener.
void	removeIMCustomInteractionMessageListener(IMCustomInteractionMessageListener listener)	Unregisters the IMCustomInteractionMessageListener.
void	removeIMCustomInteractionProgressListener(IMCustomInteractionProgressListener listener)	Unregisters the IMCustomInteractionProgressListener.
void	sendMessage(String message)	Sends a message in the interaction.

Methods inherited from interface ICustomInteraction

getCustomInteractionManager, getInteractionKey, getMediaType, getStartTime

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

addIMCustomInteractionErrorListener

void addIMCustomInteractionErrorListener(IMCustomInteractionErrorListener listener)

Registers the IMCustomInteractionErrorListener.

Parameters:

listener - Event listener to add.

removeIMCustomInteractionErrorListener

void removeIMCustomInteractionErrorListener(IMCustomInteractionErrorListener listener)

Unregisters the IMCustomInteractionErrorListener.

Parameters:

listener - Event listener to remove.

addIMCustomInteractionListener

void addIMCustomInteractionListener(IMCustomInteractionListener listener)

Registers the IMCustomInteractionListener.

Parameters:

listener - Event listener to add.

removeIMCustomInteractionListener

void removeIMCustomInteractionListener(IMCustomInteractionListener listener)

Unregisters the IMCustomInteractionListener.

Parameters:

listener - Event listener to remove.

addIMCustomInteractionMessageListener

void addIMCustomInteractionMessageListener(IMCustomInteractionMessageListener listener)

Registers the IMCustomInteractionMessageListener.

Parameters:

listener - Event listener to add.

removeIMCustomInteractionMessageListener

void removeIMCustomInteractionMessageListener(IMCustomInteractionMessageListener listener)

Unregisters the IMCustomInteractionMessageListener.

Parameters:

listener - Event listener to remove.

addIMCustomInteractionProgressListener

void addIMCustomInteractionProgressListener(IMCustomInteractionProgressListener listener)

Registers the IMCustomInteractionProgressListener.

Parameters:

listener - Event listener to add.

removeIMCustomInteractionProgressListener

void removeIMCustomInteractionProgressListener(IMCustomInteractionProgressListener listener)

Unregisters the IMCustomInteractionProgressListener.

Parameters:

listener - Event listener to remove.

disconnect

void disconnect()
         throws Exception,
altitude.integrationServer.exceptions.ISException

Disconnects the interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAllowedOperations

IMCustomInteractionCanDo getAllowedOperations()
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Allowed operations.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getData

IMCustomInteractionData getData()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Data of the instant messaging interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDnis

String getDnis()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Number dialed by the customer.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getFromAddress

String getFromAddress()
               throws Exception,
altitude.integrationServer.exceptions.ISException

ANI of the remote party talking to the agent. For inbound calls, specifies the caller ANI.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getParties

InteractionParties getParties()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

interaction parties.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getState

IMCustomInteractionState getState()
                           throws Exception,
altitude.integrationServer.exceptions.ISException

State of the instant messaging interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

sendMessage

void sendMessage(String message)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Sends a message in the interaction.

Parameters:

message - The message to send.

Throws:

Exception

altitude.integrationServer.exceptions.ISException