Technologies›App Extensions & System Integration

AppMigrationKit

iOSmacOStvOSwatchOSvisionOS

AppMigrationKit lets your app participate in data export and import when users migrate apps between devices or platforms on iOS. You build an app extension that conforms to AppMigrationExtension and implement the ResourcesExporting and ResourcesImporting protocols to package and restore your app's data, using types such as ResourcesArchiver, MigrationDataContainer, and ResourcesImportRequest to move resources across a MigrationPlatform. The framework also models the migration request and its lifecycle through MigrationRequestWithOptions, MigrationStatus, and MigrationDefaultSupportedOptions, and provides AppMigrationTester to exercise your extension.

Essentials 1

The app extension entry point your app implements to take part in migration.

  • Pr
    AppMigrationExtensioniOS 26.0+
    An app extension you extend to participate in data export and import.

Exporting Resources 3

Protocols and an archiver you use to package your app's data for export.

  • Pr
    ResourcesExportingiOS 26.0+
    A protocol for exporting transportable resources in a streaming archive format when the destination platform doesn't require special migration options.
  • Pr
    ResourcesExportingWithOptionsiOS 26.0+
    A protocol for exporting transportable resources in an archive format.
  • Cl
    ResourcesArchiveriOS 26.0+
    An object your app uses to archive resources during an export operation.

Importing Resources 2

The protocol and request type you use to restore your app's data on the destination.

  • Pr
    ResourcesImportingiOS 26.0+
    A protocol for exporting transportable resources in a streaming archive format.
  • St
    ResourcesImportRequestiOS 26.0+
    A type that exposes properties of the resources import request.

Migration Data and Targets 3

Value types that identify the app, carry its data, and describe the destination platform.

  • St
    MigrationAppIdentifieriOS 26.0+
    A type that identifies an app on a different platform.
  • St
    MigrationDataContaineriOS 26.0+
    An object describing an app's data container
  • St
    MigrationPlatformiOS 26.0+
    A type that identifies the platform used by the other device in a migration.

Requests and Status 3

Types that model a migration request, its options, and its lifecycle.

  • St
    MigrationRequestWithOptionsiOS 26.0+
    An object that exposes properties of the migration request.
  • En
    MigrationDefaultSupportedOptionsiOS 26.0+
    Options supported by default for migration requests.
  • En
    MigrationStatusiOS 26.0+
    A type the containing app uses to determine the status of a completed import.

Testing 1

A utility for exercising your migration extension during development.

  • Ac
    AppMigrationTesteriOS 26.0+
    A test-only type your app uses to test app migration extensions.

Type Aliases 1

  • Ty
    MigrationRequest
    A migration request that uses the default supported options.
← App Extensions & System Integration