Discussion

The maximum number of results the server should return (default: 10)

If a parameter provider has been given, the limit value is ignored.

Discussion

Indicates whether paging information (see identifiers) is received from the response ‘header’, the response ‘body’ or via RFC 5988 (‘webLinking’), which is the default. Other values are ignored and the default is being used.

Note: if the pageExtractor option is not set, the library will default to use an appropriate pagination strategy according to the metadataLocation. If set this option is not required and is ignored if set. See pageExtraction configuration property for more information.

Discussion

The next identifier name (default: ‘next’).

Discussion

The offset of the first element that should be included in the returned collection (default: 0)

If a parameter provider has been given, the offset value is ignored.

Discussion

An extension point to override the default strategies provided by the library. If set, the library will use this strategy to determine server paging. The strategy should conform to the protocol AGPageParameterExtractor.

Note: If this config setting is NOT set, the library will default to use an internal defined paging extractor implementation as defined by the metadataLocation configuration setting. See AGNSMutableArray+Paging API doc for example usage. See internal AGPageWebLinkingExtractor, AGPageHeaderExtractor and AGPageBodyExtractor for example pagination strategies.

Discussion

A dictionary containing all the HTTP request parameters and their values, that are passed to the server, used when issuing paging requests.

If no “parameter provider” has been provided, the values for limit/offset are used

Discussion

The previous identifier name (default: ‘previous’).