itd-api / UsersResource
Interface: UsersResource
Defined in: resources/users.ts:54
Пользователи: профили, подписки, блокировки, приватность.
Доступна как itd.users.
Extends
BaseResource
Methods
block()
block(user, options?): Promise<void>;Defined in: resources/users.ts:301
Блокирует пользователя.
Parameters
user
string
options?
RequestOptions = {}
Returns
Promise<void>
blocked()
blocked(params?): Promise<Page<UserSummary>>;Defined in: resources/users.ts:320
Загружает заблокированных пользователей. Ограничения те же, что у followers.
Parameters
params?
UserListParams = {}
Returns
Promise<Page<UserSummary>>
checkUsername()
checkUsername(username, options?): Promise<boolean>;Defined in: resources/users.ts:174
Проверяет, свободно ли имя пользователя.
Parameters
username
string
options?
RequestOptions = {}
Returns
Promise<boolean>
createProfile()
createProfile(input, options?): Promise<MyProfile>;Defined in: resources/users.ts:142
Создаёт профиль после регистрации.
Parameters
input
avatar?
string
displayName
string
username
string
options?
RequestOptions = {}
Returns
Promise<MyProfile>
deactivate()
deactivate(options?): Promise<void>;Defined in: resources/users.ts:124
Деактивирует аккаунт. Вернуть его можно через restore.
Parameters
options?
RequestOptions = {}
Returns
Promise<void>
follow()
follow(user, options?): Promise<FollowResult>;Defined in: resources/users.ts:227
Подписывается на пользователя.
У закрытого профиля вместо подписки отправляется заявка — это видно по полю status.
Parameters
user
string
options?
RequestOptions = {}
Returns
Promise<FollowResult>
followers()
followers(user, params?): Promise<Page<UserSummary>>;Defined in: resources/users.ts:256
Загружает подписчиков пользователя.
⚠️ Сервер этот список не листает. Возвращаются первые 20 записей и только они: параметр page игнорируется (любая страница отдаёт те же записи и pagination.page: 1), limit больше 20 молча уменьшается, а hasMore всегда false. Последнее честно — получить продолжение нечем.
Числу total доверять тоже не стоит: оно расходится с followersCount из профиля — на проверенных аккаунтах занижено примерно на 1–4%.
Parameters
user
string
params?
UserListParams = {}
Returns
Promise<Page<UserSummary>>
following()
following(user, params?): Promise<Page<UserSummary>>;Defined in: resources/users.ts:271
Загружает подписки пользователя. Ограничения те же, что у followers.
Parameters
user
string
params?
UserListParams = {}
Returns
Promise<Page<UserSummary>>
followStatus()
followStatus(userIds, options?): Promise<Record<string, boolean>>;Defined in: resources/users.ts:291
Проверяет, подписаны ли вы, сразу для нескольких пользователей.
Parameters
userIds
string[]
options?
RequestOptions = {}
Returns
Promise<Record<string, boolean>>
объект «идентификатор пользователя → подписаны ли вы»
Example
const statuses = await itd.users.followStatus([userA, userB]);
// { 'b89dee4f-…': true, '35ea3059-…': false }get()
get(user, options?): Promise<PublicProfile>;Defined in: resources/users.ts:165
Загружает профиль пользователя.
Parameters
user
string
UUID или имя пользователя — подходит и то, и другое
options?
RequestOptions = {}
Returns
Promise<PublicProfile>
Example
const profile = await itd.users.get('nowkie');
await itd.posts.create({ content: 'привет', wallRecipientId: profile.id });getPrivacy()
getPrivacy(options?): Promise<PrivacySettings>;Defined in: resources/users.ts:330
Загружает настройки приватности.
Parameters
options?
RequestOptions = {}
Returns
Promise<PrivacySettings>
iterateBlocked()
iterateBlocked(params?): Paginator<UserSummary>;Defined in: resources/users.ts:325
Перебирает заблокированных. Закончится после первых 20 записей — см. followers.
Parameters
params?
UserListParams = {}
Returns
iterateFollowers()
iterateFollowers(user, params?): Paginator<UserSummary>;Defined in: resources/users.ts:266
Перебирает подписчиков.
⚠️ Перебор закончится после первых 20 записей: сервер список не листает — см. followers. Метод оставлен на случай, если пагинацию починят.
Parameters
user
string
params?
UserListParams = {}
Returns
iterateFollowing()
iterateFollowing(user, params?): Paginator<UserSummary>;Defined in: resources/users.ts:276
Перебирает подписки. Закончится после первых 20 записей — см. followers.
Parameters
user
string
params?
UserListParams = {}
Returns
me()
me(options?): Promise<MyProfile>;Defined in: resources/users.ts:84
Загружает свой профиль — с подпиской и признаком подтверждённого телефона.
Parameters
options?
RequestOptions = {}
Returns
Promise<MyProfile>
pins()
pins(options?): Promise<PinsResult>;Defined in: resources/users.ts:353
Загружает значки профиля и выбранный из них.
activePin — строка-идентификатор, а не объект.
Parameters
options?
RequestOptions = {}
Returns
Promise<PinsResult>
removeBanner()
removeBanner(options?): Promise<MyProfile>;Defined in: resources/users.ts:119
Удаляет баннер профиля, устанавливая bannerId в null.
Parameters
options?
RequestOptions = {}
Returns
Promise<MyProfile>
removePin()
removePin(options?): Promise<void>;Defined in: resources/users.ts:378
Снимает активный значок.
Parameters
options?
RequestOptions = {}
Returns
Promise<void>
restore()
restore(options?): Promise<void>;Defined in: resources/users.ts:133
Восстанавливает деактивированный аккаунт.
Parameters
options?
RequestOptions = {}
Returns
Promise<void>
search()
search(query, params?): Promise<UserSummary[]>;Defined in: resources/users.ts:186
Ищет пользователей по строке запроса.
Parameters
query
string
params?
object & RequestOptions = {}
Returns
Promise<UserSummary[]>
setBanner()
setBanner(file, options?): Promise<MyProfile>;Defined in: resources/users.ts:113
Загружает изображение и устанавливает его баннером профиля.
Для установки используется идентификатор, полученный от /api/files/upload. Если файл уже загружен, используйте updateMe: { bannerId: file.id }.
Parameters
file
options?
UploadOptions = {}
Returns
Promise<MyProfile>
Example
await itd.users.setBanner(file, { filename: 'banner.webp' });setPin()
setPin(slug, options?): Promise<void>;Defined in: resources/users.ts:368
Выбирает активный значок профиля.
Parameters
slug
string
options?
RequestOptions = {}
Returns
Promise<void>
topClans()
topClans(options?): Promise<Clan[]>;Defined in: resources/users.ts:212
Загружает рейтинг кланов.
Parameters
options?
RequestOptions = {}
Returns
Promise<Clan[]>
unblock()
unblock(user, options?): Promise<void>;Defined in: resources/users.ts:311
Снимает блокировку.
Parameters
user
string
options?
RequestOptions = {}
Returns
Promise<void>
unfollow()
unfollow(user, options?): Promise<void>;Defined in: resources/users.ts:237
Отписывается от пользователя.
Parameters
user
string
options?
RequestOptions = {}
Returns
Promise<void>
updateMe()
updateMe(input, options?): Promise<MyProfile>;Defined in: resources/users.ts:93
Обновляет свой профиль. Передавайте только изменяемые поля.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<MyProfile>
updatePrivacy()
updatePrivacy(input, options?): Promise<PrivacySettings>;Defined in: resources/users.ts:339
Обновляет настройки приватности. Передавайте только изменяемые поля.
Parameters
input
options?
RequestOptions = {}
Returns
Promise<PrivacySettings>
whoToFollow()
whoToFollow(options?): Promise<UserSummary[]>;Defined in: resources/users.ts:201
Загружает рекомендации, на кого подписаться.
Parameters
options?
RequestOptions = {}
Returns
Promise<UserSummary[]>