Microsoft Windows 10

Microsoft Windows 10 Files API

The Files API from Microsoft Windows 10 — 2 operation(s) for files.

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-files-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 Files 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: Files
paths:
  /storage/files:
    get:
      operationId: listStorageFiles
      summary: Microsoft Windows 10 List storage files
      description: Retrieves files from a specified storage location. Uses StorageFolder.GetFilesAsync to enumerate files with optional query options for filtering by type, date, size, and other properties.
      tags:
      - Files
      parameters:
      - name: folderId
        in: query
        required: false
        description: Known folder identifier (Documents, Pictures, Music, Videos)
        schema:
          type: string
          enum:
          - Documents
          - Pictures
          - Music
          - Videos
          - Downloads
          - LocalAppData
          - RoamingAppData
          - TempState
      - name: fileType
        in: query
        required: false
        description: Filter by file extension (e.g., .jpg, .mp3)
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of files
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StorageFile'
        '403':
          description: Access denied to the specified location
  /storage/files/{fileId}:
    get:
      operationId: getStorageFile
      summary: Microsoft Windows 10 Get file details
      description: Retrieves detailed information about a specific file using StorageFile properties including name, path, size, date created, date modified, content type, file attributes, and storage provider information.
      tags:
      - Files
      parameters:
      - name: fileId
        in: path
        required: true
        description: Unique file identifier or path
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of file details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageFileDetail'
        '404':
          description: File not found
    delete:
      operationId: deleteStorageFile
      summary: Microsoft Windows 10 Delete a file
      description: Deletes a file using StorageFile.DeleteAsync. Supports permanent deletion or moving to the Recycle Bin as specified by the StorageDeleteOption.
      tags:
      - Files
      parameters:
      - name: fileId
        in: path
        required: true
        description: Unique file identifier
        schema:
          type: string
      - name: option
        in: query
        required: false
        description: Delete option
        schema:
          type: string
          enum:
          - Default
          - PermanentDelete
      responses:
        '204':
          description: File deleted successfully
        '404':
          description: File not found
        '403':
          description: Access denied
components:
  schemas:
    StorageFile:
      type: object
      description: A storage file (StorageFile class)
      properties:
        name:
          type: string
          description: File name with extension
        path:
          type: string
          description: Full file path
        displayName:
          type: string
          description: File name without extension
        fileType:
          type: string
          description: File extension
        contentType:
          type: string
          description: MIME content type
        dateCreated:
          type: string
          format: date-time
        isAvailable:
          type: boolean
          description: Whether the file content is available locally
      required:
      - name
      - path
    StorageFileDetail:
      type: object
      description: Detailed file information
      properties:
        name:
          type: string
        path:
          type: string
        displayName:
          type: string
        fileType:
          type: string
        contentType:
          type: string
        dateCreated:
          type: string
          format: date-time
        dateModified:
          type: string
          format: date-time
        size:
          type: integer
          format: int64
          description: File size in bytes
        attributes:
          type: array
          items:
            type: string
            enum:
            - Normal
            - ReadOnly
            - Directory
            - Archive
            - Temporary
            - LocallyIncomplete
          description: FileAttributes flags
        provider:
          type: object
          properties:
            id:
              type: string
            displayName:
              type: string
          description: StorageProvider information
externalDocs:
  description: Background Tasks Documentation
  url: https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/applifecycle/background-tasks