メインコンテンツへスキップ

コンストラクター

constructor

new StreamClient(client): StreamClient

パラメーター

名前type
clientClient

戻り値

StreamClient

定義場所

stream/stream_client.ts:972

メソッド

likesCompliance

likesCompliance(options?): Promise<EventDrivenStream> Likes のコンプライアンスデータをストリーミングします
ユーザーの Likes に関連するすべてのコンプライアンスデータをストリーミングします。
扱いやすいイベント駆動型ストリームを返します。
.on() を使用して ‘data’、‘error’、‘close’ などのイベントをリッスンします。
for await…of による非同期イテレーションにも対応しています。

パラメーター

名前type
optionsLikesComplianceStreamingOptions

戻り値

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

定義場所

stream/stream_client.ts:1016

usersCompliance

usersCompliance(partition, options?): Promise<EventDrivenStream> ユーザーのコンプライアンスデータをストリーミングします
ユーザーに関連するすべてのコンプライアンスデータをストリーミングします。
扱いやすいイベント駆動型ストリームを返します。
.on() を使って、‘data’、‘error’、‘close’ などのイベントをリッスンできます。
for await...of 構文による非同期イテレーションにも対応しています。

パラメーター

NameTypeDescription
partitionnumberパーティション番号。
optionsUsersComplianceStreamingOptions-

戻り値

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

定義場所

stream/stream_client.ts:1196

postsFirehoseKo

postsFirehoseKo(partition, options?): Promise<EventDrivenStream> 韓国語の投稿をストリーミングします。 公開されている韓国語の投稿をリアルタイムにすべてストリーミングします。 扱いやすいイベント駆動ストリームを返します。 .on() を使って ‘data’、‘error’、‘close’ などのイベントをリッスンできます。 for await...of を用いた非同期イテレーションにも対応しています。

パラメーター

NameTypeDescription
partitionnumberパーティション番号。
optionsPostsFirehoseKoStreamingOptions-

戻り値

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

定義場所

stream/stream_client.ts:1392

likesSample10

likesSample10(partition, options?): Promise<EventDrivenStream> いいねのサンプルをストリーミングします
公開されているいいねの 10% サンプルをリアルタイムにストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って 'data''error''close' といったイベントをリッスンできます。
for await...of を使った非同期反復処理にも対応しています。

パラメーター

NameTypeDescription
partitionnumberパーティション番号。
optionsLikesSample10StreamingOptions-

Returns

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

定義場所

stream/stream_client.ts:1706

likesFirehose

likesFirehose(partition, options?): Promise<EventDrivenStream> すべてのLikeのストリーム すべての公開Likeをリアルタイムでストリーミングします。 使いやすいイベント駆動型ストリームを返します。 .on() を使用して、‘data’、‘error’、‘close’ などのイベントをリッスンできます。 for await...of を使った非同期イテレーションにも対応しています。

パラメーター

NameTypeDescription
partitionnumberパーティション番号。
optionsLikesFirehoseStreamingOptions-

戻り値

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

定義元

stream/stream_client.ts:1983

postsFirehoseJa

postsFirehoseJa(partition, options?): Promise<EventDrivenStream> 日本語の投稿をストリーミングします
すべての公開された日本語の投稿をリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ などのイベントをリッスンできます。
for await…of を使った非同期イテレーションにも対応しています。

パラメーター

名前説明
partitionnumberパーティション番号。
optionsPostsFirehoseJaStreamingOptions-

戻り値

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

定義元

stream/stream_client.ts:2257

postsFirehoseEn

postsFirehoseEn(partition, options?): Promise<EventDrivenStream> 英語の投稿ストリーム すべての公開されている英語の投稿をリアルタイムでストリーミングします。 使いやすいイベント駆動型ストリームを返します。 .on() を使って ‘data’、‘error’、‘close’ などのイベントをリッスンできます。 for await...of を使った非同期イテレーションにも対応しています。

パラメーター

名前説明
partitionnumberパーティション番号。
optionsPostsFirehoseEnStreamingOptions-

戻り値

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

定義場所

stream/stream_client.ts:2571

postsSample

postsSample(options?): Promise<EventDrivenStream> 投稿サンプルのストリーム 公開投稿の 1% サンプルをリアルタイムでストリーミングします。 扱いやすいイベント駆動型ストリームを返します。 .on() を使って ‘data’、‘error’、‘close’ などのイベントを監視できます。 for await...of を用いた非同期イテレーションにも対応しています。

