ad_sdk/com.adition.ad_sdk.api.entities.exception/AdError

AdError

sealed class AdError

The SDK error type.

Contains all errors types that may occur in the SDK with a short description. In addition, each error type may contain additional useful parameters.

Note: If you are a custom renderer developer and need to send a custom error to the application, you can use AdError.CustomRendererError.

Inheritors

Types

AdIsNotLoaded

data object AdIsNotLoaded : AdError

The error is related to the inability to perform an action because the Advertisement is not loaded.

AdLoadingInProgress

data object AdLoadingInProgress : AdError

The error is related to the inability to perform an action because the Advertisement is in the loading state.

AssetWithIdNotFound

data class AssetWithIdNotFound(val assetId: String) : AdError

SDK cannot find the asset with the passed id.

BannerNotFound

data object BannerNotFound : AdError

There are no banners matching specified targeting criteria.

CacheOverflow

data class CacheOverflow(val dataSize: ULong, var cacheSize: ULong) : AdError

An attempt to write a file that is larger than the cache size.

CacheReadAction

data class CacheReadAction(val path: String, val message: String) : AdError

Occurs when the SDK cannot read bytes at the specified path.

CacheReadDenied

data class CacheReadDenied(val path: String, val message: String) : AdError

Occurs when the SDK does not have read access to the file.

CacheRemoveAction

data class CacheRemoveAction(val path: String, var message: String) : AdError

The error is related to an attempt to delete a file or folder from the disc.

CacheWriteAction

data class CacheWriteAction(val path: String, var message: String) : AdError

The error is related to an attempt to write a file to a disc or create a folder.

ClientIssue

data class ClientIssue(val statusCode: Int) : AdError

An error relating to the server response.

Configuration

data object Configuration : AdError

The error is related to an attempt to call AdServiceProvider.get before AdServiceProvider.configure.

CustomRendererError

data class CustomRendererError(val message: String) : AdError

Custom renderer error.

Decoding

data class Decoding(val exception: Exception) : AdError

Error related to data decoding.

Encoding

data class Encoding(val exception: Exception) : AdError

Error related to data encoding.

HostConnectionIssue

data class HostConnectionIssue(val message: String) : AdError

An error related to the host connection issue.

InvalidAssetName

data class InvalidAssetName(val name: String) : AdError

An issue with creating a cache path with a passed file name.

InvalidContentType

data object InvalidContentType : AdError

The ad server responded with an invalid ContentType header field.

InvalidTargetURL

data class InvalidTargetURL(val url: String) : AdError

Validation error for the URL associated with the tap.

MalformedURL

data object MalformedURL : AdError

An error related to the URL.

MismatchPlacementType

data class MismatchPlacementType(val rendererName: String, val contentUnit: String?, val learningTag: Map<String, String>?) : AdError

The error is caused by an incorrect match between the passed and received placement type.

ReachabilityUnavailable

data object ReachabilityUnavailable : AdError

An error related to the internet connection.

RedirectProcessing

data class RedirectProcessing(val message: String) : AdError

The error is related to the redirect process.

ServerErrorResponse

data class ServerErrorResponse(val message: String) : AdError

An error from the ad server with a message.

ServerIssue

data class ServerIssue(val statusCode: Int) : AdError

An error relating to the server response.

TimedOut

data object TimedOut : AdError

An error related to the timed out request.

UnknownRenderer

data class UnknownRenderer(val rendererName: String) : AdError

The renderer name received from the server is not registered.

UnknownStatusCode

data class UnknownStatusCode(val statusCode: Int) : AdError

An error relating to the server response.

UnspecifiedNetworkError

data class UnspecifiedNetworkError(val exception: Exception) : AdError

An error related to network error which is not handled by the SDK.

Properties

description

val description: String

Short error description.