UsersClient

사용자 관련 작업을 위한 Client

이 Client는 X API의 users 엔드포인트와 상호작용하기 위한 메서드를 제공합니다. 사용자 관련 모든 작업에 대해 인증, 요청 포맷 구성, 응답 파싱을 처리합니다.

​

생성자

​

constructor

• new UsersClient(client): UsersClient

새 UsersClient 인스턴스를 생성합니다

​

매개변수

Name	Type	Description
client	Client	X API의 기본 Client 인스턴스

​

반환값

UsersClient

​

정의 위치

users/client.ts:1234

​

메서드

​

getByUsernames

▸ getByUsernames(usernames, options): Promise<Response>

username으로 사용자 조회 여러 사용자의 세부 정보를 username으로 조회합니다.

​

매개변수

Name	Type	Description
usernames	any[]	쉼표로 구분된 사용자 이름 목록입니다.
options	GetByUsernamesOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise입니다. 단, requestOptions.raw가 true인 경우 원시 Response가 반환됩니다.

​

정의된 위치

users/client.ts:1279

▸ getByUsernames(usernames, options?): Promise<Get2UsersByResponse>

​

매개변수

이름	type
usernames	any[]
options?	GetByUsernamesOptions

​

반환

Promise<Get2UsersByResponse>

​

정의된 위치

users/client.ts:1292

---

​

getRepostsOfMe

▸ getRepostsOfMe(options): Promise<Response>

나를 리포스트한 포스트 가져오기 인증된 사용자의 콘텐츠를 리포스트한 포스트 리스트를 가져옵니다.

​

매개변수

이름	type
options	GetRepostsOfMeOptions & { requestOptions: { raw: true } }

​

반환

Promise<Response>

API 응답을 resolve하는 Promise이거나, requestOptions.raw가 true인 경우 원본 Response 객체

​

정의된 위치

users/client.ts:1471

▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>

​

매개변수

이름	type
options?	GetRepostsOfMeOptions

​

반환 값

Promise<Get2UsersRepostsOfMeResponse>

​

정의 위치

users/client.ts:1480

---

​

unlikePost

▸ unlikePost(id, tweetId, options): Promise<Response>

게시물 좋아요 취소 인증된 사용자가 ID로 지정된 특정 게시물에 대한 좋아요를 취소합니다.

​

매개변수

Name	Type	Description
id	string	게시물에 대해 좋아요를 취소하도록 요청하는 인증된 소스 사용자의 ID입니다.
tweetId	string	사용자가 좋아요 취소를 요청하는 게시물의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환

Promise<Response>

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

​

정의 위치

users/client.ts:1741

▸ unlikePost(id, tweetId): Promise<UsersLikesDeleteResponse>

​

매개변수

이름	타입
id	string
tweetId	string

​

반환

Promise<UsersLikesDeleteResponse>

​

정의 위치

users/client.ts:1758

---

​

getBookmarks

▸ getBookmarks(id, options): Promise<Response>

북마크 가져오기
인증된 사용자가 북마크한 포스트 목록을 가져옵니다.

​

매개변수

이름	타입	설명
id	string	결과를 조회할 인증된 소스 사용자(User)의 식별자입니다.
options	GetBookmarksOptions & { requestOptions: { raw: true } }	-

​

반환 값

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response입니다.

​

정의된 위치

users/client.ts:1861

▸ getBookmarks(id, options?): Promise<Get2UsersIdBookmarksResponse>

​

매개변수

이름	유형
id	string
options?	GetBookmarksOptions

​

반환값

Promise<Get2UsersIdBookmarksResponse>

​

정의 위치

users/client.ts:1874

---

​

createBookmark

▸ createBookmark(id, body, options): Promise<Response>

북마크 생성 인증된 사용자의 북마크에 게시물을 추가합니다.

​

매개변수

Name	Type	Description
id	string	북마크를 추가할 인증된 소스 사용자의 id입니다.
body	BookmarkAddRequest	요청 본문
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:2139

▸ createBookmark(id, body): Promise<BookmarkMutationResponse>

​

매개변수

이름	유형
id	string
body	BookmarkAddRequest

​

반환값

Promise<BookmarkMutationResponse>

​

정의 위치

users/client.ts:2154

---

​

getFollowers

▸ getFollowers(id, options): Promise<Response>

팔로워 조회 특정 User의 id를 기준으로, 해당 User를 팔로우하는 User 리스트를 조회합니다.

​

매개변수

