queryPools( )

Creates a query to retrieve a list of pools.

The Query Pools method builds a query to retrieve a list of pools and returns a PoolsQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() method.

You can refine the query by chaining PoolsQueryBuilder methods onto the query. PoolsQueryBuilder methods enable you to filter, sort, and control the results that Query Pools returns.

Query Pools has a default paging limit of 50, which you can override.

For a full description of the item object, see the object returned for the items property in PoolsQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
_createdDate	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
poolDefinitionId	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
programDefinitionId	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
programId	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
status	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
beneficiary	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
beneficiary.memberId	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
beneficiary.wixUserId	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
details.benefits.itemSetId	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
details.benefits.providerAppId	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
namespace	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
programDefinition.id	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
program.id	eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()