Expiration details, that indicate whether a given package is out of date. More...
| Header: | #include <Expiration.h> |
| Since: | Esri::ArcGISRuntime 100.5 |
Public Functions
| Expiration(const Esri::ArcGISRuntime::Expiration &other) | |
| Expiration(Esri::ArcGISRuntime::Expiration &&other) | |
| ~Expiration() | |
| QDateTime | dateTime() const |
| bool | isEmpty() const |
| bool | isExpired() const |
| QString | message() const |
| Esri::ArcGISRuntime::ExpirationType | type() const |
| Esri::ArcGISRuntime::Expiration & | operator=(const Esri::ArcGISRuntime::Expiration &other) |
| Esri::ArcGISRuntime::Expiration & | operator=(Esri::ArcGISRuntime::Expiration &&other) |
Detailed Description
Expiration details can indicate that the package in question:
- is still valid.
- has expired and should be used with caution (see ExpirationType::allowExpiredAccess).
- has expired and can no longer be used (see ExpirationType::PreventExpiredAccess).
Note: You cannot create an object of this class.
Relevant samples:
- Honor mobile map package expiration date: Access the expiration information of an expired mobile map package.
Member Function Documentation
Expiration::Expiration(const Esri::ArcGISRuntime::Expiration &other)
Copy constructor from other Expiration.
Expiration::Expiration(Esri::ArcGISRuntime::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:
- It is out-of-date but can still be used (ExpirationType::AllowExpiredAccess).
- It can no longer be used and will fail to load (ExpirationType::PreventExpiredAccess).
If this Expiration object isEmpty, returns ExpirationType::Unknown.
Esri::ArcGISRuntime::Expiration &Expiration::operator=(const Esri::ArcGISRuntime::Expiration &other)
Assignment operator from other GenerateOfflineMapParameters.
Esri::ArcGISRuntime::Expiration &Expiration::operator=(Esri::ArcGISRuntime::Expiration &&other)
Move operator from other Expiration.