Interface IRecordingManager

All Superinterfaces:

IDisposable, IEntity

public interface IRecordingManager
extends IEntity

Manages the recordings.

Method Summary

Modifier and Type	Method	Description
int	createRecorderType(RecorderTypeCreateRequest request)	Creates a recorder type.
void	deleteRecorderType(String recorderTypeName)	Deletes a recorder type.
byte[]	getAudioRecordingFile(String recordingKey, AudioRecordingEncoding encoding)	Gets the file of the audio recording.
byte[]	getAudioRecordingSegmentFile(String recordingKey, int segmentIndex, AudioRecordingEncoding encoding)	Gets the file of the audio recording segment.
int	getAudioRecordingSegmentsCount(String recordingKey)	Gets the number of the audio recording segments.
IInstance	getInstance()	Returns the instance.
byte[]	getInstantMessagingRecordingDocument(int recordingDocumentId)	Gets the contents of the instant messaging recording.
RecordingData[]	getInteractionThreadRecordingData(long interactionThreadId)	Gets the data of the recordings of the interaction thread.
RecordingData[]	getInteractionThreadRecordingData(long interactionThreadId, PurposeFilter purposeFilter)	Gets the data of the recordings of the interaction thread.
RecorderType[]	getRecorderTypes()	Gets the recorder types.
IRecordingCursor	getRecordingCursor(int cursorId)	Gets a recording cursor open in the instance.
IRecordingCursor[]	getRecordingCursors()	Returns the recording cursors open in the instance.
RecordingData	getRecordingData(int recordingId)	Gets the data of the recording.
RecordingData	getRecordingData(int recordingId, PurposeFilter purposeFilter)	Gets the data of the recording.
TableSchema	getRecordingTableSchema()	Gets the table schema of the recording.
RecordingData[]	getScriptSessionRecordingData(int scriptSessionId)	Gets the data of the recordings of the script session.
RecordingData[]	getScriptSessionRecordingData(int scriptSessionId, PurposeFilter purposeFilter)	Gets the data of the recordings of the script session.
IRecordingCursor	newRecordingCursor(String[] columns, String sql)	Opens a recording cursor.
IRecordingCursor	newRecordingCursor(String[] columns, String sql, PurposeFilter purposeFilter)	Opens a recording cursor.
void	setRecordingKey(int agentId, int sessionId, String recordingKey, int recorderTypeId)	Sets the recording key.
IRecordingCursor	tryGetRecordingCursor(int cursorId)	Gets a recording cursor open in the instance or null if it doesn't exist.
void	updateRecorderType(String recorderTypeName, RecorderTypeUpdateRequest request)	Updates a recorder type.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

createRecorderType

int createRecorderType(RecorderTypeCreateRequest request)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a recorder type.

Parameters:

request - Contains the fields that must be overwritten

Returns:

Identifier of the created recorder type.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteRecorderType

void deleteRecorderType(String recorderTypeName)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a recorder type.

Parameters:

recorderTypeName - Name of the recorder type.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAudioRecordingFile

byte[] getAudioRecordingFile(String recordingKey,
 AudioRecordingEncoding encoding)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the file of the audio recording.

Parameters:

recordingKey - Unique recording key.

encoding - The file encoding. The default value is PCM16.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAudioRecordingSegmentFile

byte[] getAudioRecordingSegmentFile(String recordingKey,
 int segmentIndex,
 AudioRecordingEncoding encoding)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the file of the audio recording segment.

Parameters:

recordingKey - Unique recording key.

segmentIndex - Number of the recording segment to get.

encoding - The file encoding. The default value is PCM16.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAudioRecordingSegmentsCount

int getAudioRecordingSegmentsCount(String recordingKey)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the number of the audio recording segments.

Parameters:

recordingKey - Unique recording key.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstantMessagingRecordingDocument

byte[] getInstantMessagingRecordingDocument(int recordingDocumentId)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contents of the instant messaging recording.

Parameters:

recordingDocumentId - Identifier of the document to get.

Returns:

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadRecordingData

RecordingData[] getInteractionThreadRecordingData(long interactionThreadId)
                                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the recordings of the interaction thread.

Parameters:

interactionThreadId - Identifier of the interaction thread.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionThreadRecordingData

RecordingData[] getInteractionThreadRecordingData(long interactionThreadId,
 PurposeFilter purposeFilter)
                                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the recordings of the interaction thread.

Parameters:

interactionThreadId - Identifier of the interaction thread.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecorderTypes

RecorderType[] getRecorderTypes()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the recorder types.

Returns:

An array of type RecorderType.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordingCursor

IRecordingCursor getRecordingCursor(int cursorId)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a recording cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IRecordingCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordingCursors

IRecordingCursor[] getRecordingCursors()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the recording cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordingData

RecordingData getRecordingData(int recordingId)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the recording.

Parameters:

recordingId - Identifier of the recording.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordingData

RecordingData getRecordingData(int recordingId,
 PurposeFilter purposeFilter)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the recording.

Parameters:

recordingId - Identifier of the recording.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRecordingTableSchema

TableSchema getRecordingTableSchema()
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the recording.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getScriptSessionRecordingData

RecordingData[] getScriptSessionRecordingData(int scriptSessionId)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the recordings of the script session.

Parameters:

scriptSessionId - Identifier of the script session.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getScriptSessionRecordingData

RecordingData[] getScriptSessionRecordingData(int scriptSessionId,
 PurposeFilter purposeFilter)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the data of the recordings of the script session.

Parameters:

scriptSessionId - Identifier of the script session.

purposeFilter - Purpose filter.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newRecordingCursor

IRecordingCursor newRecordingCursor(String[] columns,
 String sql)
                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a recording cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IRecordingCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

newRecordingCursor

IRecordingCursor newRecordingCursor(String[] columns,
 String sql,
 PurposeFilter purposeFilter)
                             throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a recording cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

purposeFilter - Purpose filter.

Returns:

The IRecordingCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

setRecordingKey

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

Sets the recording key.

Parameters:

agentId - Identifier of the agent being recorded.

sessionId - Identifier of the session being recorded.

recordingKey - Unique recording key.

recorderTypeId - Type of recorder used.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetRecordingCursor

IRecordingCursor tryGetRecordingCursor(int cursorId)
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a recording cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IRecordingCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateRecorderType

void updateRecorderType(String recorderTypeName,
 RecorderTypeUpdateRequest request)
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a recorder type.

Parameters:

recorderTypeName - Name of the recorder type.

request - Contains the fields to be updated.

Throws:

Exception

altitude.integrationServer.exceptions.ISException