Contents

pop(to:animated:completion:)

Removes each template from the navigation hierarchy until the specified template becomes visible.

Declaration

func pop(to targetTemplate: CPTemplate, animated: Bool, completion: ((Bool, (any Error)?) -> Void)? = nil)
func pop(to targetTemplate: CPTemplate, animated: Bool) async throws -> Bool

Parameters

  • targetTemplate:

    The template to make visible.

  • animated:

    If True, CarPlay animates the transition between templates.

  • completion:

    The closure CarPlay calls after it removes the required templates.

Discussion

targetTemplate must exist in the navigation hierarchy. You can use templates to access its contents.

CarPlay calls completion after it removes the required templates. The Boolean parameter is true if the specified template exists in the navigation hierarchy and CarPlay removes the required templates successfully; otherwise, it’s false and CarPlay provides an error that describes the failure.

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

See Also

Adding and Removing Templates