popTemplate(animated:completion:)

Removes the top-most template from the navigation hierarchy.

Declaration

func popTemplate(animated: Bool, completion: ((Bool, (any Error)?) -> Void)? = nil)

func popTemplate(animated: Bool) async throws -> Bool

Parameters

animated:
If True, CarPlay animates the transition between templates.
completion:
The closure CarPlay calls after it removes 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 popTemplate(animated: Bool) async throws -> Bool

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

CarPlay calls completion after it removes the top-most template from the navigation hierarchy. The Boolean parameter is true if CarPlay removes the template successfully; otherwise, it’s false and CarPlay provides an error that describes the failure.

CarPlay throws an exception if it can’t remove the template and you don’t provide a closure.

popTemplate(animated:completion:)

Declaration

Parameters

Discussion

See Also

Adding and Removing Templates