onlineOnlyServicesOption property

OnlineOnlyServicesOption onlineOnlyServicesOption

Describes how data that requires an online service will be handled when taking a map offline.

Online layers and tables cannot be taken offline in the following situations:

  • The layer or table is using a service that cannot be taken offline. For example, WmsLayer or WmtsLayer.
  • The layer or table is using a service that supports offline, such as an ArcGISFeatureLayer, but synchronization has not been enabled on the service (FeatureServiceCapabilities.supportsSync is set to false). Services utilize synchronization to take layers and tables offline and synchronize changes.

Online services that cannot be taken offline are referred to as online-only services. Online-only services require network connectivity and may involve authentication. Examples of online-only services include:

  • Dynamic information, such as changing weather or traffic conditions, that delivers frequent and regular updates to the app
  • Large datasets that would be impractical to take offline to a device

This property allows you to specify how online-only data will be handled when taking the map offline. There are three options:

  • OnlineOnlyServicesOption.exclude means that any data that cannot be taken offline will be omitted from the offline map. Choosing this option means that your offline map will not require a network connection but may not include all of the data from the original web map.
  • OnlineOnlyServicesOption.include means that data that cannot be taken offline will be accessed via the URL in the offline map. Choosing this option means that your offline map will retain all of the information from the original web map, but it will require a network connection and may require authentication.
  • OnlineOnlyServicesOption.useAuthoredSettings means that layers and tables will be taken offline, remain online or be omitted from the offline map according to the map author's intent as defined in the web map

The default value is OnlineOnlyServicesOption.exclude.

Implementation

OnlineOnlyServicesOption get onlineOnlyServicesOption {
  final coreValue = _withThrowingErrorHandler((errorHandler) {
    return runtimecore
        .RT_GenerateOfflineMapParameters_getOnlineOnlyServicesOption(
            _handle, errorHandler);
  });
  return OnlineOnlyServicesOption._fromCoreValue(coreValue);
}
void onlineOnlyServicesOption=(OnlineOnlyServicesOption value)

Implementation

set onlineOnlyServicesOption(OnlineOnlyServicesOption value) {
  _withThrowingErrorHandler((errorHandler) {
    runtimecore.RT_GenerateOfflineMapParameters_setOnlineOnlyServicesOption(
        _handle, value.coreValue, errorHandler);
  });
}