Interface IDeviceControllable

Device capability interface for controlling this device.

Namespace: Phoenix.Devices

Assembly: Phoenix.Abstractions.Devices.dll

Syntax

public interface IDeviceControllable

Properties

CanRebootDevice

Gets a value indicating whether it's possible to reboot this device in its current state.

Declaration

bool CanRebootDevice { get; }

Property Value

Type	Description
System.Boolean

IsRebooting

Gets a value indicating whether a known reboot is in progress.

Declaration

bool IsRebooting { get; }

Property Value

Type	Description
System.Boolean

Methods

GetIsDeviceAvailable()

Checks this device to see if it is connected and usable.

Declaration

bool GetIsDeviceAvailable()

Returns

Type	Description
System.Boolean	Whether or not this device is connected and usable.

Reboot()

Reboots this device.

Declaration

[Obsolete("Use method RebootAsync.", true)]
void Reboot()

RebootAsync()

Asynchronously reboots this device.

Declaration

Task RebootAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the reboot operation.

RebootAsync(CancellationToken)

Asynchronously reboots this device.

Declaration

Task RebootAsync(CancellationToken token)

Parameters

Type	Name	Description
System.Threading.CancellationToken	token	A cancellation token that should be used to cancel the work.

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the reboot operation.

Shutdown()

Shuts down this device.

Declaration

[Obsolete("Use method ShutdownAsync.", true)]
void Shutdown()

ShutdownAsync(CancellationToken)

Asynchronously shuts down this device.

Declaration

Task ShutdownAsync(CancellationToken token = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	token	A cancellation token that should be used to cancel the work.

Returns

Type	Description
System.Threading.Tasks.Task	A task that represents the shutdown operation.