topic_index.md

Topic Index

Use this index to find documentation for specific topics and keywords.

A

• Absolute path: File Storage & Locations - why to avoid them on mobile
• Authentication: Callbacks & Auth - managing tokens and auth headers

B

• Background execution: README - general introduction
• BaseDirectory: File Storage & Locations - choosing where to store files
• Batch: Downloads - enqueueing multiple files (see enqueueAll in Database & Monitoring)
• Bypassing permissions: Permissions - for iOS compile time

C

• Cache directory: Configuration - correct usage on Android
• Cancel: Lifecycle - canceling tasks
• Callbacks: Database & Monitoring - using callbacks for status updates
• Central monitoring: Database & Monitoring - monitoring all tasks in one place
• Cleanup: Database & Monitoring - managing database size
• Configuration: Configuration - global settings
• Content-Disposition: Downloads - using server suggested filenames
• Content URI: URIs - working with Android content providers
• Cookies: Requests - handling session cookies

D

• Database: Database & Monitoring - persistent task tracking
• DataTask: Requests - background server requests (no file)
• Debug: Configuration - bypassing TLS for local testing
• Directory: File Storage & Locations - specifying subdirectories
• DownloadTask: Downloads - creating a download task

E

• Enqueue: Database & Monitoring - starting background tasks
• External storage: Configuration - using SD cards on Android

F

• Filename: File Storage & Locations - naming your files
• File Picker: URIs - letting users choose files
• Foreground service: Configuration - long running tasks on Android
• Form fields: Uploads - uploading data with files

G

• Group: Lifecycle - managing bunches of tasks together

H

• Headers: Parameters - adding HTTP headers
• Holding Queue: Lifecycle - limiting concurrency

I

• iOS: README - setup and info

L

• Listeners: Database & Monitoring - streaming status updates
• Localization: Configuration - translating notification buttons

M

• Metadata: Parameters - storing user data with tasks
• Mime type: Uploads - specifying file types
• Monitoring: Database & Monitoring - tracking progress and status
• Multi-part upload: Uploads - uploading multiple files

N

• Notifications: Notifications - showing status to users

O

• Open file: Notifications - opening files on tap

P

• Parallel downloads: Downloads - chunked downloads
• Parameters: Parameters - optional task settings
• Pause: Lifecycle - pausing downloads
• Permissions: Permissions - handling user permissions
• Pickers: URIs - file and directory pickers
• Post: Parameters - sending data with requests
• Priority: Parameters - task priority and UIDT
• Progress: Database & Monitoring - tracking progress
• Proxy: Configuration - setting a network proxy

Q

• Queue: Lifecycle - managing the task queue

R

• Request: Requests - simple HTTP requests
• Resume: Lifecycle - resuming downloads
• Retries: Parameters - automatic retries

S

• Shared storage: File Storage & Locations - Photos, Downloads, etc.
• Server suggested filename: Downloads - using names from headers
• Start: Database & Monitoring - initializing the downloader
• Storage: File Storage & Locations - where files go

T

• Task: Downloads - base object for all operations
• Timeout: Configuration - setting timeouts
• Tracking: Database & Monitoring - tracking tasks
• TLS: Configuration - certificate validation

U

• UIDT: Parameters - User Initiated Data Transfer (Android 14+)
• UploadTask: Uploads - creating an upload task
• URI: URIs - working with URIs instead of files

W

• WiFi: Parameters - restricting to WiFi