UserEndpoint 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.
UserEndpoint is a specialization of LocalEndpoint for communication on behalf of information workers.
public ref class UserEndpoint : Microsoft::Rtc::Collaboration::LocalEndpointpublic class UserEndpoint : Microsoft.Rtc.Collaboration.LocalEndpointtype UserEndpoint = class
inherit LocalEndpointPublic Class UserEndpoint
Inherits LocalEndpoint- Inheritance
Remarks
The owner of a UserEndpoint is represented by an Active Directory User object. This type of endpoint is not meant to be highly available or trusted by other servers. It is rather designed to have all the capabilities that an information worker needs. So unlike an ApplicationEndpoint, it allows the owner to manage her contacts and groups or to use different devices for different modes of communication.
Constructors
| UserEndpoint(CollaborationPlatform, UserEndpointSettings) |
Creates a new instance of the UserEndpoint class. |
Properties
| ConferenceServices |
Gets an object to list and organize Conferences for the owner of the local endpoint. (Inherited from LocalEndpoint) |
| ContactGroupServices |
Gets the service which can be used to access or update the contact/group information for this endpoint. |
| Credential |
Gets or sets the credential needed to authenticate the endpoint with servers. |
| 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) |
| 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. (Inherited from LocalEndpoint) |
| OwnerPhoneUri |
Gets the tel URI of the endpoint. |
| OwnerUri |
Gets the URI of the owner of the local endpoint. |
| OwnerVoicemailUri |
Gets the provisioned owner voicemail URI. |
| PhoneContext |
Gets the phone context associated with the owner of the local endpoint. (Inherited from LocalEndpoint) |
| PinServices |
Gets the user pin services UserPinServices. |
| 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) |
| 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) |
| TelephonyMode |
Gets the telephony mode for the endpoint: None, Uc, Rcc or Dual. |
| UmEnabled |
Gets whether Unified Messaging is enabled for the user. |
| UserAgent |
Gets the user agent string that will be used in messages sent and received by the local endpoint. (Inherited from LocalEndpoint) |
Methods
| 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) |
| 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) |
| 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) |
| 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) |
| 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) |