Swiftgram/Source/ASSectionController.h
appleguy 465abb1ded [License] Simplify the Texture license to be pure Apache 2 (removing ASDK-Licenses). (#1077)
* [License] Simplify the Texture license to be pure Apache 2 (removing ASDK-Licenses)

With permission of the Facebook Open Source team, we are simplifying the Texture
license so that clients can rely on the Apache 2 terms that most of Texture is
already covered by. This means that code originally forked from AsyncDisplayKit
will be re-licensed from "BSD 3-clause + PATENTS v2" to Apache 2 without a
PATENTS file.

After getting confirmation that the updates to these core files look good, we'll
propagate this new license header to all files (in this same PR) and get sign-off
from all parties before landing.

* [License] Update all Texture source files to be pure Apache 2.

* Changelog entry for Apache 2 license update.

* Revert "[License] Update all Texture source files to be pure Apache 2."

This reverts commit ffa0fbbba9717d871dd16c4b07539f2f8208fc2b.

* [License] Update all Texture source files to be pure Apache 2, maintaining copyrights.

* [License] Update CONTRIBUTING, README, Podspec & Dangerfile.
2018-08-28 07:39:18 -07:00

75 lines
2.5 KiB
Objective-C

//
// ASSectionController.h
// Texture
//
// Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
// Changes after 4/13/2017 are: Copyright (c) Pinterest, Inc. All rights reserved.
// Licensed under Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
//
#import <Foundation/Foundation.h>
#import <AsyncDisplayKit/ASBlockTypes.h>
#import <AsyncDisplayKit/ASDimension.h>
NS_ASSUME_NONNULL_BEGIN
@class ASBatchContext;
/**
* A protocol that your section controllers should conform to,
* in order to be used with AsyncDisplayKit.
*
* @note Your supplementary view source should conform to @c ASSupplementaryNodeSource.
*/
@protocol ASSectionController <NSObject>
/**
* A method to provide the node block for the item at the given index.
* The node block you return will be run asynchronously off the main thread,
* so it's important to retrieve any objects from your section _outside_ the block
* because by the time the block is run, the array may have changed.
*
* @param index The index of the item.
* @return A block to be run concurrently to build the node for this item.
* @see collectionNode:nodeBlockForItemAtIndexPath:
*/
- (ASCellNodeBlock)nodeBlockForItemAtIndex:(NSInteger)index;
@optional
/**
* Asks the section controller whether it should batch fetch because the user is
* near the end of the current data set.
*
* @discussion Use this method to conditionally fetch batches. Example use cases are: limiting the total number of
* objects that can be fetched or no network connection.
*
* If not implemented, the assumed return value is @c YES.
*/
- (BOOL)shouldBatchFetch;
/**
* Asks the section controller to begin fetching more content (tail loading) because
* the user is near the end of the current data set.
*
* @param context A context object that must be notified when the batch fetch is completed.
*
* @discussion You must eventually call -completeBatchFetching: with an argument of YES in order to receive future
* notifications to do batch fetches. This method is called on a background queue.
*/
- (void)beginBatchFetchWithContext:(ASBatchContext *)context;
/**
* A method to provide the size range used for measuring the item
* at the given index.
*
* @param index The index of the item.
* @return A size range used for asynchronously measuring the node at this index.
* @see collectionNode:constrainedSizeForItemAtIndexPath:
*/
- (ASSizeRange)sizeRangeForItemAtIndex:(NSInteger)index;
@end
NS_ASSUME_NONNULL_END