/*
|
* Copyright (C) 2017 Twitter, Inc.
|
*
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
* you may not use this file except in compliance with the License.
|
* You may obtain a copy of the License at
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing, software
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* See the License for the specific language governing permissions and
|
* limitations under the License.
|
*
|
*/
|
|
#import <UIKit/UIKit.h>
|
@protocol TWTRTimelineDataSource;
|
@protocol TWTRTweetViewDelegate;
|
@protocol TWTRTimelineDelegate;
|
@class TWTRMoPubAdConfiguration;
|
@class TWTRTweet;
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
/**
|
This class is a `UITableViewController` subclass that displays `TWTRTweetTableViewCell` cells. It handles cell-reuse, cell-configuration, and loading more Tweets from the given timeline once the last cell is displayed.
|
|
## Usage
|
|
Initialize this class with any object that conforms to the `TWTRTimelineDataSource` protocol. We provide two such classes, `TWTRUserTimelineDataSource` and `TWTRSearchTimelineDataSource`. These provide `TWTRTweet` objects to this table view which then configures the instances of `TWTRTweetTableViewCell`.
|
|
// Create the data source
|
TWTRAPIClient *client = [[TWTRAPIClient alloc] init];
|
TWTRUserTimelineDataSource *dataSource = [[TWTRUserTimelineDataSource alloc] initWithScreenName:@"jack" APIClient:client];
|
|
// Create the timeline view controller
|
TWTRTimelineViewController *timeline = [[TWTRTimelineViewController alloc] initWithDataSource:dataSource];
|
|
## Loading More
|
|
This class loads the first batch of `TWTRTweet` objects from the Twitter API when `viewWillAppear:` is received. It also handles loading more tweets automatically once the last cell has been shown.
|
|
*/
|
@interface TWTRTimelineViewController : UITableViewController
|
|
/**
|
The source of `TWTRTweet` objects for this `TWTRTimelineViewController`.
|
May be set to update the Tweets being shown by this table view. Must be set on the main thread.
|
*/
|
@property (nonatomic, copy) id<TWTRTimelineDataSource> dataSource;
|
|
/**
|
* The configuration of MoPub ads to show in the timeline. You must
|
* link against the MoPub framework and provide this configuration in order
|
* for ads to be injected.
|
* @note Changing this will force a reload of the timeline. You can only set this once. Must be set on the main thread.
|
*/
|
@property (nonatomic, nullable) TWTRMoPubAdConfiguration *adConfiguration;
|
|
/**
|
* Whether action buttons (Like, Share) should be shown on the `TWTRTweetTableViewCell`s inside the tableview.
|
*/
|
@property (nonatomic) BOOL showTweetActions;
|
|
/**
|
* If set, this value will be passed to all TWTRTweetView instances in the timeline.
|
*/
|
@property (nonatomic, weak) id<TWTRTweetViewDelegate> tweetViewDelegate;
|
|
/**
|
* The object that acts as the delegate for the timeline.
|
*/
|
@property (nonatomic, weak) id<TWTRTimelineDelegate> timelineDelegate;
|
|
/**
|
Initializes a timeline view controller. Does not start loading tweets until
|
`viewWillAppear:` is called.
|
|
This method must be used to initialize this class. The `init` method is unavailable.
|
|
@param dataSource A timeline data source object that conforms to the `TWTRTimelineDataSource` protocol.
|
|
@return A fully initialized `TWTRTimelineViewController` or nil if the data source is missing.
|
*/
|
- (instancetype)initWithDataSource:(nullable id<TWTRTimelineDataSource>)dataSource;
|
|
/**
|
* Initializes a timeline view controller with an optional ad configuration. Does not start loading Tweets until `viewWillAppear:` is called.
|
*
|
* @param dataSource A timeline data source object that conforms to the `TWTRTimelineDataSource` protocol.
|
* @param adConfiguration Configuration for the type of MoPub ads to display. Ads will only load after
|
* the initial timeline is loaded. No ads will be displayed if nil.
|
*
|
* @return A fully initialized `TWTRTimelineViewController`. Tweets will not be loaded if the data source is nil.
|
*/
|
- (instancetype)initWithDataSource:(nullable id<TWTRTimelineDataSource>)dataSource adConfiguration:(nullable TWTRMoPubAdConfiguration *)adConfiguration;
|
|
- (instancetype)initWithStyle:(UITableViewStyle)style NS_UNAVAILABLE;
|
|
/**
|
* Asynchronously refresh and replace all the data in the table view with the latest `TWTRTweet`s.
|
*/
|
- (void)refresh;
|
|
/**
|
* Returns the number of Tweets that are currently displayed by the controller.
|
*/
|
- (NSUInteger)countOfTweets;
|
|
/**
|
* Returns the Tweet at the given index.
|
*
|
* @warning This method will throw an exception if the index is out of range of the count of Tweets.
|
*/
|
- (TWTRTweet *)tweetAtIndex:(NSInteger)index;
|
|
/**
|
* Returns a copy of the Tweets at the time of calling this method.
|
|
* This method returns the copy of the current Tweets. The Tweets may change
|
* after this method is called.
|
*/
|
- (NSArray *)snapshotTweets;
|
|
@end
|
|
NS_ASSUME_NONNULL_END
|
