> ## 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.

# StreamClient

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

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

• **new StreamClient**(`client`): [`StreamClient`](/ja/xdks/typescript/reference/classes/StreamClient)

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

| 名前       | type                                                     |
| :------- | :------------------------------------------------------- |
| `client` | [`Client`](/ja/xdks/typescript/reference/classes/Client) |

#### 戻り値

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

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

[stream/stream\_client.ts:972](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L972)

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

<div id="likescompliance">
  ### likesCompliance
</div>

▸ **likesCompliance**(`options?`): `Promise`\<`EventDrivenStream`>

Likes のコンプライアンスデータをストリーミングします\
ユーザーの Likes に関連するすべてのコンプライアンスデータをストリーミングします。

扱いやすいイベント駆動型ストリームを返します。\
.on() を使用して 'data'、'error'、'close' などのイベントをリッスンします。\
for await...of による非同期イテレーションにも対応しています。

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

| 名前        | type                              |
| :-------- | :-------------------------------- |
| `options` | `LikesComplianceStreamingOptions` |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するためのイベント駆動ストリーム

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

[stream/stream\_client.ts:1016](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L1016)

***

<div id="userscompliance">
  ### usersCompliance
</div>

▸ **usersCompliance**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

ユーザーのコンプライアンスデータをストリーミングします\
ユーザーに関連するすべてのコンプライアンスデータをストリーミングします。

扱いやすいイベント駆動型ストリームを返します。\
`.on()` を使って、'data'、'error'、'close' などのイベントをリッスンできます。\
`for await...of` 構文による非同期イテレーションにも対応しています。

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

| Name        | Type                              | Description |
| :---------- | :-------------------------------- | :---------- |
| `partition` | `number`                          | パーティション番号。  |
| `options`   | `UsersComplianceStreamingOptions` | -           |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するためのイベント駆動ストリーム

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

[stream/stream\_client.ts:1196](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L1196)

***

<div id="postsfirehoseko">
  ### postsFirehoseKo
</div>

▸ **postsFirehoseKo**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

韓国語の投稿をストリーミングします。
公開されている韓国語の投稿をリアルタイムにすべてストリーミングします。

扱いやすいイベント駆動ストリームを返します。
`.on()` を使って 'data'、'error'、'close' などのイベントをリッスンできます。
`for await...of` を用いた非同期イテレーションにも対応しています。

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

| Name        | Type                              | Description |
| :---------- | :-------------------------------- | :---------- |
| `partition` | `number`                          | パーティション番号。  |
| `options`   | `PostsFirehoseKoStreamingOptions` | -           |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを扱うイベント駆動ストリーム

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

[stream/stream\_client.ts:1392](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L1392)

***

<div id="likessample10">
  ### likesSample10
</div>

▸ **likesSample10**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

いいねのサンプルをストリーミングします\
公開されているいいねの 10% サンプルをリアルタイムにストリーミングします。

使いやすいイベント駆動型ストリームを返します。\
`.on()` を使って `'data'`、`'error'`、`'close'` といったイベントをリッスンできます。\
`for await...of` を使った非同期反復処理にも対応しています。

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

| Name        | Type                            | Description |
| :---------- | :------------------------------ | :---------- |
| `partition` | `number`                        | パーティション番号。  |
| `options`   | `LikesSample10StreamingOptions` | -           |

<div id="returns">
  #### Returns
</div>

`Promise`\<`EventDrivenStream`>

ストリーミングデータを扱うイベント駆動ストリーム

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

[stream/stream\_client.ts:1706](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L1706)

***

<div id="likesfirehose">
  ### likesFirehose
</div>

▸ **likesFirehose**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

すべてのLikeのストリーム
すべての公開Likeをリアルタイムでストリーミングします。

使いやすいイベント駆動型ストリームを返します。
`.on()` を使用して、'data'、'error'、'close' などのイベントをリッスンできます。
`for await...of` を使った非同期イテレーションにも対応しています。

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

| Name        | Type                            | Description |
| :---------- | :------------------------------ | :---------- |
| `partition` | `number`                        | パーティション番号。  |
| `options`   | `LikesFirehoseStreamingOptions` | -           |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するためのイベント駆動ストリーム

#### 定義元

[stream/stream\_client.ts:1983](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L1983)

***

<div id="postsfirehoseja">
  ### postsFirehoseJa
</div>

▸ **postsFirehoseJa**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

