LocalEndpoint

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.

LocalEndpoint is an abstract class that serves as the base class for the UserEndpoint and ApplicationEndpoint classes. Although it would be possible to create a class derived from LocalEndpoint, developers should not attempt to do so, but should instead use the UserEndpoint and ApplicationEndpoint classes.

LocalEndpoint State Transitions

The state transitions for both endpoint types, ApplicationEndpoint and UserEndpoint, are shown in the following illustrations.

State diagram for registered application endpoints

State diagram for user endpoints and unregistered application endpoints

1. The transition from Idle to Establishing occurs when BeginEstablish is called.

2. The transition from Establishing to Idle occurs when EndEstablish throws an exception.

3. The transition from Establishing to Established occurs when EndEstablish returns successfully.

4. The transition from Established to Reestablishing occurs when a registration refresh failure occurs due to a connection drop (applies only to registered application endpoints).

5. The transition from Reestablishing to Establishing occurs when the connection is restored and the registration is refreshed (applies only to registered application endpoints).

6. The transition from Established to Terminating occurs when BeginTerminate is called or when a forced deregistration by the server occurs.

7. The transition from Established to Terminating occurs when a registration refresh fails (applies only to user endpoints).

8. The transition from Idle to Terminating occurs when BeginTerminate is called on the endpoint.

9. The transition from Reestablishing to Terminating occurs when BeginTerminate is called on the endpoint.

10. The transition from Terminating to Terminated occurs when EndTerminate completes.

LocalEndpointSettings Class

The LocalEndpointSettings class contains the settings needed to initialize a LocalEndpoint object.

LocalEndpointSettings Constructors

The LocalEndpointSettings class has the following constructors.

// Initializes a LocalEndpointSettings object.
protected LocalEndpointSettings(string ownerUri);

// Initializes a LocalEndpointSettings object.
public LocalEndpointSettings(string ownerUri, string serverName, int serverPort);

LocalEndpointSettings Properties

The following are the public properties on the LocalEndpointSettings class.

// Gets the URI of the owner of this endpoint. 
public string OwnerUri {get;}

// Gets or sets whether to query for the provisioning data when the endpoint is established.
// By default, the value is set to false and hence by default we will query for provisioning data on start up.
public bool ProvisioningDataDisabled {get; set;}

// Gets or sets the current state of the call screening feature.
// If enabled, incoming calls are screened based on the user's state as perceived by the
// remote participant.
// The default value is false.
public bool PresenceBasedScreeningDisabled {get; set;}

// Gets or sets the methods supported by a registered endpoint.
// By default, this is set to support subscription and signaling sessions.
public string RegisterMethods {get; set;}

// Gets or sets the list of content types that can be supported by the endpoint.
// The content type of any MIME part with handling="required" should be in this list.
// Otherwise, incoming calls will be rejected automatically. 
public IEnumerable<ContentType> SupportedMimePartContentTypes {get; set;}

// Gets or sets the endpoint user agent string.
// This string is used to build the overall UserAgent string for the endpoint. 
// This must be set only if each endpoint's user agent string is different.
// If all endpoints in the application have the same user agent string, only set the application 
// user agent string in CollaborationPlatform. 
// The overall UserAgent string is formed by combining a default user agent string with
// CollaborationPlatform.ApplicationUserAgent and LocalEndpoint.EndpointUserAgent
public string EndpointUserAgent {get; set;}

// Gets or sets whether the endpoint will try to publish quality metrics for the audio calls.
// If set to true, the media quality metrics will not be published to the QoE server. Otherwise, by default,
// the media quality metrics will be published.
// The default value is false. Applications can override this default value.
public bool PublishingQoeMetricsDisabled {get; set;}

// Gets or sets the locality of the user.
// If the application sets this value, it overrides the default
// behavior of retrieving the value from the registration response.
public bool? IsOutsideCorporateNetwork {get; set;}

// Gets the type of user agent that this endpoint represents.
public EndpointType EndpointType {get; }

// Gets the subtype of user agent that this endpoint represents.
public EndpointSubtype EndpointSubtype {get; }

LocalEndpoint Constructors

There are no public contructors on the LocalEndpoint class. Application writers should use the classes derived from LocalEndpoint: ApplicationEndpoint and UserEndpoint.

LocalEndpoint Properties

The following are the public properties on the LocalEndpoint class.

// Gets the locality of the user.
// The default value (false) will be returned
// if the application has not overridden the value in LocalEndpointSettings
// and the value was not present in the registration response.
public bool IsOutsideCorporateNetwork {get;}

// Gets the type of user agent that this endpoint represents.
public EndpointType EndpointType{get;}

// Gets the subtype of the user agent that this endpoint represents.
public EndpointSubType EndpointSubType{get;}

