OfflineCapability Class

  • OfflineCapability
  • class Esri::ArcGISRuntime::OfflineCapability

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

    Header: #include <OfflineCapability>
    Since: Esri::ArcGISRuntime 100.1

    This class was introduced in Esri::ArcGISRuntime 100.1.

    Public Functions

    OfflineCapability(Esri::ArcGISRuntime::OfflineCapability &&other)
    OfflineCapability(const Esri::ArcGISRuntime::OfflineCapability &other)
    Esri::ArcGISRuntime::OfflineCapability &operator=(Esri::ArcGISRuntime::OfflineCapability &&other)
    Esri::ArcGISRuntime::OfflineCapability &operator=(const Esri::ArcGISRuntime::OfflineCapability &other)
    Esri::ArcGISRuntime::Error error() const
    bool isEmpty() const
    bool isRemainsOnline() const
    bool isSupportsOffline() const

    Detailed Description

    Member Function Documentation

    OfflineCapability::OfflineCapability(Esri::ArcGISRuntime::OfflineCapability &&other)

    Move constructor from other OfflineCapability.

    OfflineCapability::OfflineCapability(const Esri::ArcGISRuntime::OfflineCapability &other)

    Copy constructor from other OfflineCapability.

    Esri::ArcGISRuntime::OfflineCapability &OfflineCapability::operator=(Esri::ArcGISRuntime::OfflineCapability &&other)

    Move operator from other OfflineCapability.

    Esri::ArcGISRuntime::OfflineCapability &OfflineCapability::operator=(const Esri::ArcGISRuntime::OfflineCapability &other)

    Assignment operator from other OfflineCapability.



    Esri::ArcGISRuntime::Error OfflineCapability::error() const

    Returns the associated error if the layer or table could not be included in the offline map. Otherwise returns nullptr.

    bool OfflineCapability::isEmpty() const

    Returns whether this object is empty.

    bool OfflineCapability::isRemainsOnline() const

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

    This relates to the GenerateOfflineMapParameters::onlineOnlyServicesOption property. If GenerateOfflineMapParameters::onlineOnlyServicesOption is set to OnlineOnlyServicesOption::Exclude, this property will always be false. If GenerateOfflineMapParameters::onlineOnlyServicesOption is set to OnlineOnlyServicesOption::Include, this property may be true for layers that cannot be taken offline.

    This function was introduced in Esri::ArcGISRuntime 100.9.

    bool OfflineCapability::isSupportsOffline() const

    Returns whether this layer or table supports being taken offline.

    Note that if this property is false and the GenerateOfflineMapParameters::onlineOnlyServicesOption is set to OnlineOnlyServicesOption::Include, the OfflineCapability::isRemainsOnline property may indicate that the layer or table will remain online and be referenced by the offline map.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.