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
IUccPlatform	_IUccPlatformEvents	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 IUccServerSignalingSettings	_IUccEndpointEvents _IUccServerSignalingSettingsEvents	IUccFindServerEvent

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

Operations	Events and Callbacks	Event Data
IUccApplicationSessionParticipant IUccAudioMediaChannel IUccAudioVideoMediaChannel IUccAudioVideoSession IUccAudioVideoSessionParticipant IUccConferenceEntityView IUccConferenceInformation IUccConferenceManager IUccConferenceManagerSession IUccConferenceMediaChannel IUccConferenceSession IUccConferenceSessionParticipant IUccConferenceSessionParticipantEndpoint IUccConferenceView IUccInstantMessagingSession IUccInstantMessagingSessionParticipant IUccMediaChannel IUccSession IUccSessionCallControl IUccSessionManager IUccSessionParticipant IUccSessionParticipantEndpoint IUccSignalingChannel IUccSignalingChannelManager IUccSignalingHeaderField IUccSignalingHeaderFieldParameter IUccSignalingMessage IUccSignalingRequest IUccSignalingResponse IUccSignalingServer IUccVideoMediaChannel	_IUccApplicationSessionParticipantEvents _IUccAudioMediaChannelEvents _IUccAudioVideoMediaChannelEvents _IUccAudioVideoSessionEvents _IUccAudioVideoSessionParticipantEvents _IUccConferenceEntityViewCollectionEvents _IUccConferenceEntityViewEvents _IUccConferenceManagerSessionEvents _IUccConferenceMediaChannelCollectionEvents _IUccConferenceMediaChannelEvents _IUccConferenceSessionEvents _IUccConferenceSessionParticipantEndpointEvents _IUccConferenceSessionParticipantEvents _IUccInstantMessagingSessionEvents _IUccInstantMessagingSessionParticipantEvents _IUccMediaChannelCollectionEvents _IUccMediaChannelEvents _IUccSessionCallControlEvents _IUccSessionDescriptionEvaluator _IUccSessionEvents _IUccSessionManagerEvents _IUccSessionParticipantCollectionEvents _IUccSessionParticipantEndpointCollectionEvents _IUccSessionParticipantEvents _IUccSignalingChannelEvents	IUccAudioSignalLevelChangedEvent IUccAudioVideoMediaChannelSourceEvent IUccAudioVideoMediaChannelStreamsEvent IUccConferenceEntityViewCollectionEvent IUccConferenceSessionParticipantEndpointStateChangedEvent IUccIncomingInstantMessageEvent IUccIncomingInvitationEvent IUccIncomingMediaRequestEvent IUccIncomingRequestEvent IUccIncomingSessionEvent IUccIncomingSessionTransferEvent IUccIncomingSignalingMessageEvent IUccInstantMessagingComposingEvent IUccInvitationAcceptedEvent IUccMediaChannelCollectionEvent IUccMediaChannelEvent IUccOutgoingInvitationEvent IUccOutgoingSessionEvent IUccSessionOperationEvent IUccSessionParticipantCollectionEvent IUccSessionParticipantEndpointCollectionEvent IUccSessionParticipantOperationEvent IUccSessionParticipantStateChangedEvent IUccSessionTransferProgressEvent

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
IUccCategoryContext IUccContainerMembershipManager IUccPublication IUccPublicationManager IUccSubscriber IUccSubscription IUccSubscriptionManager IUccUserSearchManager IUccUserSearchQueryEvent	_IUccPresentityEvents _IUccPublicationEvent _IUccPublicationManagerEvents _IUccSubscriptionEvents _IUccUserSearchQueryEvents	IUccSubscriptionEvent IUccUserSearchQueryEvent IUccUserSearchResultRecord

A pointer to the IUccPublicationManager and IUccSubscriptionManager interface can be obtained by querying the interface on an IUccEndpoint interface instance.

Presence-Related API Types

Operations	Events	Event Data
IUccCategoryInstance IUccContact IUccContainer IUccContainerMember IUccGroup IUccPresenceActivity IUccPresenceCalendarDataInstance IUccPresenceCapabilities IUccPresenceCapabilityInfo IUccPresenceContactCardAddress IUccPresenceContactCardIdentity IUccPresenceContactCardInstance IUccPresenceContactCardPhone IUccPresenceContactCardUrl IUccPresenceDeviceInstance IUccPresenceFreeBusyInformation IUccPresenceNoteData IUccPresenceNoteInstance IUccPresencePhoneLine IUccPresenceServiceElement IUccPresenceServicesInstance IUccPresenceStateInstance IUccPresenceTimeZoneInformation IUccPresenceWorkingHoursBlock IUccPresenceWorkingHoursInformation IUccProvisioningPolicyInstance IUccRoutingPreamble IUccRoutingPreambleElement IUccRoutingPreambleFlagsElement IUccRoutingPreambleListElement IUccRoutingPreambleWaitElement IUccRoutingRuleElement IUccRoutingRuleInstance IUccRoutingTarget IUccServerConfigurationCategory	_IUccCategoryContextEvents _IUccCategoryInstanceEvents _IUccContainerEvents _IUccContainerMemberEvents _IUccContactEvents _IUccGroupEvents	IUccCategoryContextEvent IUccCategoryInstanceEvent IUccContainerMemberCollectionEvent IUccContainerMembershipEvent IUccContactCollectionEvent IUccGroupMembershipEvent

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
IUccAudioMediaDevice IUccMediaChannelDevices IUccMediaDevice IUccMediaDeviceManager IUccMediaDeviceSettings IUccVideoMediaDevice	_IUccMediaChannelDevicesEvents _IUccMediaDeviceManagerEvents	IUccMediaDeviceChangeEvent

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 IUccMediaConnectivityServer IUccMediaConnectivityServerConfiguration	_IUccMediaEndpointEvents	IUccFindMediaConnectivityServersEvent

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
IUccArray IUccCredential IUccCredentialCache IUccCollection IUccContext IUccDiagnosticInfo IUccDiagnosticReportingSettings IUccLocaleString IUccOperationContext IUccOperationManager IUccProperty IUccPropertyCollection IUccReadOnlyPropertyCollection IUccTraceSettings IUccUri IUccUriManager	_IUccOperationManagerEvents	IUccOperationProgressEvent IUccPropertyUpdateEvent

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.