enableCredentialSharingMode(forExtendedPANID:completion:)

Triggers Credential Share mode on a nearby eligible Apple Border Router (tvOS(27.0)).

Declaration

func enableCredentialSharingMode(forExtendedPANID extendedPANID: Data, completion: @escaping  @Sendable ((any Error)?) -> Void)

func enableCredentialSharingMode(forExtendedPANID extendedPANID: Data) async throws

Parameters

extendedPANID:
The extended PAN identifier of the Thread network.
completion:
The completion handler the framework calls once credential sharing mode has started. The error parameter is nil on success, or non-nil if credential sharing mode could not be enabled.

Discussion

This method scans for Thread credential sharing capable Apple Border Routers, selects an eligible device, and requests to generate an ephemeral 9-digit code and start credential sharing mode.

When you call this method, the ephemeral 9-digit code appears on screen along with a warning message; it is not returned to the caller.

note:

You can call this method from synchronous code using a completion handler, as shown on this page, or you can call it as an asynchronous method that has the following declarations:

// Completion handler form:
func enableCredentialSharingMode(forExtendedPANID extendedPANID: Data, completion: @escaping (Error?) -> Void)

// Async form (throws on failure):
func enableCredentialSharingMode(forExtendedPANID extendedPANID: Data) async throws

For information about concurrency and asynchronous code in Swift, see Calling Objective-C APIs Asynchronously.