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

# ActivityClient

アクティビティ操作用の Client

この Client は、X API のアクティビティ関連エンドポイントを操作するためのメソッドを提供します。すべてのアクティビティ関連の操作について、認証、リクエストの整形、レスポンスの解析を処理します。

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

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

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

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

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

| 名前       | 型                                                        | 説明                       |
| :------- | :------------------------------------------------------- | :----------------------- |
| `client` | [`Client`](/ja/xdks/typescript/reference/classes/Client) | X API のメイン Client インスタンス |

#### 戻り値

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

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

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

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

<div id="getsubscriptions">
  ### getSubscriptions
</div>

▸ **getSubscriptions**(`options`): `Promise`\<`Response`>

X のアクティビティサブスクリプションを取得します\
XAA の有効なサブスクリプションの一覧を取得します

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

| 名前                           | type     |
| :--------------------------- | :------- |
| `options`                    | `Object` |
| `options.requestOptions`     | `Object` |
| `options.requestOptions.raw` | `true`   |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の `Response` オブジェクトで解決される Promise

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

[activity/client.ts:159](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L159)

▸ **getSubscriptions**(): `Promise`\<[`ActivitySubscriptionGetResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionGetResponse)>

#### 戻り値

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

#### 定義元

[activity/client.ts:168](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L168)

***

<div id="createsubscription">
  ### createSubscription
</div>

▸ **createSubscription**(`options`): `Promise`\<`Response`>

X アクティビティサブスクリプションを作成します\
X アクティビティイベント向けのサブスクリプションを作成します

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

| パラメーター名   | type                                                                      |
| :-------- | :------------------------------------------------------------------------ |
| `options` | `CreateSubscriptionOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

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

`Promise`\<`Response`>

API レスポンスを返す Promise、または requestOptions.raw が true の場合は生の Response

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

[activity/client.ts:237](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L237)

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

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

| 名前         | type                        |
| :--------- | :-------------------------- |
| `options?` | `CreateSubscriptionOptions` |

#### 戻り値

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

#### 定義元

[activity/client.ts:246](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L246)

***

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

▸ **stream**(`options`): `Promise`\<`Response`>

アクティビティストリーム
X上のアクティビティストリーム

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

| 名前        | type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `StreamOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response へ解決される Promise

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

[activity/client.ts:332](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L332)

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

#### パラメータ

| 名前         | type            |
| :--------- | :-------------- |
| `options?` | `StreamOptions` |

#### 戻り値

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

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

[activity/client.ts:341](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L341)

***

<div id="updatesubscription">
  ### updateSubscription
</div>

▸ **updateSubscription**(`subscriptionId`, `options`): `Promise`\<`Response`>

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

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

| Name             | Type                                                                      | Description      |
| :--------------- | :------------------------------------------------------------------------ | :--------------- |
| `subscriptionId` | `string`                                                                  | 更新するサブスクリプションのID |
| `options`        | `UpdateSubscriptionOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを返す Promise。`requestOptions.raw` が true の場合は生の `Response` を返す

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

[activity/client.ts:487](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L487)

▸ **updateSubscription**(`subscriptionId`, `options?`): `Promise`\<[`ActivitySubscriptionUpdateResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionUpdateResponse)>

#### パラメータ

| 名前               | 型                           |
| :--------------- | :-------------------------- |
| `subscriptionId` | `string`                    |
| `options?`       | `UpdateSubscriptionOptions` |

#### 戻り値

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

#### 定義元

[activity/client.ts:500](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L500)

***

<div id="deletesubscription">
  ### deleteSubscription
</div>

▸ **deleteSubscription**(`subscriptionId`, `options`): `Promise`\<`Response`>

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

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

| 名前                           | 型        | 説明                |
| :--------------------------- | :------- | :---------------- |
| `subscriptionId`             | `string` | 削除するサブスクリプションの ID |
| `options`                    | `Object` | -                 |
| `options.requestOptions`     | `Object` | -                 |
| `options.requestOptions.raw` | `true`   | -                 |

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

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response に解決される Promise

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

[activity/client.ts:602](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L602)

▸ **deleteSubscription**(`subscriptionId`): `Promise`\<[`ActivitySubscriptionDeleteResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.ActivitySubscriptionDeleteResponse)>

#### パラメータ

| 名称               | 型        |
| :--------------- | :------- |
| `subscriptionId` | `string` |

#### 戻り値

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

#### 定義元

[activity/client.ts:615](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/activity/client.ts#L615)