com.tomtom.sdk.search:search-common/com.tomtom.sdk.search.common.error/SearchFailure

SearchFailure

abstract class SearchFailure

Failure that can occur during search operations.

Parameters

message

Error message providing more context about the failure.

canRetry

Indicates whether the failed operation can be retried. For example, transient server errors (5xx) and rate limiting (429) are typically retryable, while client errors (4xx) are not. Defaults to false.

Inheritors

Types

Link copied to clipboard
class ApiKeyFailure(val message: String = API_KEY_ERROR_MESSAGE) : SearchFailure

Failure related to problems with the API key used for authentication.

Link copied to clipboard
class BadInputFailure(val message: String) : SearchFailure

Failure due to invalid or incorrect input parameters.

Link copied to clipboard
class CancelFailure(val message: String) : SearchFailure

Failure when a search request is cancelled.

Link copied to clipboard
object Companion

Contains the default values for the SearchFailure class.

Link copied to clipboard
class DeserializationFailure(val message: String) : SearchFailure

Failure due to unsuccessful deserialization of an online JSON response.

Link copied to clipboard
class HttpFailure(val httpErrorCode: Int, val message: String) : SearchFailure

Failure where an online REST API call returned an unexpected HTTP status code.

Link copied to clipboard
open class NetworkFailure(val message: String) : SearchFailure

Failure caused by a network-related issue.

Link copied to clipboard
class OfflineMapFailure(val message: String) : SearchFailure

Failure related to issues with the offline map data.

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open override fun toString(): String

Returns a string representation of the SearchFailure instance.