Class

CloudKit.QueryResponse

A CloudKit.QueryResponse object encapsulates the results of using a query to fetch records

Declaration

interface CloudKit.QueryResponse

Overview

The performQuery method in the CloudKit.Database class returns a Promise object that resolves to a CloudKit.QueryResponse object. You should not create instances of this class directly.

If the criteria matches more records than are returned by the server, the continuationMarker property is non-null, or the moreComing property is true. To fetch the rest of the matching records, pass the CloudKit.QueryResponse object to another performQuery call until the continuationMarker property is null or the moreComing property is false.

For an example use of this class, see the performQuery method in CloudKit.Database.

Topics

Accessing Request Properties

zoneID

A CloudKit.ZoneID dictionary that identifies a record zone in the database.

resultsLimit

The maximum number of records to fetch.

continuationMarker

Marks the location of the last batch of results.

desiredKeys

An array of strings containing record field names that limits the amount of data returned in this operation.

zoneWide

A Boolean value that determines whether all zones should be searched.

Accessing Response Properties

moreComing

A Boolean value that indicates whether there are more records to fetch.

query

A CloudKit.Query dictionary containing the criteria for matching records in the database.

Identifying the Class

isQueryResponse

A Boolean value indicating whether this object is an instance of the CloudKit.QueryResponse class.

Logging

toString

Returns a string representation of this CloudKit.QueryResponse object.

Relationships