TomTom Maps for JavaScript
    Preparing search index...

    Type Alias APIErrorDetails

    What a TomTom API said about a request it failed, as a service's SDKServiceError and the map's TomTomMapError both carry it.

    type APIErrorDetails = {
        apiErrorCode?: string;
        privatePreviewAccess?: PrivatePreviewAccess;
    }

    Implemented by

    Index
    apiErrorCode? privatePreviewAccess?
    apiErrorCode?: string

    The API's own name for the error, from its detailedError.code, when its response carries one.

    On an INSUFFICIENT_PERMISSIONS it tells the causes apart: 'Forbidden' when the API is not enabled for the key, 'InvalidReferer' when the key's domain restriction refused the page.

    privatePreviewAccess?: PrivatePreviewAccess

    The access the API key lacks, on an INSUFFICIENT_PERMISSIONS from a Private Preview API, such as Calculate Reachable Range or the Landmarks 3D tiles, that named no other cause. The message names it too.

    Settings
    Member Visibility

    On This Page
    Properties