DevicesManager Class

Article
09/23/2016

Represents synchronous and asynchronous operations that are used to interact with the devices provider.

Namespace: Microsoft.WindowsServerSolutions.Common.Devices
Assembly: DevicesOM (in DevicesOM.dll)

Inheritance Hierarchy

System.Object
Microsoft.WindowsServerSolutions.Common.Devices.DevicesManager

Syntax

public sealed class DevicesManager : IDevicesEventNotifier, IDisposable

public ref class DevicesManager sealed : IDevicesEventNotifier, 
    IDisposable

Public NotInheritable Class DevicesManager
    Implements IDevicesEventNotifier, IDisposable

Constructors

	Name	Description
	DevicesManager()	Initializes a new instance of the DevicesManager class.

Properties

	Name	Description
	Connected	Indicates whether the devices manager is connected to the devices provider.
	DeviceInfoCollection	Gets a reference to the ReadOnlyDeviceInfoCollection.

Methods

	Name	Description
	AuthoritativeRefreshDevices(Guid, IEnumerable<ReportDeviceParameters>, Boolean)	Refreshes the list of devices of the specified type.
	AuthoritativeRefreshDevicesAsync(Guid, IEnumerable<ReportDeviceParameters>, Boolean)	Asynchronously refreshes the list of devices.
	Connect()	Connects the devices manager to the devices provider.
	Connect(TimeSpan)	Connects the devices manager to the devices provider with the specified timeout period.
	ConnectAsync()	Asynchronously connects the devices manager to the devices provider.
	ConnectAsync(TimeSpan)	Asynchronously connects the devices manager to the devices provider with the specified time-out period.
	Disconnect()	Disconnects the devices manager from the devices provider and cancels all pending operations.
	Dispose()	Release all resources that are used by the DevicesManager object.
	Equals(Object)	(Inherited from Object.)
	GetAllDevicesInfo()	Returns a ReadOnlyDeviceInfoCollection that contains all of the DeviceInfo objects.
	GetAllDevicesInfoAsync()	Asynchronously gets the information for all of the devices.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	RemoveDevice(String, Guid)	Removes a device from the database.
	RemoveDeviceAsync(String, Guid)	Asynchronously removes a device from the database.
	ReportDevice(Guid, ReportDeviceParameters)	Reports when a new device is added; or when a name, or an identity status of a device is updated.
	ReportDevice(String, Guid, String, DeviceIdentityStatus, String)	Reports when a new device is added; or when a name, or identity status of a device is updated.
	ReportDeviceAsync(Guid, ReportDeviceParameters)	Asynchronously reports when a new device is added; or when a name, or identity status of a device is updated.
	ReportDeviceAsync(String, Guid, String, DeviceIdentityStatus, String)	Asynchronously reports when a new device is added; or a name, or identity status of a device is updated.
	ReportDeviceProperties(String, IList<DeviceProperty>)	Reports the properties of a device.
	ReportDevicePropertiesAsync(String, IList<DeviceProperty>)	Asynchronously reports the properties of a device.
	ToString()	(Inherited from Object.)

Events

	Name	Description
	AuthoritativeRefreshDevicesCompleted	Represents an event that is raised when the AuthoritativeRefreshDevicesAsync operation finishes.
	ConnectionClosed	Represents an event that is raised when the connection to the devices provider is not available.
	ConnectionOpened	Represents an event that is raised when the connection to the devices provider is available.
	ConnectionTimedOut	Represents an event that is raised when a connection is not established in the time-out period.
	GetAllDevicesInfoCompleted	Represents an event that is raised when the GetAllDevicesInfoAsync operation finishes.
	RemoveDeviceCompleted	Represents an event that is raised when the ReportDeviceAsync operation finishes.
	ReportDeviceCompleted	Represents an event that is raised when the ReportDeviceAsync operation finishes.
	ReportDevicePropertiesCompleted	Represents an event that is raised when the ReportDevicePropertiesAsync operation finishes.

Remarks

The DevicesManager class is the main object model class of the Devices Provider. It is used to query the Device Provider backend to perform synchronous and asynchronous operations such as adding and removing devices, adding and updating device properties, and getting device property information.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.