DialDevice DialDevice DialDevice DialDevice Class

Definition

Represents the remote device capable of running DIAL apps.

public : sealed class DialDevice : IDialDevice, IDialDevice2public sealed class DialDevice : IDialDevice, IDialDevice2Public NotInheritable Class DialDevice Implements IDialDevice, IDialDevice2// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Get an instance of this class by handling the DialDeviceSelected event and accessing the DialDeviceSelectedEventArgs.SelectedDialDevice or by handling the DisconnectButtonClicked handler and accessing the DialDisconnectButtonClickedEventArgs.Device property.

Properties

FriendlyName FriendlyName FriendlyName FriendlyName

Gets the friendly name for the DIAL device.

public : PlatForm::String FriendlyName { get; }public string FriendlyName { get; }Public ReadOnly Property FriendlyName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The friendly name for the DIAL device.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Id Id Id Id

Gets the remote device's ID. You can use this ID with the Windows.Devices.Enumeration APIs as well.

public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The ID of the remote device.

Thumbnail Thumbnail Thumbnail Thumbnail

Gets a stream containing the thumbnail image for the DIAL device.

public : IRandomAccessStreamReference Thumbnail { get; }public IRandomAccessStreamReference Thumbnail { get; }Public ReadOnly Property Thumbnail As IRandomAccessStreamReference// You can use this property in JavaScript.
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Methods

DeviceInfoSupportsDialAsync(DeviceInformation) DeviceInfoSupportsDialAsync(DeviceInformation) DeviceInfoSupportsDialAsync(DeviceInformation) DeviceInfoSupportsDialAsync(DeviceInformation)

Indicates whether or not the device supports launching DIAL apps.

public : static IAsyncOperation<PlatForm::Boolean> DeviceInfoSupportsDialAsync(DeviceInformation device)public static IAsyncOperation<bool> DeviceInfoSupportsDialAsync(DeviceInformation device)Public Static Function DeviceInfoSupportsDialAsync(device As DeviceInformation) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
device
DeviceInformation DeviceInformation DeviceInformation DeviceInformation

The device you want to get information for.

Returns

True if app launching is supported; false, otherwise.

FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)

Returns a DialDevice object for a given a device ID (acquired from a query using the Windows.Devices.Enumeration APIs).

public : static IAsyncOperation<DialDevice> FromIdAsync(PlatForm::String value)public static IAsyncOperation<DialDevice> FromIdAsync(String value)Public Static Function FromIdAsync(value As String) As IAsyncOperation( Of DialDevice )// You can use this method in JavaScript.
Parameters
value
PlatForm::String String String String

The ID of the device you want a DialDevice object for.

Returns

GetDeviceSelector(String) GetDeviceSelector(String) GetDeviceSelector(String) GetDeviceSelector(String)

Returns an AQS filter string to be used with the Windows.Devices.Enumeration APIs (such as the CreateWatcher API) for a given Dial app.

public : static PlatForm::String GetDeviceSelector(PlatForm::String appName)public static string GetDeviceSelector(String appName)Public Static Function GetDeviceSelector(appName As String) As string// You can use this method in JavaScript.
Parameters
appName
PlatForm::String String String String

The name of the app.

Returns
PlatForm::String string string string

The AQS filter.

GetDialApp(String) GetDialApp(String) GetDialApp(String) GetDialApp(String)

Creates a new DialApp object. This method does not establish a connection to the device or validate that the app exists. That is done when any function is called on the resulting DialApp object.

public : DialApp GetDialApp(PlatForm::String appName)public DialApp GetDialApp(String appName)Public Function GetDialApp(appName As String) As DialApp// You can use this method in JavaScript.
Parameters
appName
PlatForm::String String String String

The name of the app. This becomes the AppName property of the new object.

Returns

The DialApp object for the app.