IUccIncomingRequestEvent.Accept Method

  • 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.

Accepts the incoming request.

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

Syntax

'Declaration
Sub Accept

void Accept ()

void Accept ()

void Accept ()

function Accept ()

Remarks

If a session invitation request is not accepted before the inviting user has terminated the session, calling Accept on the terminated session raises an Invalid State exception. An inviting user can terminate a session at any time after adding the local user as a participant (causing the platform to issue the invitation). For this reason, the client receiving the invitation should anticipate an exception with the Accept call.

If the accepted incoming session is of the type UCC_SESSION_TYPE.UCCST_APPLICATION, the inviting user receives an OnInvitationAccepted event. Other session types such as instant messaging session receive an OnStateChanged event indicating the invited participant has connected to the session. The UCC_PARTICIPANT_STATE_CHANGE_REASON enumeration value UCC_PARTICIPANT_STATE_CHANGE_REASON.UCCPSCR_NORMAL indicates a participant has accepted the invitation.

Win32 COM/C++ Syntax

HRESULT Accept
(
);

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 simplistic example handles any incoming session regardles of type. The local user is not advised of the invitation in this example. Instead, the invitation is simple accepted. The example anticipates the possibility that the incoming session can be in an invalid state and catches the possible COM Invalid State exception.

Note

See Code Listing: Basic Event Registration and Other Helper Methods in C# for the complete code listing for UCC_Advise

/// <summary>
/// handles session invitations by accepting all
/// incoming sessions.
/// </summary>
/// <param name="pEventSource">Local Endpoint</param>
/// <param name="pEventData">Incoming session</param>
void _IUccSessionManagerEvents.OnIncomingSession(
    IUccEndpoint pEventSource,
    UccIncomingSessionEvent pEventData)
{
    try
    {
        pEventData.Accept();

        //advise for session events on accepted session
        UCC_Advise<_IUccSessionEvents>(pEventData.Session, this);

    }
    catch (COMException)
    {
        Console.WriteLine("Incoming session is in invalid state!");
    }
}

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

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

Other Resources

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