ApplicationEndpoint Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
ApplicationEndpoint is a specialization of LocalEndpoint for communication on behalf of services and applications.
public ref class ApplicationEndpoint : Microsoft::Rtc::Collaboration::LocalEndpointpublic class ApplicationEndpoint : Microsoft.Rtc.Collaboration.LocalEndpointtype ApplicationEndpoint = class
inherit LocalEndpointPublic Class ApplicationEndpoint
Inherits LocalEndpoint- Inheritance
Remarks
ApplicationEndpoints are meant to be used within a service that can serve thousands of information workers at the same time. They are designed to be globally trusted by other server components.
An ApplicationEndpoint is generally used in conjunction with its corresponding Active Directory Contact object. It only needs to register if it needs to publish endpoint bound presence.
ApplicationEndpoints are also designed to be highly available. While an ApplicationEndpoint will terminate automatically if its Contact Object is deleted, registered ApplicationEndpoints will attempt to re-register until the service is re-established in case of a temporary server outage.
Constructors
| ApplicationEndpoint(CollaborationPlatform, ApplicationEndpointSettings) |
Creates a new instance of the ApplicationEndpoint class. |
Properties
| ConferenceServices |
Gets an object to list and organize Conferences for the owner of the local endpoint. (Inherited from LocalEndpoint) |
| DefaultDomain |
Gets the default domain for the endpoint URI. (Inherited from LocalEndpoint) |
| EndpointSubtype |
Gets the subtype of the local endpoint. (Inherited from LocalEndpoint) |
| EndpointType |
Gets the type of user agent that this endpoint represents. (Inherited from LocalEndpoint) |
| EndpointUri |
Gets the URI of the endpoint. (Inherited from LocalEndpoint) |
| InnerEndpoint |
Gets the inner endpoint. (Inherited from LocalEndpoint) |
| IsDefaultRoutingEndpoint |
Gets whether the endpoint is the default routing endpoint to handle incoming calls. |
| IsOutsideCorporateNetwork |
Gets whether the endpoint registers inside or outside the corporate network. (Inherited from LocalEndpoint) |
| LocalOwnerPresence |
Gets an object used to publish the Presence data of the owner of the local endpoint. (Inherited from LocalEndpoint) |
| MaxRegisterRetries |
Gets the maximum number of times that the endpoint should try to recover from registration refresh failure. (Inherited from LocalEndpoint) |
| OutboundConnectionDefaultAddressFamilyHint |
Gets the address family default for making outbound connnections. (Inherited from LocalEndpoint) |
| 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. (Inherited from LocalEndpoint) |
| PinServices |
Gets the application pin services ApplicationPinServices. |
| Platform |
Gets the platform that this endpoint is bound to. (Inherited from LocalEndpoint) |
| PresenceBasedScreeningDisabled |
Gets whether Presence screening is disabled. (Inherited from LocalEndpoint) |
| PresenceServices |
Gets the presence services for this endpoint. |
| ProvisioningDataDisabled |
Obsolete.
Gets whether querying provisioning data has been disabled. (Inherited from LocalEndpoint) |
| ProvisioningDataQueryDisabled |
Gets whether querying provisioning data has been disabled. |
| PublishingQoeMetricsDisabled |
Gets whether the platform will try to publish quality metrics for the audio calls. (Inherited from LocalEndpoint) |
| RegisterMethods |
Gets the SIP methods that the local endpoint supports and can receive upon registration. (Inherited from LocalEndpoint) |
| RemotePresence |
Obsolete.
Gets an object to subscribe to or query the Presence of remote Users and Applications. (Inherited from LocalEndpoint) |
| State |
Gets the state of the local endpoint. (Inherited from LocalEndpoint) |
| SupportedMimePartContentTypes |
Gets the list of M/MIME content types that are supported by the endpoint. (Inherited from LocalEndpoint) |
| SyncRoot |
Obsolete.
Synchronization object for locking instances. (Inherited from LocalEndpoint) |
| UserAgent |
Gets the user agent string that will be used in messages sent and received by the local endpoint. (Inherited from LocalEndpoint) |
| UseRegistration |
Gets whether registration is performed for the endpoint. |
Methods
| BeginDrain(AsyncCallback, Object) |
Starts declining requests for new conversations on the endpoint. |
| BeginEstablish(AsyncCallback, Object) |
Establishes the endpoint so that it can receive incoming calls and conference invitations. (Inherited from LocalEndpoint) |
| BeginEstablish(IEnumerable<SignalingHeader>, AsyncCallback, Object) |
Establishes the endpoint so that it can receive incoming calls and conference invitations. (Inherited from LocalEndpoint) |
| BeginGetProvisioningData(AsyncCallback, Object) |
Queries the latest provisioning data (advanced). (Inherited from LocalEndpoint) |
| BeginTerminate(AsyncCallback, Object) |
Terminates the local endpoint after cleaning up all communication and collaboration resources. (Inherited from LocalEndpoint) |
| EndDrain(IAsyncResult) |
This method is used to determine whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed |
| EndEstablish(IAsyncResult) |
Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed. (Inherited from LocalEndpoint) |
| EndGetProvisioningData(IAsyncResult) |
Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed. (Inherited from LocalEndpoint) |
| EndTerminate(IAsyncResult) |
Determines whether the corresponding operation completed successfully. This method will wait if the operation has not yet completed. (Inherited from LocalEndpoint) |
| GetConversations() |
Gets a snapshot of the conversations managed by the local endpoint. (Inherited from LocalEndpoint) |
| GetMatchingConversation(SessionReceivedEventArgs) |
Intercepts an incoming signaling session for conference type endpoints Conference when there is more than one conversation (advanced). |
| GetProvisioningData() |
Gets the latest Provisioning Data from the endpoint cache. (Inherited from LocalEndpoint) |
| HandleSignalingSession(SessionReceivedEventArgs) |
Intercepts an incoming signaling session before it is processed by the local endpoint (advanced). (Inherited from LocalEndpoint) |
| RegisterForIncomingCall<TCall>(IncomingCallDelegate<TCall>) |
Registers a delegate to handle incoming calls for a specific modality. (Inherited from LocalEndpoint) |
| SetProxyInformation(ConnectionContext) |
Sets the information about the next hop proxy. |
| SetProxyInformation(String, Int32) |
Obsolete.
Sets the information about the next hop proxy. |
| UnregisterForIncomingCall<TCall>(IncomingCallDelegate<TCall>) |
Removes a previously registered delegate that was handling incoming calls of a specific modality. (Inherited from LocalEndpoint) |
Events
| ConferenceInvitationReceived |
Raised when an invitation to a conference is received. (Inherited from LocalEndpoint) |
| OwnerPropertiesChanged |
Raised when any of the application endpoint owner's properties change. |
| RepublishingRequired |
Raised when the server indicates that the Presence publication of the local endpoint owner is stale. (Inherited from LocalEndpoint) |
| StateChanged |
Raised when the local endpoint state changes. (Inherited from LocalEndpoint) |