Finish a navigation session
When reaching the final destination on the route or when the user cancels the turn-by-turn navigation, the session should be finished.
Mutation
To finish a navigation session, provide the navigation id and the current_location. When finishing a navigation session, updates or recalculations can no longer be done. If the mutation executed succesfully, OK will be returned on the data object. The status of the navigation session will be set to finished within the navigationUpdatedById subscription or the navigation query. When using a query, please be aware that changes can take a little while to process.
After the status has been set to finished make sure to also unsubscribe from any active navigationUpdatedById subscription.
Arguments
input • NavigationFinishInput
• Required
Navigation finish input
Response
A response can either contain a data or an
errors object. The response header will always return
200 as a status code.
Data object
When successful, a data object will be returned with the
requested fields. If there are no fields present the
data object will return the operation name with the
appropriate return type. If the operation was a query, this output
will be an object of the schema’s query root type; if the operation
was a mutation, this output will be an object of the schema’s mutation
root type.
Error object
If unsuccessful, an errors object will be returned with
more details in the extensions object. The error object
can contain any of the following objects.