パラメーター

名前
optionsPostsSampleStreamingOptions

戻り値

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

定義元

stream/stream_client.ts:2887

postsSample10

postsSample10(partition, options?): Promise<EventDrivenStream> 10% サンプルの投稿をストリーミングします
公開投稿の 10% サンプルをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
dataerrorclose といったイベントをリッスンするには .on() を使用します。
for await...of による非同期イテレーションにも対応しています。

パラメーター

NameTypeDescription
partitionnumberパーティション番号。
optionsPostsSample10StreamingOptions-

戻り値

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

定義場所

stream/stream_client.ts:3145

postsCompliance

postsCompliance(partition, options?): Promise<EventDrivenStream> 投稿コンプライアンスデータをストリーミングします
投稿に関連するすべてのコンプライアンスデータをストリーミングします。
使いやすいイベント駆動型ストリームを返します。
'data''error''close' などのイベントをリッスンするには .on() を使用します。
また、for await...of を使った非同期イテレーションにも対応しています。

パラメーター

NameTypeDescription
partitionnumberパーティション番号。
optionsPostsComplianceStreamingOptions-

戻り値

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

定義場所

stream/stream_client.ts:3459

labelsCompliance

labelsCompliance(options?): Promise<EventDrivenStream> ポストのラベルをストリーミングします。 投稿に適用されるすべてのラベル付与イベントをストリーミングします。 使いやすいイベント駆動型ストリームを返します。 .on() を使用して、'data''error''close' などのイベントを監視できます。 for await...of による非同期イテレーションにも対応しています。

パラメーター

名前type
optionsLabelsComplianceStreamingOptions

Returns

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

定義場所

stream/stream_client.ts:3651

posts

posts(options?): Promise<EventDrivenStream> フィルターされた投稿をストリーミングします
アクティブなルールセットにマッチする投稿をリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
'data''error''close' などのイベントを待ち受けるには .on() を使用します。
for await...of を使った非同期イテレーションにも対応しています。

パラメーター

名前
optionsPostsStreamingOptions

戻り値

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

定義場所

stream/stream_client.ts:3827

postsFirehose

postsFirehose(partition, options?): Promise<EventDrivenStream> すべての投稿をストリーミングします
すべての公開された投稿をリアルタイムでストリーミングします。
扱いやすいイベント駆動のストリームを返します。
'data''error''close' などのイベントを受信するには .on() を使用します。
for await...of 構文による async イテレーションにも対応しています。

パラメーター

NameTypeDescription
partitionnumberパーティション番号。
optionsPostsFirehoseStreamingOptions-

戻り値

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

定義元

stream/stream_client.ts:4125

postsFirehosePt

postsFirehosePt(partition, options?): Promise<EventDrivenStream> ポルトガル語の投稿ストリーム
すべての公開ポルトガル語の投稿をリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って、dataerrorclose などのイベントを監視できます。
for await...of 構文を使った非同期イテレーションにも対応しています。

パラメーター

名称Type説明
partitionnumberパーティション番号。
optionsPostsFirehosePtStreamingOptions-

戻り値

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

定義元

stream/stream_client.ts:4439

getRuleCounts

getRuleCounts(options?): Promise<Get2TweetsSearchStreamRulesCountsResponse> ストリームルール数を取得します
フィルタ済みストリームのアクティブなルールセット内にあるルール数を取得します。

パラメーター

名前
optionsGetRuleCountsStreamingOptions

戻り値

Promise<Get2TweetsSearchStreamRulesCountsResponse> API レスポンスを返す Promise

定義場所

stream/stream_client.ts:4753

getRules

getRules(options?): Promise<RulesLookupResponse> ストリームルールを取得します
フィルタ済みストリーム用の有効なルールセット全体、またはその一部を取得します。

パラメーター

名前
optionsGetRulesStreamingOptions

戻り値

Promise<RulesLookupResponse> API レスポンスを返す Promise

定義場所

stream/stream_client.ts:4854

updateRules

updateRules(body, options?): Promise<AddOrDeleteRulesResponse> ストリームルールを更新します
フィルター済みストリームのアクティブなルールセットに対して、ルールを追加または削除します。

パラメータ

名前type
bodyany
optionsUpdateRulesStreamingOptions

戻り値

Promise<AddOrDeleteRulesResponse> API レスポンスを返す Promise

定義場所

stream/stream_client.ts:4987