IUccSessionManager Interface

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Encapsulates the session management for a communication and collaboration session.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Public Interface IUccSessionManager
    Inherits IUnknown

public interface IUccSessionManager : IUnknown

public interface class IUccSessionManager : IUnknown

public interface IUccSessionManager extends IUnknown

public interface IUccSessionManager extends IUnknown

Remarks

In UCC API, session management involves creating outgoing sessions and handling events when an incoming session invitation arrives or before an outgoing session invitation is sent. An application catches the events by implementing the _IUccSessionManagerEvents dispinterface and advise an instance of this interface of the implementation.

Win32 COM/C++ Syntax

interface IUccSessionManager : IUnknown

Example

The following example is drawn from a constructor of an application class that wraps an instance of IUccSessionManager (this.sm). Note that the example advises for events on the session manager instance immediately after obtaining the new instance.

/// <summary>
/// Application session manager class constructor.
/// Obtains IUccSessionManager interface from passed IUccEndpoint
/// instance
/// </summary>
/// <param name="endPoint">local endpoint instance</param>
public SessionManager(IUccEndpoint endPoint)
{

    if (endPoint != null)
    {
        //obtain session manager from registered endpoint
        this.sm = endPoint as IUccSessionManager;

        //advise for session manager events
        UCC_Advise<_IUccSessionManagerEvents>(
            this.sm, 
            this);
    }
    else
    {
        throw new ArgumentNullException(
            "endPoint", 
            "parameter cannot be null");
    }
}

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccSessionManager Members
Microsoft.Office.Interop.UccApi Namespace

Other Resources

Code Listing: Basic Event Registration and Other Helper Methods in C#