Skip to content

Commit 3123d2e

Browse files
Steven WhiteSteven White
Steven White
authored and
Steven White
committed
Merged PR 21148: new Ge Insider Preview APIs
new Ge Insider Preview APIs
1 parent 97ba361 commit 3123d2e

14 files changed

Lines changed: 358 additions & 0 deletions

‎windows.devices.enumeration.pnp/pnpobjecttype.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ The [PnpObject](pnpobject.md) represents an association endpoint service.
5656

5757
The [PnpObject](pnpobject.md) represents a device input panel.
5858

59+
### -field AssociationEndpointProtocol: 9
60+
61+
TBD
62+
5963
## -remarks
6064

6165
### Version history

‎windows.devices.enumeration/deviceinformation_createfromidasync_1003420271.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind,Windows.Devices.Enumeration.IDeviceEnumerationSettings)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Devices.Enumeration.DeviceInformation.CreateFromIdAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind,Windows.Devices.Enumeration.IDeviceEnumerationSettings)
7+
8+
<!--
9+
public static Windows.Foundation.IAsyncOperation<Windows.Devices.Enumeration.DeviceInformation> CreateFromIdAsync (string deviceId, System.Collections.Generic.IEnumerable<string> additionalProperties, Windows.Devices.Enumeration.DeviceInformationKind kind, Windows.Devices.Enumeration.IDeviceEnumerationSettings settings);
10+
-->
11+
12+
13+
## -description
14+
15+
Asynchronously creates a [DeviceInformation](deviceinformation.md) object from a [DeviceInformation](deviceinformation.md) ID, a list of additional properties, a [DeviceInformationKind](deviceinformationkind.md), and a settings object.
16+
17+
## -parameters
18+
19+
### -param deviceId
20+
21+
A string containing the [DeviceInformation](deviceinformation.md) ID.
22+
23+
### -param additionalProperties
24+
25+
An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) object in the enumeration results. For more info about what the properties represent, see [Device information properties](/windows/uwp/devices-sensors/device-information-properties).
26+
27+
### -param kind
28+
29+
The type of [DeviceInformation](deviceinformation.md) object that you want to create.
30+
31+
### -param settings
32+
33+
Enumeration settings come from a device API's **GetDeviceEnumerationSettings** method, and contain opaque data. An object implementing this must also implement the **IDeviceEnumerationSettings** interface.
34+
35+
## -returns
36+
37+
An asynchronous operation object which, when it completes, contains a newly created [DeviceInformation](deviceinformation.md) object.
38+
39+
## -remarks
40+
41+
## -see-also

‎windows.devices.enumeration/deviceinformation_createwatcher_283258381.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
-api-id: M:Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind,Windows.Devices.Enumeration.IDeviceEnumerationSettings)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Devices.Enumeration.DeviceInformation.CreateWatcher(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind,Windows.Devices.Enumeration.IDeviceEnumerationSettings)
7+
8+
<!--
9+
public static Windows.Devices.Enumeration.DeviceWatcher CreateWatcher (string aqsFilter, System.Collections.Generic.IEnumerable<string> additionalProperties, Windows.Devices.Enumeration.DeviceInformationKind kind, Windows.Devices.Enumeration.IDeviceEnumerationSettings settings);
10+
-->
11+
12+
13+
## -description
14+
15+
Creates a [DeviceWatcher](devicewatcher.md) for devices matching the specified Advanced Query Syntax (AQS) string, the specified collection of properties, the kind of device, and the settings.
16+
17+
## -parameters
18+
19+
### -param aqsFilter
20+
21+
An AQS string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector_838466080.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class.
22+
23+
### -param additionalProperties
24+
25+
An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](/windows/uwp/devices-sensors/device-information-properties).
26+
27+
### -param kind
28+
29+
The specific types of devices the [DeviceWatcher](devicewatcher.md) is interested in.
30+
31+
### -param settings
32+
33+
Enumeration settings come from a device API's **GetDeviceEnumerationSettings** method, and contain opaque data. An object implementing this must also implement the **IDeviceEnumerationSettings** interface.
34+
35+
## -returns
36+
37+
The created [DeviceWatcher](devicewatcher.md).
38+
39+
## -remarks
40+
41+
## -see-also

