# ItemKeyedDataSource.LoadInitialCallback

Artifact: [androidx.paging:paging-common](https://developer.android.com/jetpack/androidx/releases/paging) [View Source](https://cs.android.com/search?q=file:androidx/paging/ItemKeyedDataSource.jvmAndAndroid.kt+class:androidx.paging.ItemKeyedDataSource.LoadInitialCallback) Added in [2.0.0](https://developer.android.com/jetpack/androidx/releases/paging#2.0.0) Deprecated in [3.0.0](https://developer.android.com/jetpack/androidx/releases/paging#3.0.0)

*** ** * ** ***


```
public abstract class ItemKeyedDataSource.LoadInitialCallback<Value extends Object> extends ItemKeyedDataSource.LoadCallback<@NonNull Value>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.paging.ItemKeyedDataSource.LoadCallback](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadCallback)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) Value\> ||
|   | ↳ | [androidx.paging.ItemKeyedDataSource.LoadInitialCallback](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback) |

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> ItemKeyedDataSource is deprecated and has been replaced by PagingSource, use this instead:
>
> ```
> PagingSource<Key, Value>
> ```

Callback for `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource#loadInitial(androidx.paging.ItemKeyedDataSource.LoadInitialParams)` to return data and, optionally, position/count information.

A callback can be called only once, and will throw if called again.

If you can compute the number of items in the data set before and after the loaded range, call the three parameter `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback#onResult(kotlin.collections.List,kotlin.Int,kotlin.Int)` to pass that information. You can skip passing this information by calling the single parameter `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback#onResult(kotlin.collections.List,kotlin.Int,kotlin.Int)`, either if it's difficult to compute, or if `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialParams#placeholdersEnabled()` is `false`, so the positioning information will be ignored.

It is always valid for a DataSource loading method that takes a callback to stash the callback and call it later. This enables DataSources to be fully asynchronous, and to handle temporary, recoverable error states (such as a network error that can be retried).

| Parameters |
|---|---|
| `<Value extends https://developer.android.com/reference/java/lang/Object.html>` | Type of items being loaded. |

## Summary

| ### Public constructors |
|---|
| `<Value extends https://developer.android.com/reference/java/lang/Object.html> [LoadInitialCallback](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback#LoadInitialCallback())()` **This method is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource |

| ### Public methods |
|---|---|
| `abstract void` | `[onResult](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback#onResult(kotlin.collections.List,kotlin.Int,kotlin.Int))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull Value> data, int position, int totalCount)` **This method is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource |

### Inherited methods

From [androidx.paging.ItemKeyedDataSource.LoadCallback](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadCallback) `abstract void` `[onResult](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadCallback#onResult(kotlin.collections.List))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull Value> data)`

**This method is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource

## Public constructors

### LoadInitialCallback

```
public <Value extends Object> [LoadInitialCallback](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback#LoadInitialCallback())()
```

> [!CAUTION]
> **This method is deprecated.**   
> ItemKeyedDataSource is deprecated and has been replaced by PagingSource, use this instead:
>
> ```
> PagingSource<Key, Value>
> ```

| Parameters |
|---|---|
| `<Value extends https://developer.android.com/reference/java/lang/Object.html>` | Type of items being loaded. |

## Public methods

### onResult

Added in [2.0.0](https://developer.android.com/jetpack/androidx/releases/paging#2.0.0)

```
public abstract void [onResult](https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback#onResult(kotlin.collections.List,kotlin.Int,kotlin.Int))(@NonNull List<@NonNull Value> data, int position, int totalCount)
```

> [!CAUTION]
> **This method is deprecated.**   
> ItemKeyedDataSource is deprecated and has been replaced by PagingSource, use this instead:
>
> ```
> PagingSource<Key, Value>
> ```

Called to pass initial load state from a DataSource.

Call this method from your DataSource's `loadInitial` function to return data, and inform how many placeholders should be shown before and after. If counting is cheap to compute (for example, if a network load returns the information regardless), it's recommended to pass data back through this method.

It is always valid to pass a different amount of data than what is requested. Pass an empty list if there is no more data to load.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull Value> data` | List of items loaded from the DataSource. If this is empty, the DataSource is treated as empty, and no further loads will occur. |
| `int position` | Position of the item at the front of the list. If there are `N` items before the items in data that can be loaded from this DataSource, pass `N`. |
| `int totalCount` | Total number of items that may be returned from this `https://developer.android.com/reference/androidx/paging/DataSource`. Includes the number in the initial `data` parameter as well as any items that can be loaded in front or behind of `data`. |