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

# EventPaginator

イベント (DM イベントなど) を扱う Paginator

<div id="hierarchy">
  ## 継承階層
</div>

* [`Paginator`](/ja/xdks/typescript/reference/classes/Paginator)\<`any`>

  ↳ **`EventPaginator`**

<div id="constructors">
  ## コンストラクタ
</div>

<div id="constructor">
  ### constructor
</div>

• **new EventPaginator**(`fetchPage`): [`EventPaginator`](/ja/xdks/typescript/reference/classes/EventPaginator)

新しい `EventPaginator` インスタンスを作成します

<div id="parameters">
  #### パラメーター
</div>

| Name        | Type                                                                                                                          | Description                        |
| :---------- | :---------------------------------------------------------------------------------------------------------------------------- | :--------------------------------- |
| `fetchPage` | (`token?`: `string`) => `Promise`\<[`PaginatedResponse`](/ja/xdks/typescript/reference/interfaces/PaginatedResponse)\<`any`>> | ページネーション用トークンを指定してデータの1ページ分を取得する関数 |

<div id="returns">
  #### 戻り値
</div>

[`EventPaginator`](/ja/xdks/typescript/reference/classes/EventPaginator)

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[constructor](/ja/xdks/typescript/reference/classes/Paginator#constructor)

#### 定義元

[paginator.ts:90](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L90)

<div id="accessors">
  ## アクセサ
</div>

<div id="items">
  ### items
</div>

• `get` **items**(): `T`\[]

取得済みのすべてのアイテムを返します

<div id="returns">
  #### 戻り値
</div>

`T`\[]

<div id="inherited-from">
  #### 継承元
</div>

Paginator.items

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:97](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L97)

***

<div id="meta">
  ### meta
</div>

• `get` **meta**(): `any`

現在のページネーション用メタデータを取得します

<div id="returns">
  #### 戻り値
</div>

`any`

<div id="inherited-from">
  #### 継承元
</div>

Paginator.meta

#### 定義元

[paginator.ts:104](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L104)

***

<div id="includes">
  ### includes
</div>

• `get` **includes**(): `undefined` | `Record`\<`string`, `any`>

現在の includes データを取得します

<div id="returns">
  #### 戻り値
</div>

`undefined` | `Record`\<`string`, `any`>

<div id="inherited-from">
  #### 継承元
</div>

Paginator.includes

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:111](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L111)

***

<div id="errors">
  ### errors
</div>

• `get` **errors**(): `undefined` | `any`\[]

現在の errors を取得します

<div id="returns">
  #### 戻り値
</div>

`undefined` | `any`\[]

<div id="inherited-from">
  #### 継承元
</div>

Paginator.errors

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:118](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L118)

***

<div id="done">
  ### done
</div>

• `get` **done**(): `boolean`

ページネーションが完了しているかどうかを確認します

<div id="returns">
  #### 戻り値
</div>

`boolean`

<div id="inherited-from">
  #### 継承元
</div>

Paginator.done

#### 定義元

[paginator.ts:125](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L125)

***

<div id="ratelimited">
  ### rateLimited
</div>

• `get` **rateLimited**(): `boolean`

レート制限に達したかどうかを確認します。

<div id="returns">
  #### 戻り値
</div>

`boolean`

<div id="inherited-from">
  #### 継承元
</div>

Paginator.rateLimited

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:132](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L132)

***

<div id="events">
  ### events
</div>

• `get` **events**(): `any`\[]

<div id="returns">
  #### 戻り値
</div>

`any`\[]

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:362](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L362)

<div id="methods">
  ## メソッド
</div>

<div id="fetchnext">
  ### fetchNext
</div>

▸ **fetchNext**(): `Promise`\<`void`>

次のページを取得し、現在のインスタンスに項目を追加します

このメソッドは次のページのデータを取得し、その項目を現在の paginator インスタンスに追加します。ページネーションの状態とメタデータを更新します。

<div id="returns">
  #### 戻り値
</div>

`Promise`\<`void`>

**`使用例`**

