C++
C#
VB
JScript
All

Classes ISession­Engine


The ISessionEngine interface manages the creation of interviews for either inbound or outbound interviewing.

Groups

Operations
Method AcknowledgeInterviewerMessage

Acknowledge that an immediate message was read by the interviewer.
Method AddInterviewersMessage

Sends an immediate message to interviewers for a supervisor.
Method CloseInterviewerSession

Closes an interviewer session on the Interview tier.
Method CloseSupervisorSession

Closes a supervisor session on the Interview tier.
Method ConnectInterviewerStation

Connects the Interviewer station.
Method ConnectSupervisorStation

Connects the Supervisor station.
Method CreateInterview

Creates a new interview on the Interview tier.
Method CreateInterviewerSession

Creates an interviewer session on the Interview tier.
Method CreateInterviewWithAuthentication

Authenticates and creates a new interview on the Interview tier.
Method CreateSupervisorSession

Creates a supervisor session on the Interview tier.
Method GetAcknowledgedMessages

Gets acknowledgments from interviewers that the immediate messages sent by a supervisor have been read.
Method GetActivityReport

Gets the specified activity report.
Method GetCurrentCallStatus

Gets the call status for an interviewer.
Method GetCurrentSampleRecord

Gets the current sample record for the interviewer session.
Method GetMonitoredPageNo

Gets the last monitored page number for an interviewer session.
Method GetMonitoredPages

Gets the monitored pages for an interviewer session.
Method GetMonitoredPagesChange

Gets the interviewer status and the monitored pages for an interviewer session, optionally blocking until either have changed.
Method GetNewSampleRecord

Gets a new sample record from sample management.
Method GetNewSampleRecordWithCriteria

Gets a new sample record from sample management based on selection criteria.
Method GetNextInterviewerMessages

Gets the new immediate messages for an interviewer.
Method InvokeInterviewFunction

Invoke the specified function for the specified interview and return the result as XML.
Method ManageFile

Upload or download a file.
Method PercentLoaded

Gets the percentage load for the session engine.
Method PostInterviewerEvent

Posts an interviewer event to the Interview tier.
Method PostInterviewEvent

Posts an event to an interview.
Method RunAudioOperation

Runs an audio operation for an interviewer session.
Method SetInterviewerStatus

Set the status message for an interviewer.
Method StartMonitoring

Starts monitoring for an interviewer session.
Method StopMonitoring

Stops monitoring for an interviewer session.
Method UpdateCurrentSampleRecord

Updates the current sample record for the interviewer session.
Method UpdateInterviewerSession

Updates the Interviewer and Station properties for an interviewer session on the Interview tier.
Read-only Properties
IDL Property DPMAgent

The DPM Agent the engine is using to read data from DPM
IDL Property IsActive

Returns True if the session engine is active, otherwise returns False.
IDL Property Name

A read-only property that returns the name of the session engine.
Read/Write Properties
IDL Property State

The current state of the engine.

Interface ID

The ID of the ISessionEngine interface is 2D9CE6E1-24B7-4aea-BCD3-53ECA8810F6B.