이름	타입	설명
id	string	조회할 사용자의 ID입니다.
options	GetFollowersOptions & { requestOptions: { raw: true } }	-

​

반환 값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response를 반환합니다.

​

정의된 위치

users/client.ts:2245

▸ getFollowers(id, options?): Promise<Get2UsersIdFollowersResponse>

​

매개변수

이름	타입
id	string
options?	GetFollowersOptions

​

반환

Promise<Get2UsersIdFollowersResponse>

​

정의 위치

users/client.ts:2258

---

​

unpinList

▸ unpinList(id, listId, options): Promise<Response>

리스트 고정 해제 인증된 사용자가 ID로 지정한 특정 리스트의 고정을 해제합니다.

​

매개변수

이름	타입	설명
id	string	결과를 반환할 인증된 소스 사용자의 ID입니다.
listId	string	고정 해제할 리스트의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:2474

▸ unpinList(id, listId): Promise<ListUnpinResponse>

​

매개변수

이름	유형
id	string
listId	string

​

반환값

Promise<ListUnpinResponse>

​

정의된 위치

users/client.ts:2491

---

​

getById

▸ getById(id, options): Promise<Response>

id로 사용자 조회 특정 사용자의 세부 정보를 해당 id를 사용해 조회합니다.

​

매개변수

이름	타입	설명
id	string	조회할 사용자의 ID입니다.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw 가 true 인 경우 원시 Response입니다.

​

정의된 위치

users/client.ts:2594

▸ getById(id, options?): Promise<Get2UsersIdResponse>

​

매개변수

이름	유형
id	string
options?	GetByIdOptions

​

반환값

Promise<Get2UsersIdResponse>

​

정의 위치

users/client.ts:2607

---

​

getMentions

▸ getMentions(id, options): Promise<Response>

멘션 가져오기 특정 사용자의 ID를 사용해 해당 사용자를 언급한 포스트 목록을 조회합니다.

​

매개변수

Name	Type	Description
id	string	조회할 사용자의 ID입니다.
options	GetMentionsOptions & { requestOptions: { raw: true } }	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response

​

정의된 위치

users/client.ts:2781

▸ getMentions(id, options?): Promise<Get2UsersIdMentionsResponse>

​

매개변수

이름	타입
id	string
options?	GetMentionsOptions

​

반환 값

Promise<Get2UsersIdMentionsResponse>

​

정의된 위치

users/client.ts:2794

---

​

unrepostPost

▸ unrepostPost(id, sourceTweetId, options): Promise<Response>

게시물 리포스트 취소 인증된 사용자가 지정된 ID를 가진 특정 게시물의 리포스트를 취소합니다.

​

매개변수

이름	타입	설명
id	string	게시물을 리포스트하려는 인증된 소스 사용자의 ID입니다.
sourceTweetId	string	사용자가 리트윗을 취소하려는 게시물의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:3149