‎windows.devices.enumeration/deviceinformation_findallasync_1515902986.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
-api-id: M:Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind,Windows.Devices.Enumeration.IDeviceEnumerationSettings)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Devices.Enumeration.DeviceInformation.FindAllAsync(System.String,Windows.Foundation.Collections.IIterable{System.String},Windows.Devices.Enumeration.DeviceInformationKind,Windows.Devices.Enumeration.IDeviceEnumerationSettings)
7+
8+
<!--
9+
public static Windows.Foundation.IAsyncOperation<Windows.Devices.Enumeration.DeviceInformationCollection> FindAllAsync (string aqsFilter, System.Collections.Generic.IEnumerable<string> additionalProperties, Windows.Devices.Enumeration.DeviceInformationKind kind, Windows.Devices.Enumeration.IDeviceEnumerationSettings settings);
10+
-->
11+
12+
13+
## -description
14+
15+
Asynchronously enumerates [DeviceInformation](deviceinformation.md) objects matching the specified Advanced Query Syntax (AQS) device interface selector string, the device kind, including the specified collection of properties, and with the settings.
16+
17+
## -parameters
18+
19+
### -param aqsFilter
20+
21+
An AQS device interface selector string that filters the [DeviceInformation](deviceinformation.md) objects to enumerate. Typically this string is retrieved from the **GetDeviceSelector** method of a class that interacts with devices. For example, [GetDeviceSelector](../windows.devices.portable/storagedevice_getdeviceselector_838466080.md) retrieves the string for the [StorageDevice](../windows.devices.portable/storagedevice.md) class.
22+
23+
### -param additionalProperties
24+
25+
An iterable list of additional properties to include in the [Properties](deviceinformation_properties.md) property of the [DeviceInformation](deviceinformation.md) objects in the enumeration results. For more info on what the properties represent, see [Device information properties](/windows/uwp/devices-sensors/device-information-properties).
26+
27+
### -param kind
28+
29+
The specific type of device to find.
30+
31+
### -param settings
32+
33+
Enumeration settings come from a device API's **GetDeviceEnumerationSettings** method, and contain opaque data. An object implementing this must also implement the **IDeviceEnumerationSettings** interface.
34+
35+
## -returns
36+
37+
An asynchronous operation object which, when it completes, contains the [DeviceInformation](deviceinformation.md) objects.
38+
39+
## -remarks
40+
41+
## -see-also

‎windows.devices.enumeration/deviceinformationcustompairing_addpairingsetmember_1277113744.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
-api-id: M:Windows.Devices.Enumeration.DeviceInformationCustomPairing.AddPairingSetMember(Windows.Devices.Enumeration.DeviceInformation)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Devices.Enumeration.DeviceInformationCustomPairing.AddPairingSetMember(Windows.Devices.Enumeration.DeviceInformation)
7+
8+
<!--
9+
public void AddPairingSetMember (Windows.Devices.Enumeration.DeviceInformation device);
10+
-->
11+
12+
13+
## -description
14+
15+
Add a member of a pairing set (for Bluetooth LE and IPP style printers). For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
16+
17+
## -parameters
18+
19+
### -param device
20+
21+
An object representing the device to add to the set.
22+
23+
## -remarks
24+
25+
## -see-also
26+
27+
[Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set)

‎windows.devices.enumeration/deviceinformationcustompairing_pairingsetmembersrequested.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
-api-id: E:Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairingSetMembersRequested
3+
-api-type: winrt event
4+
---
5+
6+
# Windows.Devices.Enumeration.DeviceInformationCustomPairing.PairingSetMembersRequested
7+
8+
<!--
9+
public event Windows.Foundation.TypedEventHandler<Windows.Devices.Enumeration.DeviceInformationCustomPairing,Windows.Devices.Enumeration.DevicePairingSetMembersRequestedEventArgs> PairingSetMembersRequested;
10+
-->
11+
12+
13+
## -description
14+
15+
TBD. For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
16+
17+
## -remarks
18+
19+
## -see-also
20+
21+
[Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set)