日本語の投稿をストリーミングします\
すべての公開された日本語の投稿をリアルタイムでストリーミングします。

使いやすいイベント駆動型ストリームを返します。\
.on() を使って 'data'、'error'、'close' などのイベントをリッスンできます。\
for await...of を使った非同期イテレーションにも対応しています。

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

| 名前          | 型                                 | 説明         |
| :---------- | :-------------------------------- | :--------- |
| `partition` | `number`                          | パーティション番号。 |
| `options`   | `PostsFirehoseJaStreamingOptions` | -          |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するイベント駆動型ストリーム

#### 定義元

[stream/stream\_client.ts:2257](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L2257)

***

<div id="postsfirehoseen">
  ### postsFirehoseEn
</div>

▸ **postsFirehoseEn**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

英語の投稿ストリーム
すべての公開されている英語の投稿をリアルタイムでストリーミングします。

使いやすいイベント駆動型ストリームを返します。
`.on()` を使って 'data'、'error'、'close' などのイベントをリッスンできます。
`for await...of` を使った非同期イテレーションにも対応しています。

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

| 名前          | 型                                 | 説明         |
| :---------- | :-------------------------------- | :--------- |
| `partition` | `number`                          | パーティション番号。 |
| `options`   | `PostsFirehoseEnStreamingOptions` | -          |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するためのイベント駆動型ストリーム

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

[stream/stream\_client.ts:2571](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L2571)

***

<div id="postssample">
  ### postsSample
</div>

▸ **postsSample**(`options?`): `Promise`\<`EventDrivenStream`>

投稿サンプルのストリーム
公開投稿の 1% サンプルをリアルタイムでストリーミングします。

扱いやすいイベント駆動型ストリームを返します。
`.on()` を使って 'data'、'error'、'close' などのイベントを監視できます。
`for await...of` を用いた非同期イテレーションにも対応しています。

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

| 名前        | 型                             |
| :-------- | :---------------------------- |
| `options` | `PostsSampleStreamingOptions` |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するためのイベント駆動型のストリーム

#### 定義元

[stream/stream\_client.ts:2887](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L2887)

***

<div id="postssample10">
  ### postsSample10
</div>

▸ **postsSample10**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

10% サンプルの投稿をストリーミングします\
公開投稿の 10% サンプルをリアルタイムでストリーミングします。

使いやすいイベント駆動型ストリームを返します。\
`data`、`error`、`close` といったイベントをリッスンするには `.on()` を使用します。\
`for await...of` による非同期イテレーションにも対応しています。

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

| Name        | Type                            | Description |
| :---------- | :------------------------------ | :---------- |
| `partition` | `number`                        | パーティション番号。  |
| `options`   | `PostsSample10StreamingOptions` | -           |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するイベント駆動型のストリーム

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

[stream/stream\_client.ts:3145](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L3145)

***

<div id="postscompliance">
  ### postsCompliance
</div>

▸ **postsCompliance**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

投稿コンプライアンスデータをストリーミングします\
投稿に関連するすべてのコンプライアンスデータをストリーミングします。

使いやすいイベント駆動型ストリームを返します。\
`'data'`、`'error'`、`'close'` などのイベントをリッスンするには .on() を使用します。\
また、`for await...of` を使った非同期イテレーションにも対応しています。

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

| Name        | Type                              | Description |
| :---------- | :-------------------------------- | :---------- |
| `partition` | `number`                          | パーティション番号。  |
| `options`   | `PostsComplianceStreamingOptions` | -           |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを扱うイベント駆動ストリーム

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

[stream/stream\_client.ts:3459](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L3459)

***

<div id="labelscompliance">
  ### labelsCompliance
</div>

▸ **labelsCompliance**(`options?`): `Promise`\<`EventDrivenStream`>

ポストのラベルをストリーミングします。
投稿に適用されるすべてのラベル付与イベントをストリーミングします。

使いやすいイベント駆動型ストリームを返します。
`.on()` を使用して、`'data'`、`'error'`、`'close'` などのイベントを監視できます。
`for await...of` による非同期イテレーションにも対応しています。

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

| 名前        | type                               |
| :-------- | :--------------------------------- |
| `options` | `LabelsComplianceStreamingOptions` |

<div id="returns">
  #### Returns
</div>

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するためのイベント駆動型のストリーム

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

[stream/stream\_client.ts:3651](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L3651)

***

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

▸ **posts**(`options?`): `Promise`\<`EventDrivenStream`>

