Getting Started Using Unified Communications Client API

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.

This section discusses the requirements and some common programming tasks associated with Unified Communications Client API. These include creating a new application project, registering with an Office Communications Server instance, registering for API events, and handling raised events. For information about Unified Communications Client API interfaces and enumerations, see API Object Models.

Before you start, ensure the following requirements are met:

• Microsoft Office Communications Server is installed on the server side of all Unified Communications Client API clients.
• An audio/video (A/V) multipoint control unit (MCU) is installed on Office Communications Server if the client uses the A/V conferencing feature.
• Media Relay is enabled on Office Communications Server if the client connects to the server from behind a firewall.
• Microsoft Windows XP (Gold, SP1, or SP2), Microsoft Windows 2000 SP4, or Microsoft Windows Server 2003 is installed on a client computer.
• Microsoft DirectX 9.0 is installed on the client computer.
• Microsoft C Run-Time Library (MSVCM80.DLL or MSVCM90.DLL in Microsoft .NET Framework 2.0, 3.0 or 3.5) is installed on a client computer.
• The Unified Communications Client API binaries, UccApi.dll, rtmpltfm.dll, UCCAPIRES.dll, and the primary interoperable assembly, Microsoft.Office.Interop.UccApi.Dll, are installed on a client computer. By default, the UccApiSdk.msi package installs these libraries in the C:\Program Files\Microsoft UccAPI directory.
• A client must create an application manifest if it references the UccAPI.dll as a private assembly. To view the instructions, see Create an Application Manifest to Reference a Private Copy of UccAPI.Dll.

In This Section

• Create an Application Manifest to Reference a Private Copy of UccAPI.Dll
  Describes how to create an application manifest and provides an example.

• Create a Visual Studio Project for a Unified Communications Client API Client
  Describes how to create a project in the Microsoft Visual Studio development system.

• Unified Communications Client API Coclasses
  Discusses the use of Unified Communications Client Platform API coclasses in assisting developers in creating a custom client.

• Advise for and Handle Events in a Unified Communications Client API Client
  Discusses event handling as part of programming with Unified Communications Client API.

• Work with Properties and Property Collections
  Discusses the programming patterns used with these basic Unified Communications Client API interface data building blocks. Properties and property collections are used throughout the API.

• Trace and Handle Errors in Unified Communications Client API
  Provides the error messages and codes returned by the Unified Communications Client Platform on an exception.

• Publishing and Subscribing
  Describes how to publish, subscribe, and query category instances that represent contacts and other user information in Unified Communications Client API presence information.

See Also

Concepts

Using Unified Communications Client API
About Unified Communications Client API
Microsoft Unified Communications Client 1.0 SDK