Interface IExternalInteractionRegistration

All Superinterfaces:

IDisposable, IEntity

public interface IExternalInteractionRegistration
extends IEntity

Represents a registration of an interaction whose origin is external to Altitude uCI, that is being handled by an agent.

Method Summary

Modifier and Type	Method	Description
void	addExternalInteractionRegistrationEndedListener(ExternalInteractionRegistrationEndedListener listener)	Registers the ExternalInteractionRegistrationEndedListener.
void	end()	Stops the external interaction registration.
void	endWithError(int errorCode, String errorDetail)	Stops the external interaction registration when it has errors
boolean	getAgentIsBusy()	true if the agent should not be distributed other interaction while handling the current one.
String	getAgentName()	Name of the agent that is handling the external.
BusinessStatus	getBusinessStatus()	The business status of the external interaction.
String	getCampaignName()	Name of the campaign of the external interaction.
Integer	getContactProfileId()	Identifier of the contact profile.
ICustomInteractionManager	getCustomInteractionManager()	The custom interaction manager used to manage custom interactions.
ExternalInteractionRegistrationData	getData()	Returns all properties of the external interaction registration.
Integer	getDirectoryId()	Identifier of the directory.
ExternalInteractionStatus	getExternalInteractionStatus()	Status of the external interaction.
String	getFromAddress()	Address of the initiator of the external interaction.
int	getId()	Identifier of the external interaction registration.
String	getInteractionKey()	Global identifier of the interaction.
String	getMediaName()	Name of the media of the external interaction.
InteractionOrigin	getOrigin()	Origin of the external interaction.
Attribute[][]	getOutcomes()	Gets or sets the outcomes.
Attribute[][]	getOutcomesFormatted()	Returns the formatted outcomes.
Integer	getRecordingDocumentId()	Identifier of the recording document.
String	getToAddress()	Address of the recipient of the external interaction.
void	removeExternalInteractionRegistrationEndedListener(ExternalInteractionRegistrationEndedListener listener)	Unregisters the ExternalInteractionRegistrationEndedListener.
void	setBusinessStatus(BusinessStatus value)	The business status of the external interaction.
void	setContactProfile(Integer directoryId, Integer contactProfileId)	Sets the contact profile.
void	setExternalInteractionStatus(ExternalInteractionStatus value)	Status of the external interaction.
void	setOutcomes(Attribute[][] value)	Gets or sets the outcomes.
void	setRecordingDocumentId(Integer value)	Identifier of the recording document.
void	setRecordingKey(String recordingKey, int recorderTypeId)	Sets the recording key.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

addExternalInteractionRegistrationEndedListener

void addExternalInteractionRegistrationEndedListener(ExternalInteractionRegistrationEndedListener listener)

Registers the ExternalInteractionRegistrationEndedListener.

Parameters:

listener - Event listener to add.

removeExternalInteractionRegistrationEndedListener

void removeExternalInteractionRegistrationEndedListener(ExternalInteractionRegistrationEndedListener listener)

Unregisters the ExternalInteractionRegistrationEndedListener.

Parameters:

listener - Event listener to remove.

end

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

Stops the external interaction registration.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

endWithError

void endWithError(int errorCode,
 String errorDetail)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Stops the external interaction registration when it has errors

Parameters:

errorCode - The error code supplied by the provider

errorDetail - The error message supplied by the provider

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentIsBusy

boolean getAgentIsBusy()
                throws Exception,
altitude.integrationServer.exceptions.ISException

true if the agent should not be distributed other interaction while handling the current one.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentName

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

Name of the agent that is handling the external.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getBusinessStatus

BusinessStatus getBusinessStatus()
                          throws Exception,
altitude.integrationServer.exceptions.ISException

The business status of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setBusinessStatus

void setBusinessStatus(BusinessStatus value)
                throws Exception,
altitude.integrationServer.exceptions.ISException

The business status of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignName

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

Name of the campaign of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContactProfileId

Integer getContactProfileId()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the contact profile.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCustomInteractionManager

ICustomInteractionManager getCustomInteractionManager()
                                               throws Exception,
altitude.integrationServer.exceptions.ISException

The custom interaction manager used to manage custom interactions.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getData

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

Returns all properties of the external interaction registration.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectoryId

Integer getDirectoryId()
                throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the directory.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getExternalInteractionStatus

ExternalInteractionStatus getExternalInteractionStatus()
                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Status of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setExternalInteractionStatus

void setExternalInteractionStatus(ExternalInteractionStatus value)
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Status of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getFromAddress

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

Address of the initiator of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getId

int getId()
   throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the external interaction registration.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionKey

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

Global identifier of the interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getMediaName

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

Name of the media of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOrigin

InteractionOrigin getOrigin()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Origin of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOutcomes

Attribute[][] getOutcomes()
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets or sets the outcomes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setOutcomes

void setOutcomes(Attribute[][] value)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets or sets the outcomes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getOutcomesFormatted

Attribute[][] getOutcomesFormatted()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the formatted outcomes.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordingDocumentId

Integer getRecordingDocumentId()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the recording document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setRecordingDocumentId

void setRecordingDocumentId(Integer value)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the recording document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getToAddress

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

Address of the recipient of the external interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setContactProfile

void setContactProfile(Integer directoryId,
 Integer contactProfileId)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the contact profile.

Parameters:

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setRecordingKey

void setRecordingKey(String recordingKey,
 int recorderTypeId)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Sets the recording key.

Parameters:

recordingKey - Unique recording key.

recorderTypeId - Type of recorder used.

Throws:

Exception

altitude.integrationServer.exceptions.ISException