One Logo Pool Ball
Foundation · IOS API REFERENCE

ProgressManager

class · iOS 27.0+ · SDK 27.1

@dynamicMemberLookup final class ProgressManager

An object that conveys ongoing progress to the user for a specified task.

Members (13)

get · iOS 27.0+

isFinished

TypeScript
get isFinished(): boolean
Swift declaration
final var isFinished: Bool { get }

The state of completion of work. If `completedCount` >= `totalCount`, the value will be `true`.

init · iOS 27.0+

init

TypeScript
static init(totalCount?: (number) | null): ProgressManager
Swift declaration
convenience init(totalCount: Int?)

Initializes `self` with `totalCount`. If `totalCount` is set to `nil`, `self` is indeterminate. - Parameter totalCount: Total units of work.

get · iOS 27.0+

totalCount

TypeScript
get totalCount(): (number) | null
Swift declaration
final var totalCount: Int? { get }

The total units of work.

get · iOS 27.0+

description

TypeScript
get description(): string
Swift declaration
final var description: String { get }

A description.

get · iOS 27.0+

completedCount

TypeScript
get completedCount(): number
Swift declaration
final var completedCount: Int { get }

The completed units of work.

get · iOS 27.0+

isIndeterminate

TypeScript
get isIndeterminate(): boolean
Swift declaration
final var isIndeterminate: Bool { get }

The state of initialization of `totalCount`. If `totalCount` is `nil`, the value will be `true`.

get · iOS 27.0+

debugDescription

TypeScript
get debugDescription(): string
Swift declaration
final var debugDescription: String { get }

A debug description.

get · iOS 27.0+

fractionCompleted

TypeScript
get fractionCompleted(): number
Swift declaration
final var fractionCompleted: Double { get }

The proportion of work completed. This takes into account the fraction completed in its children instances if children are present. If `self` is indeterminate, the value will be 0.0.

method · iOS 27.0+

assign

TypeScript
assignCountTo(count: number, reporter: ProgressReporter): void
Swift declaration
final func assign(count: Int, to reporter: ProgressReporter)

Adds a `ProgressReporter` as a child, with its progress representing a portion of `self`'s progress. If a cycle is detected, this will cause a crash at runtime. - Parameters: - count: Units, which is a portion of `totalCount`delegated to an instance of `Subprogress`. - reporter: A `ProgressReporter` instance.

method · iOS 27.0+

assign

TypeScript
assignCountTo33533(count: number, progress: Progress): void
Swift declaration
final func assign(count: Int, to progress: Progress)

Adds a Foundation's `Progress` instance as a child which constitutes a certain `count` of `self`'s `totalCount`. - Parameters: - count: Number of units delegated from `self`'s `totalCount`. - progress: `Progress` which receives the delegated `count`.

method · iOS 27.0+

complete

TypeScript
complete(count: number): void
Swift declaration
final func complete(count: Int)

Increases `completedCount` by `count`. - Parameter count: Units of work.

get · iOS 27.0+

reporter

TypeScript
get reporter(): ProgressReporter
Swift declaration
final var reporter: ProgressReporter { get }

A `ProgressReporter` instance, used for providing read-only observation of progress updates or composing into other `ProgressManager`s.

method · iOS 27.0+

setCounts

TypeScript
setCounts(counts: ((arg0: number, arg1: (number) | null) => void)): void
Swift declaration
final func setCounts(_ counts: (inout Int, inout Int?) -> Void)

Skipped declarations

15 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

ProgressManager.subprogress(assigningCount:)

The iOS SDK compiler rejected this binding: instance method 'out' requires that 'Subprogress' be a class type

ProgressManager.subscript(dynamicMember:)

Passing a Swift type itself is not supported.

ProgressManager.subscript(dynamicMember:)

Passing a Swift type itself is not supported.

ProgressManager.subscript(dynamicMember:)

Passing a Swift type itself is not supported.

ProgressManager.subscript(dynamicMember:)

Passing a Swift type itself is not supported.

ProgressManager.subscript(dynamicMember:)

Passing a Swift type itself is not supported.

ProgressManager.subscript(dynamicMember:)

Passing a Swift type itself is not supported.

ProgressManager.subscript(dynamicMember:)

Passing a Swift type itself is not supported.

ProgressManager.summary(of:)

Passing a Swift type itself is not supported.

ProgressManager.summary(of:)

Passing a Swift type itself is not supported.

ProgressManager.summary(of:)

Passing a Swift type itself is not supported.

ProgressManager.summary(of:)

Passing a Swift type itself is not supported.

ProgressManager.summary(of:)

Passing a Swift type itself is not supported.

ProgressManager.summary(of:)

Passing a Swift type itself is not supported.

ProgressManager.summary(of:)

Passing a Swift type itself is not supported.

All Foundation types →