DEPRECATED: Diffusion iOS Classic API  5.9.4
 All Data Structures Files Functions Variables Enumerations Enumerator Properties Macros Pages
<DFPagedTopicDelegate> Protocol Referenceabstract

Delegate for events from a Paged Topic. More...

#import <DFPagedTopicDelegate.h>

Inheritance diagram for <DFPagedTopicDelegate>:
Collaboration diagram for <DFPagedTopicDelegate>:

Instance Methods

(void) - pageWithLines:status:handler:
 Notifies receipt of a page from the server.
 
(void) - addedLines:status:handler:
 Notifies lines added to the end of the current page.
 
(void) - statusChanged:handler:
 Notifies a status change.
 
(void) - updatedLines:index:handler:
 Notifies an update to the data of a line on the current page.
 
(void) - updatedLines:status:index:handler:
 Notifies an update to the data of a line on the current page.
 

Detailed Description

Delegate for events from a Paged Topic.

Author
Martin Cowie - created 6 Jan 2012
Since
4.1

Method Documentation

- (void) addedLines: (NSArray *)  lines
status: (DFPageStatus *)  status
handler: (DFPagedTopicHandler *)  handler 

Notifies lines added to the end of the current page.

Parameters
handlerthe handler
statusthe current status of the Topic.
linesthe lines of data to be added to the end of the current page. There may be less than or equal to the number of lines required to fill the page and the status would indicate whether there is now more following the current page.
- (void) pageWithLines: (NSArray *)  lines
status: (DFPageStatus *)  status
handler: (DFPagedTopicHandler *)  handler 

Notifies receipt of a page from the server.

This may be received in response to [DFPagedTopicHandler openLinesPerPage:linesPerPage] or [DFPagedTopicHandler page] requests.

Parameters
handlerthe handler
statusthe current status of the Topic.
linesthe lines of data on the page. Contains either NSString or NSArray objects for string or record based topics, respectively.
- (void) statusChanged: (DFPageStatus *)  status
handler: (DFPagedTopicHandler *)  handler 

Notifies a status change.

This will happen if lines have been added or removed which affect the pagination (e.g. the current page number of the total number of pages has changed). If lines have been added or removed on or before the current page then the status will indicate that the page is 'dirty', meaning that what is currently displayed is out of date and should be refreshed (using [DFPagedTopicHandler page]) .

Parameters
handlerthe handler
statusthe current status in relation to the current page.
- (void) updatedLines: (NSArray *)  lines
index: (int)  index
handler: (DFPagedTopicHandler *)  handler 
optional

Notifies an update to the data of a line on the current page.

Parameters
handlerthe handler
indexthe relative index of the line within the current page (where the index of the first line is 0).
linesan NSArray containing a single line of data which may be used to replace the current line.
Deprecated:
in favor of [updatedLines:status:index:handler:]
- (void) updatedLines: (NSArray *)  lines
status: (DFPageStatus *)  status
index: (int)  index
handler: (DFPagedTopicHandler *)  handler 
optional

Notifies an update to the data of a line on the current page.

Parameters
handlerthe handler
statusthe current status of the Topic
indexthe relative index of the line within the current page (where the index of the first line is 0).
linesan NSArray containing a single line of data which may be used to replace the current line.

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