UserWatcher UserWatcher UserWatcher UserWatcher Class

Definition

Namespace:: Windows.System Windows.System Windows.System Windows.System

Edit

Provides events that fire during enumeration of users, when the collection of users changes, or when a user's authentication status changes.

public : sealed class UserWatcher : IUserWatcherpublic sealed class UserWatcher : IUserWatcherPublic NotInheritable Class UserWatcher Implements IUserWatcher// You can use this class in JavaScript.

Attributes: ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

Windows 10 requirements

Device family	Windows 10 (introduced v10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Status Status Status Status

Edit

Gets the status of a user watcher.

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

Value: UserWatcherStatus UserWatcherStatus UserWatcherStatus UserWatcherStatus

The status of the user watcher.

Methods

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

Edit

Starts the user watcher.

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

Remarks

You must add a handler for the UserWatcher.Added before event before calling Start.

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

Edit

Stops the user watcher.

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

Events

Added Added Added Added

Edit

Fires when a user is added to the collection of users returned by User.FindAllAsync.

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

AuthenticationStatusChanged AuthenticationStatusChanged AuthenticationStatusChanged AuthenticationStatusChanged

Edit

Fires when a user's authentication status has changed.

public : event TypedEventHandler AuthenticationStatusChanged<UserWatcher,  UserChangedEventArgs>public event TypedEventHandler AuthenticationStatusChanged<UserWatcher,  UserChangedEventArgs>Public Event AuthenticationStatusChanged<UserWatcher,  UserChangedEventArgs>// You can use this event in JavaScript.

AuthenticationStatusChanging AuthenticationStatusChanging AuthenticationStatusChanging AuthenticationStatusChanging

Edit

Fires when a user's authentication status is about to change.

public : event TypedEventHandler AuthenticationStatusChanging<UserWatcher,  UserAuthenticationStatusChangingEventArgs>public event TypedEventHandler AuthenticationStatusChanging<UserWatcher,  UserAuthenticationStatusChangingEventArgs>Public Event AuthenticationStatusChanging<UserWatcher,  UserAuthenticationStatusChangingEventArgs>// You can use this event in JavaScript.

EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted

Edit

Fires when the initial pass of watcher events has been processed and the collection of users is complete.

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

Removed Removed Removed Removed

Edit

Fires when a user is removed from the collection of users returned by User.FindAllAsync.

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

Stopped Stopped Stopped Stopped

Edit

Fires when the user watcher has stopped.

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

Updated Updated Updated Updated

Edit

Fires when the data associated with a user has changed.

public : event TypedEventHandler Updated<UserWatcher,  UserChangedEventArgs>public event TypedEventHandler Updated<UserWatcher,  UserChangedEventArgs>Public Event Updated<UserWatcher,  UserChangedEventArgs>// You can use this event in JavaScript.