CommunitiesClient

​

하위 모듈

• xdk.communities.client 모듈
  • CommunitiesClient
    • CommunitiesClient.__init__()
    • CommunitiesClient.get_by_id()
    • CommunitiesClient.search()
• xdk.communities.models 모듈
  • GetByIdResponse
    • GetByIdResponse.model_config
  • SearchResponse
    • SearchResponse.model_config

​

모듈 내용

이 모듈은 X API의 커뮤니티 관련 엔드포인트에 대한 접근을 제공하며, 커뮤니티 관련 모든 기능을 위한 주요 진입점 역할을 합니다.

​

class xdk.communities.CommunitiesClient

커뮤니티 관련 작업을 위한 Client

​

매개변수

path.client · Client

​

__init__

​

매개변수

path.client · Client

​

get_by_id

id로 Community 가져오기 지정된 id를 사용하여 특정 Community의 세부 정보를 조회합니다.

​

매개변수

path.id · Any

커뮤니티의 ID입니다.

path.community_fields · List or None · 기본값: "None"

표시할 커뮤니티 필드를 쉼표로 구분한 목록입니다.

​

반환값

GetByIdResponse - 응답 데이터

​

search

커뮤니티 검색 지정된 검색 쿼리와 일치하는 커뮤니티 목록을 가져옵니다.

​

Parameters

path.query · str

커뮤니티를 검색하기 위한 쿼리입니다.

path.max_results · int or None · 기본값: "None"

요청에서 반환할 검색 결과의 최대 개수입니다.

path.next_token · Any or None · 기본값: "None"

다음 ‘페이지’의 결과를 가져올 때 사용하는 파라미터입니다. 이 파라미터에 사용되는 값은 API가 제공한 응답에서 그대로 가져오며, 수정해서는 안 됩니다.

path.pagination_token · Any or None · 기본값: "None"

다음 ‘페이지’의 결과를 가져올 때 사용하는 파라미터입니다. 이 파라미터에 사용되는 값은 API가 제공한 응답에서 그대로 가져오며, 수정해서는 안 됩니다.

path.community_fields · List or None · 기본값: "None"

표시할 커뮤니티 필드를 쉼표로 구분한 리스트입니다.

​

반환

IteratorSearchResponse