ActivityClient

このモジュールは、X API の activity エンドポイントと対話するためのクライアントを提供します。 リアルタイムのストリーミング処理は、到着したデータを逐次生成して返すジェネレーターを返します。 ストリーミング接続は、自動的に指数バックオフ付きのリトライロジックで管理され、堅牢に動作します。

​

ActivityClient

クラス 基底クラス: object

アクティビティ操作向けのストリーミング Client

​

コンストラクター

​

__init__

​

パラメータ

path.client · Client

​

create_subscription

X アクティビティのサブスクリプションを作成 X アクティビティイベント用のサブスクリプションを作成します body: リクエストボディ :returns: レスポンスデータ :rtype: CreateSubscriptionResponse

​

パラメーター

body.body · CreateSubscriptionRequest

​

delete_subscription

X アクティビティのサブスクリプションを削除します X アクティビティイベント用のサブスクリプションを削除します

​

パラメーター

path.subscription_id · Any

削除するサブスクリプションのID。

​

戻り値

DeleteSubscriptionResponse - レスポンスデータ

​

get_subscriptions

X アクティビティのサブスクリプションを取得します XAA の有効なサブスクリプションの一覧を取得します :returns: レスポンスデータ :rtype: GetSubscriptionsResponse

​

戻り値

GetSubscriptionsResponse

​

stream

Activity Stream（ストリーミング） X 上のアクティビティのストリーム これは、データが利用可能になり次第リアルタイムでデータを返すストリーミングエンドポイントです。 返される各アイテムは、ストリームからの 1 つのデータポイントを表します。 接続は指数バックオフによるリトライロジックで自動的に管理されます。 ストリームが切断された場合でも、SDK は Client 側での操作なしに自動で再接続します。

​

パラメーター

path.backfill_minutes · int or None · デフォルト: "None"

要求するバックフィルの分数。

path.start_time · str or None · デフォルト: "None"

YYYY-MM-DDTHH:mm:ssZ。ポストのラベルが提供される最も早い UTC タイムスタンプ。

path.end_time · str or None · デフォルト: "None"

YYYY-MM-DDTHH:mm:ssZ。ポストのラベルが提供される最も遅い UTC タイムスタンプ。

path.stream_config · StreamConfig

リトライ動作、タイムアウト、およびコールバックをカスタマイズするためのオプションの StreamConfig。

​

update_subscription

X アクティビティのサブスクリプションを更新する X アクティビティイベントのサブスクリプションを更新します

​

パラメーター

path.subscription_id · Any

更新するサブスクリプションのIDです。

body.body · UpdateSubscriptionRequest

リクエストボディ