Inherits from NSObject
Conforms to AGPageConfig
Declared in AGPageConfiguration.h
AGPageConfiguration.m

Overview

The internal implementation of the AGPageConfig to configure Paging params.

Tasks

Instance Methods

parameterProvider

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

- (NSDictionary *)parameterProvider

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

Declared In

AGPageConfig.h

setMetadataLocation:

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.

- (void)setMetadataLocation:(NSString *)metadataLocation

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.

Declared In

AGPageConfig.h