IUccEndpoint Interface
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.
Encapsulates an entity engaged in the real-time communications and collaborations from a particular communications device or using a particular media.
Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
Syntax
'Declaration
Public Interface IUccEndpoint
Inherits IUnknown
public interface IUccEndpoint : IUnknown
public interface class IUccEndpoint : IUnknown
public interface IUccEndpoint extends IUnknown
public interface IUccEndpoint extends IUnknown
Remarks
This interface represents a user using a particular communication device. It provides the user context for presence and communications services. An enabled endpoint of a registered user also serves as the factory object for managing communications and collaboration sessions as well as publication and subscription of category instances. It also be used to manage media devices on a local computer and media connectivity across firewalls. This means that the IUccSessionManager, IUccPublicationManager, IUccSubscriptionManager, IUccMediaEndpointSettings, and IUccServerSignalingSettings interfaces can all be queried from an IUccEndpoint instance.
An endpoint is obtained from an IUccPlatform instance factory object with a call into CreateEndpoint.
Win32 COM/C++ Syntax
interface IUccEndpoint : IUnknown
Example
The following example creates a new local user endpoint and returns the obtained endpoint interface to calling code. It is important that a client advise for endpoint events in order to receive critical endpoint events such as OnEnable.
private IUccEndpoint CreateLocalEndpoint(UccUri localUserUri)
{
IUccEndpoint returnValue = null;
// Create the sip endpoint and advise for endpoint events
returnValue = this.platform.CreateEndpoint(
UCC_ENDPOINT_TYPE.UCCET_PRINCIPAL_SERVER_BASED,
localUserUri,
null,
null);
if (returnValue != null)
{
//advise for endpoint events to catch OnEnable
UCC_Advise<_IUccEndpointEvents>(
returnValue,
this);
}
return returnValue;
}
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
IUccEndpoint Members
Microsoft.Office.Interop.UccApi Namespace
Other Resources
Code Listing: Basic Event Registration and Other Helper Methods in C#