Skip To Content ArcGIS for Developers Sign In Dashboard

<CoreTypes.h> - Core Enums

Collection of Core enumerations. More...

Header: #include <CoreTypes.h>

Types

enum class AspectRatioMode { IgnoreAspectRatio, KeepAspectRatio, KeepAspectRatioByExpanding }
enum class AuthenticationChallengeType { Unknown, UsernamePassword, OAuth, ClientCertificate, SslHandshake }
enum class AuthenticationType { Unknown, Token, HTTP, Certificate }
enum class ExpirationType { Unknown, AllowExpiredAccess, PreventExpiredAccess }
enum class ItemType { Unknown, PortalItem, LocalItem }
enum class LicenseLevel { Developer, Lite, Basic, Standard, Advanced }
enum class LicenseStatus { Invalid, Expired, LoginRequired, Valid }
enum class LicenseType { Developer, NamedUser, LicenseKey }
enum class LocalItemType { Unknown, MobileMap, MobileScene, MobileMapPackage, MobileScenePackage }
enum class LoginType { Unknown, OAuth, ClientCertificate, UsernamePassword }
enum class NetworkCachePolicy { AlwaysNetwork, PreferNetwork, PreferCache, AlwaysCache }
enum class OAuthMode { Unknown, User, App }
enum class SortOrder { Ascending, Descending }
enum class SpatialRelationship { Unknown, Relate, Equals, Disjoint, Intersects, …, IndexIntersects }
enum class StatisticType { Average, Count, Maximum, Minimum, StandardDeviation, …, Variance }
enum class UnitSystem { Imperial, Metric }

Detailed Description

Type Documentation

enum class AspectRatioMode

Enumerates the aspect ratio mode used.

ConstantValueDescription
AspectRatioMode::IgnoreAspectRatioQt::AspectRatioMode::IgnoreAspectRatioThe size is scaled freely. The aspect ratio is not preserved.
AspectRatioMode::KeepAspectRatioQt::AspectRatioMode::KeepAspectRatioThe size is scaled to a rectangle as large as possible inside a given rectangle, preserving the aspect ratio.
AspectRatioMode::KeepAspectRatioByExpandingQt::AspectRatioMode::KeepAspectRatioByExpandingThe size is expanded to a rectangle as small as possible outside given rectangle, preserving the aspect ratio.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class AuthenticationChallengeType

Enumerates types of authentication challenges.

ConstantValueDescription
AuthenticationChallengeType::Unknown0No authentication challenge type defined.
AuthenticationChallengeType::UsernamePassword1Authentication challenge type requiring username and/or password.
AuthenticationChallengeType::OAuth2Authentication challenge type requiring an OAuth authorization code.
AuthenticationChallengeType::ClientCertificate3Authentication challenge type requiring a client certificate.
AuthenticationChallengeType::SslHandshake4Authentication challenge type indicating one or more SSL errors have occurred.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class AuthenticationType

Enumerates supported authentication types for secured services.

ConstantValueDescription
AuthenticationType::Unknown0No authentication type defined.
AuthenticationType::Token1Token-based authentication.
AuthenticationType::HTTP2HTTP Basic or Digest authentication.
AuthenticationType::Certificate3The client certificate-based security. Requires setting a SSL configuration.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class ExpirationType

Enumerates the possible types of package expiration.

The ExpirationType can be one of:

ConstantValueDescription
ExpirationType::Unknown-1The expiration object is not valid. The package may not be loaded or may have no expiration.
ExpirationType::AllowExpiredAccess0The expiration is provided for warning purposes only. The package can still be used.
ExpirationType::PreventExpiredAccess1The expiration is mandatory and the package can no longer be used - for example, the resource will fail to load.

This enum was introduced or modified in Esri::ArcGISRuntime 100.5.

enum class ItemType

Enumerates the type of item.

ConstantValueDescription
ItemType::Unknown-1Unknown.
ItemType::PortalItem0Portal item.
ItemType::LocalItem1Local item.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class LicenseLevel

Enumerates the level of licensing used.

ConstantValueDescription
LicenseLevel::Developer0Licensed for developer use only.
LicenseLevel::Lite1Licensed for lite level deployment.
LicenseLevel::Basic2Licensed for basic level deployment.
LicenseLevel::Standard3Licensed for standard level deployment.
LicenseLevel::Advanced4Licensed for advanced level deployment.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class LicenseStatus

Enumerates the license status of a Runtime license.

ConstantValueDescription
LicenseStatus::Invalid0License is not valid.
LicenseStatus::Expired1License is expired.
LicenseStatus::LoginRequired2Login is required to license the app.
LicenseStatus::Valid3License is valid.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class LicenseType

Enumerates the license type of a Runtime license.

ConstantValueDescription
LicenseType::Developer0Licensed for developer use only.
LicenseType::NamedUser1License is a named-user license.
LicenseType::LicenseKey2License is a license key string.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class LocalItemType

Enumerates the type of local item.

