Skip To Content ArcGIS for Developers Sign In Dashboard

Expiration Class

(Esri::ArcGISRuntime::Expiration)

Expiration details, that indicate whether a given package is out of date. More...

Header: #include <Expiration>
Since: Esri::ArcGISRuntime 100.5

Public Functions

Expiration(const Expiration &other)
Expiration(Expiration &&other)
~Expiration()
QDateTime dateTime() const
bool isEmpty() const
bool isExpired() const
QString message() const
Esri::ArcGISRuntime::ExpirationType type() const
Expiration &operator=(const Expiration &other)
Expiration &operator=(Expiration &&other)

Detailed Description

Expiration details, that indicate whether a given package is out of date.

Expiration details can indicate that the package in question:

Note: You cannot create an object of this class.

Member Function Documentation

Expiration::Expiration(const Expiration &other)

Copy constructor from other Expiration.

Expiration::Expiration(Expiration &&other)

Move constructor from other Expiration.

Expiration::~Expiration()

Destructor.

QDateTime Expiration::dateTime() const

Gets the date and time when the package will expire.

This property is in Unix time (milliseconds since Epoch) using UTC.

If this Expiration object isEmpty, returns a null QDateTime.

bool Expiration::isEmpty() const

Gets whether this Expiration object is empty.

Returns true if empty.

bool Expiration::isExpired() const

Returns whether the current package has expired.

This property shows whether the given package was expired at the time it was loaded. Subsequent checks can be made by performing a comparison of the current time against the dateTime property.

If this Expiration object isEmpty, returns false.

QString Expiration::message() const

Gets an accompanying message which provides contextual information when the package has expired.

The message could indicate the reasons for expiration or where an up-to-date version of the data can be obtained from. The author of the package may have configured the message to contain raw text, hyperlinks or HTML.

The message can be empty.

If this Expiration object isEmpty, returns an empty QString.

Esri::ArcGISRuntime::ExpirationType Expiration::type() const

Gets the type of expiration for the given package.

This property indicates what expiration entails for a given package. That is, when the package expires:

If this Expiration object isEmpty, returns ExpirationType::Unknown.

Expiration &Expiration::operator=(const Expiration &other)

Assignment operator from other GenerateOfflineMapParameters.

Expiration &Expiration::operator=(Expiration &&other)

Move operator from other Expiration.


Feedback on this topic?