메인 콘텐츠로 건너뛰기
connections 작업을 위한 Client 이 Client는 X API의 connections 엔드포인트와 상호 작용하기 위한 메서드를 제공합니다. 인증, 요청 포맷 구성, 응답 파싱을 포함해 connections 관련 모든 작업을 처리합니다.

생성자

constructor

new ConnectionsClient(client): ConnectionsClient ConnectionsClient 인스턴스를 생성합니다

매개변수

NameTypeDescription
clientClient주요 X API Client 인스턴스

반환

ConnectionsClient

정의 위치

connections/client.ts:88

메서드

getConnectionHistory

getConnectionHistory(options): Promise<Response> 연결 이력 가져오기
인증된 App의 활성 및 과거 스트리밍 연결과 각 연결 해제 사유를 반환합니다.

매개변수

이름type
optionsGetConnectionHistoryOptions & { requestOptions: { raw: true } }

반환

Promise<Response> API 응답으로 해결되는 Promise. 단, requestOptions.rawtrue이면 원시 Response 객체를 반환합니다.

정의 위치

connections/client.ts:129 getConnectionHistory(options?): Promise<Get2ConnectionsResponse>

매개변수

이름Type
options?GetConnectionHistoryOptions

반환값

Promise<Get2ConnectionsResponse>

정의된 위치

connections/client.ts:138

deleteAll

deleteAll(options): Promise<Response> 모든 연결 종료 인증된 App의 모든 활성 스트리밍 연결을 종료합니다.

매개변수

이름type
optionsObject
options.requestOptionsObject
options.requestOptions.rawtrue

Returns

Promise<Response> API 응답으로 resolve되는 Promise, 또는 requestOptions.raw가 true인 경우 원시 Response

정의 위치

connections/client.ts:318 deleteAll(): Promise<KillAllConnectionsResponse>

반환값

Promise<KillAllConnectionsResponse>

정의된 위치

connections/client.ts:327