ArcGIS Runtime SDK for iOS: AGSLocalItem Class Reference
ArcGIS Runtime SDK for iOS  100.7
AGSLocalItem Class Reference

Description

A unit of content on-disk.

Instances of this class represent a unit of content locally on-disk. It is similar to AGSPortalItem except it is local on the device instead of being remote on a portal.

Since
100
Inheritance diagram for AGSLocalItem:
AGSItem AGSObject

Instance Methods

(id< AGSCancelable >) - fetchDataWithCompletion:
 
(void) - setThumbnailWithImage:
 
(id< AGSCancelable >) - updateItemPropertiesWithCompletion:
 

Properties

NSString * accessInformation
 
NSDate * created
 
AGSEnvelopeextent
 
NSURL * fileURL
 
NSString * itemDescription
 
NSString * itemID
 
NSDate * modified
 
NSString * name
 
NSString * originalPortalItemID
 
NSURL * portalURL
 
NSString * snippet
 
NSString * spatialReferenceName
 
NSArray< NSString * > * tags
 
NSString * termsOfUse
 
AGSLoadableImagethumbnail
 
NSString * title
 
AGSLocalItemType type
 
NSArray< NSString * > * typeKeywords
 

Method Documentation

§ fetchDataWithCompletion:()

- (id<AGSCancelable>) fetchDataWithCompletion: (void(^)(NSData *__nullable data, NSError *__nullable error))  completion

Kicks off an operation to fetch the raw bytes for the item. The completion block is invoked when the operation completes successfully or if an error is encountered.

Parameters
completionblock that is invoked when operation finishes
Returns
operation which can be canceled
Since
100

§ setThumbnailWithImage:()

- (void) setThumbnailWithImage: (nullable AGSImage *)  image

Sets the thumbnail for this item.

Parameters
imageThe NSImage/UIImage 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.
Since
100

Property Documentation

§ accessInformation

- (NSString*) accessInformation
readwritenonatomiccopyinherited

The access information about the item.

Since
100

§ created

- (NSDate*) created
readnonatomicstronginherited

Date on which the item was first saved.

Since
100

§ extent

- (AGSEnvelope*) extent
readwritenonatomicstronginherited

The default extent of the item. Only applicable to certain item types.

Since
100

§ fileURL

- (NSURL*) fileURL
readnonatomicstrong

The file URL of this local item.

Since
100.3

§ itemDescription

- (NSString*) itemDescription
readwritenonatomiccopyinherited

The description of the item, if any.

Since
100

§ itemID

- (NSString*) itemID
readnonatomiccopyinherited

The ID of the item.

Since
100

§ modified

- (NSDate*) modified
readnonatomicstronginherited

Date on which the item was modified.

Since
100

§ name

- (NSString*) name
readnonatomiccopyinherited

The file name of the item for file types.

Since
100.5

§ originalPortalItemID

- (NSString*) originalPortalItemID
readnonatomiccopy

The item ID of the portal item that this local item originated from.

Since
100.3

§ portalURL

- (NSURL*) portalURL
readnonatomicstrong

The URL of the portal from which this local item was downloaded. This property can be used in conjunction with the AGSLocalItem::originalPortalItemID to find the URL of the portal from which this local item was downloaded. This can be useful when following offline map workflows as it allows you to find the URL of the online web map. This property will be nil when the local item was not created from an online resource - for example if exported from ArcGIS Pro.

Since
100.6

§ snippet

- (NSString*) snippet
readwritenonatomiccopyinherited

Snippet or summary of the item with a character limit of 250 characters.

Since
100

§ spatialReferenceName

- (NSString*) spatialReferenceName
readwritenonatomiccopyinherited

Spatial reference of the geographic content

Since
100

§ tags

- (NSArray<NSString*>*) tags
readwritenonatomiccopyinherited

Words or short phrases that describe the item.

Since
100

§ termsOfUse

- (NSString*) termsOfUse
readwritenonatomiccopyinherited

The terms of use of the item. It is stored in the "licenseInfo" property in json. The property can contain HTML markup.

Since
100.4

§ thumbnail

- (AGSLoadableImage*) thumbnail
readnonatomicstronginherited

The thumbnail image of the item. The image needs to be loaded asynchronously by calling loadWithCompletion: (AGSLoadable-p)

If it is nil, there is no item thumbnail.

Since
100

§ title

- (NSString*) title
readwritenonatomiccopyinherited

Title of the item.

Since
100

§ type

- (AGSLocalItemType) type
readnonatomicassign

The type of content that is local

Since
100

§ typeKeywords

- (NSArray<NSString *>*) typeKeywords
readwritenonatomiccopyinherited

An array of keywords that further describes the type of item. Each item is tagged with a set of type keywords that are derived based on its primary type.

Since
100.5