AGSWebMapQuery Class Reference

---

Description

Instances of this class represent predefined queries stored in a web map. The query contains information that can be combined with user input to execute queries using the AGSQueryTask.

Since:

2.2

Inheritance diagram for AGSWebMapQuery:

List of all members.

Public Member Functions
(void)	- decodeWithJSON:
(NSDictionary *)	- encodeToJSON
(id)	- initWithJSON:
Properties
NSString *	displayField
NSString *	name
NSArray *	parameters
NSURL *	URL
NSArray *	visibleFields
NSString *	whereClause

---

Member Function Documentation

- (void) decodeWithJSON:

(NSDictionary *)

json

[optional, inherited]

Decode object from JSON representation.

Parameters:

json

The JSON representation of the object to be decoded.

Since:

1.0

- (NSDictionary *) encodeToJSON

[optional, inherited]

Encode and return JSON representation for object.

Returns:

JSON representation of object.

Since:

1.0

- (id) initWithJSON:

(NSDictionary *)

json

[optional, inherited]

Initialize and return object from JSON representation.

Parameters:

json

The JSON representation of the object to be created.

Returns:

Object decoded from JSON representation.

Since:

1.0

Reimplemented in AGSWebMapFeatureCollection.

---

Property Documentation

- (NSString*) displayField [read, retain]

Since:

2.2

- (NSString*) name [read, retain]

The name of this query in the webmap.

Since:

2.2

- (NSArray*) parameters [read, retain]

An array of AGSWebMapQueryParameter objects representing the predicates to be used in the whereClause.

Since:

2.2

- (NSURL*) URL [read, retain]

The URL of the layer to query. The URL points to a REST resource that represents a layer in a Map, Image, or Feature service. This URL can be used to instantiate an AGSQueryTask

Since:

2.2

- (NSArray*) visibleFields [read, retain]

An array of strings representing the fields that must be returned in the results. This array can be used with AGSQuery::outFields.

Since:

2.2

- (NSString*) whereClause [read, retain]

The general structure of an SQL where clause to perform the query. The clause contains numbered placeholders such as {0} {1} which need to be replaced with predicates that are constructed from items in the parameters list.

Since:

2.2