Type Alias SDKErrorCode

SDKErrorCode: typeof sdkErrorCodes[number]

What went wrong, as an SDK error names it in its code.

A code that is also one of the TomTom Navigation SDK's common failures carries its name. The error's canRetry is true for the three whose condition clears on its own: RATE_LIMITED, LIVE_SERVICE_NOT_AVAILABLE and NETWORK_NOT_AVAILABLE.

Code	When
`INVALID_REQUEST`	The SDK's request validation failed, a service could not build a request sent with `validateRequest: false`, `discoverPlaces` found no category matching its `poiCategoryQuery`, or the API answered `400` or another `4xx` not below
`INSECURE_BASE_URL`	`commonBaseURL` is neither `https:` nor `http:` on a loopback address, checked even with `validateRequest: false`
`INVALID_CREDENTIALS`	The API answered `401`: the key is missing, invalid or expired
`INSUFFICIENT_PERMISSIONS`	The API answered `403`: the key is valid but not allowed this request, because that API is not enabled for it (a Private Preview API needs its access granted) or its domain restriction refused the page
`NOT_FOUND`	The API answered `404`, or `geocodeOne` or `discoverOnePlace` found no place
`RATE_LIMITED`	The API still answered `429` after the retries `retry` allows
`LIVE_SERVICE_NOT_AVAILABLE`	The API answered a `5xx`
`NETWORK_NOT_AVAILABLE`	No response arrived: offline, DNS, TLS or CORS failure
`ABORTED`	The call's `signal` was aborted
`WEBGL_UNSUPPORTED`	The browser cannot create the WebGL2 context the map draws with
`WEBGL_CONTEXT_LOST`	The browser took the map's WebGL context away, for example after a GPU reset
`STYLE_LOAD_FAILED`	The map style failed to load, and not because of an HTTP status above
`INTERNAL`	Anything else, such as a response the SDK could not read

Type Alias SDKErrorCode

Settings