//
//  PaginationStoreFlowable.swift
//  StoreFlowable
//
//  Created by Kensuke Tamura on 2020/12/23.
//

/**
 * Provides input / output methods that abstract the data acquisition destination.
 *
 * This class is generated from `PaginationStoreFlowableFactory.create`.
 */
public protocol PaginationStoreFlowable: StoreFlowable {

    /**
     * Request next data.
     *
     * Do nothing if there is no additional data or if already data retrieving.
     *
     * - parameter continueWhenError: Even if the data state is an `LoadingState.error` when `refresh` is called, the refresh will continue. Default value is `true`.
     */
    func requestNextData(continueWhenError: Bool) async
    
    /**
     * Treat the passed data as the latest acquired data.
     * and the new data will be notified.
     *
     * Use when new data is created or acquired externally.
     *
     * - parameter newData: Latest data.
     * - parameter nextKey: Key for next request. If null is set, the stored key will be used.
     */
    func update(newData: DATA?, nextKey: String?) async
}

public extension PaginationStoreFlowable {

    func requestNextData(continueWhenError: Bool = true) async {
        await requestNextData(continueWhenError: continueWhenError)
    }

    func update(newData: DATA?, nextKey: String? = nil) async {
        await update(newData: newData, nextKey: nextKey)
    }
}