core/com.tealium.prism.core.api.network

Package-level declarations

Types

Provides access to the current connectivity status of the device either synchronously through calling isConnected or by observing through connectionStatus.

CooldownHelper

class CooldownHelper

A helper class to keep track of a cooldown period based on errors occurring.

DeserializedNetworkCallback

typealias DeserializedNetworkCallback<T> = NetworkCallback<TealiumResult<NetworkHelper.HttpValue<T>>>

HttpMethod

data class HttpMethod(val value: String)

Simple data class to hold the Http Method name of an Http request.

HttpRequest

class HttpRequest

Represents the data for an HTTP request

HttpResponse

data class HttpResponse(val url: URL, val statusCode: Int, val message: String, val headers: Map<String, List<String>>, val body: ByteArray? = null)

Represents the response data for an HTTP response

NetworkCallback

typealias NetworkCallback<T> = Callback<T>

NetworkClient

interface NetworkClient

Utility class for making asynchronous Http requests.

NetworkException

sealed class NetworkException : TealiumIOException

Return type to signify that an error has occurred. The type returned indicates what type of error has occurred, and the isRetryable implementation will indicate if it is safe to retry the request.

NetworkHelper

interface NetworkHelper

Utility interface for making basic async network requests. For more complex requirements, use the NetworkClient instead.

NetworkResult

sealed class NetworkResult

Describes the available results of a network request.

NetworkUtilities

class NetworkUtilities(connectivity: Connectivity, val networkClient: NetworkClient, val networkHelper: NetworkHelper, logger: Logger) : Connectivity

Utility class to group networking utilities onto a single object for a given com.tealium.prism.core.Tealium instance

RequestInterceptor

interface RequestInterceptor

Interface for intercepting network responses and deciding whether a request is retried.

RequestInterceptors

object RequestInterceptors

Utility object for getting the built-in RequestInterceptors, to add to a client derived with NetworkClient.newClient.

ResourceCache

interface ResourceCache<T : DataItemConvertible>

Utility class to automatically manage reading and writing resources from a DataStore as well as providing etag storage support.

ResourceRefresher

interface ResourceRefresher<T : DataItemConvertible>

A utility class to repeatedly fetch some resource

RetryAfterAboveMaxDelay

enum RetryAfterAboveMaxDelay : Enum<RetryAfterAboveMaxDelay>

What an interceptor does when a retryable failure has a Retry-After header longer than the interceptor's maximum delay.

RetryPolicy

sealed class RetryPolicy

The RetryPolicy returned by a RequestInterceptor to decide if and when a failed request is retried.