ApplicationEndpointSettings Class

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Represents the settings needed to initialize an ApplicationEndpoint.

public ref class ApplicationEndpointSettings : Microsoft::Rtc::Collaboration::LocalEndpointSettings

public class ApplicationEndpointSettings : Microsoft.Rtc.Collaboration.LocalEndpointSettings

type ApplicationEndpointSettings = class
    inherit LocalEndpointSettings

Public Class ApplicationEndpointSettings
Inherits LocalEndpointSettings

Inheritance

Object

LocalEndpointSettings

ApplicationEndpointSettings

Derived

Microsoft.Rtc.Internal.Collaboration.ApplicationEndpointSettingsInternal

Remarks

For manually provisioned endpoints, the application creates an instance of this class and populates it.

For auto-provisioned endpoints, an instance of the ApplicationEndpointSettings class is automatically created and passed into the event handler registered through RegisterForApplicationEndpointSettings(EventHandler<ApplicationEndpointSettingsDiscoveredEventArgs>). The application can then customize the settings it needs to and create the ApplicationEndpoint.

Constructors

ApplicationEndpointSettings(String, ConnectionContext)	Creates a new instance of the ApplicationEndpointSettings class.
ApplicationEndpointSettings(String, String, Int32)	Creates a new instance of the ApplicationEndpointSettings class.
ApplicationEndpointSettings(String)	Creates a new instance of the ApplicationEndpointSettings class.

Properties

AdditionalHeaders	Gets or sets the collection of additional headers that should be placed on every SIP message sent by the endpoint. This may be null. (Inherited from LocalEndpointSettings)
AutomaticPresencePublicationEnabled	Gets or sets whether presence information will be published automatically on behalf of the endpoint as part of the establishment process.
EndpointSubtype	The subtype of the user agent that this endpoint represents. (Inherited from LocalEndpointSettings)
EndpointType	The type of user agent that this endpoint represents. (Inherited from LocalEndpointSettings)
EndpointUserAgent	Gets or sets the endpoint user agent string. (Inherited from LocalEndpointSettings)
IsDefaultRoutingEndpoint	Gets the flag that indicates whether this endpoint is marked as default endpoint to handle incoming requests that are not routable to other endpoints.
IsOutsideCorporateNetwork	Gets or sets whether the endpoint registers inside or outside the corporate network. (Inherited from LocalEndpointSettings)
MaxRegisterRetries	Gets or sets the maximum number of times that the endpoint should try to recover from registration refresh failure. (Inherited from LocalEndpointSettings)
MediaEdgeAuthenticationService	Gets or sets the connection context for the service that grants communication permissions via a media edge service deployed in the perimeter network.
OutboundConnectionConfiguration	Gets the object containing outbound configuration settings. (Inherited from LocalEndpointSettings)
OwnerDisplayName	Gets the display name of the owner.
OwnerPhoneUri	Gets or sets the tel URI of the endpoint. Optional.
OwnerUri	Gets the URI of the owner of this endpoint. (Inherited from LocalEndpointSettings)
Presence	Gets the presence-related settings.
PresenceBasedScreeningDisabled	Gets or sets whether calls should used be screened based on presence. (Inherited from LocalEndpointSettings)
ProvisioningDataDisabled	Obsolete. Gets or sets whether to query for the provisioning data when the endpoint is established. (Inherited from LocalEndpointSettings)
ProvisioningDataQueryDisabled	Gets or sets whether to query for the provisioning data when the endpoint is established.
ProxyCertificateSubject	Gets or sets the subject of the certificate to expect from the proxy.
ProxyHost	Gets the proxy host to use as the first hop instead of a direct connection to the other endpoint.
ProxyPort	Gets the port to use for connecting to a proxy.
PublishingQoeMetricsDisabled	Gets or sets whether the endpoint will try to publish quality metrics for the audio calls. (Inherited from LocalEndpointSettings)
RegisterMethods	Gets or sets the methods supported by a registered endpoint. (Inherited from LocalEndpointSettings)
SupportedMimePartContentTypes	Gets or sets the list of content types that can be supported by the endpoint. (Inherited from LocalEndpointSettings)
UseRegistration	Gets or sets whether registration is required for this endpoint. The default value is false.

Methods

SetEndpointType(EndpointType, EndpointSubtype)	Sets the type of user agent that this endpoint represents.
SetEndpointType(EndpointType)	Sets the type of user agent that this endpoint represents.