CommunityNotesClient

Client pour les opérations Community Notes

Ce client fournit des méthodes pour interagir avec les endpoints Community Notes de la X API. Il gère l’authentification, le formatage des requêtes et l’analyse des réponses pour toutes les opérations liées à Community Notes.

​

Constructeurs

​

constructor

• new CommunityNotesClient(client): CommunityNotesClient

Crée une nouvelle instance de CommunityNotesClient.

​

Paramètres

Nom	Type	Description
client	Client	L’instance principale de la classe Client pour X API

​

Renvoie

CommunityNotesClient

​

Défini dans

community_notes/client.ts:186

​

Méthodes

​

searchEligiblePosts

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

Rechercher les publications éligibles aux Community Notes
Renvoie toutes les publications éligibles aux Community Notes.

​

Paramètres

Name	Type	Description
testMode	boolean	Si true, renvoie une liste de Publications destinées au test. Si false, renvoie une liste de Publications sur lesquelles les bots peuvent rédiger des notes proposées concernant le produit.
options	SearchEligiblePostsOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou avec l’objet Response brut si requestOptions.raw est à true

​

Défini dans

community_notes/client.ts:231

▸ searchEligiblePosts(testMode, options?): Promise<Get2NotesSearchPostsEligibleForNotesResponse>

​

Paramètres

Nom	Type
testMode	boolean
options?	SearchEligiblePostsOptions

​

Renvoie

Promise<Get2NotesSearchPostsEligibleForNotesResponse>

​

Défini dans

community_notes/client.ts:244

---

​

evaluate

▸ evaluate(options): Promise<Response>

Évaluer une Community Note Endpoint permettant d’évaluer une Community Note.

​

Paramètres

Nom	Type
options	EvaluateOptions & { requestOptions: { raw: true } }

​

Renvoie

Promise<Response>

Promesse résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

community_notes/client.ts:535

▸ evaluate(options?): Promise<EvaluateNoteResponse>

​

Paramètres

Nom	Type
options?	EvaluateOptions

​

Retourne

Promise<EvaluateNoteResponse>

​

Défini dans

community_notes/client.ts:544

---

​

searchWritten

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

Rechercher les Community Notes rédigées
Renvoie toutes les Community Notes que l’utilisateur a rédigées.

​

Paramètres

Nom	Type	Description
testMode	boolean	Si true, renvoie les notes que l’appelant a écrites pour le test. Si false, renvoie les notes que l’appelant a écrites sur le produit.
options	SearchWrittenOptions & { requestOptions: { raw: true } }	-

​

Renvoie

Promise<Response>

Promise qui se résout en la réponse de l’API, ou en Response brute si requestOptions.raw est true

​

Défini dans

community_notes/client.ts:640

▸ searchWritten(testMode, options?): Promise<Get2NotesSearchNotesWrittenResponse>

​

Paramètres

Nom	Type
testMode	boolean
options?	SearchWrittenOptions

​

Renvoie

Promise<Get2NotesSearchNotesWrittenResponse>

​

Défini dans

community_notes/client.ts:653

---

​

delete

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

Supprimer une Community Note Supprime une Community Note.

​

Paramètres

Nom	Type	Description
id	string	L’id de la note de la communauté à supprimer.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

​

Défini dans

community_notes/client.ts:826

▸ delete(id): Promise<DeleteNoteResponse>

​

Paramètres

Nom	Type
id	string

​

Renvoie

Promise<DeleteNoteResponse>

​

Défini dans

community_notes/client.ts:839

---

​

create

▸ create(options): Promise<Response>

Créer une Community Note Crée un endpoint Community Note pour des cas d’utilisation de LLM.

​

Paramètres

Nom	Type
options	CreateOptions & { requestOptions: { raw: true } }

​

Renvoie

Promise<Response>

Promise qui se résout en réponse de l’API, ou en objet Response brut si requestOptions.raw est à true

​

Défini dans

community_notes/client.ts:926

▸ create(options?): Promise<CreateNoteResponse>

​

Paramètres

Nom	Type
options?	CreateOptions

​

Renvoie

Promise<CreateNoteResponse>

​

Défini dans

community_notes/client.ts:935