Functional Grouping of 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.
The following Microsoft Unified Communications Client API types are grouped according to their functional role.
Platform-Related API Types
Operations | Events | Event Data |
---|---|---|
None |
The IUccPlatform interface is the entry point that a Unified Communications Client API application uses to access the API. It is the foundation of a client built with the UCC API platform. An instance of IUccPlatform provides the underlying SIP protocol and media stack support a UCC client must have to interoperate with Microsoft Office Communications Server.
An IUccPlatform instance is also a factory object for IUccEndpoint instances. An IUccMediaDeviceManager interface pointer can be queried from the IUccPlatform interface as well.
Endpoint-Related API Types
Operations | Events | Event Data |
---|---|---|
IUccEndpoint |
An enabled IUccEndpoint instance can be used to query interfaces for the following operations:
- IUccSessionManager
- IUccConferenceManager
- IUccPublicationManager
- IUccSubscriptionManager
- IUccMediaEndpointSettings
- IUccServerSignalingSettings
- IUccSignalingChannelManager
- IUccUserSearchManager
- IUccDiagnosticReportingSettings
Session-Related API Types
A pointer to the IUccSessionManager and IUccConferenceManager interfaces can be obtained by querying the interface on an IUccEndpoint interface instance.
Publication/Subscription-Related API Types
Operations | Events | Event Data |
---|---|---|
IUccContainerMembershipManager IUccPublicationManager IUccSubscriptionManager IUccUserSearchManager |
IUccUserSearchQueryEvent |
A pointer to the IUccPublicationManager and IUccSubscriptionManager interface can be obtained by querying the interface on an IUccEndpoint interface instance.
Presence-Related API Types
A pointer to the IUccServerSignalingSettings interface can be obtained by querying the interface on an IUccEndpoint interface instance.
Device Management-Related API Types
Operations | Events | Event Data |
---|---|---|
IUccMediaDeviceManager |
The starting point for managing a media device is IUccMediaDeviceManager. A pointer to the IUccMediaDeviceManager interface can be obtained by querying the interface on an IUccPlatform interface instance.
Media Connectivity-Related API Types
Operations | Events | Event Data |
---|---|---|
IUccMediaEndpointSettings |
A starting point for managing media connectivity is IUccMediaEndpointSettings. A pointer to the IUccMediaEndpointSettings interface can be obtained by querying the interface on an IUccEndpoint interface instance.
Utility-Related API Types
Operations | Events | Event Data |
---|---|---|
IUccDiagnosticReportingSettings |
These types are used helper types. A pointer to the IUccDiagnosticSettings interface can be obtained by querying the interface on an IUccEndpoint interface instance. IUccOperationManager can be obtained by querying the interface on an IUccAudioVideoSessionParticipant object. IUccUriManager is obtained by instantiating the UccUriManager co-class.