RemoteSystem
RemoteSystem
RemoteSystem
RemoteSystem
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
This class manages the attributes of a discovered remote system (device) and provides the capabilities to discover remote systems as part of Project Rome.
public : sealed class RemoteSystem : IRemoteSystem, IRemoteSystem2public sealed class RemoteSystem : IRemoteSystem, IRemoteSystem2Public NotInheritable Class RemoteSystem Implements IRemoteSystem, IRemoteSystem2// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
Remarks
This class is instantiated whenever a remote system (device) is discovered, is updated, or disappears (the instance is referenced as a property of the RemoteSystemAddedEventArgs, RemoteSystemUpdatedEventArgs, or RemoteSystemRemovedEventArgs class).
The properties of the RemoteSystem class are used to determine the operations that can be done on a given remote system.
Properties
DisplayName DisplayName DisplayName DisplayName
Gets the machine name of the given remote system.
public : PlatForm::String DisplayName { get; }public string DisplayName { get; }Public ReadOnly Property DisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The name of the given remote system.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
Id Id Id Id
Gets the unique string identifier for the given remote system.
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 string identifier for the remote system.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
IsAvailableByProximity IsAvailableByProximity IsAvailableByProximity IsAvailableByProximity
Checks whether the given remote system is available through proximal connection (such as a Bluetooth or local network connection) as opposed to cloud connection.
public : PlatForm::Boolean IsAvailableByProximity { get; }public bool IsAvailableByProximity { get; }Public ReadOnly Property IsAvailableByProximity As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the given remote system is available by proximal connection, False otherwise.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
IsAvailableBySpatialProximity IsAvailableBySpatialProximity IsAvailableBySpatialProximity IsAvailableBySpatialProximity
Checks whether the given remote system is available through spatially proximal connection.
public : PlatForm::Boolean IsAvailableBySpatialProximity { get; }public bool IsAvailableBySpatialProximity { get; }Public ReadOnly Property IsAvailableBySpatialProximity As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if the given remote system is available by spatially proximal connection, false otherwise.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
| Capabilities |
remoteSystem
|
Kind Kind Kind Kind
Gets a String representation of the device type of the given remote system (desktop, Xbox, ...).
public : PlatForm::String Kind { get; }public string Kind { get; }Public ReadOnly Property Kind As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The device type of the remote system.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
Remarks
This property should not be used to make functionality or experience decisions regarding connected devices. Instead, device capabilities should be checked with the GetCapabilitySupportedAsync method. The Kind property is meant to provide developers with information about the types of devices being connected to so that they can display this information in the UI.
ManufacturerDisplayName ManufacturerDisplayName ManufacturerDisplayName ManufacturerDisplayName
Prerelease. Gets the manufacturer name of the given remote system.
public : PlatForm::String ManufacturerDisplayName { get; }public string ManufacturerDisplayName { get; }Public ReadOnly Property ManufacturerDisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The name of the given remote system's manufacturer.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
| Capabilities |
remoteSystem
|
ModelDisplayName ModelDisplayName ModelDisplayName ModelDisplayName
Prerelease. Gets the model name of the given remote system.
public : PlatForm::String ModelDisplayName { get; }public string ModelDisplayName { get; }Public ReadOnly Property ModelDisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The model name of the given remote system.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
| Capabilities |
remoteSystem
|
Status Status Status Status
Gets the status of this remote system's availability.
public : RemoteSystemStatus Status { get; }public RemoteSystemStatus Status { get; }Public ReadOnly Property Status As RemoteSystemStatus// You can use this property in JavaScript.
The availability status of the remote system.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
Methods
CreateWatcher() CreateWatcher() CreateWatcher() CreateWatcher()
Returns a RemoteSystemWatcher object with no filters.
public : static RemoteSystemWatcher CreateWatcher()public static RemoteSystemWatcher CreateWatcher()Public Static Function CreateWatcher() As RemoteSystemWatcher// You can use this method in JavaScript.
A watcher that can raise events related to the status of any discoverable device.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
- See Also
CreateWatcher(IIterable)
CreateWatcher(IIterable)
CreateWatcher(IIterable)
CreateWatcher(IIterable)
Returns a RemoteSystemWatcher object that filters the remote systems it can see. The filters parameter determines which remote systems will be seen.
public : static RemoteSystemWatcher CreateWatcher(IIterable<IRemoteSystemFilter> filters)public static RemoteSystemWatcher CreateWatcher(IEnumerable<IRemoteSystemFilter> filters)Public Static Function CreateWatcher(filters As IEnumerable<IRemoteSystemFilter>) As RemoteSystemWatcher// You can use this method in JavaScript.
- filters
- IIterable<IRemoteSystemFilter> IEnumerable<IRemoteSystemFilter> IEnumerable<IRemoteSystemFilter> IEnumerable<IRemoteSystemFilter>
A list of objects implementing the IRemoteSystemFilter interface. Each item in the list acts as a filter for the set of remote systems that can be discovered.
A watcher that can raise events related to the status of any discoverable devices that pass the given filter(s).
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
- See Also
FindByHostNameAsync(HostName) FindByHostNameAsync(HostName) FindByHostNameAsync(HostName) FindByHostNameAsync(HostName)
Attempts to discover a single remote system specified by the HostName parameter.
public : static IAsyncOperation<RemoteSystem> FindByHostNameAsync(HostName hostName)public static IAsyncOperation<RemoteSystem> FindByHostNameAsync(HostName hostName)Public Static Function FindByHostNameAsync(hostName As HostName) As IAsyncOperation( Of RemoteSystem )// You can use this method in JavaScript.
A wrapper object for the address of a remote system to be discovered. For information on how to instantiate a , see the HostName constructor.
An asynchronous operation that returns the RemoteSystem that was found. Returns null if no was found.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
GetCapabilitySupportedAsync(String) GetCapabilitySupportedAsync(String) GetCapabilitySupportedAsync(String) GetCapabilitySupportedAsync(String)
Reports whether the RemoteSystem is capable of the given Remote System feature.
public : IAsyncOperation<PlatForm::Boolean> GetCapabilitySupportedAsync(PlatForm::String capabilityName)public IAsyncOperation<bool> GetCapabilitySupportedAsync(String capabilityName)Public Function GetCapabilitySupportedAsync(capabilityName As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
- capabilityName
- PlatForm::String String String String
The Remote System capability to check. This should be the value of one of the properties of KnownRemoteSystemCapabilities.
An asynchronous operation with a value of true if the RemoteSystem is capable, otherwise false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
| Capabilities |
remoteSystem
|
IsAuthorizationKindEnabled(RemoteSystemAuthorizationKind) IsAuthorizationKindEnabled(RemoteSystemAuthorizationKind) IsAuthorizationKindEnabled(RemoteSystemAuthorizationKind) IsAuthorizationKindEnabled(RemoteSystemAuthorizationKind)
Checks whether the client device is authorized to discover other users' devices or just same-user devices.
public : static PlatForm::Boolean IsAuthorizationKindEnabled(RemoteSystemAuthorizationKind kind)public static bool IsAuthorizationKindEnabled(RemoteSystemAuthorizationKind kind)Public Static Function IsAuthorizationKindEnabled(kind As RemoteSystemAuthorizationKind) As bool// You can use this method in JavaScript.
- kind
- RemoteSystemAuthorizationKind RemoteSystemAuthorizationKind RemoteSystemAuthorizationKind RemoteSystemAuthorizationKind
The RemoteSystemAuthorizationKind to check.
Returns true if the client device is set to kind authorization scheme, otherwise false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
| Capabilities |
remoteSystem
|
Remarks
This authorization is a system-wide setting. The user can view and change it by going to Settings > System > Shared experiences.
RequestAccessAsync() RequestAccessAsync() RequestAccessAsync() RequestAccessAsync()
Gets the status of the calling app's access to the Remote Systems feature. This method should always be called before an app attempts to discover remote systems.
public : static IAsyncOperation<RemoteSystemAccessStatus> RequestAccessAsync()public static IAsyncOperation<RemoteSystemAccessStatus> RequestAccessAsync()Public Static Function RequestAccessAsync() As IAsyncOperation( Of RemoteSystemAccessStatus )// You can use this method in JavaScript.
An asynchronous operation that returns the status of access.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
remoteSystem
|
Remarks
This method must be called from the UI thread.