‎windows.devices.enumeration/deviceinformationkind.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ The [DeviceInformation](deviceinformation.md) object represents a single physica
7171

7272
The [Id](deviceinformation_id.md) for this object as a string.
7373

74+
### -field AssociationEndpointProtocol:9
75+
76+
TBD
77+
7478
## -remarks
7579

7680
A **DeviceInformationKind** value can be passed to the various enumeration APIs to indicate the specific kind of device you want to enumerate. In most scenarios, you will receive the [DeviceInformation](deviceinformation.md) from the device selector. To see how to enumerate over specific kinds of devices using DeviceInformationKind, see [Enumerate devices](/windows/uwp/devices-sensors/enumerate-devices).

‎windows.devices.enumeration/devicepairingaddpairingsetmemberstatus.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
-api-id: T:Windows.Devices.Enumeration.DevicePairingAddPairingSetMemberStatus
3+
-api-type: winrt enum
4+
---
5+
6+
# Windows.Devices.Enumeration.DevicePairingAddPairingSetMemberStatus
7+
8+
<!--
9+
public enum DevicePairingAddPairingSetMemberStatus
10+
-->
11+
12+
13+
## -description
14+
15+
Defines constants that specify TBD. For more info, and code examples, see [Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set).
16+
17+
## -enum-fields
18+
19+
### -field AddedToSet: 0
20+
21+
Specifies that the device was successfully added to the set.
22+
23+
### -field CouldNotBeAddedToSet: 1
24+
25+
Specifies that we failed to add set member(s).
26+
27+
### -field SetDiscoveryNotAttemptedByProtocol: 2
28+
29+
Specifies TBD
30+
31+
### -field SetDiscoveryCompletedByProtocol: 3
32+
33+
Specifies TBD
34+
35+
### -field SetDiscoveryPartiallyCompletedByProtocol: 4
36+
37+
Specifies TBD
38+
39+
### -field Failed: 5
40+
41+
Specifies that an unknown failure occurred, for which we have no mapping.
42+
43+
## -remarks
44+
45+
## -see-also
46+
47+
[Pairing a set with the DeviceInformationPairing.Custom property](/windows/uwp/devices-sensors/pairing-a-set)

‎windows.devices.enumeration/devicepairingkinds.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ public enum Windows.Devices.Enumeration.DevicePairingKinds : uint
1414
Indicates the kinds of pairing supported by your application or requested by the system. As an input value, use this value to indicate what kinds of pairing your application supports. When this datatype is received as an output value, it indicates the kind of pairing requested by the system. In this case, your code will need to respond accordingly.
1515

1616
## -enum-fields
17+
1718
### -field None:0
1819
No pairing is supported.
1920

@@ -32,6 +33,10 @@ The application must display the given PIN to the user and ask the user to confi
3233
### -field ProvidePasswordCredential:16
3334
The application must request a user name and password from the user. With a value of **ProvidePasswordCredential**, call [AcceptWithPasswordCredential](devicepairingrequestedeventargs_acceptwithpasswordcredential_1073078053.md) from the event args of the [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event handler to accept the pairing. Pass in the [PasswordCredential](../windows.security.credentials/passwordcredential.md) that encapsulates the user name and password as a parameter.
3435

36+
### -field ProvideAddress:32
37+
38+
TBD
39+
3540
## -remarks
3641
This value is a collection of flags. It is possible to have multiple values set for a single pairing action.
3742

‎windows.devices.enumeration/devicepairingrequestedeventargs_acceptwithaddress_1238468511.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
-api-id: M:Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.AcceptWithAddress(System.String)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Devices.Enumeration.DevicePairingRequestedEventArgs.AcceptWithAddress(System.String)
7+
8+
<!--
9+
public void AcceptWithAddress (string address);
10+
-->
11+
12+
13+
## -description
14+
15+
Accepts a [PairingRequested](deviceinformationcustompairing_pairingrequested.md) event with an address, and pairs the device with the application.
16+
17+
## -parameters
18+
19+
### -param address
20+
21+
TBD
22+
23+
## -remarks
24+
25+
## -see-also
26+
27+
## -examples

0 commit comments

Comments
 (0)