TWTRListTimelineDataSource Class Reference
Inherits from | NSObject |
---|---|
Conforms to | TWTRTimelineDataSource |
Declared in | TWTRListTimelineDataSource.h |
Overview
Data source representing a list of Tweets. These Tweets are ordered chronologically with the most recent first.
listID
The ID of the list to show Tweets for. Either the listID
or the listSlug
and listOwnerScreenName
are required.
@property (nonatomic, copy, readonly) NSString *listID
Declared In
TWTRListTimelineDataSource.h
listSlug
The slug of the list to show Tweets for. Either the listID
or the listSlug
and listOwnerScreenName
are required.
@property (nonatomic, copy, readonly) NSString *listSlug
Declared In
TWTRListTimelineDataSource.h
maxTweetsPerRequest
The number of Tweets to request in each query to the Twitter Timeline API when fetching the next batch of Tweets. Will request 30 Tweets by default. Setting this value to 0 will use the server default.
@property (nonatomic, readonly) NSUInteger maxTweetsPerRequest
Declared In
TWTRListTimelineDataSource.h
includeRetweets
Whether to request retweets in the set of Tweets from the server.
@property (nonatomic, readonly) BOOL includeRetweets
Discussion
Defaults to YES.
Declared In
TWTRListTimelineDataSource.h
– initWithListID:APIClient:
Convenience initializer. Uses default values for maxTweetsPerRequest
and includeRetweets
.
- (instancetype)initWithListID:(NSString *)listID APIClient:(TWTRAPIClient *)client
Parameters
listID |
(required) The ID of the list. |
---|---|
client |
(required) The API client to use for making network requests. |
Return Value
A full initialized list timeline datasource.
Declared In
TWTRListTimelineDataSource.h
– initWithListSlug:listOwnerScreenName:APIClient:
Convenience initializer. Uses default values for maxTweetsPerRequest
and includeRetweets
.
- (instancetype)initWithListSlug:(NSString *)listSlug listOwnerScreenName:(NSString *)listOwnerScreenName APIClient:(TWTRAPIClient *)client
Parameters
listSlug |
(required) The slug of the list. |
---|---|
listOwnerScreenName |
(required) The list owner’s screen name. |
client |
(required) The API client to use for making network requests. |
Return Value
A full initialized list timeline datasource.
Declared In
TWTRListTimelineDataSource.h
– initWithListID:listSlug:listOwnerScreenName:APIClient:maxTweetsPerRequest:includeRetweets:
Designated initializer for creating list timeline data sources taking all parameters.
- (instancetype)initWithListID:(nullable NSString *)listID listSlug:(nullable NSString *)listSlug listOwnerScreenName:(nullable NSString *)listOwnerScreenName APIClient:(TWTRAPIClient *)client maxTweetsPerRequest:(NSUInteger)maxTweetsPerRequest includeRetweets:(BOOL)includeRetweets
Parameters
listID |
(optional) The ID of the list. Provide either the |
---|---|
listSlug |
(optional) The slug of the list. Provide either the |
listOwnerScreenName |
(optional) The list owner’s screen name. Provide either the |
client |
(required) The API client to use for making networking requests |
maxTweetsPerRequest |
(optional) The number of Tweets per batch to request. A value of 0 will use the server default. |
includeRetweets |
(optional) Whether retweets should be requested. |
Return Value
A fully initialized list timeline datasource.
Declared In
TWTRListTimelineDataSource.h