ConstantValueDescription
LocalItemType::Unknown-1Unknown.
LocalItemType::MobileMap0Mobile map.
LocalItemType::MobileScene1Mobile scene.
LocalItemType::MobileMapPackage2Mobile map package.
LocalItemType::MobileScenePackage3Mobile scene package.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class LoginType

Supported login types for portal.

The LoginType can be one of:

ConstantValueDescription
LoginType::Unknown-1Login type is unknown.
LoginType::OAuth0Login uses an OAuth 2.0 based workflow.
LoginType::ClientCertificate1Login uses a digital certificate to identify the user.
LoginType::UsernamePassword2Login uses a username and password to identify the user.

This enum was introduced or modified in Esri::ArcGISRuntime 100.2.

enum class NetworkCachePolicy

Enumerates the cache behavior for requests.

ConstantValueDescription
NetworkCachePolicy::AlwaysNetworkQNetworkRequest::CacheLoadControl::AlwaysNetworkAlways load from network and do not check if the cache has a valid entry (similar to the "Reload" feature in browsers). In addition, force intermediate caches to re-validate.
NetworkCachePolicy::PreferNetworkQNetworkRequest::CacheLoadControl::PreferNetworkLoad from the network if the cached entry is older than the network entry. This will never return stale data from the cache, but revalidate resources that have become stale.
NetworkCachePolicy::PreferCacheQNetworkRequest::CacheLoadControl::PreferCacheLoad from cache if available, otherwise load from network. Note that this can return possibly stale (but not expired) items from cache.
NetworkCachePolicy::AlwaysCacheQNetworkRequest::CacheLoadControl::AlwaysCacheOnly load from cache, indicating error if the item was not cached (i.e., off-line mode).

This enum was introduced or modified in Esri::ArcGISRuntime 100.8.

enum class OAuthMode

Enumerates the supported modes for logging in using OAuth.

ConstantValueDescription
OAuthMode::Unknown0No mode specified.
OAuthMode::User1OAuth User authentication mode. Requires client ID.
OAuthMode::App2OAuth App authentication mode. Requires client ID and client secret.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SortOrder

Enumerates the sort order in a query on a FeatureTable.

ConstantValueDescription
SortOrder::Ascending0Sorts fields in acending order.
SortOrder::Descending1Sorts fields in descending order.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SpatialRelationship

Enumerates different types of spatial relationships between geometries that can be tested for.

Geometry tests compare a base (first) geometry to a comparison (second) geometry, though for most relationships, this order does not matter.

The SpatialRelationship can be one of:

ConstantValueDescription
SpatialRelationship::Unknown-1Unknown relationship.
SpatialRelationship::Relate0Matched a spatial relationship function.
SpatialRelationship::Equals1Geometries are equal.
SpatialRelationship::Disjoint2The intersection of the geometries is empty.
SpatialRelationship::Intersects3The geometries are not disjoint.
SpatialRelationship::Touches4The intersection of the geometries is not empty, while the intersection of their interiors is empty.
SpatialRelationship::Crosses5Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and a polygon cross if they share a polyline in common on the interior of the polygon which is not equivalent to the entire polyline.
SpatialRelationship::Within6The base geometry is equal to its intersection with the comparison geometry and the intersection of their interiors is not empty.
SpatialRelationship::Contains7Same relationship as SpatialRelationshipWithin, but with the base and comparison geometry roles swapped.
SpatialRelationship::Overlaps8The dimension of both geometries and the intersection of the geometries are all the same, and intersection of the geometries is not equal to either of the geometries. (See Esri::ArcGISRuntime::Geometry for description of dimension.)
SpatialRelationship::EnvelopeIntersects9The minimum bounding envelope of the two geometries have the SpatialRelationshipIntersects relationship.
SpatialRelationship::IndexIntersects10The base geometry intersects one or more spatial index entries for the comparison geometry, indicating that the geometries may intersect or are close to each other.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

See also Esri::ArcGISRuntime::Geometry.

enum class StatisticType

An enumeration that represents the various statistics that can be calculated for values in a field in a table.

The StatisticType can be one of:

ConstantValueDescription
StatisticType::Average0Returns the average for all non-null values in a column.
StatisticType::Count1Returns the number of non-null values in a column.
StatisticType::Maximum2Returns the maximum value found within a column.
StatisticType::Minimum3Returns the minimum value found within a column.
StatisticType::StandardDeviation4Returns the standard deviation of the values within a column.
StatisticType::Sum5Returns the sum of all non-null values within a column.
StatisticType::Variance6Returns the variance of the values within a column.

This enum was introduced or modified in Esri::ArcGISRuntime 100.2.

enum class UnitSystem

Enumerates the unit system.

The UnitSystem can be one of:

ConstantValueDescription
UnitSystem::Imperial0Imperial units (feet, inches, and so on).
UnitSystem::Metric1Metric units (meters, centimeters, and so on).

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.


Feedback on this topic?