생성자
constructor
• new UsersClient(client): UsersClient
새로운 users 클라이언트 인스턴스를 생성합니다.
매개변수
반환값
UsersClient
정의 위치
users/client.ts:1234메서드
getByUsernames
▸ getByUsernames(usernames, options): Promise<Response>
username으로 User 목록 조회
Retrieves details of multiple Users by their usernames.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:1279 ▸ getByUsernames(usernames, options?): Promise<Get2UsersByResponse>
매개변수
반환값
Promise<Get2UsersByResponse>
정의 위치
users/client.ts:1292getRepostsOfMe
▸ getRepostsOfMe(options): Promise<Response>
나의 리포스트 조회
Retrieves a list of Posts that repost content from the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:1471 ▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>
매개변수
반환값
Promise<Get2UsersRepostsOfMeResponse>
정의 위치
users/client.ts:1480unlikePost
▸ unlikePost(id, tweetId, options): Promise<Response>
Unlike Post
Causes the authenticated user to Unlike a specific Post by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:1741 ▸ unlikePost(id, tweetId): Promise<UsersLikesDeleteResponse>
매개변수
반환값
Promise<UsersLikesDeleteResponse>
정의 위치
users/client.ts:1758getBookmarks
▸ getBookmarks(id, options): Promise<Response>
Bookmark 목록 조회
Retrieves a list of Posts bookmarked by the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:1861 ▸ getBookmarks(id, options?): Promise<Get2UsersIdBookmarksResponse>
매개변수
반환값
Promise<Get2UsersIdBookmarksResponse>
정의 위치
users/client.ts:1874createBookmark
▸ createBookmark(id, body, options): Promise<Response>
Bookmark 생성
Adds a post to the authenticated user’s bookmarks.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:2139 ▸ createBookmark(id, body): Promise<BookmarkMutationResponse>
매개변수
반환값
Promise<BookmarkMutationResponse>
정의 위치
users/client.ts:2154getFollowers
▸ getFollowers(id, options): Promise<Response>
팔로워 조회
Retrieves a list of Users who follow a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:2245 ▸ getFollowers(id, options?): Promise<Get2UsersIdFollowersResponse>
매개변수
반환값
Promise<Get2UsersIdFollowersResponse>
정의 위치
users/client.ts:2258unpinList
▸ unpinList(id, listId, options): Promise<Response>
Unpin List
Causes the authenticated user to unpin a specific List by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:2474 ▸ unpinList(id, listId): Promise<ListUnpinResponse>
매개변수
반환값
Promise<ListUnpinResponse>
정의 위치
users/client.ts:2491getById
▸ getById(id, options): Promise<Response>
ID로 User 조회
Retrieves details of a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:2594 ▸ getById(id, options?): Promise<Get2UsersIdResponse>
매개변수
반환값
Promise<Get2UsersIdResponse>
정의 위치
users/client.ts:2607getMentions
▸ getMentions(id, options): Promise<Response>
Get mentions
Retrieves a list of Posts that mention a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:2781 ▸ getMentions(id, options?): Promise<Get2UsersIdMentionsResponse>
매개변수
반환값
Promise<Get2UsersIdMentionsResponse>
정의 위치
users/client.ts:2794unrepostPost
▸ unrepostPost(id, sourceTweetId, options): Promise<Response>
Unrepost Post
Causes the authenticated user to unrepost a specific Post by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:3149 ▸ unrepostPost(id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>
매개변수
반환값
Promise<UsersRetweetsDeleteResponse>
정의 위치
users/client.ts:3166deleteBookmark
▸ deleteBookmark(id, tweetId, options): Promise<Response>
Bookmark 삭제
Removes a Post from the authenticated user’s Bookmarks by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:3273 ▸ deleteBookmark(id, tweetId): Promise<BookmarkMutationResponse>
매개변수
반환값
Promise<BookmarkMutationResponse>
정의 위치
users/client.ts:3290unfollowList
▸ unfollowList(id, listId, options): Promise<Response>
Unfollow List
Causes the authenticated user to unfollow a specific List by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:3391 ▸ unfollowList(id, listId): Promise<ListFollowedResponse>
매개변수
반환값
Promise<ListFollowedResponse>
정의 위치
users/client.ts:3408unmuteUser
▸ unmuteUser(sourceUserId, targetUserId, options): Promise<Response>
Unmute User
Causes the authenticated user to unmute a specific user by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:3515 ▸ unmuteUser(sourceUserId, targetUserId): Promise<MuteUserMutationResponse>
매개변수
반환값
Promise<MuteUserMutationResponse>
정의 위치
users/client.ts:3532getMe
▸ getMe(options): Promise<Response>
Get my User
Retrieves details of the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:3631 ▸ getMe(options?): Promise<Get2UsersMeResponse>
매개변수
반환값
Promise<Get2UsersMeResponse>
정의 위치
users/client.ts:3640getMuting
▸ getMuting(id, options): Promise<Response>
뮤트 목록 조회
Retrieves a list of Users muted by the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:3796 ▸ getMuting(id, options?): Promise<Get2UsersIdMutingResponse>
매개변수
반환값
Promise<Get2UsersIdMutingResponse>
정의 위치
users/client.ts:3809muteUser
▸ muteUser(id, options): Promise<Response>
Mute User
Causes the authenticated user to mute a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:4015 ▸ muteUser(id, options?): Promise<MuteUserMutationResponse>
매개변수
반환값
Promise<MuteUserMutationResponse>
정의 위치
users/client.ts:4028search
▸ search(query, options): Promise<Response>
Search Users
Retrieves a list of Users matching a search query.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:4136 ▸ search(query, options?): Promise<Get2UsersSearchResponse>
매개변수
반환값
Promise<Get2UsersSearchResponse>
정의 위치
users/client.ts:4149getBlocking
▸ getBlocking(id, options): Promise<Response>
차단 목록 조회
Retrieves a list of Users blocked by the specified User ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:4362 ▸ getBlocking(id, options?): Promise<Get2UsersIdBlockingResponse>
매개변수
반환값
Promise<Get2UsersIdBlockingResponse>
정의 위치
users/client.ts:4375getByIds
▸ getByIds(ids, options): Promise<Response>
ID로 User 목록 조회
Retrieves details of multiple Users by their IDs.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:4581 ▸ getByIds(ids, options?): Promise<Get2UsersResponse>
매개변수
반환값
Promise<Get2UsersResponse>
정의 위치
users/client.ts:4594getFollowing
▸ getFollowing(id, options): Promise<Response>
팔로잉 조회
Retrieves a list of Users followed by a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:4777 ▸ getFollowing(id, options?): Promise<Get2UsersIdFollowingResponse>
매개변수
반환값
Promise<Get2UsersIdFollowingResponse>
정의 위치
users/client.ts:4790followUser
▸ followUser(id, options): Promise<Response>
Follow User
Causes the authenticated user to follow a specific user by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:5002 ▸ followUser(id, options?): Promise<UsersFollowingCreateResponse>
매개변수
반환값
Promise<UsersFollowingCreateResponse>
정의 위치
users/client.ts:5015likePost
▸ likePost(id, options): Promise<Response>
Like Post
Causes the authenticated user to Like a specific Post by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:5123 ▸ likePost(id, options?): Promise<UsersLikesCreateResponse>
매개변수
반환값
Promise<UsersLikesCreateResponse>
정의 위치
users/client.ts:5136getLikedPosts
▸ getLikedPosts(id, options): Promise<Response>
Get liked Posts
Retrieves a list of Posts liked by a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:5244 ▸ getLikedPosts(id, options?): Promise<Get2UsersIdLikedTweetsResponse>
매개변수
반환값
Promise<Get2UsersIdLikedTweetsResponse>
정의 위치
users/client.ts:5257getPosts
▸ getPosts(id, options): Promise<Response>
Post 목록 조회
Retrieves a list of posts authored by a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:5526 ▸ getPosts(id, options?): Promise<Get2UsersIdTweetsResponse>
매개변수
반환값
Promise<Get2UsersIdTweetsResponse>
정의 위치
users/client.ts:5539blockDms
▸ blockDms(id, options): Promise<Response>
Block DMs
Blocks direct messages to or from a specific User by their ID for the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:5909 ▸ blockDms(id): Promise<UsersDMBlockCreateResponse>
매개변수
반환값
Promise<UsersDMBlockCreateResponse>
정의 위치
users/client.ts:5922getListMemberships
▸ getListMemberships(id, options): Promise<Response>
List 멤버십 조회
Retrieves a list of Lists that a specific User is a member of by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:6013 ▸ getListMemberships(id, options?): Promise<Get2UsersIdListMembershipsResponse>
매개변수
반환값
Promise<Get2UsersIdListMembershipsResponse>
정의 위치
users/client.ts:6026getPinnedLists
▸ getPinnedLists(id, options): Promise<Response>
Get pinned Lists
Retrieves a list of Lists pinned by the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:6238 ▸ getPinnedLists(id, options?): Promise<Get2UsersIdPinnedListsResponse>
매개변수
반환값
Promise<Get2UsersIdPinnedListsResponse>
정의 위치
users/client.ts:6251pinList
▸ pinList(id, body, options): Promise<Response>
Pin List
Causes the authenticated user to pin a specific List by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:6421 ▸ pinList(id, body): Promise<ListPinnedResponse>
매개변수
반환값
Promise<ListPinnedResponse>
정의 위치
users/client.ts:6436getByUsername
▸ getByUsername(username, options): Promise<Response>
username으로 User 조회
Retrieves details of a specific User by their username.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:6533 ▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>
매개변수
반환값
Promise<Get2UsersByUsernameUsernameResponse>
정의 위치
users/client.ts:6546unfollowUser
▸ unfollowUser(sourceUserId, targetUserId, options): Promise<Response>
Unfollow User
Causes the authenticated user to unfollow a specific user by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:6724 ▸ unfollowUser(sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>
매개변수
반환값
Promise<UsersFollowingDeleteResponse>
정의 위치
users/client.ts:6741getTimeline
▸ getTimeline(id, options): Promise<Response>
타임라인 조회
Retrieves a reverse chronological list of Posts in the authenticated User’s Timeline.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:6844 ▸ getTimeline(id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
매개변수
반환값
Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
정의 위치
users/client.ts:6857getFollowedLists
▸ getFollowedLists(id, options): Promise<Response>
팔로우한 List 조회
Retrieves a list of Lists followed by a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:7221 ▸ getFollowedLists(id, options?): Promise<Get2UsersIdFollowedListsResponse>
매개변수
반환값
Promise<Get2UsersIdFollowedListsResponse>
정의 위치
users/client.ts:7234followList
▸ followList(id, options): Promise<Response>
Follow List
Causes the authenticated user to follow a specific List by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:7446 ▸ followList(id, options?): Promise<ListFollowedResponse>
매개변수
반환값
Promise<ListFollowedResponse>
정의 위치
users/client.ts:7459unblockDms
▸ unblockDms(id, options): Promise<Response>
Unblock DMs
Unblocks direct messages to or from a specific User by their ID for the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:7567 ▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>
매개변수
반환값
Promise<UsersDMUnBlockCreateResponse>
정의 위치
users/client.ts:7580repostPost
▸ repostPost(id, options): Promise<Response>
Repost Post
Causes the authenticated user to repost a specific Post by its ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:7671 ▸ repostPost(id, options?): Promise<UsersRetweetsCreateResponse>
매개변수
반환값
Promise<UsersRetweetsCreateResponse>
정의 위치
users/client.ts:7684getBookmarkFolders
▸ getBookmarkFolders(id, options): Promise<Response>
Bookmark 폴더 조회
Retrieves a list of Bookmark folders created by the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:7792 ▸ getBookmarkFolders(id, options?): Promise<BookmarkFoldersResponse>
매개변수
반환값
Promise<BookmarkFoldersResponse>
정의 위치
users/client.ts:7805getOwnedLists
▸ getOwnedLists(id, options): Promise<Response>
Get owned Lists
Retrieves a list of Lists owned by a specific User by their ID.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:7944 ▸ getOwnedLists(id, options?): Promise<Get2UsersIdOwnedListsResponse>
매개변수
반환값
Promise<Get2UsersIdOwnedListsResponse>
정의 위치
users/client.ts:7957getBookmarksByFolderId
▸ getBookmarksByFolderId(id, folderId, options): Promise<Response>
폴더 ID로 Bookmark 조회
Retrieves Posts in a specific Bookmark folder by its ID for the authenticated user.
매개변수
반환값
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
정의 위치
users/client.ts:8173 ▸ getBookmarksByFolderId(id, folderId): Promise<BookmarkFolderPostsResponse>
매개변수
반환값
Promise<BookmarkFolderPostsResponse>