// Gets the RealTimeEndpoint wrapped by this endpoint.
public RealTimeEndpoint InnerEndpoint{get;}

// Gets the platform that this endpoint is bound to.
public CollaborationPlatform Platform{get;}

// Gets the state of the local endpoint.
public LocalEndpointState State{get;}

// Gets the URI of the owner of the endpoint.
public virtual string OwnerUri{get;}

// Gets the phone URI of the owner of the endpoint.
public abstract string OwnerPhoneUri{get;}

// Gets the display name of the owner of the endpoint.
public string OwnerDisplayName{get; protected set;}

// Gets the URI of the endpoint.
public string EndpointUri{get;}

// Gets the default domain for the endpoint URI. 
public string DefaultDomain{get;}

// Gets the phone context for the endpoint.
// Phone context information is retrieved from provisioning data. 
// If user level value is available in provisioning data, then this property returns that value. 
// Otherwise, the pool level value is returned.
// If provisioning data is not available, this property returns an empty string. 
public string PhoneContext{get;}

// Gets the conference services object used to schedule conferences
// and to perform other conference tasks.
public ConferenceServices ConferenceServices{get;}

// Gets the service that can be used to subscribe for presence information.
// Supported only if the endpoint is registered on a server.
public RemotePresence RemotePresence{get;}

// Gets the service used to publish presence data for this endpoint.
// Supported only if the endpoin tis registered on a server.
public LocalOwnerPresence LocalOwnerPresence{get;}

// Gets the current state of the call screening feature.
// If enabled, incoming calls are screened based on the user's state as perceived by the
// remote participant. 
public bool PresenceBasedScreeningDisabled {get;}

// Gets the methods supported by a registered endpoint.
// By default, this is set to support subscription and signaling sessions.
public string RegisterMethods{get;}

// Gets the list of content types that can be supported by the endpoint.
// The content type of any mime part with handling=required should be in this list.
// Otherwise, incoming calls will be rejected automatically.
public IEnumerable<ContentType> SupportedMimePartContentTypes {get; }

// Gets the user agent string that will be used for messages.
// This is formed by combining a default user agent string with
// CollaborationPlatform.ApplicationUserAgent and
// LocalEndpoint.EndpointUserAgent.
public string UserAgent {get;}

// Gets the flag that controls whether the endpoint
// will attempt to publish quality metrics for audio calls.
public bool PublishingQoeMetricsDisabled {get;}

// Gets whether provisioning data query has been disabled.
public bool ProvisioningDataDisabled {get; set;}

// Gets whether the provisioning data autorefresh has been disabled.
public bool ProvisioningDataAutoRefreshDisabled {get;}

The following table lists frequently-used properties of the LocalEndpoint class, and their descriptions.

LocalEndpoint Methods

The following are the public methods on the LocalEndpoint class.

// Returns a snapshot of the conversations managed by this endpoint.
public ReadOnlyCollection<Conversation> GetConversations();

// Initializes the endpoint so that it is ready for receiving incoming messages.
public IAsyncResult BeginEstablish(AsyncCallback userCallback, object state);

// Initializes the endpoint so that it is ready for receiving incoming messages.
public IAsyncResult BeginEstablish(IEnumerable<SignalingHeader> additionalHeaders, 
    AsyncCallback userCallback, object state);

// Completes the establish operation.
public SipResponseData EndEstablish(IAsyncResult result);

//Terminates the endpoint and cleans up active sessions and resources.
//The endpoint is no longer usable.
public IAsyncResult BeginTerminate(AsyncCallback userCallback, object state);

// Completes the asynchronous Terminate operation.
public void EndTerminate(IAsyncResult result)

// Initiates an operation to query for the latest provisioning data.
public IAsyncResult BeginGetProvisioningData(AsyncCallback userCallback, object state);

// Completes the operation to query for the latest provisioning data
public ProvisioningData EndGetProvisioningData(IAsyncResult result);

// Adds an application handler for handling incoming calls of a specific type.
// Only one delegate can be registered for each TCall type.  
// Subsequent calls to this method will overwrite the previously set value.
public void RegisterForIncomingCall<TCall>(IncomingCallDelegate<TCall> incomingCallDelegate) where TCall : Call;

// Removes a previously added handler that was handling incoming calls of a specific type.
public void UnRegisterForIncomingCall<TCall>(IncomingCallDelegate<TCall> incomingCallDelegate) where TCall:Call;

// Handles an incoming signaling session.
// A derived class can override this method to process an incoming SignalingSession before UCMA 2.0 Core processes it.
protected virtual bool HandleSignalingSession(SessionReceivedEventArgs sessionReceivedEventArgs);

The following table lists commonly-used methods of the LocalEndpoint class, and their descriptions.

LocalEndpoint Events

The following table lists frequently-used events on the LocalEndpoint class, and their descriptions.