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

Description

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

The layer contains the footprints of managed facilities. A facility represents any occupiable structure, such as an office or campus building, retail setting, or industrial structure. Facilities have one or more floor levels and are optionally grouped into sites.

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

Instance Methods

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

Class Methods

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

Properties

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

Method Documentation

◆ facilityLayerDefinitionWithLayerID:facilityIDField:nameField:siteIDField:

+ (instancetype) facilityLayerDefinitionWithLayerID: (NSString *)  layerID
facilityIDField: (NSString *)  facilityIDField
nameField: (NSString *)  nameField
siteIDField: (NSString *)  siteIDField 

Creates a new AGSFacilityLayerDefinition object with the provided arguments.

Parameters
layerIDAn ID that specifies a layer in the map or scene that contains facilities.
facilityIDFieldThe name of the attribute field that contains a facility feature's unique identifier.
nameFieldThe name of the attribute field that contains a facility feature's name.
siteIDFieldThe name of the attribute field that contains a facility feature's site identifier (a foreign key to the layer that contains sites).
Since
100.12

◆ 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:facilityIDField:nameField:siteIDField:

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

Creates a new AGSFacilityLayerDefinition object with the provided arguments.

Parameters
layerIDAn ID that specifies a layer in the map or scene that contains facilities.
facilityIDFieldThe name of the attribute field that contains a facility feature's unique identifier.
nameFieldThe name of the attribute field that contains a facility feature's name.
siteIDFieldThe name of the attribute field that contains a facility feature's site identifier (a foreign key to the layer that contains sites).
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

◆ facilityIDField

- (NSString*) facilityIDField
readnonatomiccopy

The name of the attribute field that contains a facility feature's unique identifier.

Since
100.12

◆ layerID

- (NSString*) layerID
readnonatomiccopy

An ID that specifies a layer in the map or scene that contains facilities. The layer provides access to facility features for floor filtering.

Since
100.12

◆ nameField

- (NSString*) nameField
readnonatomiccopy

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

Since
100.12

◆ siteIDField

- (NSString*) siteIDField
readnonatomiccopy

The name of the attribute field that contains a facility feature's site identifier (a foreign key to the site layer).

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