Interface IDevice

Represents a device.

Inherited Members

ICapability.GetCapabilityInterface<T>()

ICapability.HasCapabilityInterface(Type)

Namespace: Phoenix.Devices

Assembly: Phoenix.Abstractions.Devices.dll

Syntax

public interface IDevice : ICapability

Properties

Alias

Gets or sets a user defined alias for the device.

Declaration

string Alias { get; set; }

Property Value

Type	Description
System.String

AttachedObjectModel

Gets or sets the game object model that is attached to this device.

Declaration

object AttachedObjectModel { get; set; }

Property Value

Type	Description
System.Object

Configuration

Gets or sets the configuration string for this device.

Declaration

string Configuration { get; set; }

Property Value

Type	Description
System.String

ConfigurationType

Gets or sets the configuration type for this device.

Declaration

string ConfigurationType { get; set; }

Property Value

Type	Description
System.String

ConnectionStatus

Gets a value indicating the device connection status.

Declaration

DeviceConnectionStatus ConnectionStatus { get; }

Property Value

Type	Description
DeviceConnectionStatus

DeviceImplementation

Gets the underlying device implementation.

Declaration

object DeviceImplementation { get; }

Property Value

Type	Description
System.Object

DeviceTypeDisplayName

Gets the display name of the device type.

Declaration

string DeviceTypeDisplayName { get; }

Property Value

Type	Description
System.String

DeviceTypeName

Gets the name of the device type.

Declaration

string DeviceTypeName { get; }

Property Value

Type	Description
System.String

DisplayName

Gets the display name for UI and logging. This is the Name if valid or the IPAddress.

Declaration

string DisplayName { get; }

Property Value

Type	Description
System.String

Id

Gets the unique identifier of the device.

Declaration

string Id { get; }

Property Value

Type	Description
System.String

IPAddress

Gets the IPAddress of this device.

Declaration

IPAddress IPAddress { get; }

Property Value

Type	Description
System.Net.IPAddress

Name

Gets or sets the name of this device.

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String

PhoenixId

Gets a value representing the identifier phoenix places on the device for tracking.

Declaration

Guid PhoenixId { get; }

Property Value

Type	Description
System.Guid

XboxLiveDeviceId

Gets a value representing the XBL device ID.

Declaration

string XboxLiveDeviceId { get; }

Property Value

Type	Description
System.String

Methods

Cleanup()

Performs device cleanup

Declaration

void Cleanup()

Serialize()

Serializes device information.

Declaration

SerializableIDevice Serialize()

Returns

Type	Description
SerializableIDevice	The serialized device.

Extension Methods

ICapabilityExtensions.IsCapable(ICapability, Type[])

ICapabilityExtensions.HasCapabilityInterface<T>(ICapability)

IDeviceExtensions.GetFileName(IDevice, String)

IDeviceExtensions.SetJsonConfiguration<T>(IDevice, T, JsonSerializerSettings)