▸ unrepostPost(id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>

​

매개변수

이름	타입
id	string
sourceTweetId	string

​

반환값

Promise<UsersRetweetsDeleteResponse>

​

정의된 곳

users/client.ts:3166

---

​

deleteBookmark

▸ deleteBookmark(id, tweetId, options): Promise<Response>

북마크 삭제 인증된 사용자의 북마크에서 지정된 ID의 게시물을 제거합니다.

​

매개변수

Name	Type	Description
id	string	북마크에서 게시물을 제거할 인증된 소스 사용자의 ID입니다.
tweetId	string	소스 사용자가 북마크에서 제거하려는 게시물의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다

​

정의 위치

users/client.ts:3273

▸ deleteBookmark(id, tweetId): Promise<BookmarkMutationResponse>

​

매개변수

이름	유형
id	string
tweetId	string

​

반환값

Promise<BookmarkMutationResponse>

​

정의 위치

users/client.ts:3290

---

​

unfollowList

▸ unfollowList(id, listId, options): Promise<Response>

리스트 언팔로우 인증된 사용자가 ID로 지정된 특정 리스트의 팔로우를 해제합니다.

​

매개변수

Name	Type	Description
id	string	리스트 팔로우를 취소할 인증된 소스 사용자의 ID입니다.
listId	string	팔로우를 취소할 리스트의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환

Promise<Response>

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

​

정의 위치

users/client.ts:3391

▸ unfollowList(id, listId): Promise<ListFollowedResponse>

​

매개변수

이름	type
id	string
listId	string

​

반환

Promise<ListFollowedResponse>

​

정의 위치

users/client.ts:3408

---

​

unmuteUser

▸ unmuteUser(sourceUserId, targetUserId, options): Promise<Response>

사용자 음소거 해제 인증된 사용자가 id로 지정된 특정 사용자의 음소거를 해제합니다.

​

매개변수

Name	Type	Description
sourceUserId	string	음소거 해제를 요청하는 인증된 소스 사용자의 ID입니다.
targetUserId	string	소스 사용자가 음소거 해제를 요청하는 대상 사용자의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

API 응답을 resolve하는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response 객체

​

정의 위치

users/client.ts:3515

▸ unmuteUser(sourceUserId, targetUserId): Promise<MuteUserMutationResponse>

​

매개변수

이름	타입
sourceUserId	string
targetUserId	string

​

반환

Promise<MuteUserMutationResponse>

​

정의된 위치

users/client.ts:3532

---

​

getMe

▸ getMe(options): Promise<Response>

내 사용자 정보 가져오기 인증된 사용자의 상세 정보를 조회합니다.

​

매개변수

이름	type
options	GetMeOptions & { requestOptions: { raw: true } }

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다

​

정의된 위치

users/client.ts:3631

▸ getMe(options?): Promise<Get2UsersMeResponse>

​

매개변수

이름	타입
options?	GetMeOptions

​

반환값

Promise<Get2UsersMeResponse>

​

정의 위치

users/client.ts:3640

---

​

getMuting

▸ getMuting(id, options): Promise<Response>

뮤트 대상 가져오기
인증된 사용자가 뮤트한 사용자 목록을 조회합니다.

​

매개변수

Name	Type	Description
id	string	결과를 반환할 인증된 소스 사용자(User)의 id입니다.
options	GetMutingOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response입니다.

​

정의 위치

users/client.ts:3796

▸ getMuting(id, options?): Promise<Get2UsersIdMutingResponse>

​

매개변수

이름	타입
id	string
options?	GetMutingOptions

​

반환

Promise<Get2UsersIdMutingResponse>

​

정의 위치

users/client.ts:3809

---

​

muteUser

▸ muteUser(id, options): Promise<Response>

사용자 음소거 인증된 사용자가 해당 User의 id를 사용해 특정 사용자를 음소거합니다.

​

매개변수

Name	Type	Description
id	string	대상 사용자의 음소거를 요청하는 인증된 소스 사용자의 id입니다.
options	MuteUserOptions & { requestOptions: { raw: true } }	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response입니다.

​

정의된 위치

users/client.ts:4015

▸ muteUser(id, options?): Promise<MuteUserMutationResponse>

​

매개변수

이름	타입
id	string
options?	MuteUserOptions

​

반환값

Promise<MuteUserMutationResponse>

​

정의 위치

users/client.ts:4028

---

​

search

▸ search(query, options): Promise<Response>

사용자 검색 검색 쿼리와 일치하는 사용자의 목록을 가져옵니다.

​

매개변수

이름	type	설명
query	string	사용자를 검색할 때 사용할 쿼리 문자열입니다.
options	SearchOptions & { requestOptions: { raw: true } }	-

​

반환

Promise<Response>

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

​

정의 위치

users/client.ts:4136

▸ search(query, options?): Promise<Get2UsersSearchResponse>

​

매개변수

이름	type
query	string
options?	SearchOptions

​

반환 값

Promise<Get2UsersSearchResponse>

​

정의 위치

users/client.ts:4149

---

​

getBlocking

▸ getBlocking(id, options): Promise<Response>

차단 목록 가져오기 지정된 사용자 ID가 차단한 사용자 목록을 조회합니다.

​

매개변수

이름	타입	설명
id	string	결과를 반환할 인증된 소스 사용자의 id입니다.
options	GetBlockingOptions & { requestOptions: { raw: true } }	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response가 반환됩니다

​

정의 위치

users/client.ts:4362

▸ getBlocking(id, options?): Promise<Get2UsersIdBlockingResponse>

​

매개변수

이름	타입
id	string
options?	GetBlockingOptions

​

반환

Promise<Get2UsersIdBlockingResponse>

​

정의된 위치

users/client.ts:4375

---

​

getByIds

▸ getByIds(ids, options): Promise<Response>

ID로 사용자 가져오기 여러 사용자의 세부 정보를 해당 ID로 조회합니다.

​

매개변수

이름	Type	설명
ids	any[]	쉼표로 구분된 사용자 ID 리스트입니다. 최대 100개의 ID를 지정할 수 있습니다.
options	GetByIdsOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:4581

▸ getByIds(ids, options?): Promise<Get2UsersResponse>

​

매개변수

이름	타입
ids	any[]
options?	GetByIdsOptions

​

반환값

Promise<Get2UsersResponse>

​

정의된 위치

users/client.ts:4594

---

​

getFollowing

▸ getFollowing(id, options): Promise<Response>

팔로우 중인 사용자 조회 지정된 User의 id를 사용하여 해당 User가 팔로우 중인 User 리스트를 조회합니다.

​

매개변수

Name	Type	Description
id	string	조회할 사용자의 ID입니다.
options	GetFollowingOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response

​

정의된 위치

users/client.ts:4777

▸ getFollowing(id, options?): Promise<Get2UsersIdFollowingResponse>

​

매개변수

이름	타입
id	string
options?	GetFollowingOptions

​

반환값

Promise<Get2UsersIdFollowingResponse>

​

정의 위치

users/client.ts:4790

---

​

followUser

▸ followUser(id, options): Promise<Response>

사용자 팔로우 인증된 사용자가 특정 사용자의 id로 해당 사용자를 팔로우합니다.

​

매개변수

이름	유형	설명
id	string	대상 사용자를 팔로우하도록 요청하는 인증된 소스 사용자의 ID입니다.
options	FollowUserOptions & { requestOptions: { raw: true } }	-

​

반환 값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response입니다

​

정의 위치

users/client.ts:5002

▸ followUser(id, options?): Promise<UsersFollowingCreateResponse>

​

매개변수

이름	타입
id	string
options?	FollowUserOptions

​

반환 값

Promise<UsersFollowingCreateResponse>

​

정의된 위치

users/client.ts:5015

---

​

likePost

▸ likePost(id, options): Promise<Response>

게시물 좋아요 인증된 사용자가 지정된 ID의 특정 게시물에 좋아요를 표시합니다.

​

Parameters

Name	Type	Description
id	string	게시물에 좋아요를 등록하도록 요청하는 인증된 소스 User의 id입니다.
options	LikePostOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response

​

정의 위치

users/client.ts:5123

▸ likePost(id, options?): Promise<UsersLikesCreateResponse>

​

매개변수

이름	타입
id	string
options?	LikePostOptions

​

반환값

Promise<UsersLikesCreateResponse>

​

정의 위치

users/client.ts:5136

---

​

getLikedPosts

▸ getLikedPosts(id, options): Promise<Response>

좋아요한 포스트 가져오기
특정 사용자의 ID를 사용해 해당 사용자가 좋아요한 포스트 목록을 조회합니다.

​

매개변수

이름	타입	설명
id	string	조회할 사용자의 ID입니다.
options	GetLikedPostsOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response

​

정의된 위치

users/client.ts:5244

▸ getLikedPosts(id, options?): Promise<Get2UsersIdLikedTweetsResponse>

​

매개변수

이름	타입
id	string
options?	GetLikedPostsOptions

​

반환값

Promise<Get2UsersIdLikedTweetsResponse>

​

정의된 위치

users/client.ts:5257

---

​

getPosts

▸ getPosts(id, options): Promise<Response>

포스트 가져오기 특정 사용자의 id를 사용해 해당 사용자가 작성한 포스트 목록을 조회합니다.

​

매개변수

Name	Type	Description
id	string	조회할 사용자의 id입니다.
options	GetPostsOptions & { requestOptions: { raw: true } }	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response가 반환됩니다

​

정의 위치

users/client.ts:5526

▸ getPosts(id, options?): Promise<Get2UsersIdTweetsResponse>

​

매개변수

이름	타입
id	string
options?	GetPostsOptions

​

반환

Promise<Get2UsersIdTweetsResponse>

​

정의된 위치

users/client.ts:5539

---

​

blockDms

▸ blockDms(id, options): Promise<Response>

DM 차단 인증된 사용자에 대해 특정 사용자의 id를 기준으로, 해당 사용자와 주고받는 다이렉트 메시지를 차단합니다.

​

Parameters

Name	Type	Description
id	string	인증된 사용자가 DM을 차단하려는 대상 사용자의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:5909

▸ blockDms(id): Promise<UsersDMBlockCreateResponse>

​

매개변수

이름	type
id	string

​

반환값

Promise<UsersDMBlockCreateResponse>

​

정의 위치

users/client.ts:5922

---

​

getListMemberships

▸ getListMemberships(id, options): Promise<Response>

리스트 멤버십 가져오기
특정 사용자의 id를 기준으로, 그 사용자가 멤버로 속해 있는 리스트들의 목록을 조회합니다.

​

매개변수

이름	타입	설명
id	string	조회할 사용자의 id입니다.
options	GetListMembershipsOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원본 Response를 반환합니다

​

정의 위치

users/client.ts:6013

▸ getListMemberships(id, options?): Promise<Get2UsersIdListMembershipsResponse>

​

매개변수

이름	타입
id	string
options?	GetListMembershipsOptions

​

반환

Promise<Get2UsersIdListMembershipsResponse>

​

정의된 위치

users/client.ts:6026

---

​

getPinnedLists

▸ getPinnedLists(id, options): Promise<Response>

고정된 리스트 가져오기 인증된 사용자가 고정한 리스트를 조회합니다.

​

매개변수

Name	Type	Description
id	string	결과를 반환할 인증된 소스 사용자(source User)의 ID입니다.
options	GetPinnedListsOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:6238

▸ getPinnedLists(id, options?): Promise<Get2UsersIdPinnedListsResponse>

​

매개변수

이름	타입
id	string
options?	GetPinnedListsOptions

​

반환

Promise<Get2UsersIdPinnedListsResponse>

​

정의된 위치

users/client.ts:6251

---

​

pinList

▸ pinList(id, body, options): Promise<Response>

리스트 고정 인증된 사용자가 id를 사용해 특정 리스트를 고정합니다.

​

매개변수

Name	Type	Description
id	string	리스트를 고정할 인증된 소스 사용자의 ID입니다.
body	ListPinnedRequest	요청 본문입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise입니다. requestOptions.raw가 true인 경우 원시 Response가 반환됩니다

​

정의된 위치

users/client.ts:6421

▸ pinList(id, body): Promise<ListPinnedResponse>

​

매개변수

이름	타입
id	string
body	ListPinnedRequest

​

반환

Promise<ListPinnedResponse>

​

정의된 위치

users/client.ts:6436

---

​

getByUsername

▸ getByUsername(username, options): Promise<Response>

username으로 User 조회 지정된 username을 가진 특정 User의 상세 정보를 조회합니다.

​

매개변수

Name	Type	Description
username	string	사용자 이름입니다.
options	GetByUsernameOptions & { requestOptions: { raw: true } }	-

​

반환

Promise<Response>

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

​

정의 위치

users/client.ts:6533

▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>

​

매개변수

이름	타입
username	string
options?	GetByUsernameOptions

​

반환값

Promise<Get2UsersByUsernameUsernameResponse>

​

정의된 위치

users/client.ts:6546

---

​

unfollowUser

▸ unfollowUser(sourceUserId, targetUserId, options): Promise<Response>

사용자 언팔로우 인증된 사용자가 특정 id를 가진 사용자를 언팔로우합니다.

​

매개변수

Name	Type	Description
sourceUserId	string	언팔로우를 요청하는 인증된 소스 사용자의 ID입니다.
targetUserId	string	언팔로우 대상 사용자의 ID입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response

​

정의된 위치

users/client.ts:6724

▸ unfollowUser(sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>

​

매개변수

이름	타입
sourceUserId	string
targetUserId	string

​

반환값

Promise<UsersFollowingDeleteResponse>

​

정의된 위치

users/client.ts:6741

---

​

getTimeline

▸ getTimeline(id, options): Promise<Response>

타임라인 가져오기 인증된 사용자의 타임라인에서 포스트를 최신순(시간 역순)으로 정렬한 목록을 가져옵니다.

​

매개변수

이름	type	설명
id	string	역순 시간순 타임라인 포스트를 가져올 인증된 소스 사용자의 id입니다.
options	GetTimelineOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원본 Response를 반환합니다.

​

정의된 위치

users/client.ts:6844

▸ getTimeline(id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

​

매개변수

이름	타입
id	string
options?	GetTimelineOptions

​

반환

Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

​

정의된 위치

users/client.ts:6857

---

​

getFollowedLists

▸ getFollowedLists(id, options): Promise<Response>

팔로우 중인 리스트 가져오기 특정 사용자 ID를 기준으로, 해당 사용자가 팔로우 중인 리스트 목록을 조회합니다.

​

매개변수

Name	Type	Description
id	string	조회할 사용자의 ID입니다.
options	GetFollowedListsOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response

​

정의 위치

users/client.ts:7221

▸ getFollowedLists(id, options?): Promise<Get2UsersIdFollowedListsResponse>

​

매개변수

이름	타입
id	string
options?	GetFollowedListsOptions

​

반환

Promise<Get2UsersIdFollowedListsResponse>

​

정의된 위치

users/client.ts:7234

---

​

followList

▸ followList(id, options): Promise<Response>

리스트 팔로우 인증된 사용자가 지정된 id의 특정 리스트를 팔로우하도록 합니다.

​

Parameters

Name	Type	Description
id	string	리스트를 팔로우할 인증된 소스 사용자의 ID.
options	FollowListOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원본 Response를 반환합니다

​

정의된 위치

users/client.ts:7446

▸ followList(id, options?): Promise<ListFollowedResponse>

​

매개변수

이름	타입
id	string
options?	FollowListOptions

​

반환값

Promise<ListFollowedResponse>

​

정의 위치

users/client.ts:7459

---

​

unblockDms

▸ unblockDms(id, options): Promise<Response>

DM 차단 해제 인증된 사용자의 계정에서 특정 사용자의 ID를 지정해, 해당 사용자와 주고받는 다이렉트 메시지(DM) 차단을 해제합니다.

​

매개변수

Name	Type	Description
id	string	인증된 사용자가 DM 차단 해제를 요청하는 대상 User의 id입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise로, requestOptions.raw가 true인 경우 원시 Response를 반환합니다.

​

정의 위치

users/client.ts:7567

▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>

​

매개변수

이름	유형
id	string

​

반환값

Promise<UsersDMUnBlockCreateResponse>

​

정의 위치

users/client.ts:7580

---

​

repostPost

▸ repostPost(id, options): Promise<Response>

게시물 리포스트 인증된 사용자가 ID로 지정된 특정 게시물을 리포스트합니다.

​

매개변수

Name	Type	Description
id	string	게시물 리포스트를 요청하는 인증된 소스 사용자의 ID입니다.
options	RepostPostOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:7671

▸ repostPost(id, options?): Promise<UsersRetweetsCreateResponse>

​

매개변수

이름	type
id	string
options?	RepostPostOptions

​

반환

Promise<UsersRetweetsCreateResponse>

​

정의된 위치

users/client.ts:7684

---

​

getBookmarkFolders

▸ getBookmarkFolders(id, options): Promise<Response>

북마크 폴더 가져오기 인증된 사용자가 만든 북마크 폴더 목록을 가져옵니다.

​

매개변수

Name	Type	Description
id	string	결과를 조회할 인증된 소스 사용자의 id입니다.
options	GetBookmarkFoldersOptions & { requestOptions: { raw: true } }	-

​

반환 값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response입니다.

​

정의된 위치

users/client.ts:7792

▸ getBookmarkFolders(id, options?): Promise<BookmarkFoldersResponse>

​

매개변수

이름	타입
id	string
options?	GetBookmarkFoldersOptions

​

반환값

Promise<BookmarkFoldersResponse>

​

정의된 위치

users/client.ts:7805

---

​

getOwnedLists

▸ getOwnedLists(id, options): Promise<Response>

소유한 리스트 가져오기 특정 사용자의 id를 사용해, 해당 사용자가 소유한 리스트 목록을 조회합니다.

​

매개변수

이름	타입	설명
id	string	조회할 User의 식별자(ID)입니다.
options	GetOwnedListsOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:7944

▸ getOwnedLists(id, options?): Promise<Get2UsersIdOwnedListsResponse>

​

매개변수

이름	타입
id	string
options?	GetOwnedListsOptions

​

반환값

Promise<Get2UsersIdOwnedListsResponse>

​

정의된 위치

users/client.ts:7957

---

​

getBookmarksByFolderId

▸ getBookmarksByFolderId(id, folderId, options): Promise<Response>

폴더 ID로 북마크 가져오기 인증된 사용자의 계정에서, 지정된 ID의 특정 북마크 폴더에 있는 포스트를 조회합니다.

​

매개변수

Name	Type	Description
id	string	결과를 반환할 인증된 소스 사용자의 id입니다.
folderId	string	인증된 사용자가 게시물을 가져오려는 북마크 폴더의 id입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

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

​

정의 위치

users/client.ts:8173

▸ getBookmarksByFolderId(id, folderId): Promise<BookmarkFolderPostsResponse>

​

매개변수

이름	타입
id	string
folderId	string

​

반환 값

Promise<BookmarkFolderPostsResponse>

​

정의된 위치

users/client.ts:8190