@@ -23,26 +23,61 @@ The project root folder contains the Visual Studio 2015 solution (.sln) and all
---
### \WindowsDevicePortalWrapper
The WindowsDevicePortalWrapper folder contains the Visual Studio 2015 c# project (.csproj), the source code required to build the DLL and a setttings file used by [StyleCop](http://stylecop.codeplex.com).
### \WindowsDevicePortalWrapper.Shared
The WindowsDevicePortalWrapper.Shared folder is a code only project that contains platform independent code for accessing the Windows Device Portal. Large methods use conditional compilation blocks for platform specific code. Small methods requiring platform specific code are duplicated into source files residing in the folders containing that platform's .csproj file.
#### DevicePortal.cs
Implements public properties and establishes a connection to the device.
The root file for the Microsoft.Tools.WindowsDevicePortal.DevicePortal class.
Events:
(All events are part of the DevicePortal class)
* ConnectionStatus
Properties:
(All properties are part of the DevicePortal class)
* Address
* ConnectionHttpStatusCode
* DeviceFamily
* OperatingSystemVersion
* Platform
* PlatformName
Methods:
(All methods are part of the DevicePortal class)
* DevicePortal()
* Connect()
* SendConnectionStatus()
#### Utilities.cs
A static class providing utility functions utilized throughout the Windows Device Portal Wrapper project.
#### Settings.StyleCop
#### WindowsDevicePortalWrapper.csproj
Methods:
(All methods are part of the Utilities class)
* BuildEndpoint()
* Hex64Encode()
---
### \WindowsDevicePortalWrapper\Core
### \WindowsDevicePortalWrapper.Shared\Core
The Core sub-folder contains the implementation of methods supported by all Windows Device Portal platforms.
#### AppDeployment.cs
Events:
(All events are part of the DevicePortal class)
* AppInstallStatus
Methods:
(All methods are part of the DevicePortal class)
* CopyInstallationFileToStream()
* CreateAppInstallEndpointAndBoundaryString()
* GetInstalledAppPackages()
* InstallApplication()
* UninstallApplication()
* SendAppInstallStats()
Defines the data contract used by the application deployment methods.
#### AppFileExplorer.cs
#### DeviceManager.cs
@@ -73,23 +108,25 @@ The Core sub-folder contains the implementation of methods supported by all Wind
---
### \WindowsDevicePortalWrapper\Events
### \WindowsDevicePortalWrapper.Shared\Events
The Interfaces sub-folder contains events defined by the Windows Device Portal Wrapper and their associated event arg classes.
#### ApplicationInstallStatus.cs
#### ConnectionStatus.cs
#### WebSocketMessageReceivedEventArgs.cs
---
### \WindowsDevicePortalWrapper\Exceptions
### \WindowsDevicePortalWrapper.Shared\Exceptions
The Interfaces sub-folder contains the exceptions defined by the Windows Device Portal Wrapper.
#### DevicePortalException.cs
---
### \WindowsDevicePortalWrapper\HoloLens
### \WindowsDevicePortalWrapper.Shared\HoloLens
The HoloLens sub-folder contains the implmentation of HoloLens specific Windows Device Portal methods.
#### HolographicOs.cs
@@ -106,29 +143,57 @@ The HoloLens sub-folder contains the implmentation of HoloLens specific Windows
---
### \WindowsDevicePortalWrapper\HttpRest
### \WindowsDevicePortalWrapper.Shared\HttpRest
The HttpRest sub-folder contains methods used to send requests and receive data from the Windows Device Portal's REST API.
#### CsrfToken.cs
Provides CSRF token management support.
Methods:
(All methods are part of the DevicePortal class)
* ApplyCsrfToken()
Sets the CSRF token header on the HTTP request.
* RetrieveCsrfToken
Gets the CSRF token header value from the HTTP response and stores it for future use.
#### RestDelete.cs
Methods:
(All methods are part of the DevicePortal class)
* Delete()
#### RestGet.cs
Methods:
(All methods are part of the DevicePortal class)
* Get<T>()
#### RestPost.cs
Methods:
(All methods are part of the DevicePortal class)
* Post()
#### RestPut.cs
#### ServerCertificateValidation.cs
Methods:
(All methods are part of the DevicePortal class)
* Put()
* Put<T>()
#### WebSocket.cs
---
### \WindowsDevicePortalWrapper\Interfaces
### \WindowsDevicePortalWrapper.Shared\Interfaces
The Interfaces sub-folder contains the definitions of interfaces defined by the Windows Device Portal Wrapper.
#### IDevicePortalConnection.cs
Defines the IDevicePortalConnection interface, for which an implementation must be provided by tools which consume the Windows Device Portal Wrapper.
---
### \WindowsDevicePortalWrapper\Xbox
### \WindowsDevicePortalWrapper.Shared\Xbox
The Xbox sub-folder contains the implmentation of Xbox One specific Windows Device Portal methods.
#### SmbShare.cs
@@ -139,6 +204,111 @@ The Xbox sub-folder contains the implmentation of Xbox One specific Windows Devi
---
### \WindowsDevicePortalWrapper
The WindowsDevicePortalWrapper folder contains the references and files required to build a the Windows Device Portal Wrapper project targeting version 4.5.2 of the .net framework.
#### CertificateHandling.cs
Methods:
(All methods are part of the DevicePortal class)
* GetDeviceCertificate()
* ServerCertificateValidation()
* ServerCertificateNonValidation()
---
### \WindowsDevicePortalWrapper\Core
The WindowsDevicePortalWrapper\Core folder contains the .net 4.5.2 specific Core Device Portal API functionality.
#### AppDeployment.cs
Methods:
(All methods are part of the DevicePortal class)
* GetInstallStatus()
---
### \WindowsDevicePortalWrapper\HttpRest
The WindowsDevicePortalWrapper\Core folder contains the .net 4.5.2 specific HTTP REST functionality.
#### RestDelete.cs
Methods:
(All methods are part of the DevicePortal class)
* Delete(Uri)
#### RestGet.cs
Methods:
(All methods are part of the DevicePortal class)
* Get(Uri)
#### RestPost.cs
Methods:
(All methods are part of the DevicePortal class)
* Post(Uri)
#### RestPut.cs
Methods:
(All methods are part of the DevicePortal class)
* Put(Uri)
---
### \WindowsDevicePortalWrapper.UniversalWindows
The WindowsDevicePortalWrapper.UnversalWindows folder contains the references and files required to build a the Windows Device Portal Wrapper project targeting the Windows 10 Universal Windows Platform.
The WindowsDevicePortalWrapper\Core folder contains the Universal Windows Platform specific HTTP REST functionality.
#### RestDelete.cs
Methods:
(All methods are part of the DevicePortal class)
* Delete(Uri)
#### RestGet.cs
Methods:
(All methods are part of the DevicePortal class)
* Get(Uri)
#### RestPost.cs
Methods:
(All methods are part of the DevicePortal class)
* Post(Uri)
#### RestPut.cs
Methods:
(All methods are part of the DevicePortal class)
* Put(Uri)
---
### Core methods
Please see the [Windows Device Portal Core API reference](https://msdn.microsoft.com/en-us/windows/uwp/debug-test-perf/device-portal-api-core) for additional information.
