Inherits from NSObject
Declared in TWTRTimelineCursor.h

Overview

This Model object is a generic type of Cursor to represent the range of Tweets which have already been loaded from the Twitter API. A dataset that supports “cursoring” splits of a set of results (or Tweets in our case) in pages. One page is loaded at a time, and the cursor from the previous request is used to calculated which set of Tweets should be requested.

Positions

For User, Search, and List Timelines generally corresponds to a real Tweet ID.

       newer Tweets
     (not yet loaded)

 -- newest/highest Tweet --      maxPosition

       loaded Tweets

 -- oldest/lowest Tweet --      minPosition
                                minPosition - 1
       older Tweets
     (not yet loaded)

More: https://dev.twitter.com/overview/api/cursoring

Properties

maxPosition

The ID of the Tweet highest up in a batch of Tweets received from a Timeline. Often this corresponds to the newest Tweet in terms of time.

@property (nonatomic, copy, readonly) NSString *maxPosition

Discussion

For User, Search, and List Timelines this corresponds to a real Tweet ID..

Declared In

TWTRTimelineCursor.h

minPosition

The ID of the Tweet lowest in a batch of Tweets received from a Timeline. This often corresponds to the oldest Tweet in terms of time.

@property (nonatomic, copy, readonly) NSString *minPosition

Declared In

TWTRTimelineCursor.h

Instance Methods

init

- (instancetype)init

initWithMaxPosition:minPosition:

Initialize a new cursor.

- (instancetype)initWithMaxPosition:(NSString *)maxPosition minPosition:(NSString *)minPosition

Parameters

maxPosition

The highest (newest) Tweet ID received in this batch of Tweets.

minPosition

The lowest (oldest) Tweet ID received in this batch of Tweets.

Return Value

The initialized cursor to be passed back from a request for a Timeline from the Twitter API.

Declared In

TWTRTimelineCursor.h