All Implemented Interfaces:
```
public final class RemoteFile

                    
```
Remote file
A remote file is used when we need to download content from a remote location and keep a local cached copy of it. It also supports expiring the cached copy or using a fallback local file if there is no connection available.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`remoteFileContent`
`private final String`	`cacheFileDateKey`
`private final String`	`remoteFileURL`
`private final Boolean`	`validateRemoteFileAsJSON`
`private final String`	`cacheFileName`
`private final Integer`	`cacheFileExpirationInSeconds`
`private final String`	`fallbackFilePathInAssets`
`private final Boolean`	`isUpdateCacheImmediately`
`private Long`	`updateTimeout`
`private Boolean`	`isBlockUntilUpdated`

Constructor Summary

Constructors
Constructor	Description
`RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets, Boolean isUpdateCacheImmediately, Long updateTimeout, Boolean isBlockUntilUpdated)`
`RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets, Boolean isUpdateCacheImmediately, Long updateTimeout)`
`RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets, Boolean isUpdateCacheImmediately)`
`RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getRemoteFileContent()`	Content of the remote file
`final Unit`	`setRemoteFileContent(String remoteFileContent)`	Content of the remote file
`final String`	`getCacheFileDateKey()`	Shared preferences key to hold the date when the cache file was last updated
`final String`	`getRemoteFileURL()`	URL of the file to download
`final Boolean`	`getValidateRemoteFileAsJSON()`	Whether the downloaded file should be validated as JSON before being returned and cached
`final String`	`getCacheFileName()`	File name to use when caching the remote file locally
`final Integer`	`getCacheFileExpirationInSeconds()`	Number of seconds before refreshing the local cache
`final String`	`getFallbackFilePathInAssets()`	Name of a file in the assets/ folder to use as fall back if there is no connection and no cached version
`final Boolean`	`isUpdateCacheImmediately()`	Whether the cache should be updated from remote immediately if needed (blocking operation).
`final Long`	`getUpdateTimeout()`	Timeout before abandon getting file content from remote, in milliseconds
`final Unit`	`setUpdateTimeout(Long updateTimeout)`	Timeout before abandon getting file content from remote, in milliseconds
`final Boolean`	`isBlockUntilUpdated()`	Whether to try getting content from remote without timeout
`final Unit`	`setBlockUntilUpdated(Boolean isBlockUntilUpdated)`	Whether to try getting content from remote without timeout
`final Boolean`	`shouldRetryCacheUpdate()`
`final Boolean`	`isCacheEnabled()`
`final Boolean`	`isRemoteEnabled()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteFile

RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets, Boolean isUpdateCacheImmediately, Long updateTimeout, Boolean isBlockUntilUpdated)

RemoteFile

RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets, Boolean isUpdateCacheImmediately, Long updateTimeout)

RemoteFile

RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets, Boolean isUpdateCacheImmediately)

RemoteFile

RemoteFile(String remoteFileURL, Boolean validateRemoteFileAsJSON, String cacheFileName, Integer cacheFileExpirationInSeconds, String fallbackFilePathInAssets)

Method Detail
- getRemoteFileContent
```
 final String getRemoteFileContent()
```
  Content of the remote file
- setRemoteFileContent
```
 final Unit setRemoteFileContent(String remoteFileContent)
```
  Content of the remote file
- getCacheFileDateKey
```
 final String getCacheFileDateKey()
```
  Shared preferences key to hold the date when the cache file was last updated
- getRemoteFileURL
```
 final String getRemoteFileURL()
```
  URL of the file to download
- getValidateRemoteFileAsJSON
```
 final Boolean getValidateRemoteFileAsJSON()
```
  Whether the downloaded file should be validated as JSON before being returned and cached
- getCacheFileName
```
 final String getCacheFileName()
```
  File name to use when caching the remote file locally
- getCacheFileExpirationInSeconds
```
 final Integer getCacheFileExpirationInSeconds()
```
  Number of seconds before refreshing the local cache
- getFallbackFilePathInAssets
```
 final String getFallbackFilePathInAssets()
```
  Name of a file in the assets/ folder to use as fall back if there is no connection and no cached version
- isUpdateCacheImmediately
```
 final Boolean isUpdateCacheImmediately()
```
  Whether the cache should be updated from remote immediately if needed (blocking operation). Otherwise, if a cache exists, it is not updated and needs to be updated later.
- getUpdateTimeout
```
 final Long getUpdateTimeout()
```
  Timeout before abandon getting file content from remote, in milliseconds
- setUpdateTimeout
```
 final Unit setUpdateTimeout(Long updateTimeout)
```
  Timeout before abandon getting file content from remote, in milliseconds
- isBlockUntilUpdated
```
 final Boolean isBlockUntilUpdated()
```
  Whether to try getting content from remote without timeout
- setBlockUntilUpdated
```
 final Unit setBlockUntilUpdated(Boolean isBlockUntilUpdated)
```
  Whether to try getting content from remote without timeout
- shouldRetryCacheUpdate
```
 final Boolean shouldRetryCacheUpdate()
```
- isCacheEnabled
```
 final Boolean isCacheEnabled()
```
- isRemoteEnabled
```
 final Boolean isRemoteEnabled()
```

Class RemoteFile

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RemoteFile

RemoteFile

RemoteFile

RemoteFile

Method Detail

getRemoteFileContent

setRemoteFileContent

getCacheFileDateKey

getRemoteFileURL

getValidateRemoteFileAsJSON

getCacheFileName

getCacheFileExpirationInSeconds

getFallbackFilePathInAssets

isUpdateCacheImmediately

getUpdateTimeout

setUpdateTimeout

isBlockUntilUpdated

setBlockUntilUpdated

shouldRetryCacheUpdate

isCacheEnabled

isRemoteEnabled