생성자
constructor
client): UsersClient
새 Users 클라이언트 인스턴스를 생성합니다
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
client | Client | 주요 X API 클라이언트 인스턴스 |
반환
UsersClient
정의됨
users/client.ts:720메서드
getMentions
id, options?): Promise<Get2UsersIdMentionsResponse>
멘션 가져오기
지정한 User의 id를 기준으로 해당 User를 언급한 Post 목록을 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 조회할 사용자 ID입니다. |
options | GetMentionsOptions | - |
반환
Promise<Get2UsersIdMentionsResponse>
API 응답으로 이행되는 Promise
정의 위치
users/client.ts:737getRepostsOfMe
options?): Promise<Get2UsersRepostsOfMeResponse>
나에 대한 리포스트 가져오기
인증된 사용자의 콘텐츠를 리포스트한 Post 목록을 반환합니다.
매개변수
| 이름 | 유형 |
|---|---|
options | GetRepostsOfMeOptions |
반환값
Promise<Get2UsersRepostsOfMeResponse>
API 응답으로 해결되는 Promise
정의됨
users/client.ts:849getBookmarks
id, options?): Promise<Get2UsersIdBookmarksResponse>
북마크 가져오기
인증된 사용자가 북마크한 Post 목록을 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 결과를 반환할 인증된 소스 사용자에 대한 ID입니다. |
options | GetBookmarksOptions | - |
반환
Promise<Get2UsersIdBookmarksResponse>
API 응답으로 이행되는 Promise
정의됨
users/client.ts:938createBookmark
id, body): Promise<BookmarkMutationResponse>
북마크 생성
인증된 사용자의 북마크에 Post를 추가합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 북마크를 추가할 인증된 소스 사용자의 ID. |
body | BookmarkAddRequest | 요청 본문 |
반환값
Promise<BookmarkMutationResponse>
API 응답으로 resolve되는 Promise
정의된 위치
getBlocking
id, options?): Promise<Get2UsersIdBlockingResponse>
차단 조회
지정된 사용자 ID가 차단한 사용자 목록을 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 결과를 반환할 인증된 소스 사용자의 id입니다. |
options | GetBlockingOptions | - |
반환
Promise<Get2UsersIdBlockingResponse>
API 응답으로 이행되는 Promise
정의됨
users/client.ts:1075getBookmarksByFolderId
id, folderId): Promise<BookmarkFolderPostsResponse>
폴더 ID로 북마크 가져오기
인증된 사용자의 특정 북마크 폴더에서 해당 ID로 포함된 Posts를 가져옵니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 결과를 반환할 인증된 소스 사용자(User)의 id입니다. |
folderId | string | 인증된 사용자(User)가 Post를 가져오려는 북마크 폴더의 id입니다. |
반환
Promise<BookmarkFolderPostsResponse>
API 응답으로 해결되는 Promise
정의 위치
users/client.ts:1153getById
id, options?): Promise<Get2UsersIdResponse>
ID로 사용자 조회
ID를 통해 특정 사용자의 세부 정보를 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 조회할 사용자(User)의 id. |
options | GetByIdOptions | - |
반환
Promise<Get2UsersIdResponse>
API 응답으로 이행되는 Promise
정의됨
users/client.ts:1196unrepostPost
id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>
Post 재게시 취소
인증된 사용자가 ID로 지정된 특정 Post의 재게시를 취소합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | Post 재게시를 요청하는 인증된 소스 사용자의 ID입니다. |
sourceTweetId | string | 사용자가 리트윗 취소를 요청하는 Post의 ID입니다. |
반환
Promise<UsersRetweetsDeleteResponse>
API 응답으로 resolve되는 Promise
정의된 위치
getFollowers
id, options?): Promise<Get2UsersIdFollowersResponse>
팔로워 가져오기
지정한 사용자의 ID를 기준으로 해당 사용자를 팔로우하는 사용자 목록을 반환합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 조회할 사용자의 id입니다. |
options | GetFollowersOptions | - |
반환
Promise<Get2UsersIdFollowersResponse>
API 응답으로 resolve되는 Promise
정의 위치
users/client.ts:1308likePost
id, options?): Promise<UsersLikesCreateResponse>
Post 좋아요
인증된 사용자가 지정된 ID의 특정 Post에 좋아요를 표시합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | Post에 좋아요를 요청하는 인증된 소스 User의 ID입니다. |
options | LikePostOptions | - |
반환
Promise<UsersLikesCreateResponse>
API 응답으로 resolve되는 Promise
정의 위치
users/client.ts:1382unlikePost
id, tweetId): Promise<UsersLikesDeleteResponse>
Post 좋아요 취소
인증된 사용자가 ID로 지정된 특정 Post의 좋아요를 취소합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 좋아요 취소를 요청하는 인증된 소스 사용자의 ID입니다. |
tweetId | string | 사용자가 좋아요 취소를 요청하는 Post의 ID입니다. |
반환
Promise<UsersLikesDeleteResponse>
API 응답으로 해결되는 Promise
정의 위치
users/client.ts:1434unfollowList
id, listId): Promise<ListFollowedResponse>
리스트 팔로우 해제
인증된 사용자가 지정한 ID의 특정 리스트 팔로우를 해제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 목록 언팔로우를 수행하는 인증된 소스 사용자(User)의 id입니다. |
listId | string | 언팔로우할 목록(List)의 id입니다. |
반환값
Promise<ListFollowedResponse>
API 응답으로 resolve되는 Promise
정의됨
users/client.ts:1478getFollowing
id, options?): Promise<Get2UsersIdFollowingResponse>
팔로잉 가져오기
특정 사용자의 ID를 통해 해당 사용자가 팔로우하는 사용자 목록을 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 조회할 사용자의 id입니다. |
options | GetFollowingOptions | - |
반환
Promise<Get2UsersIdFollowingResponse>
API 응답으로 해소되는 Promise
정의됨
users/client.ts:1521followUser
id, options?): Promise<UsersFollowingCreateResponse>
사용자 팔로우
인증된 사용자가 지정한 사용자 ID를 가진 사용자를 팔로우합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 대상 사용자를 팔로우하도록 요청하는 인증된 소스 사용자의 id입니다. |
options | FollowUserOptions | - |
반환
Promise<UsersFollowingCreateResponse>
API 응답으로 resolve되는 Promise
정의 위치
users/client.ts:1595getLikedPosts
id, options?): Promise<Get2UsersIdLikedTweetsResponse>
좋아요한 Post 가져오기
특정 사용자의 id를 사용해 해당 사용자가 좋아요한 Post 목록을 가져옵니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 조회할 사용자 id입니다. |
options | GetLikedPostsOptions | - |
반환
Promise<Get2UsersIdLikedTweetsResponse>
API 응답으로 이행되는 Promise
정의된 위치
unfollowUser
sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>
사용자 언팔로우
인증된 사용자가 지정된 사용자의 ID를 통해 해당 사용자의 팔로우를 취소합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
sourceUserId | string | 대상 사용자에 대한 언팔로우를 요청하는, 인증된 소스 사용자의 id입니다. |
targetUserId | string | 소스 사용자가 언팔로우를 요청하는 대상 사용자의 id입니다. |
반환
Promise<UsersFollowingDeleteResponse>
API 응답으로 resolve되는 Promise
정의됨
users/client.ts:1739unpinList
id, listId): Promise<ListUnpinResponse>
리스트 고정 해제
인증된 사용자가 ID로 지정된 특정 리스트의 고정을 해제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 결과를 반환할 인증된 소스 사용자의 id입니다. |
listId | string | 고정을 해제할 리스트의 id입니다. |
반환값
Promise<ListUnpinResponse>
API 응답으로 해결되는 Promise
정의된 위치
repostPost
id, options?): Promise<UsersRetweetsCreateResponse>
Post 리포스트
인증된 사용자가 ID로 지정된 특정 Post를 리포스트합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | Post를 재게시하도록 요청하는 인증된 소스 사용자(User)의 id입니다. |
options | RepostPostOptions | - |
반환값
Promise<UsersRetweetsCreateResponse>
API 응답으로 resolve되는 Promise
정의 위치
users/client.ts:1832getPinnedLists
id, options?): Promise<Get2UsersIdPinnedListsResponse>
고정된 리스트 가져오기
인증된 사용자가 고정한 리스트를 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 결과를 반환할 인증된 소스 사용자에 대한 ID입니다. |
options | GetPinnedListsOptions | - |
반환
Promise<Get2UsersIdPinnedListsResponse>
API 응답으로 resolve되는 Promise
정의됨
users/client.ts:1880pinList
id, body): Promise<ListPinnedResponse>
리스트 고정
인증된 사용자가 ID로 지정한 특정 리스트를 고정합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 목록을 고정할 인증된 소스 사용자의 ID. |
body | ListPinnedRequest | 요청 본문 |
반환
Promise<ListPinnedResponse>
API 응답으로 이행되는 Promise
정의됨
users/client.ts:1944getListMemberships
id, options?): Promise<Get2UsersIdListMembershipsResponse>
리스트 멤버십 조회
특정 사용자의 ID를 기준으로, 해당 사용자가 구성원으로 속한 리스트들을 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 조회할 사용자 id입니다. |
options | GetListMembershipsOptions | - |
반환
Promise<Get2UsersIdListMembershipsResponse>
API 응답으로 resolve되는 Promise
정의
users/client.ts:1984unmuteUser
sourceUserId, targetUserId): Promise<MuteUserMutationResponse>
사용자 음소거 해제
인증된 사용자가 사용자 ID로 지정된 특정 사용자의 음소거를 해제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
sourceUserId | string | 대상 사용자의 음소거 해제를 요청하는 인증된 소스 사용자의 id입니다. |
targetUserId | string | 소스 사용자가 음소거 해제를 요청하는 대상 사용자의 id입니다. |
반환값
Promise<MuteUserMutationResponse>
API 응답으로 해결되는 Promise
정의된 위치
blockDms
id): Promise<UsersDMBlockCreateResponse>
DM 차단
인증된 사용자가 특정 사용자의 ID를 지정하여 해당 사용자와의 다이렉트 메시지를 주고받지 못하도록 차단합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 인증된 사용자가 DM 차단을 요청하는 대상 사용자의 id입니다. |
반환값
Promise<UsersDMBlockCreateResponse>
API 응답으로 resolve되는 Promise
정의 위치
users/client.ts:2111getFollowedLists
id, options?): Promise<Get2UsersIdFollowedListsResponse>
팔로우한 Lists 가져오기
특정 사용자의 ID를 통해 해당 사용자가 팔로우 중인 Lists를 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 조회할 사용자 id입니다. |
options | GetFollowedListsOptions | - |
반환
Promise<Get2UsersIdFollowedListsResponse>
API 응답으로 이행되는 Promise
정의
users/client.ts:2149followList
id, options?): Promise<ListFollowedResponse>
리스트 팔로우
인증된 사용자가 ID로 지정된 특정 리스트를 팔로우합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 해당 목록을 팔로우할 인증된 소스 사용자(User)의 id입니다. |
options | FollowListOptions | - |
반환값
Promise<ListFollowedResponse>
API 응답으로 해석(resolve)되는 Promise
정의됨
users/client.ts:2223getByIds
ids, options?): Promise<Get2UsersResponse>
ID로 사용자 가져오기
여러 사용자의 상세 정보를 해당 ID로 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
ids | any[] | 쉼표로 구분된 사용자 ID 목록입니다. 최대 100개의 ID를 지정할 수 있습니다. |
options | GetByIdsOptions | - |
반환
Promise<Get2UsersResponse>
API 응답으로 이행되는 Promise
정의됨
users/client.ts:2271getMe
options?): Promise<Get2UsersMeResponse>
내 사용자 정보 가져오기
인증된 사용자의 상세 정보를 조회합니다.
매개변수
| 이름 | 타입 |
|---|---|
options | GetMeOptions |
반환값
Promise<Get2UsersMeResponse>
API 응답으로 resolve되는 Promise
정의된 위치
unblockDms
id): Promise<UsersDMUnBlockCreateResponse>
DM 차단 해제
인증된 사용자가 특정 사용자의 ID를 기준으로 해당 사용자와의 다이렉트 메시지를 차단 해제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 인증된 사용자가 DM 차단 해제를 요청하는 대상 사용자(User)의 id. |
반환
Promise<UsersDMUnBlockCreateResponse>
API 응답으로 해결되는 Promise
정의된 위치
getMuting
id, options?): Promise<Get2UsersIdMutingResponse>
뮤트 목록 가져오기
인증된 사용자가 뮤트한 사용자 목록을 가져옵니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 결과를 반환할 인증된 소스 사용자(User)의 id입니다. |
options | GetMutingOptions | - |
반환
Promise<Get2UsersIdMutingResponse>
API 응답으로 이행되는 Promise
정의된 위치
muteUser
id, options?): Promise<MuteUserMutationResponse>
사용자 음소거
인증된 사용자가 지정한 사용자 ID를 기준으로 해당 사용자를 음소거합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 대상 사용자의 음소거를 요청하는 인증된 소스 사용자의 id입니다. |
options | MuteUserOptions | - |
반환
Promise<MuteUserMutationResponse>
API 응답으로 resolve되는 Promise
정의
users/client.ts:2500getPosts
id, options?): Promise<Get2UsersIdTweetsResponse>
Post 가져오기
특정 사용자의 ID로 해당 사용자가 작성한 Post 목록을 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 조회할 사용자 id. |
options | GetPostsOptions | - |
반환
Promise<Get2UsersIdTweetsResponse>
API 응답으로 해석(resolve)되는 Promise
정의된 위치
deleteBookmark
id, tweetId): Promise<BookmarkMutationResponse>
북마크 삭제
인증된 사용자의 북마크에서 해당 ID의 Post를 제거합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 북마크에서 항목을 제거하려는 인증된 소스 사용자의 ID입니다. |
tweetId | string | 소스 사용자가 북마크에서 제거하려는 Post의 ID입니다. |
반환
Promise<BookmarkMutationResponse>
API 응답으로 이행되는 Promise
정의된 위치
getByUsernames
usernames, options?): Promise<Get2UsersByResponse>
사용자명으로 사용자 가져오기
여러 사용자의 세부 정보를 사용자명으로 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
usernames | any[] | 쉼표로 구분된 사용자 이름 목록입니다. |
options | GetByUsernamesOptions | - |
반환
Promise<Get2UsersByResponse>
API 응답으로 resolve되는 Promise
정의 위치
users/client.ts:2717getByUsername
username, options?): Promise<Get2UsersByUsernameUsernameResponse>
username으로 사용자 조회
username으로 특정 사용자의 상세 정보를 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
username | string | 사용자명. |
options | GetByUsernameOptions | - |
반환값
Promise<Get2UsersByUsernameUsernameResponse>
API 응답으로 이행되는 Promise
정의된 위치
getBookmarkFolders
id, options?): Promise<BookmarkFoldersResponse>
Bookmark 폴더 가져오기
인증된 사용자가 만든 Bookmark 폴더 목록을 가져옵니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 결과를 반환할 인증된 소스 사용자의 id입니다. |
options | GetBookmarkFoldersOptions | - |
반환
Promise<BookmarkFoldersResponse>
API 응답으로 이행되는 Promise
정의 위치
users/client.ts:2843search
query, options?): Promise<Get2UsersSearchResponse>
사용자 검색
검색 쿼리와 일치하는 사용자 목록을 반환합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
query | any | 사용자를 검색할 때 사용하는 쿼리 문자열입니다. |
options | SearchOptions | - |
반환값
Promise<Get2UsersSearchResponse>
API 응답으로 resolve되는 Promise입니다.
정의된 위치
getTimeline
id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
타임라인 가져오기
인증된 사용자의 타임라인에서 최신순(역순 연대기)으로 정렬된 Post 목록을 반환합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 인증된 소스 User의 역순(최신순) 타임라인 Post 목록을 조회할 대상의 id입니다. |
options | GetTimelineOptions | - |
반환
Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
API 응답으로 resolve되는 Promise
정의
users/client.ts:2975getOwnedLists
id, options?): Promise<Get2UsersIdOwnedListsResponse>
소유한 리스트 가져오기
특정 사용자의 ID로 그 사용자가 소유한 리스트 목록을 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 조회할 사용자 id. |
options | GetOwnedListsOptions | - |
반환
Promise<Get2UsersIdOwnedListsResponse>
API 응답으로 이행되는 Promise