```typescript theme={null}
const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // 最初のページを取得
console.log(followers.items.length); // フォロワーの数

if (!followers.done) {
  await followers.fetchNext(); // 2ページ目を取得
  console.log(followers.items.length); // ページ全体のフォロワー総数
}
```

**`Throws`**

API リクエストが失敗した場合にスローされます

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[fetchNext](/ja/xdks/typescript/reference/classes/Paginator#fetchnext)

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:156](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L156)

***

<div id="next">
  ### next
</div>

▸ **next**(): `Promise`\<[`Paginator`](/ja/xdks/typescript/reference/classes/Paginator)\<`any`>>

次のページを新しいインスタンスとして取得します。

このメソッドは、現在の paginator の状態に影響を与えることなく、次のページから開始する新しい paginator インスタンスを生成します。

<div id="returns">
  #### 戻り値
</div>

`Promise`\<[`Paginator`](/ja/xdks/typescript/reference/classes/Paginator)\<`any`>>

次ページ用の新しい `Paginator` インスタンス

**`Example`**

```typescript theme={null}
const followers = await client.users.getFollowers('783214');
await followers.fetchNext(); // 最初のページを取得

if (!followers.done) {
  const nextPage = await followers.next(); // 次のページを新しいインスタンスとして取得
  console.log(followers.items.length); // まだ最初のページ
  console.log(nextPage.items.length); // 2ページ目
}
```

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[next](/ja/xdks/typescript/reference/classes/Paginator#next)

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:211](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L211)

***

<div id="fetchprevious">
  ### fetchPrevious
</div>

▸ **fetchPrevious**(): `Promise`\<`void`>

前のページを取得します (対応している場合) 。

<div id="returns">
  #### 戻り値
</div>

`Promise`\<`void`>

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[fetchPrevious](/ja/xdks/typescript/reference/classes/Paginator#fetchprevious)

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:225](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L225)

***

<div id="previous">
  ### previous
</div>

▸ **previous**(): `Promise`\<[`Paginator`](/ja/xdks/typescript/reference/classes/Paginator)\<`any`>>

前のページを新しいインスタンスとして取得します。

<div id="returns">
  #### 戻り値
</div>

`Promise`\<[`Paginator`](/ja/xdks/typescript/reference/classes/Paginator)\<`any`>>

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[previous](/ja/xdks/typescript/reference/classes/Paginator#previous)

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:260](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L260)

***

<div id="fetchlast">
  ### fetchLast
</div>

▸ **fetchLast**(`count`): `Promise`\<`void`>

最大で指定した数の追加アイテムを取得します

#### パラメータ

| 名前      | type     |
| :------ | :------- |
| `count` | `number` |

<div id="returns">
  #### 戻り値
</div>

`Promise`\<`void`>

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[fetchLast](/ja/xdks/typescript/reference/classes/Paginator#fetchlast)

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:274](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L274)

***

<div id="reset">
  ### reset
</div>

▸ **reset**(): `void`

ページネーターを初期状態にリセットします。

<div id="returns">
  #### 戻り値
</div>

`void`

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[reset](/ja/xdks/typescript/reference/classes/Paginator#reset)

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:288](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L288)

***

<div id="iterator">
  ### \[iterator]
</div>

▸ **\[iterator]**(): `Iterator`\<`any`, `any`, `undefined`>

取得されたすべての項目に対するイテレータ

<div id="returns">
  #### 戻り値
</div>

`Iterator`\<`any`, `any`, `undefined`>

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[\[iterator\]](Paginator.md#\[iterator])

#### 定義箇所

[paginator.ts:303](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L303)

***

<div id="asynciterator">
  ### \[asyncIterator]
</div>

▸ **\[asyncIterator]**(): `AsyncIterator`\<`any`, `any`, `undefined`>

ページを自動取得する非同期イテレーター

<div id="returns">
  #### 戻り値
</div>

`AsyncIterator`\<`any`, `any`, `undefined`>

<div id="inherited-from">
  #### 継承元
</div>

[Paginator](/ja/xdks/typescript/reference/classes/Paginator).[\[asyncIterator\]](Paginator.md#\[asynciterator])

<div id="defined-in">
  #### 定義場所
</div>

[paginator.ts:312](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/paginator.ts#L312)