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

# CommunityNotesClient

> X API TypeScript SDK의 CommunityNotesClient 클래스에 대한 레퍼런스. X API v2 community notes 엔드포인트에 대한 메서드, 매개변수 및 반환 타입.

community notes 작업을 위한 클라이언트

이 클라이언트는 X API의 community notes 엔드포인트와 상호작용하기 위한 메서드를
제공합니다. 모든 community notes 관련 작업에 대한 인증, 요청 형식화 및 응답
파싱을 처리합니다.

## 생성자

### constructor

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

새 community notes 클라이언트 인스턴스를 생성합니다

#### 매개변수

| 이름       | 타입                                                    | 설명                  |
| :------- | :---------------------------------------------------- | :------------------ |
| `client` | [`Client`](/xdks/typescript/reference/classes/Client) | 메인 X API 클라이언트 인스턴스 |

#### 반환값

[`CommunityNotesClient`](/xdks/typescript/reference/classes/CommunityNotesClient)

#### 정의 위치

[community\_notes/client.ts:186](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L186)

## 메서드

### searchEligiblePosts

▸ **searchEligiblePosts**(`testMode`, `options`): `Promise`\<`Response`>

Search for Posts Eligible for Community Notes
Community Notes에 적합한 모든 게시물을 반환합니다.

#### 매개변수

| 이름         | 타입                                                                         | 설명                                                                               |
| :--------- | :------------------------------------------------------------------------- | :------------------------------------------------------------------------------- |
| `testMode` | `boolean`                                                                  | true인 경우 테스트용 게시물 목록을 반환합니다. false인 경우 봇이 제품에 대해 제안된 노트를 작성할 수 있는 게시물 목록을 반환합니다. |
| `options`  | `SearchEligiblePostsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                                |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

[community\_notes/client.ts:231](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L231)

▸ **searchEligiblePosts**(`testMode`, `options?`): `Promise`\<[`Get2NotesSearchPostsEligibleForNotesResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2NotesSearchPostsEligibleForNotesResponse)>

#### 매개변수

| 이름         | 타입                           |
| :--------- | :--------------------------- |
| `testMode` | `boolean`                    |
| `options?` | `SearchEligiblePostsOptions` |

#### 반환값

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

#### 정의 위치

[community\_notes/client.ts:244](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L244)

***

### evaluate

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

Evaluate a Community Note
Community Note를 평가하는 엔드포인트.

#### 매개변수

| 이름        | 타입                                                              |
| :-------- | :-------------------------------------------------------------- |
| `options` | `EvaluateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

[community\_notes/client.ts:535](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L535)

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

#### 매개변수

| 이름         | 타입                |
| :--------- | :---------------- |
| `options?` | `EvaluateOptions` |

#### 반환값

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

#### 정의 위치

[community\_notes/client.ts:544](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L544)

***

### searchWritten

▸ **searchWritten**(`testMode`, `options`): `Promise`\<`Response`>

Search for Community Notes Written
사용자가 작성한 모든 community notes를 반환합니다.

#### 매개변수

| 이름         | 타입                                                                   | 설명                                                                      |
| :--------- | :------------------------------------------------------------------- | :---------------------------------------------------------------------- |
| `testMode` | `boolean`                                                            | true인 경우 호출자가 테스트를 위해 작성한 노트를 반환합니다. false인 경우 호출자가 제품에서 작성한 노트를 반환합니다. |
| `options`  | `SearchWrittenOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                                       |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

[community\_notes/client.ts:640](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L640)

▸ **searchWritten**(`testMode`, `options?`): `Promise`\<[`Get2NotesSearchNotesWrittenResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2NotesSearchNotesWrittenResponse)>

#### 매개변수

| 이름         | 타입                     |
| :--------- | :--------------------- |
| `testMode` | `boolean`              |
| `options?` | `SearchWrittenOptions` |

#### 반환값

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

#### 정의 위치

[community\_notes/client.ts:653](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L653)

***

### delete

▸ **delete**(`id`, `options`): `Promise`\<`Response`>

Delete a Community Note
community note를 삭제합니다.

#### 매개변수

| 이름                           | 타입       | 설명                        |
| :--------------------------- | :------- | :------------------------ |
| `id`                         | `string` | 삭제할 community note id입니다. |
| `options`                    | `Object` | -                         |
| `options.requestOptions`     | `Object` | -                         |
| `options.requestOptions.raw` | `true`   | -                         |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

[community\_notes/client.ts:826](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L826)

▸ **delete**(`id`): `Promise`\<[`DeleteNoteResponse`](/xdks/typescript/reference/interfaces/Schemas.DeleteNoteResponse)>

#### 매개변수

| 이름   | 타입       |
| :--- | :------- |
| `id` | `string` |

#### 반환값

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

#### 정의 위치

[community\_notes/client.ts:839](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L839)

***

### create

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

Create a Community Note
LLM 사용 사례를 위한 community note 엔드포인트를 생성합니다.

#### 매개변수

| 이름        | 타입                                                            |
| :-------- | :------------------------------------------------------------ |
| `options` | `CreateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

[community\_notes/client.ts:926](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L926)

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

#### 매개변수

| 이름         | 타입              |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### 반환값

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

#### 정의 위치

[community\_notes/client.ts:935](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/community_notes/client.ts#L935)