Class PagedSource

Inheritance

object

PagedSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Streams.Dsl

Assembly: Akka.Streams.dll

Syntax

public static class PagedSource

Methods

Create<T, TKey>(TKey, Func<TKey, Task<Page<T, TKey>>>)

Defines a factory for "paged source".

"Paged source" is a Source streaming items from a paged API. The paged API is accessed with a page key and returns data. This data contain items and optional information about the key of the next page.

Declaration

public static Source<T, NotUsed> Create<T, TKey>(TKey firstKey, Func<TKey, Task<PagedSource.Page<T, TKey>>> pageFactory)

Parameters

Type	Name	Description
TKey	firstKey	key of first page
Func<TKey, Task<PagedSource.Page<T, TKey>>>	pageFactory	maps page key to Task of page data

Returns

Type	Description
Source<T, NotUsed>

Type Parameters

Name	Description
T	type of page items
TKey	type of page keys