ArcGIS Runtime SDK for iOS: AGSSiteLayerDefinition Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSSiteLayerDefinition Class Reference

Description

Defines the properties of the layer that contains sites for a floor-aware map or scene.

The layer contains the boundaries of managed sites. A site is the largest space designation in the ArcGIS Indoors Information Model and is used to represent an area such as a campus, a barrack, or an industrial site. A site can contain multiple facilities.

See also
AGSGeoModelFloorDefinition
Since
100.12
Inheritance diagram for AGSSiteLayerDefinition:
AGSObject <AGSJSONSerializable>

Instance Methods

(instancetype) - initWithLayerID:nameField:siteIDField:
 
(nullable id) - toJSON:
 

Class Methods

(nullable id< AGSJSONSerializable >) + fromJSON:error:
 
(instancetype) + siteLayerDefinitionWithLayerID:nameField:siteIDField:
 

Properties

NSString * layerID
 
NSString * nameField
 
NSString * siteIDField
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 

Method Documentation

◆ fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject
error: (NSError **)  error 
staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters
JSONObjectNSDictionary or NSArray containing the JSON.
errorencountered during the operation, if any.
Since
100

◆ initWithLayerID:nameField:siteIDField:

- (instancetype) initWithLayerID: (NSString *)  layerID
nameField: (NSString *)  nameField
siteIDField: (NSString *)  siteIDField 

Creates a new AGSSiteLayerDefinition object with the provided arguments.

Parameters
layerIDAn ID that specifies a layer in the map or scene that contains site features.
nameFieldThe name of the attribute field that contains each site feature's name.
siteIDFieldThe name of the attribute field that contains each site feature's unique identifier.
Since
100.12

◆ siteLayerDefinitionWithLayerID:nameField:siteIDField:

+ (instancetype) siteLayerDefinitionWithLayerID: (NSString *)  layerID
nameField: (NSString *)  nameField
siteIDField: (NSString *)  siteIDField 

Creates a new AGSSiteLayerDefinition object with with the provided arguments.

Parameters
layerIDAn ID that specifies a layer in the map or scene that contains site features.
nameFieldThe name of the attribute field that contains each site feature's name.
siteIDFieldThe name of the attribute field that contains each site feature's unique identifier.
Since
100.12

◆ toJSON:

- (nullable id) toJSON: (NSError **)  error
requiredinherited

Returns JSON representation for this object.

Parameters
errorencountered during the operation, if any.
Returns
NSDictionary or NSArray containing the JSON.
Since
100

Reimplemented in AGSPortalItem.

Property Documentation

◆ layerID

- (NSString*) layerID
readnonatomiccopy

An ID that specifies a layer in the map or scene that contains site features.

Since
100.12

◆ nameField

- (NSString*) nameField
readnonatomiccopy

The name of the attribute field that contains each site feature's name.

Since
100.12

◆ siteIDField

- (NSString*) siteIDField
readnonatomiccopy

The name of the attribute field that contains each site feature's unique identifier.

Since
100.12

◆ unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON
readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns
NSDictionary containing the unknown JSON.
Since
100

◆ unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON
readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns
NSDictionary containing the unsupported JSON.
Since
100