OfflineRegion (Trimble MAPS Maps SDK for Android 0.9.39 Reference)

java.lang.Object
- com.trimblemaps.mapsdk.offline.OfflineRegion

```
public class OfflineRegion
extends java.lang.Object
```
An offline region is the basic building block for offline mobile maps. Use OfflineManager.CreateOfflineRegionCallback to create a new offline region.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`OfflineRegion.DownloadState`	A region is either inactive (not downloading, but previously-downloaded resources are available for use), or active (resources are being downloaded or will be downloaded, if necessary, when network access is available).
`static interface`	`OfflineRegion.OfflineRegionDeleteCallback`	This callback receives an asynchronous response containing a notification when an offline region has been deleted, or a `String` error message otherwise.
`static interface`	`OfflineRegion.OfflineRegionInvalidateCallback`	This callback receives an asynchronous response containing a notification when an offline region has been invalidated, or a `String` error message otherwise.
`static interface`	`OfflineRegion.OfflineRegionObserver`	A region can have a single observer, which gets notified whenever a change to the region's status occurs.
`static interface`	`OfflineRegion.OfflineRegionStatusCallback`	This callback receives an asynchronous response containing the OfflineRegionStatus of the offline region, or a `String` error message otherwise.
`static interface`	`OfflineRegion.OfflineRegionUpdateMetadataCallback`	This callback receives an asynchronous response containing the newly update OfflineMetadata in the database, or an error message otherwise.

Field Summary

Fields
Modifier and Type Field Description

static int STATE_ACTIVE

static int STATE_INACTIVE

Fields
Modifier and Type	Field	Description
`static int`	`STATE_ACTIVE`
`static int`	`STATE_INACTIVE`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`delete(OfflineRegion.OfflineRegionDeleteCallback callback)`	Remove an offline region from the database and perform any resources evictions necessary as a result.
`protected void`	`finalize()`
`OfflineRegionDefinition`	`getDefinition()`
`long`	`getID()`
`byte[]`	`getMetadata()`
`void`	`getStatus(OfflineRegion.OfflineRegionStatusCallback callback)`	Retrieve the current status of the region.
`void`	`invalidate(OfflineRegion.OfflineRegionInvalidateCallback callback)`	Invalidate all the tiles from an offline region forcing TrimbleMaps GL to revalidate the tiles with the server before using.
`boolean`	`isDeliveringInactiveMessages()`	Gets whether or not the `OfflineRegionObserver` will continue to deliver messages even if the region state has been set as STATE_INACTIVE.
`void`	`setDeliverInactiveMessages(boolean deliverInactiveMessages)`	When set true, the `OfflineRegionObserver` will continue to deliver messages even if the region state has been set as STATE_INACTIVE (operations happen asynchronously).
`void`	`setDownloadState(int state)`	Pause or resume downloading of regional resources.
`void`	`setObserver(OfflineRegion.OfflineRegionObserver observer)`	Register an observer to be notified when the state of the region changes.
`void`	`updateMetadata(byte[] bytes, OfflineRegion.OfflineRegionUpdateMetadataCallback callback)`	Update an offline region metadata from the database.

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

- Field Detail
  - STATE_INACTIVE
```
public static final int STATE_INACTIVE
```
    See Also:
    
    Constant Field Values
  - STATE_ACTIVE
```
public static final int STATE_ACTIVE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isDeliveringInactiveMessages
```
public boolean isDeliveringInactiveMessages()
```
    Gets whether or not the `OfflineRegionObserver` will continue to deliver messages even if the region state has been set as STATE_INACTIVE.
    
    Returns:
    
    true if delivering inactive messages
  - setDeliverInactiveMessages
```
public void setDeliverInactiveMessages(boolean deliverInactiveMessages)
```
    When set true, the `OfflineRegionObserver` will continue to deliver messages even if the region state has been set as STATE_INACTIVE (operations happen asynchronously). If set false, the client won't be notified of further messages.
    
    Parameters:
    
    deliverInactiveMessages - true if it should deliver inactive messages
  - getID
```
public long getID()
```
  - getDefinition
```
public OfflineRegionDefinition getDefinition()
```
  - getMetadata
```
public byte[] getMetadata()
```
  - setObserver
```
public void setObserver(@Nullable
                        OfflineRegion.OfflineRegionObserver observer)
```
    Register an observer to be notified when the state of the region changes.
    
    Parameters:
    
    observer - the observer to be notified
  - setDownloadState
```
public void setDownloadState(int state)
```
    Pause or resume downloading of regional resources.
    After a download has been completed, you are required to reset the state of the region to STATE_INACTIVE.
    
    Parameters:
    
    state - the download state
  - getStatus
```
public void getStatus(@NonNull
                      OfflineRegion.OfflineRegionStatusCallback callback)
```
    Retrieve the current status of the region. The query will be executed asynchronously and the results passed to the given callback which will be executed on the main thread.
    
    Parameters:
    
    callback - the callback to invoked.
  - delete
```
public void delete(@NonNull
                   OfflineRegion.OfflineRegionDeleteCallback callback)
```
    Remove an offline region from the database and perform any resources evictions necessary as a result.
    Eviction works by removing the least-recently requested resources not also required by other regions, until the database shrinks below a certain size.
    
    When the operation is complete or encounters an error, the given callback will be executed on the main thread.
    Note that this operation can be potentially slow if packing the database occurs automatically (OfflineManager.runPackDatabaseAutomatically(boolean))
    After you call this method, you may not call any additional methods on this object.
    
    Parameters:
    
    callback - the callback to be invoked
  - invalidate
```
public void invalidate(@Nullable
                       OfflineRegion.OfflineRegionInvalidateCallback callback)
```
    Invalidate all the tiles from an offline region forcing TrimbleMaps GL to revalidate the tiles with the server before using. This is more efficient than deleting the offline region and downloading it again because if the data on the cache matches the server, no new data gets transmitted.
    
    Parameters:
    
    callback - the callback to be invoked
  - updateMetadata
```
public void updateMetadata(@NonNull
                           byte[] bytes,
                           @NonNull
                           OfflineRegion.OfflineRegionUpdateMetadataCallback callback)
```
    Update an offline region metadata from the database.
    When the operation is complete or encounters an error, the given callback will be executed on the main thread.
    
    Parameters:
    
    bytes - the metadata in bytes
    
    callback - the callback to be invoked
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object

Class OfflineRegion

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_INACTIVE

STATE_ACTIVE

Method Detail

isDeliveringInactiveMessages

setDeliverInactiveMessages

getID

getDefinition

getMetadata

setObserver

setDownloadState

getStatus

delete

invalidate

updateMetadata

finalize