setRootTemplate(_:animated:completion:)

Sets the root template of the navigation hierarchy.

Declaration

func setRootTemplate(_ rootTemplate: CPTemplate, animated: Bool, completion: ((Bool, (any Error)?) -> Void)? = nil)

func setRootTemplate(_ rootTemplate: CPTemplate, animated: Bool) async throws -> Bool

Parameters

rootTemplate:
The template to use as the root of a new navigation hierarchy.
animated:
If True, CarPlay animates the presentation of the template. CarPlay ignores this flag when there isn’t an existing navigation hierarchy to replace.
completion:
The closure CarPlay calls after it presents the template.

Discussion

important:

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 declaration:

func setRootTemplate(_ rootTemplate: CPTemplate, animated: Bool) async throws -> Bool

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

If you set a root template when a navigation hierarchy already exists, CarPlay replaces the entire hierarchy.

CarPlay calls completion after it presents the template. The Boolean parameter is true when the presentation succeeds; otherwise, it’s false and CarPlay provides an error that describes the failure. CarPlay throws an exception if the presentation fails and you don’t provide a closure.

setRootTemplate(_:animated:completion:)

Declaration

Parameters

Discussion

See Also

Configuring the Interface Controller