Microsoft Windows 10

Microsoft Windows 10 Background Transfers API

The Background Transfers API from Microsoft Windows 10 — 1 operation(s) for background transfers.

Documentation GitHub OpenAPI

Documentation

https://learn.microsoft.com/en-us/uwp/api/

https://learn.microsoft.com/en-us/windows/uwp/get-started/

https://learn.microsoft.com/en-us/windows/win32/apiindex/windows-api-list

https://learn.microsoft.com/en-us/windows/win32/desktop-programming

https://learn.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts

https://learn.microsoft.com/en-us/windows/ai/windows-ml/api-reference

https://learn.microsoft.com/en-us/windows/ai/windows-ml/get-started

https://learn.microsoft.com/en-us/uwp/api/windows.storage

https://learn.microsoft.com/en-us/windows/uwp/files/

https://learn.microsoft.com/en-us/cortana/voice-commands/vcd

https://learn.microsoft.com/en-us/uwp/api/windows.ui.input.inking

https://learn.microsoft.com/en-us/windows/uwp/design/input/pen-and-stylus-interactions

https://learn.microsoft.com/en-us/windows/uwp/composition/visual-layer

https://learn.microsoft.com/en-us/windows/uwp/composition/using-the-visual-layer-with-xaml

https://learn.microsoft.com/en-us/windows/win32/directx

https://learn.microsoft.com/en-us/windows/win32/getting-started-with-directx-graphics

https://learn.microsoft.com/en-us/windows/apps/develop/audio-video-camera

https://learn.microsoft.com/en-us/windows/win32/medfound/audio-video-capture-in-media-foundation

https://learn.microsoft.com/en-us/windows/uwp/networking/which-networking-technology

https://learn.microsoft.com/en-us/windows/uwp/devices-sensors/bluetooth-dev-faq

https://learn.microsoft.com/en-us/windows/win32/bluetooth/bluetooth-programming-with-windows-sockets

https://learn.microsoft.com/en-us/uwp/api/windows.devices.geolocation

https://learn.microsoft.com/en-us/windows/win32/sensorsapi/introduction-to-the-sensor-and-location-platform-in-windows

https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello

https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello-auth-service

https://learn.microsoft.com/en-us/windows/apps/winui/winui2/

https://learn.microsoft.com/en-us/windows/apps/winui/winui2/getting-started

https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-windows-10/refs/heads/main/openapi/microsoft-windows-10-background-transfers-api-openapi.yml

Other Resources

https://github.com/Microsoft/Windows-universal-samples

https://learn.microsoft.com/en-us/uwp/api/

https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/

https://learn.microsoft.com/en-us/windows/win32/api/

https://github.com/microsoft/Windows-classic-samples

https://github.com/WindowsNotifications/quickstart-sending-local-toast-win10

https://learn.microsoft.com/en-us/uwp/api/windows.ui.notifications

https://learn.microsoft.com/en-us/windows/ai/windows-ml/tutorials

https://github.com/Microsoft/Windows-Machine-Learning

https://learn.microsoft.com/en-us/windows/uwp/files/best-practices-for-writing-to-files

https://learn.microsoft.com/en-us/cortana/voice-commands/voicecommand-design-guidelines

https://github.com/Microsoft/Windows-universal-samples/tree/master/Samples/SimpleInk

https://learn.microsoft.com/en-us/uwp/api/windows.ui.composition

https://github.com/microsoft/Windows.UI.Composition-Win32-Samples

https://github.com/microsoft/DirectX-Graphics-Samples

https://microsoft.github.io/DirectX-Specs/

https://learn.microsoft.com/en-us/uwp/api/windows.media.capture

https://learn.microsoft.com/en-us/uwp/api/windows.networking.sockets

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/websocket/

https://learn.microsoft.com/en-us/windows/win32/api/_bluetooth/

https://learn.microsoft.com/en-us/windows/win32/locationapi/windows-location-api-portal

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/geolocation/

https://learn.microsoft.com/en-us/uwp/api/windows.devices.sensors

https://learn.microsoft.com/en-us/windows/security/identity-protection/hello-for-business/webauthn-apis

https://learn.microsoft.com/en-us/windows/winui/api/microsoft.ui.xaml.controls

https://github.com/microsoft/microsoft-ui-xaml

https://learn.microsoft.com/en-us/samples/microsoft/windows-universal-samples/backgroundtask/

OpenAPI Specification

openapi: 3.1.0
info:
  title: Microsoft Windows 10 Windows Background Tasks Accelerometer Background Transfers API
  description: API for running code in the background when an application is suspended or not running. Based on the Windows.ApplicationModel.Background namespace, it supports time-triggered, system-triggered, and maintenance-triggered background tasks. Key classes include BackgroundTaskBuilder, BackgroundTaskRegistration, SystemTrigger, TimeTrigger, and BackgroundTaskCompletedEventArgs.
  version: 1.0.0
  contact:
    name: Microsoft Developer Support
    url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks
  license:
    name: Microsoft Software License
    url: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://api.windows.com
  description: Windows Platform API
tags:
- name: Background Transfers
paths:
  /networking/background-transfers/downloads:
    post:
      operationId: createBackgroundDownload
      summary: Microsoft Windows 10 Create a background download
      description: Creates a background download operation using BackgroundDownloader. Background transfers continue even when the app is suspended and support progress tracking, pause/resume, and cost-aware transfers.
      tags:
      - Background Transfers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundDownloadRequest'
      responses:
        '201':
          description: Background download created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundTransferOperation'
        '400':
          description: Invalid download request
    get:
      operationId: listBackgroundDownloads
      summary: Microsoft Windows 10 List background downloads
      description: Retrieves the list of active and pending background download operations using BackgroundDownloader.GetCurrentDownloadsAsync.
      tags:
      - Background Transfers
      responses:
        '200':
          description: Successful retrieval of downloads
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackgroundTransferOperation'
components:
  schemas:
    BackgroundDownloadRequest:
      type: object
      properties:
        uri:
          type: string
          format: uri
          description: Source URI
        destinationFile:
          type: string
          description: Destination file path
        costPolicy:
          type: string
          enum:
          - Default
          - UnrestrictedOnly
          - Always
          default: Default
        priority:
          type: string
          enum:
          - Default
          - High
          - Low
          default: Default
      required:
      - uri
      - destinationFile
    BackgroundTransferOperation:
      type: object
      properties:
        id:
          type: string
        uri:
          type: string
          format: uri
        destinationFile:
          type: string
        status:
          type: string
          enum:
          - Idle
          - Running
          - PausedByApplication
          - PausedCostedNetwork
          - PausedNoNetwork
          - Completed
          - Canceled
          - Error
        progress:
          type: object
          properties:
            bytesReceived:
              type: integer
              format: int64
            totalBytesToReceive:
              type: integer
              format: int64
externalDocs:
  description: Background Tasks Documentation
  url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks