Contents

transferProvisionalHome(connectionDetails:targetHomeUniqueIdentifier:)

Transfers a temporary, provisional home to a person’s home hub.

Declaration

func transferProvisionalHome(connectionDetails: HMHome.ProvisionalHomeConnectionDetails, targetHomeUniqueIdentifier: UUID) async throws(HMHome.ProvisionalHomeTransferError) -> HMHome.ProvisionalHomeTransferResult

Parameters

  • connectionDetails:

    A structure containing the opaque token HomeKit uses to transfer a provisional home to a home hub.

  • targetHomeUniqueIdentifier:

    The UUID you obtain from the home installation server that identifies the destination home on a home hub. This UUID is distinct from a provisional home’s own identifier.

Return Value

Transfer results for each accessory, allowing you to identify a partially successful transfer.

Overview

When you transfer a temporary home to a person’s home hub, HomeKit encodes a snapshot of all paired accessories, creates a secure channel with the connection details’ transferToken, and uses the channel to send the snapshot to the home hub.

See Also

Providing installation services