Module com.esri.arcgisruntime
Class OfflineMapItemInfo
java.lang.Object
com.esri.arcgisruntime.tasks.offlinemap.OfflineMapItemInfo
Contains metadata for an offline map item.
- Since:
- 100.1.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets information on the source of the map and its copyright status.Gets the description of the map.Gets the summary description snippet of the map.getTags()
Gets the list of tags associated with the map.Gets the terms of use for the item.byte[]
Gets the thumbnail data for the map, if this has been set using the setThumbnailData method.getTitle()
Gets the title of the map.void
setAccessInformation
(String accessInformation) Sets information on the source of the map and its copyright status.void
setDescription
(String description) Sets the description of the map.void
setSnippet
(String snippet) Sets the summary description snippet of the map.void
setTermsOfUse
(String termsOfUse) Sets the terms of use for the item.void
setThumbnailData
(byte[] thumbnailData) Sets the thumbnail data for the map.void
Sets the title of the map.
-
Constructor Details
-
OfflineMapItemInfo
public OfflineMapItemInfo()Constructs a new OfflineMapItemInfo instance.- Since:
- 100.1.0
-
-
Method Details
-
getAccessInformation
Gets information on the source of the map and its copyright status.- Returns:
- text describing the source of the map and its copyright status
- Since:
- 100.1.0
-
setAccessInformation
Sets information on the source of the map and its copyright status.- Parameters:
accessInformation
- text describing the source of the map and its copyright status- Since:
- 100.1.0
-
getDescription
Gets the description of the map.- Returns:
- the description of the map
- Since:
- 100.1.0
-
setDescription
Sets the description of the map.- Parameters:
description
- the description of the map- Since:
- 100.1.0
-
getSnippet
Gets the summary description snippet of the map.- Returns:
- the summary description snippet of the map
- Since:
- 100.1.0
-
setSnippet
Sets the summary description snippet of the map.- Parameters:
snippet
- the summary description snippet of the map- Since:
- 100.1.0
-
getTags
Gets the list of tags associated with the map. The returned List object is modifiable and changes made to it will affect the tags used by this OfflineMapItemInfo.- Returns:
- the list of tags associated with the map
- Since:
- 100.1.0
-
getTermsOfUse
Gets the terms of use for the item. This may include HTML markup.- Returns:
- the terms of use
- Since:
- 100.4.0
-
setTermsOfUse
Sets the terms of use for the item. This may include HTML markup.- Parameters:
termsOfUse
- the terms of use- Since:
- 100.4.0
-
getThumbnailData
public byte[] getThumbnailData()Gets the thumbnail data for the map, if this has been set using the setThumbnailData method.- Returns:
- the thumbnail data for the map, or null if this has not been set using
setThumbnailData(byte[])
- Since:
- 100.1.0
-
setThumbnailData
public void setThumbnailData(byte[] thumbnailData) Sets the thumbnail data for the map.- Parameters:
thumbnailData
- a byte array representing the thumbnail. The recommended image size is 200 pixels wide by 133 pixels high. Acceptable image formats are PNG, GIF, and JPEG. The maximum file size for an image is 1 MB.- Throws:
IllegalArgumentException
- if thumbnailData is null or emptyArcGISRuntimeException
- if thumbnailData is invalid- Since:
- 100.1.0
-
getTitle
Gets the title of the map.- Returns:
- the title of the map
- Since:
- 100.1.0
-
setTitle
Sets the title of the map.- Parameters:
title
- the title of the map- Since:
- 100.1.0
-