フィルターされた投稿をストリーミングします\
アクティブなルールセットにマッチする投稿をリアルタイムでストリーミングします。

使いやすいイベント駆動型ストリームを返します。\
`'data'`、`'error'`、`'close'` などのイベントを待ち受けるには `.on()` を使用します。\
`for await...of` を使った非同期イテレーションにも対応しています。

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

| 名前        | 型                       |
| :-------- | :---------------------- |
| `options` | `PostsStreamingOptions` |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを処理するためのイベント駆動型のストリーム

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

[stream/stream\_client.ts:3827](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L3827)

***

<div id="postsfirehose">
  ### postsFirehose
</div>

▸ **postsFirehose**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

すべての投稿をストリーミングします\
すべての公開された投稿をリアルタイムでストリーミングします。

扱いやすいイベント駆動のストリームを返します。\
`'data'`、`'error'`、`'close'` などのイベントを受信するには .on() を使用します。\
`for await...of` 構文による async イテレーションにも対応しています。

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

| Name        | Type                            | Description |
| :---------- | :------------------------------ | :---------- |
| `partition` | `number`                        | パーティション番号。  |
| `options`   | `PostsFirehoseStreamingOptions` | -           |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを扱うためのイベント駆動型ストリーム

#### 定義元

[stream/stream\_client.ts:4125](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L4125)

***

<div id="postsfirehosept">
  ### postsFirehosePt
</div>

▸ **postsFirehosePt**(`partition`, `options?`): `Promise`\<`EventDrivenStream`>

ポルトガル語の投稿ストリーム\
すべての公開ポルトガル語の投稿をリアルタイムでストリーミングします。

使いやすいイベント駆動型ストリームを返します。\
`.on()` を使って、`data`、`error`、`close` などのイベントを監視できます。\
`for await...of` 構文を使った非同期イテレーションにも対応しています。

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

| 名称          | Type                              | 説明         |
| :---------- | :-------------------------------- | :--------- |
| `partition` | `number`                          | パーティション番号。 |
| `options`   | `PostsFirehosePtStreamingOptions` | -          |

#### 戻り値

`Promise`\<`EventDrivenStream`>

ストリーミングデータを扱うイベント駆動型のストリーム

#### 定義元

[stream/stream\_client.ts:4439](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L4439)

***

<div id="getrulecounts">
  ### getRuleCounts
</div>

▸ **getRuleCounts**(`options?`): `Promise`\<[`Get2TweetsSearchStreamRulesCountsResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2TweetsSearchStreamRulesCountsResponse)>

ストリームルール数を取得します\
フィルタ済みストリームのアクティブなルールセット内にあるルール数を取得します。

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

| 名前        | 型                               |
| :-------- | :------------------------------ |
| `options` | `GetRuleCountsStreamingOptions` |

#### 戻り値

`Promise`\<[`Get2TweetsSearchStreamRulesCountsResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2TweetsSearchStreamRulesCountsResponse)>

API レスポンスを返す Promise

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

[stream/stream\_client.ts:4753](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L4753)

***

<div id="getrules">
  ### getRules
</div>

▸ **getRules**(`options?`): `Promise`\<[`RulesLookupResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.RulesLookupResponse)>

ストリームルールを取得します\
フィルタ済みストリーム用の有効なルールセット全体、またはその一部を取得します。

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

| 名前        | 型                          |
| :-------- | :------------------------- |
| `options` | `GetRulesStreamingOptions` |

#### 戻り値

`Promise`\<[`RulesLookupResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.RulesLookupResponse)>

API レスポンスを返す Promise

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

[stream/stream\_client.ts:4854](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L4854)

***

<div id="updaterules">
  ### updateRules
</div>

▸ **updateRules**(`body`, `options?`): `Promise`\<[`AddOrDeleteRulesResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.AddOrDeleteRulesResponse)>

ストリームルールを更新します\
フィルター済みストリームのアクティブなルールセットに対して、ルールを追加または削除します。

#### パラメータ

| 名前        | type                          |
| :-------- | :---------------------------- |
| `body`    | `any`                         |
| `options` | `UpdateRulesStreamingOptions` |

#### 戻り値

`Promise`\<[`AddOrDeleteRulesResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.AddOrDeleteRulesResponse)>

API レスポンスを返す Promise

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

[stream/stream\_client.ts:4987](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/stream/stream_client.ts#L4987)