The ResponseManager class has the capability to retrieve Response Documents, Interaction Messages, Interaction Urls and Interaction Files. It can also watch for changes to response management data, and receive any updates at the server.

Namespace: ININ.IceLib.People.ResponseManagement
Assembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (21.4.0.172)

Syntax

C#
public class ResponseManager
Visual Basic
Public Class ResponseManager

Remarks

Use this class to get response management documents, interaction messages, interaction urls and interaction files.

Examples

This example shows how the classes ResponseManager and PeopleManager can be used to get Response Documents, Interaction Messages, Interaction Urls and Interaction Files.
CopyC#
public class MyResponseManagementClass
{
    private Session _Session;
    private PeopleManager _PeopleManager;
    private ResponseManager _ResponseManager;

    private void MyClient_StartWatchingCompleted(object sender, AsyncCompletedEventArgs e)
    {
        if ( e.Error != null )
        {
            // handle the error
            return;
        }

        // this means that our request 'StartWatching' to the server was successful.
        // TODO: Add your code here.
    }

    private void InitiateResponseManagement()
    {
        if (_PeopleManager == null)
            _PeopleManager = PeopleManager.GetInstance(_Session);
        if (_ResponseManager == null)
            _ResponseManager = new ResponseManager(_PeopleManager);

        // The following statements will make sure that the data obtained from the server is always upto date.
        _ResponseManager.StartWatchingCompleted += new AsyncCompletedEventHandler(MyClient_StartWatchingCompleted);
        object userStateObject1 = new object();
        _ResponseManager.StartWatchingAsync(userStateObject1);

        // The following statements will get the response management data from the server.
        _ResponseManager.GetAvailableResponsesCompleted += new AsyncCompletedEventHandler(MyClient_GetAvailableResponsesCompleted);
        object userStateObject2 = new object();
        _ResponseManager.GetAvailableResponsesAsync(userStateObject2);
    }

    private void LoadResponseManagementTreeView()
    {
        EditableResponseDocument userDocument = _ResponseManager.UserDocument;
        ReadOnlyCollection<ResponseDocument> serverDocuments = _ResponseManager.ServerDocuments;
        ReadOnlyCollection<ResponseItem> interactionMessages = _ResponseManager.InteractionMessages;
        ReadOnlyCollection<ResponseItem> interactionUrls = _ResponseManager.InteractionUrls;
        ReadOnlyCollection<ResponseItem> interactionFiles = _ResponseManager.InteractionFiles;
        // ......
        // ......
    }

    private void MyClient_GetAvailableResponsesCompleted(object sender, AsyncCompletedEventArgs e)
    {
        if (e.Error != null)
        {
            // handle the error
            return;
        }

        LoadResponseManagementTreeView();
    }

    // TODO: Add your methods here
}

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.People.ResponseManagement..::..ResponseManager

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also