java.lang.Object
com.esri.arcgisruntime.mapping.Expiration
Expiration details that indicate whether a given package is out of date.
Expiration details can indicate that the package in question:
- is still valid
- has expired and should be used with caution -
ExpirationType.ALLOW_EXPIRED_ACCESS
- has expired and can no longer be used -
ExpirationType.PREVENT_EXPIRED_ACCESS
- Since:
- 100.5.0
-
Method Summary
Modifier and TypeMethodDescriptionGets a Calendar object that has the date and time when the package will expire.Gets an accompanying message which provides contextual information when the package has expired.getType()
Gets the type of expiration for the given package.boolean
Gets whether the current package has expired.
-
Method Details
-
getDateTime
Gets a Calendar object that has the date and time when the package will expire.- Returns:
- a Calendar object that has the date and time of the expiration
- Since:
- 100.5.0
-
getMessage
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.
- Returns:
- the message that provides information when the package has expired
- Since:
- 100.5.0
-
isExpired
public boolean isExpired()Gets whether the current package has expired.- Returns:
- a boolean value that represents whether the package has expired
- Since:
- 100.5.0
-
getType
Gets the type of expiration for the given package.This property indicates what expiration entails for the given package. That is, when the package expires:
- it is out-of-date but can still be used -
ExpirationType.ALLOW_EXPIRED_ACCESS
- it can no longer be used and will fail to load -
ExpirationType.PREVENT_EXPIRED_ACCESS
- Returns:
- the type of expiration
- Since:
- 100.5.0
- it is out-of-date but can still be used -
-