<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.

Constant	Value	Description
`AspectRatioMode::IgnoreAspectRatio`	`Qt::AspectRatioMode::IgnoreAspectRatio`	The size is scaled freely. The aspect ratio is not preserved.
`AspectRatioMode::KeepAspectRatio`	`Qt::AspectRatioMode::KeepAspectRatio`	The size is scaled to a rectangle as large as possible inside a given rectangle, preserving the aspect ratio.
`AspectRatioMode::KeepAspectRatioByExpanding`	`Qt::AspectRatioMode::KeepAspectRatioByExpanding`	The 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.

Constant	Value	Description
`AuthenticationChallengeType::Unknown`	`0`	No authentication challenge type defined.
`AuthenticationChallengeType::UsernamePassword`	`1`	Authentication challenge type requiring username and/or password.
`AuthenticationChallengeType::OAuth`	`2`	Authentication challenge type requiring an OAuth authorization code.
`AuthenticationChallengeType::ClientCertificate`	`3`	Authentication challenge type requiring a client certificate.
`AuthenticationChallengeType::SslHandshake`	`4`	Authentication 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.

Constant	Value	Description
`AuthenticationType::Unknown`	`0`	No authentication type defined.
`AuthenticationType::Token`	`1`	Token-based authentication.
`AuthenticationType::HTTP`	`2`	HTTP Basic or Digest authentication.
`AuthenticationType::Certificate`	`3`	The 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:

Constant	Value	Description
`ExpirationType::Unknown`	`-1`	The expiration object is not valid. The package may not be loaded or may have no expiration.
`ExpirationType::AllowExpiredAccess`	`0`	The expiration is provided for warning purposes only. The package can still be used.
`ExpirationType::PreventExpiredAccess`	`1`	The 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.

Constant	Value	Description
`ItemType::Unknown`	`-1`	Unknown.
`ItemType::PortalItem`	`0`	Portal item.
`ItemType::LocalItem`	`1`	Local item.

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

enum class LicenseLevel

Enumerates the level of licensing used.

Constant	Value	Description
`LicenseLevel::Developer`	`0`	Licensed for developer use only.
`LicenseLevel::Lite`	`1`	Licensed for lite level deployment.
`LicenseLevel::Basic`	`2`	Licensed for basic level deployment.
`LicenseLevel::Standard`	`3`	Licensed for standard level deployment.
`LicenseLevel::Advanced`	`4`	Licensed 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.

Constant	Value	Description
`LicenseStatus::Invalid`	`0`	License is not valid.
`LicenseStatus::Expired`	`1`	License is expired.
`LicenseStatus::LoginRequired`	`2`	Login is required to license the app.
`LicenseStatus::Valid`	`3`	License is valid.

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

enum class LicenseType

Enumerates the possible license types that the application could be licensed as.

The LicenseType can be one of:

Constant	Value	Description
`LicenseType::Developer`	`0`	The license type has not been set and will run in developer mode.
`LicenseType::NamedUser`	`1`	Using a subscription license from a named user account.
`LicenseType::LicenseKey`	`2`	Licensed from a license string.

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

enum class LocalItemType

Enumerates the type of local item.

Constant	Value	Description
`LocalItemType::Unknown`	`-1`	Unknown.
`LocalItemType::MobileMap`	`0`	Mobile map.
`LocalItemType::MobileScene`	`1`	Mobile scene.
`LocalItemType::MobileMapPackage`	`2`	Mobile map package.
`LocalItemType::MobileScenePackage`	`3`	Mobile 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:

Constant	Value	Description
`LoginType::Unknown`	`-1`	Login type is unknown.
`LoginType::OAuth`	`0`	Login uses an OAuth 2.0 based workflow.
`LoginType::ClientCertificate`	`1`	Login uses a digital certificate to identify the user.
`LoginType::UsernamePassword`	`2`	Login 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.

Constant	Value	Description
`NetworkCachePolicy::AlwaysNetwork`	`QNetworkRequest::CacheLoadControl::AlwaysNetwork`	Always 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::PreferNetwork`	`QNetworkRequest::CacheLoadControl::PreferNetwork`	Load 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::PreferCache`	`QNetworkRequest::CacheLoadControl::PreferCache`	Load from cache if available, otherwise load from network. Note that this can return possibly stale (but not expired) items from cache.
`NetworkCachePolicy::AlwaysCache`	`QNetworkRequest::CacheLoadControl::AlwaysCache`	Only 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.

Constant	Value	Description
`OAuthMode::Unknown`	`0`	No mode specified.
`OAuthMode::User`	`1`	OAuth User authentication mode. Requires client ID.
`OAuthMode::App`	`2`	OAuth 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.

Constant	Value	Description
`SortOrder::Ascending`	`0`	Sorts fields in acending order.
`SortOrder::Descending`	`1`	Sorts 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:

Constant	Value	Description
`SpatialRelationship::Unknown`	`-1`	Unknown relationship. Normally the result when an error occurs.
`SpatialRelationship::Relate`	`0`	Matched a spatial relationship function.
`SpatialRelationship::Equals`	`1`	Geometries are equal.
`SpatialRelationship::Disjoint`	`2`	The intersection of the geometries is empty.
`SpatialRelationship::Intersects`	`3`	The geometries are not disjoint.
`SpatialRelationship::Touches`	`4`	The intersection of the geometries is not empty, while the intersection of their interiors is empty.
`SpatialRelationship::Crosses`	`5`	Two 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::Within`	`6`	The base geometry is equal to its intersection with the comparison geometry and the intersection of their interiors is not empty.
`SpatialRelationship::Contains`	`7`	Same relationship as SpatialRelationshipWithin, but with the base and comparison geometry roles swapped.
`SpatialRelationship::Overlaps`	`8`	The 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::EnvelopeIntersects`	`9`	The minimum bounding envelope of the two geometries have the SpatialRelationshipIntersects relationship.
`SpatialRelationship::IndexIntersects`	`10`	The 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:

Constant	Value	Description
`StatisticType::Average`	`0`	Returns the average for all non-null values in a column.
`StatisticType::Count`	`1`	Returns the number of non-null values in a column.
`StatisticType::Maximum`	`2`	Returns the maximum value found within a column.
`StatisticType::Minimum`	`3`	Returns the minimum value found within a column.
`StatisticType::StandardDeviation`	`4`	Returns the standard deviation of the values within a column.
`StatisticType::Sum`	`5`	Returns the sum of all non-null values within a column.
`StatisticType::Variance`	`6`	Returns 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:

Constant	Value	Description
`UnitSystem::Imperial`	`0`	Imperial units (feet, inches, and so on).
`UnitSystem::Metric`	`1`	Metric units (meters, centimeters, and so on).

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