zdk.objc
Instance Methods | Properties | List of all members
<ZDKPagination> Protocol Reference

Search pagination. More...

#import <ZDKPagination.h>

Inheritance diagram for <ZDKPagination>:
<ZDKZHandle>

Instance Methods

(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKZHandle>
(long int) - handle
 
(void) - initialize
 
(void) - releaseReference
 
(NSString *) - handlesDescription
 

Properties

NSString *_Nullable nextPageUrl
 Next page URL. More...
 
BOOL nextPage
 Specifies the possibility of having a next page. More...
 
int nextStart
 The number of skipped contacts in the next page. More...
 
int nextLimit
 Number of selected next page records. More...
 
NSString *_Nullable nextPageId
 Next page ID. More...
 

Detailed Description

Search pagination.

Describes the search pagination used for paged searching.

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

Property Documentation

◆ nextLimit

- (int) nextLimit
readnonatomicassign

Number of selected next page records.

Number of selected next page records.

Returns
Number of selected next page records

◆ nextPage

- (BOOL) nextPage
readnonatomicassign

Specifies the possibility of having a next page.

Specifies the possibility of having a next page.

Returns
  • 0 - next page is available
  • 1 - next page is NOT available

◆ nextPageId

- (NSString* _Nullable) nextPageId
readnonatomicassign

Next page ID.

Next page ID for CRMs that supports this type of pagination.

Returns
The next page ZDKD

◆ nextPageUrl

- (NSString* _Nullable) nextPageUrl
readnonatomicassign

Next page URL.

Next page URL.

Returns
The next page URL

◆ nextStart

- (int) nextStart
readnonatomicassign

The number of skipped contacts in the next page.

The number of contacts skipped before selecting records for next page.

Returns
The number of skipped contacts in the next page

The documentation for this protocol was generated from the following file: