Backgroundtasks

BackgroundTasks Documentation

Search these docs to answer questions about background task APIs.

Return Format

Always include: 1. Summary - Answer the question concisely 2. File paths - List relevant files for full details

Files

• backgroundtasks-index.md - Framework overview, task types
• bgtaskscheduler.md - Task scheduling and registration

Navigation: BackgroundTasks

Essentials

• Background Tasks updates
• BGTaskScheduler

Getting the shared task scheduler

• class var shared: BGTaskScheduler

Checking task requirements

• class var supportedResources: BGContinuedProcessingTaskRequest.Resources

Scheduling a task

• func register(forTaskWithIdentifier: String, using: dispatch_queue_t?, launchHandler: (BGTask) -> Void) -> Bool)
• func submit(BGTaskRequest) throws)

Canceling a task

• func cancel(taskRequestWithIdentifier: String))
• func cancelAllTaskRequests())

Getting all scheduled tasks

• [func getPendingTaskRequests(completionHandler: ([BGTaskRequest]) -> Void)](/documentation/backgroundtasks/bgtaskscheduler/getpendingtaskrequests(completionhandler:))

Handling errors

• BGTaskScheduler.Error

Getting the error codes

• BGTaskScheduler.Error.Code

Identifying an error

• case notPermitted
• case tooManyPendingTaskRequests
• case unavailable
• case immediateRunIneligible

Initializers

• init?(rawValue: Int))

• static var notPermitted: BGTaskScheduler.Error.Code
• static var tooManyPendingTaskRequests: BGTaskScheduler.Error.Code
• static var unavailable: BGTaskScheduler.Error.Code

Getting the error domain

• static var errorDomain: String

Type Properties

• static var immediateRunIneligible: BGTaskScheduler.Error.Code

• BGTaskScheduler.Error.Code

Identifying an error

• case notPermitted
• case tooManyPendingTaskRequests
• case unavailable
• case immediateRunIneligible

Initializers

• init?(rawValue: Int))

• class let errorDomain: String

• BGTask

Reading Task Information

• var identifier: String

Configuring a Task

• var expirationHandler: (() -> Void)?
• func setTaskCompleted(success: Bool))

Background tasks

• Using background tasks to update your app
• Refreshing and Maintaining Your App Using Background Tasks
• Choosing Background Strategies for Your App
• BGProcessingTask
• BGAppRefreshTask
• BGHealthResearchTask

Foreground tasks with background support

• Performing long-running tasks on iOS and iPadOS
• BGContinuedProcessingTask

Titling the task

• var title: String
• var subtitle: String
• func updateTitle(String, subtitle: String))

• Background GPU Access

Task requests

• BGProcessingTaskRequest

Initializing a Processing Task Request

• init(identifier: String))

Setting Task Request Options

• var requiresExternalPower: Bool
• var requiresNetworkConnectivity: Bool

• BGAppRefreshTaskRequest

Initializing a refresh task request

• init(identifier: String))

• BGTaskRequest

Configuring a Task Request

• var earliestBeginDate: Date?
• var identifier: String

• BGHealthResearchTaskRequest

Setting file permissions

• var protectionTypeOfRequiredData: NSString

• BGContinuedProcessingTaskRequest

Creating a task request

• init(identifier: String, title: String, subtitle: String))

Identifying resource dependencies

• var requiredResources: BGContinuedProcessingTaskRequest.Resources
• BGContinuedProcessingTaskRequest.Resources

Identiying a resource

• static var gpu: BGContinuedProcessingTaskRequest.Resources

Creating a resource

• init(rawValue: Int))

Choosing a processing strategy

• var strategy: BGContinuedProcessingTaskRequest.SubmissionStrategy
• BGContinuedProcessingTaskRequest.SubmissionStrategy

Choosing a strategy

• case fail
• case queue

Creating a strategy

• init?(rawValue: Int))

Titling the task

• var subtitle: String
• var title: String

Development and testing

• Starting and Terminating Tasks During Development

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.

Navigation: BackgroundTasks

Class

BGTaskScheduler

Available on: iOS 13.0+, iPadOS 13.0+, Mac Catalyst 13.1+, tvOS 13.0+, visionOS 1.0+

A class for scheduling tasks that add background support to your app’s most critical work.

class BGTaskScheduler

Overview

Background tasks give your app a way to run code even when the app is suspended:

• To register, schedule, and run tasks in the background, see Using background tasks to update your app.
• To submit work in the foreground that can finish even if the app moves to the background, see Performing long-running tasks on iOS and iPadOS.

Inherits From

• NSObject

Conforms To

• CVarArg
• CustomDebugStringConvertible
• CustomStringConvertible
• Equatable
• Hashable
• NSObjectProtocol

Getting the shared task scheduler

• shared The shared background task scheduler instance.

Checking task requirements

• supportedResources Additional system resources that a continuous background task can request.

Scheduling a task

• register(forTaskWithIdentifier:using:launchHandler:)) Register a launch handler for the task with the associated identifier that’s executed on the specified queue.
• submit(_:)) Submit a previously registered background task for execution.

Canceling a task

• cancel(taskRequestWithIdentifier:)) Cancel a previously scheduled task request.
• cancelAllTaskRequests()) Cancel all scheduled task requests.

Getting all scheduled tasks

• getPendingTaskRequests(completionHandler:)) Request a list of unexecuted scheduled task requests.

Handling errors

• BGTaskScheduler.Error The Errors for the BGTaskSchedulerError domain.
• BGTaskScheduler.Error.Code An enumeration of the task scheduling errors.
• errorDomain The background tasks error domain as a string.

Essentials

• Background Tasks updates Learn about important changes in Background Tasks.
• BGTask An abstract class for the framework’s tasks.

---

Extracted from Apple DocC JSON by apple-skills tooling. This is unofficial content. All documentation belongs to Apple Inc.