IUccIncomingSessionEvent.Session Property

  • Article

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.

Gets the new incoming session object.

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

Syntax

'Declaration
ReadOnly Property Session As IUccSession

IUccSession Session { get; }

property IUccSession^ Session {
    IUccSession^ get ();
}

/** @property */
IUccSession get_Session ()

function get Session () : IUccSession

Property Value

A value of the IUccSession** (IUccSession, for a .NET application) type. This returns the incoming session object.

Remarks

The session property gives the local client access to the incoming session instance. Interaction with the remote inviting user must be done on this session instance.

Win32 COM/C++ Syntax

HRESULT get_Session
(
   IUccSession** ppIncomingSession
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Example

The following example handles OnIncomingSession by opening a client dialog which provides a user with the necessary mechanism to accept or reject an incoming session invitation. Upon user acceptance, the example accepts the invitation with call into Accept. The Session property of the pEventData object provides an instance of IUccSession that can be passed to an application class designed to encasulate a session.

/// <summary>
/// handles session invitations by displaying a dialog for
/// local user advising user of invitation and providing a mechanism
/// for the user to respond to the invitation
/// </summary>
/// <param name="pEventSource"></param>
/// <param name="pEventData"></param>
void OnIncomingSessionX(
    IUccEndpoint pEventSource,
    UccIncomingSessionEvent pEventData)
{

    DialogResult result;
                // First ask the user for permission to accept or decline the
                // pending invitation.

    result = MessageBox.Show(
        "Accept incoming IM session from " +
        pEventData.Inviter.Uri.UserAtHost +
        "?",
        "Incoming Session",
        MessageBoxButtons.YesNo);

    if (result != DialogResult.Yes)
    {
        // The user has said "no" to the invitation. Thus, rejected
        // the incoming session.
        pEventData.Reject(UCC_REJECT_OR_TERMINATE_REASON.UCCROTR_DECLINE);
        return;
    }
    IUccSession imSession = pEventData.Session;
    // open IM dialog
    pEventData.Accept();
    //open client UI form that handles instant messaging functionality
    //and provide UI dialog with imSession reference so the dialog
    //can handle the session's related events.

}

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

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

IUccIncomingSessionEvent Interface
IUccIncomingSessionEvent Members
Microsoft.Office.Interop.UccApi Namespace