client): UsersClient
새 UsersClient 인스턴스를 생성합니다
매개변수
반환값
UsersClient
정의 위치
users/client.ts:1234 ▸ getByUsernames(usernames, options): Promise<Response>
username으로 사용자 조회
여러 사용자의 세부 정보를 username으로 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise입니다. 단, requestOptions.raw가 true인 경우 원시 Response가 반환됩니다.
users/client.ts:1279
▸ getByUsernames(usernames, options?): Promise<Get2UsersByResponse>
매개변수
반환
Promise<Get2UsersByResponse>
users/client.ts:1292
▸ getRepostsOfMe(
options): Promise<Response>
나를 리포스트한 포스트 가져오기
인증된 사용자의 콘텐츠를 리포스트한 포스트 리스트를 가져옵니다.
매개변수
반환
Promise<Response>
API 응답을 resolve하는 Promise이거나, requestOptions.raw가 true인 경우 원본 Response 객체
users/client.ts:1471
▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>
매개변수
Promise<Get2UsersRepostsOfMeResponse>
정의 위치
users/client.ts:1480▸ unlikePost(
id, tweetId, options): Promise<Response>
게시물 좋아요 취소
인증된 사용자가 ID로 지정된 특정 게시물에 대한 좋아요를 취소합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:1741 ▸ unlikePost(id, tweetId): Promise<UsersLikesDeleteResponse>
매개변수
반환
Promise<UsersLikesDeleteResponse>
정의 위치
users/client.ts:1758▸ getBookmarks(
id, options): Promise<Response>
북마크 가져오기인증된 사용자가 북마크한 포스트 목록을 가져옵니다.
매개변수
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response입니다.
users/client.ts:1861
▸ getBookmarks(id, options?): Promise<Get2UsersIdBookmarksResponse>
매개변수
반환값
Promise<Get2UsersIdBookmarksResponse>
정의 위치
users/client.ts:1874▸ createBookmark(
id, body, options): Promise<Response>
북마크 생성
인증된 사용자의 북마크에 게시물을 추가합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:2139 ▸ createBookmark(id, body): Promise<BookmarkMutationResponse>
매개변수
반환값
Promise<BookmarkMutationResponse>
정의 위치
users/client.ts:2154▸ getFollowers(
id, options): Promise<Response>
팔로워 조회
특정 User의 id를 기준으로, 해당 User를 팔로우하는 User 리스트를 조회합니다.
매개변수
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response를 반환합니다.
users/client.ts:2245
▸ getFollowers(id, options?): Promise<Get2UsersIdFollowersResponse>
매개변수
반환
Promise<Get2UsersIdFollowersResponse>
정의 위치
users/client.ts:2258▸ unpinList(
id, listId, options): Promise<Response>
리스트 고정 해제
인증된 사용자가 ID로 지정한 특정 리스트의 고정을 해제합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:2474 ▸ unpinList(id, listId): Promise<ListUnpinResponse>
매개변수
반환값
Promise<ListUnpinResponse>
users/client.ts:2491
▸ getById(
id, options): Promise<Response>
id로 사용자 조회
특정 사용자의 세부 정보를 해당 id를 사용해 조회합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw 가 true 인 경우 원시 Response입니다.
users/client.ts:2594
▸ getById(id, options?): Promise<Get2UsersIdResponse>
매개변수
반환값
Promise<Get2UsersIdResponse>
정의 위치
users/client.ts:2607▸ getMentions(
id, options): Promise<Response>
멘션 가져오기
특정 사용자의 ID를 사용해 해당 사용자를 언급한 포스트 목록을 조회합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response
users/client.ts:2781
▸ getMentions(id, options?): Promise<Get2UsersIdMentionsResponse>
매개변수
Promise<Get2UsersIdMentionsResponse>
users/client.ts:2794
▸ unrepostPost(
id, sourceTweetId, options): Promise<Response>
게시물 리포스트 취소
인증된 사용자가 지정된 ID를 가진 특정 게시물의 리포스트를 취소합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:3149 ▸ unrepostPost(id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>
매개변수
반환값
Promise<UsersRetweetsDeleteResponse>
정의된 곳
users/client.ts:3166▸ deleteBookmark(
id, tweetId, options): Promise<Response>
북마크 삭제
인증된 사용자의 북마크에서 지정된 ID의 게시물을 제거합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다
정의 위치
users/client.ts:3273 ▸ deleteBookmark(id, tweetId): Promise<BookmarkMutationResponse>
매개변수
반환값
Promise<BookmarkMutationResponse>
정의 위치
users/client.ts:3290▸ unfollowList(
id, listId, options): Promise<Response>
리스트 언팔로우
인증된 사용자가 ID로 지정된 특정 리스트의 팔로우를 해제합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw 가 true인 경우 원시 Response
정의 위치
users/client.ts:3391 ▸ unfollowList(id, listId): Promise<ListFollowedResponse>
매개변수
반환
Promise<ListFollowedResponse>
정의 위치
users/client.ts:3408▸ unmuteUser(
sourceUserId, targetUserId, options): Promise<Response>
사용자 음소거 해제
인증된 사용자가 id로 지정된 특정 사용자의 음소거를 해제합니다.
매개변수
반환값
Promise<Response>
API 응답을 resolve하는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response 객체
정의 위치
users/client.ts:3515 ▸ unmuteUser(sourceUserId, targetUserId): Promise<MuteUserMutationResponse>
매개변수
반환
Promise<MuteUserMutationResponse>
users/client.ts:3532
▸ getMe(
options): Promise<Response>
내 사용자 정보 가져오기
인증된 사용자의 상세 정보를 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다
users/client.ts:3631
▸ getMe(options?): Promise<Get2UsersMeResponse>
매개변수
반환값
Promise<Get2UsersMeResponse>
정의 위치
users/client.ts:3640▸ getMuting(
id, options): Promise<Response>
뮤트 대상 가져오기인증된 사용자가 뮤트한 사용자 목록을 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response입니다.
정의 위치
users/client.ts:3796 ▸ getMuting(id, options?): Promise<Get2UsersIdMutingResponse>
매개변수
반환
Promise<Get2UsersIdMutingResponse>
정의 위치
users/client.ts:3809▸ muteUser(
id, options): Promise<Response>
사용자 음소거
인증된 사용자가 해당 User의 id를 사용해 특정 사용자를 음소거합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response입니다.
users/client.ts:4015
▸ muteUser(id, options?): Promise<MuteUserMutationResponse>
매개변수
반환값
Promise<MuteUserMutationResponse>
정의 위치
users/client.ts:4028▸ search(
query, options): Promise<Response>
사용자 검색
검색 쿼리와 일치하는 사용자의 목록을 가져옵니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:4136 ▸ search(query, options?): Promise<Get2UsersSearchResponse>
매개변수
Promise<Get2UsersSearchResponse>
정의 위치
users/client.ts:4149▸ getBlocking(
id, options): Promise<Response>
차단 목록 가져오기
지정된 사용자 ID가 차단한 사용자 목록을 조회합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response가 반환됩니다
정의 위치
users/client.ts:4362 ▸ getBlocking(id, options?): Promise<Get2UsersIdBlockingResponse>
매개변수
반환
Promise<Get2UsersIdBlockingResponse>
users/client.ts:4375
▸ getByIds(
ids, options): Promise<Response>
ID로 사용자 가져오기
여러 사용자의 세부 정보를 해당 ID로 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:4581 ▸ getByIds(ids, options?): Promise<Get2UsersResponse>
매개변수
반환값
Promise<Get2UsersResponse>
users/client.ts:4594
▸ getFollowing(
id, options): Promise<Response>
팔로우 중인 사용자 조회
지정된 User의 id를 사용하여 해당 User가 팔로우 중인 User 리스트를 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response
users/client.ts:4777
▸ getFollowing(id, options?): Promise<Get2UsersIdFollowingResponse>
매개변수
반환값
Promise<Get2UsersIdFollowingResponse>
정의 위치
users/client.ts:4790▸ followUser(
id, options): Promise<Response>
사용자 팔로우
인증된 사용자가 특정 사용자의 id로 해당 사용자를 팔로우합니다.
매개변수
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response입니다
정의 위치
users/client.ts:5002 ▸ followUser(id, options?): Promise<UsersFollowingCreateResponse>
매개변수
Promise<UsersFollowingCreateResponse>
users/client.ts:5015
▸ likePost(
id, options): Promise<Response>
게시물 좋아요
인증된 사용자가 지정된 ID의 특정 게시물에 좋아요를 표시합니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:5123 ▸ likePost(id, options?): Promise<UsersLikesCreateResponse>
매개변수
반환값
Promise<UsersLikesCreateResponse>
정의 위치
users/client.ts:5136▸ getLikedPosts(
id, options): Promise<Response>
좋아요한 포스트 가져오기특정 사용자의 ID를 사용해 해당 사용자가 좋아요한 포스트 목록을 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response
users/client.ts:5244
▸ getLikedPosts(id, options?): Promise<Get2UsersIdLikedTweetsResponse>
매개변수
반환값
Promise<Get2UsersIdLikedTweetsResponse>
users/client.ts:5257
▸ getPosts(
id, options): Promise<Response>
포스트 가져오기
특정 사용자의 id를 사용해 해당 사용자가 작성한 포스트 목록을 조회합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response가 반환됩니다
정의 위치
users/client.ts:5526 ▸ getPosts(id, options?): Promise<Get2UsersIdTweetsResponse>
매개변수
반환
Promise<Get2UsersIdTweetsResponse>
users/client.ts:5539
▸ blockDms(
id, options): Promise<Response>
DM 차단
인증된 사용자에 대해 특정 사용자의 id를 기준으로, 해당 사용자와 주고받는 다이렉트 메시지를 차단합니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise. 단, requestOptions.raw가 true인 경우에는 원시 Response
정의 위치
users/client.ts:5909 ▸ blockDms(id): Promise<UsersDMBlockCreateResponse>
매개변수
반환값
Promise<UsersDMBlockCreateResponse>
정의 위치
users/client.ts:5922▸ getListMemberships(
id, options): Promise<Response>
리스트 멤버십 가져오기특정 사용자의 id를 기준으로, 그 사용자가 멤버로 속해 있는 리스트들의 목록을 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원본 Response를 반환합니다
정의 위치
users/client.ts:6013 ▸ getListMemberships(id, options?): Promise<Get2UsersIdListMembershipsResponse>
매개변수
반환
Promise<Get2UsersIdListMembershipsResponse>
users/client.ts:6026
▸ getPinnedLists(
id, options): Promise<Response>
고정된 리스트 가져오기
인증된 사용자가 고정한 리스트를 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw 가 true인 경우 원시 Response
정의 위치
users/client.ts:6238 ▸ getPinnedLists(id, options?): Promise<Get2UsersIdPinnedListsResponse>
매개변수
반환
Promise<Get2UsersIdPinnedListsResponse>
users/client.ts:6251
▸ pinList(
id, body, options): Promise<Response>
리스트 고정
인증된 사용자가 id를 사용해 특정 리스트를 고정합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise입니다. requestOptions.raw가 true인 경우 원시 Response가 반환됩니다
users/client.ts:6421
▸ pinList(id, body): Promise<ListPinnedResponse>
매개변수
반환
Promise<ListPinnedResponse>
users/client.ts:6436
▸ getByUsername(
username, options): Promise<Response>
username으로 User 조회
지정된 username을 가진 특정 User의 상세 정보를 조회합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:6533 ▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>
매개변수
반환값
Promise<Get2UsersByUsernameUsernameResponse>
users/client.ts:6546
▸ unfollowUser(
sourceUserId, targetUserId, options): Promise<Response>
사용자 언팔로우
인증된 사용자가 특정 id를 가진 사용자를 언팔로우합니다.
매개변수
반환
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response
users/client.ts:6724
▸ unfollowUser(sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>
매개변수
반환값
Promise<UsersFollowingDeleteResponse>
users/client.ts:6741
▸ getTimeline(
id, options): Promise<Response>
타임라인 가져오기
인증된 사용자의 타임라인에서 포스트를 최신순(시간 역순)으로 정렬한 목록을 가져옵니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원본 Response를 반환합니다.
users/client.ts:6844
▸ getTimeline(id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
매개변수
반환
Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
users/client.ts:6857
▸ getFollowedLists(
id, options): Promise<Response>
팔로우 중인 리스트 가져오기
특정 사용자 ID를 기준으로, 해당 사용자가 팔로우 중인 리스트 목록을 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response
정의 위치
users/client.ts:7221 ▸ getFollowedLists(id, options?): Promise<Get2UsersIdFollowedListsResponse>
매개변수
반환
Promise<Get2UsersIdFollowedListsResponse>
users/client.ts:7234
▸ followList(
id, options): Promise<Response>
리스트 팔로우
인증된 사용자가 지정된 id의 특정 리스트를 팔로우하도록 합니다.
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원본 Response를 반환합니다
users/client.ts:7446
▸ followList(id, options?): Promise<ListFollowedResponse>
매개변수
반환값
Promise<ListFollowedResponse>
정의 위치
users/client.ts:7459▸ unblockDms(
id, options): Promise<Response>
DM 차단 해제
인증된 사용자의 계정에서 특정 사용자의 ID를 지정해, 해당 사용자와 주고받는 다이렉트 메시지(DM) 차단을 해제합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise로, requestOptions.raw가 true인 경우 원시 Response를 반환합니다.
정의 위치
users/client.ts:7567 ▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>
매개변수
반환값
Promise<UsersDMUnBlockCreateResponse>
정의 위치
users/client.ts:7580▸ repostPost(
id, options): Promise<Response>
게시물 리포스트
인증된 사용자가 ID로 지정된 특정 게시물을 리포스트합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise, 또는 requestOptions.raw가 true인 경우 원시 Response 객체
정의 위치
users/client.ts:7671 ▸ repostPost(id, options?): Promise<UsersRetweetsCreateResponse>
매개변수
반환
Promise<UsersRetweetsCreateResponse>
users/client.ts:7684
▸ getBookmarkFolders(
id, options): Promise<Response>
북마크 폴더 가져오기
인증된 사용자가 만든 북마크 폴더 목록을 가져옵니다.
매개변수
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다.
users/client.ts:7792
▸ getBookmarkFolders(id, options?): Promise<BookmarkFoldersResponse>
매개변수
반환값
Promise<BookmarkFoldersResponse>
users/client.ts:7805
▸ getOwnedLists(
id, options): Promise<Response>
소유한 리스트 가져오기
특정 사용자의 id를 사용해, 해당 사용자가 소유한 리스트 목록을 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise, 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:7944 ▸ getOwnedLists(id, options?): Promise<Get2UsersIdOwnedListsResponse>
매개변수
반환값
Promise<Get2UsersIdOwnedListsResponse>
users/client.ts:7957
▸ getBookmarksByFolderId(
id, folderId, options): Promise<Response>
폴더 ID로 북마크 가져오기
인증된 사용자의 계정에서, 지정된 ID의 특정 북마크 폴더에 있는 포스트를 조회합니다.
매개변수
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
users/client.ts:8173 ▸ getBookmarksByFolderId(id, folderId): Promise<BookmarkFolderPostsResponse>
매개변수
Promise<BookmarkFolderPostsResponse>
users/client.ts:8190