LocalEndpoint Class

Definition

Represents an endpoint used by the current application to communicate and collaborate with other endpoints.

public ref class LocalEndpoint abstract
public abstract class LocalEndpoint
type LocalEndpoint = class
Public MustInherit Class LocalEndpoint
Inheritance
LocalEndpoint
Derived

Remarks

Conceptually, one can think of LocalEndpoint as a "device" to communicate or collaborate with other endpoints of the network. Similar to the way a phone is owned by someone and used for making voice calls, a LocalEndpoint is owned by a User or an Application and used for collaborating and communicating with other users and applications.

The LocalEndpoint and its owner each have a dedicated address or Universal Resource Identifier (URI). It is thus possible to communicate with a specific endpoint or with its owner (through one of its endpoints) depending on the URI that is requested by the initiator of communication.

A LocalEndpoint can be used to manage the owner's Contacts and Groups, its Presence data, and to subscribe to the Presence of other applications and users. It can also be used to schedule, update and cancel conferences or participate in communications that can be multi-modal and multi-party.

The state of the LocalEndpoint indicates whether the endpoint can receive incoming traffic or not. A LocalEndpoint may register against a server if it represents a user or it represents a service which publishes endpoint bound presence. When the registration fails, an application can retry to establish the endpoint. When the automatic registration refresh fails, the LocalEndpoint will try to re-establish the endpoint and indicate when the re-registration is successful through a State transition.

LocalEndpoint has two concrete implementations: UserEndpoint and ApplicationEndpoint.

Properties

ConferenceServices

Gets an object to list and organize Conferences for the owner of the local endpoint.

DefaultDomain

Gets the default domain for the endpoint URI.

EndpointSubtype

Gets the subtype of the local endpoint.

EndpointType

Gets the type of user agent that this endpoint represents.

EndpointUri

Gets the URI of the endpoint.

InnerEndpoint

Gets the inner endpoint.

IsOutsideCorporateNetwork

Gets whether the endpoint registers inside or outside the corporate network.

LocalOwnerPresence

Gets an object used to publish the Presence data of the owner of the local endpoint.

MaxRegisterRetries

Gets the maximum number of times that the endpoint should try to recover from registration refresh failure.

OutboundConnectionDefaultAddressFamilyHint

Gets the address family default for making outbound connnections.

OwnerDisplayName

Gets the display name of the owner of the local endpoint.

OwnerPhoneUri

Gets the phone URI of the owner of the local endpoint.

OwnerUri

Gets the URI of the owner of the local endpoint.

PhoneContext

Gets the phone context associated with the owner of the local endpoint.

Platform

Gets the platform that this endpoint is bound to.

PresenceBasedScreeningDisabled

Gets whether Presence screening is disabled.

PresenceServices

Gets the class instance, which provides services related to subscription to remote presentities.

ProvisioningDataDisabled
Obsolete.

Gets whether querying provisioning data has been disabled.

PublishingQoeMetricsDisabled

Gets whether the platform will try to publish quality metrics for the audio calls.

RegisterMethods

Gets the SIP methods that the local endpoint supports and can receive upon registration.

RemotePresence
Obsolete.

Gets an object to subscribe to or query the Presence of remote Users and Applications.

State

Gets the state of the local endpoint.

SupportedMimePartContentTypes

Gets the list of M/MIME content types that are supported by the endpoint.

SyncRoot
Obsolete.

Synchronization object for locking instances.

UserAgent

Gets the user agent string that will be used in messages sent and received by the local endpoint.

Methods

BeginEstablish(AsyncCallback, Object)

Establishes the endpoint so that it can receive incoming calls and conference invitations.

BeginEstablish(IEnumerable<SignalingHeader>, AsyncCallback, Object)

Establishes the endpoint so that it can receive incoming calls and conference invitations.

BeginGetProvisioningData(AsyncCallback, Object)

Queries the latest provisioning data (advanced).

BeginTerminate(AsyncCallback, Object)

Terminates the local endpoint after cleaning up all communication and collaboration resources.

EndEstablish(IAsyncResult)

Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.

EndGetProvisioningData(IAsyncResult)

Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.

EndTerminate(IAsyncResult)

Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed.

GetConversations()

Gets a snapshot of the conversations managed by the local endpoint.

GetProvisioningData()

Gets the latest Provisioning Data from the endpoint cache.

HandleSignalingSession(SessionReceivedEventArgs)

Intercepts an incoming signaling session before it is processed by the local endpoint (advanced).

RegisterForIncomingCall<TCall>(IncomingCallDelegate<TCall>)

Registers a delegate to handle incoming calls for a specific modality.

UnregisterForIncomingCall<TCall>(IncomingCallDelegate<TCall>)

Removes a previously registered delegate that was handling incoming calls of a specific modality.

Events

ConferenceInvitationReceived

Raised when an invitation to a conference is received.

RepublishingRequired

Raised when the server indicates that the Presence publication of the local endpoint owner is stale.

StateChanged

Raised when the local endpoint state changes.

Extension Methods

BeginDrain(LocalEndpoint, LocalEndpointDrainOptions, AsyncCallback, Object)
BeginGetMediaRelayToken(LocalEndpoint, Boolean, AsyncCallback, Object)
BeginGetProvisioningData(LocalEndpoint, String, String, String[], AsyncCallback, Object)
BeginTerminate(LocalEndpoint, LocalEndpointTerminationOptions, AsyncCallback, Object)
EndGetMediaRelayToken(LocalEndpoint, IAsyncResult)
GetCachedProvisioningData(LocalEndpoint)
GetConferenceServices(LocalEndpoint, String, String)
TriggerRegistrationRefresh(LocalEndpoint, TimeSpan)

Applies to