Package com.esri.arcgisruntime.tasks.offlinemap

Class OfflineCapability

java.lang.Object

com.esri.arcgisruntime.tasks.offlinemap.OfflineCapability

public final class OfflineCapability
extends Object

Describes whether a layer or table can be included in an offline map.

Since:

100.1.0

See Also:

OfflineMapTask.getOfflineMapCapabilitiesAsync(GenerateOfflineMapParameters), OfflineMapCapabilities

Method Summary

Modifier and Type	Method	Description
ArcGISRuntimeException	getError()	Gets the error if the layer or table could not be included in the offline map, or null if no error occurred.
boolean	isRemainsOnline()	Indicates if this online only layer or table will be referenced from an offline map.
boolean	isSupportsOffline()	Indicates if the layer or table supports being taken offline.

Methods inherited from class java.lang.Object

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

Method Detail

getError

public ArcGISRuntimeException getError()

Gets the error if the layer or table could not be included in the offline map, or null if no error occurred.

Returns:

an ArcGISRuntimeException describing the error, or null if no error occurred for the layer or table

Since:

100.1.0

isSupportsOffline

public boolean isSupportsOffline()

Indicates if the layer or table supports being taken offline. Note that if this property is false and GenerateOfflineMapParameters.getOnlineOnlyServicesOption() is set to GenerateOfflineMapParameters.OnlineOnlyServicesOption.INCLUDE, the isRemainsOnline() property may indicate that the layer or table will remain online and be referenced by the offline map.

Returns:

true if the layer or table supports being taken offline, false if it doesn't support being taken offline or an error occurred when checking it

Since:

100.1.0

See Also:

getError()

isRemainsOnline

public boolean isRemainsOnline()

Indicates if this online only layer or table will be referenced from an offline map. This relates to the GenerateOfflineMapParameters.getOnlineOnlyServicesOption() property. If GenerateOfflineMapParameters.getOnlineOnlyServicesOption() is set to GenerateOfflineMapParameters.OnlineOnlyServicesOption.EXCLUDE, this property will always be false. If GenerateOfflineMapParameters.getOnlineOnlyServicesOption() is set to GenerateOfflineMapParameters.OnlineOnlyServicesOption.INCLUDE, this property may be true for layers that cannot be taken offline.

Returns:

indicates if this online only layer or table will be referenced from an offline map

Since:

100.9.0