RemoteSystemSessionParticipantWatcher RemoteSystemSessionParticipantWatcher RemoteSystemSessionParticipantWatcher RemoteSystemSessionParticipantWatcher Class

Definition

Handles the discovery and monitoring of remote session participants by raising the appropriate events.

public : sealed class RemoteSystemSessionParticipantWatcher : IRemoteSystemSessionParticipantWatcherpublic sealed class RemoteSystemSessionParticipantWatcher : IRemoteSystemSessionParticipantWatcherPublic NotInheritable Class RemoteSystemSessionParticipantWatcher Implements IRemoteSystemSessionParticipantWatcher// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

This class is instantiated when the CreateParticipantWatcher method is called on an instance of RemoteSystemSession. Instances of this class each correspond to one instance of RemoteSystemSession (and therefore one remote session).

Properties

Status Status Status Status

Gets the operational status of this participant watcher.

public : RemoteSystemSessionParticipantWatcherStatus Status { get; }public RemoteSystemSessionParticipantWatcherStatus Status { get; }Public ReadOnly Property Status As RemoteSystemSessionParticipantWatcherStatus// You can use this property in JavaScript.

Methods

Start() Start() Start() Start()

Starts watching for participants in the remote session. The discovery process runs until the Stop method is called. A RemoteSystemSessionParticipantWatcher object can have its Start method called again at a later time.

public : void Start()public void Start()Public Function Start() As void// You can use this method in JavaScript.

Stop() Stop() Stop() Stop()

Stops watching for discoverable session participants.

public : void Stop()public void Stop()Public Function Stop() As void// You can use this method in JavaScript.

Events

Added Added Added Added

Raised when a new participant has been added to the remote session.

public : event TypedEventHandler Added<RemoteSystemSessionParticipantWatcher,  RemoteSystemSessionParticipantAddedEventArgs>public event TypedEventHandler Added<RemoteSystemSessionParticipantWatcher,  RemoteSystemSessionParticipantAddedEventArgs>Public Event Added<RemoteSystemSessionParticipantWatcher,  RemoteSystemSessionParticipantAddedEventArgs>// You can use this event in JavaScript.

EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted

Raised after the initial enumeration of participants has completed.

public : event TypedEventHandler EnumerationCompleted<RemoteSystemSessionParticipantWatcher,  object>public event TypedEventHandler EnumerationCompleted<RemoteSystemSessionParticipantWatcher,  object>Public Event EnumerationCompleted<RemoteSystemSessionParticipantWatcher,  object>// You can use this event in JavaScript.

Remarks

An app may delay UI rendering for session participants until this point, so that the UI elements for many participant can be rendered at once. Participant discovery events can continue to be raised after this event.

Removed Removed Removed Removed

Raised when a participant in the session has been removed.

public : event TypedEventHandler Removed<RemoteSystemSessionParticipantWatcher,  RemoteSystemSessionParticipantRemovedEventArgs>public event TypedEventHandler Removed<RemoteSystemSessionParticipantWatcher,  RemoteSystemSessionParticipantRemovedEventArgs>Public Event Removed<RemoteSystemSessionParticipantWatcher,  RemoteSystemSessionParticipantRemovedEventArgs>// You can use this event in JavaScript.