Package com.cloudinary.android.policy

Class UploadPolicy

java.lang.Object

com.cloudinary.android.policy.UploadPolicy

Direct Known Subclasses:

GlobalUploadPolicy

public class UploadPolicy
extends java.lang.Object

Represents the set of conditions that must be met for a request to execute. Note: A request will be executed regardless of policy once the TimeWindow expires.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UploadPolicy.BackoffPolicy	Enum to define the backoff policy for request rescheduling.
static class	UploadPolicy.Builder	A utility class to construct an instance of UploadPolicy.
static class	UploadPolicy.NetworkType	Enum to define requirements for network.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UploadPolicy(UploadPolicy.NetworkType networkType, boolean requiresCharging, boolean requiresIdle, int maxErrorRetries, long backoffMillis, UploadPolicy.BackoffPolicy backoffPolicy)	Use UploadPolicy.Builder to configure and get an instance of UploadPolicy.

Method Summary

Modifier and Type	Method	Description
static UploadPolicy	defaultPolicy()
long	getBackoffMillis()
UploadPolicy.BackoffPolicy	getBackoffPolicy()
int	getMaxErrorRetries()	Maximum retries before failing the request permanently.
UploadPolicy.NetworkType	getNetworkType()	UploadPolicy.NetworkType required to execute the request.
boolean	hasRequirements()
boolean	isRequiresCharging()	Whether charging is required to execute the request.
boolean	isRequiresIdle()	Whether the phone needs to be idle to execute the request.
UploadPolicy.Builder	newBuilder()	Get a new builder with the configuration copied from this policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UploadPolicy

protected UploadPolicy(UploadPolicy.NetworkType networkType, boolean requiresCharging, boolean requiresIdle, int maxErrorRetries, long backoffMillis, UploadPolicy.BackoffPolicy backoffPolicy)

Use UploadPolicy.Builder to configure and get an instance of UploadPolicy.

Method Details

defaultPolicy

public static UploadPolicy defaultPolicy()

Returns:

An instance of UploadPolicy get the default configuration.

getNetworkType

public UploadPolicy.NetworkType getNetworkType()

UploadPolicy.NetworkType required to execute the request.

isRequiresCharging

public boolean isRequiresCharging()

Whether charging is required to execute the request.

isRequiresIdle

public boolean isRequiresIdle()

Whether the phone needs to be idle to execute the request.

getMaxErrorRetries

public int getMaxErrorRetries()

Maximum retries before failing the request permanently.

getBackoffPolicy

public UploadPolicy.BackoffPolicy getBackoffPolicy()

getBackoffMillis

public long getBackoffMillis()

hasRequirements

public boolean hasRequirements()

newBuilder

public UploadPolicy.Builder newBuilder()

Get a new builder with the configuration copied from this policy.