> ## Documentation Index
> Fetch the complete documentation index at: https://klef.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# PageReader

> Reads a list page by page.

```csharp
public static class PageReader
```

## Fields

**MaxPages** `int` *required*

How many pages a read allows.

**MaxRestarts** `int` *required*

How many restarts a read allows.

## Methods

### Check()

```csharp
public static void Check<T>(PageRequest request, Page<T> page)
```

Refuses a page that breaks the paging rules.

#### Type Parameters

**T** *required*

#### Parameters

**request** `PageRequest` *required*

**page** `Page\<\<T\>\>` *required*

**Type:** `Page<<T>>`

### ListAllAsync()

```csharp
public static Task<PagedRead<Principal>> ListAllAsync(this ITargetConnector connector, ConnectionContext context, string kind, int size = 1000, Action<Page<Principal>>? onPage = null, CancellationToken cancellationToken = default)
```

Lists and resolves every principal of a kind.

#### Parameters

**connector** `ITargetConnector` *required*

**context** `ConnectionContext` *required*

**kind** `string` *required*

**size** `int`

**onPage** `Action\<Page\<Principal\>\>`

**Type:** `Action<Page<Principal>>`

**cancellationToken** `CancellationToken`

#### Returns

`Task<PagedRead<Principal>>`

### ListAllWorkersAsync()

```csharp
public static Task<PagedRead<SourceWorker>> ListAllWorkersAsync(this ISupportsWorkerReads source, ConnectionContext context, int size = 1000, Action<Page<SourceWorker>>? onPage = null, CancellationToken cancellationToken = default)
```

Lists every worker page by page.

#### Parameters

**source** `ISupportsWorkerReads` *required*

**context** `ConnectionContext` *required*

**size** `int`

**onPage** `Action\<Page\<SourceWorker\>\>`

**Type:** `Action<Page<SourceWorker>>`

**cancellationToken** `CancellationToken`

#### Returns

`Task<PagedRead<SourceWorker>>`

### ReadAllAsync()

```csharp
public static Task<PagedRead<T>> ReadAllAsync<T>(SourceFetchRequest request, Func<SourceFetchRequest, Task<Page<T>>> read, Action<Page<T>>? onPage = null, ReadCache? cache = null)
```

Reads a whole source fetch page by page.

#### Type Parameters

**T** *required*

#### Parameters

**request** `SourceFetchRequest` *required*

**read** `Func\<SourceFetchRequest,Task\<Page\<\<T\>\>\>\>` *required*

**Type:** `Func<SourceFetchRequest,Task<Page<<T>>>>`

**onPage** `Action\<Page\<\<T\>\>\>`

**Type:** `Action<Page<<T>>>`

**cache** `ReadCache`

#### Returns

`Task<PagedRead<<T>>>`

```csharp
public static Task<PagedRead<T>> ReadAllAsync<T>(Func<PageRequest, Task<Page<T>>> read, int size = 1000, Action<Page<T>>? onPage = null, ReadCache? cache = null)
```

Reads a whole list page by page.

#### Type Parameters

**T** *required*

#### Parameters

**read** `Func\<PageRequest,Task\<Page\<\<T\>\>\>\>` *required*

**Type:** `Func<PageRequest,Task<Page<<T>>>>`

**size** `int`

**onPage** `Action\<Page\<\<T\>\>\>`

**Type:** `Action<Page<<T>>>`

**cache** `ReadCache`

#### Returns

`Task<PagedRead<<T>>>`

### ReadCatalogAsync()

```csharp
public static Task<CatalogRead> ReadCatalogAsync(this ITargetConnector connector, ConnectorManifest manifest, ConnectionContext context, int size = 1000, bool records = true, CancellationToken cancellationToken = default)
```

Reads every page of the records of each object fields take values from, unless `records` is [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool), and of each values\_from lookup list, and discovers the fields the tenant adds at each extensible item, and lists each declared resource from the values that reach it.

A source that fails to read, or reads only in part, becomes one of the catalog's read errors, named by its field. Fields the tenant adds at a path no item marks extensible are refused, as a read error named by that path.

#### Parameters

**connector** `ITargetConnector` *required*

**manifest** `ConnectorManifest` *required*

**context** `ConnectionContext` *required*

**size** `int`

**records** `bool`

**cancellationToken** `CancellationToken`

#### Returns

`Task<CatalogRead>`

### ReadChangesAsync()

```csharp
public static Task<ChangesRead?> ReadChangesAsync<T>(Func<PageRequest, Task<Page<T>>> read, Func<Page<T>, Task> onPage, Func<T, string> idOf, int size = 1000, ReadCache? cache = null)
```

Reads what changed since a watermark, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when the vendor says to read in full.

#### Type Parameters

**T** *required*

#### Parameters

**read** `Func\<PageRequest,Task\<Page\<\<T\>\>\>\>` *required*

**Type:** `Func<PageRequest,Task<Page<<T>>>>`

**onPage** `Func\<Page\<\<T\>\>,Task\>` *required*

**Type:** `Func<Page<<T>>,Task>`

**idOf** `Func\<T, string\>` *required*

**size** `int`

**cache** `ReadCache`

#### Returns

`Task<ChangesRead>`

### ReadPagesAsync()

```csharp
public static Task<PagesRead> ReadPagesAsync<T>(Func<PageRequest, Task<Page<T>>> read, Func<Page<T>, Task> onPage, int size = 1000, ReadCache? cache = null)
```

Reads a list, handing over each page.

#### Type Parameters

**T** *required*

#### Parameters

**read** `Func\<PageRequest,Task\<Page\<\<T\>\>\>\>` *required*

**Type:** `Func<PageRequest,Task<Page<<T>>>>`

**onPage** `Func\<Page\<\<T\>\>,Task\>` *required*

**Type:** `Func<Page<<T>>,Task>`

**size** `int`

**cache** `ReadCache`

#### Returns

`Task<PagesRead>`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.