DialReceiverApp
DialReceiverApp
DialReceiverApp
DialReceiverApp
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.]
Provides a mechanism for server apps to supply requested data to the DIAL REST service, which can be queried by client apps.
public : sealed class DialReceiverApp : IDialReceiverApppublic sealed class DialReceiverApp : IDialReceiverAppPublic NotInheritable Class DialReceiverApp Implements IDialReceiverApp// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
Get an instance of this class by accessing the Current property.
Properties
Current Current Current Current
Prerelease. Gets an instance of the DialReceiverApp class.
public : static DialReceiverApp Current { get; }public static DialReceiverApp Current { get; }Public Static ReadOnly Property Current As DialReceiverApp// You can use this property in JavaScript.
An instance of the DialReceiverApp class.
Methods
GetAdditionalDataAsync() GetAdditionalDataAsync() GetAdditionalDataAsync() GetAdditionalDataAsync()
Prerelease. Retrives the a map of key/value pairs representing the data previously set with SetAdditionalDataAsync.
public : IAsyncOperation<IMap<PlatForm::String, PlatForm::String>> GetAdditionalDataAsync()public IAsyncOperation<IDictionary<string, string>> GetAdditionalDataAsync()Public Function GetAdditionalDataAsync() As IAsyncOperation( Of IDictionarystring, string )// You can use this method in JavaScript.
A map of key/value pairs representing the data previously set with SetAdditionalDataAsync.
SetAdditionalDataAsync(IIterable<>>)
SetAdditionalDataAsync(IIterable<>>)
SetAdditionalDataAsync(IIterable<>>)
SetAdditionalDataAsync(IIterable<>>)
Prerelease. Used by the server app to send a set of data in key/value pairs to the DIAL REST service so that it can be queried from a client app.
public : IAsyncAction SetAdditionalDataAsync(IIterable<IKeyValuePair<PlatForm::String, PlatForm::String>> additionalData)public IAsyncAction SetAdditionalDataAsync(IEnumerable<KeyValuePair<String, String>> additionalData)Public Function SetAdditionalDataAsync(additionalData As IEnumerable<KeyValuePair<String, String>>) As IAsyncAction// You can use this method in JavaScript.
- additionalData
- IIterable<IKeyValuePair<PlatForm::String, PlatForm::String>> IEnumerable<KeyValuePair<String, String>> IEnumerable<KeyValuePair<String, String>> IEnumerable<KeyValuePair<String, String>>
The set of key/value pairs to send to the DIAL REST service.
Clients retrieve the additional data by making an HTTP GET request to the DIAL REST service application URL. UWP client apps can perform this task by calling DialDevice.GetDialApp followed by DialApp.GetAppStateAsync, and then accessing the DialAppStateDetails.FullXml property to retrieve the additional data. The additional data is added to the DIAL app XML in accordance with the DIAL specification.