Class: UserResource

User Friends

.friends(page): Promise<UserModel[]> 1.0.0

GET /user/{user_tag}/friends

Gets current user's friends

Parameters

Name	Type	Description
page?	number	Page number (default 0)

Returns

Promise<UserModel[]>

Array of UserModel objects

Throws

If user not found in cache

Example

const friends = await rest.users.friends();
const nextPage = await rest.users.friends(1);

---

.getFriends(user, page): Promise<UserModel[]> 1.0.0

GET /user/{user_tag}/friends

Gets user friends

Parameters

Name	Type	Description
user	string | number	User ({tag}/{id}/u{id})
page	number	Page number

Returns

Promise<UserModel[]>

Array of UserModel objects

Throws

If parameters are invalid

Example

const friends = await rest.users.getFriends('username', 0);
const friendsById = await rest.users.getFriends(12345, 1);

---

.getRelationships(user): Promise<RelationshipsResult> 1.0.0

GET /user/{user_tag}/relationships

Gets user relationships

Parameters

Name	Type	Description
user	string | number	User ({tag}/{id}/u{id})

Returns

Promise<RelationshipsResult>

Relationships data

Throws

If user identifier is invalid

Example

const relationships = await rest.users.getRelationships('username');

---

.ignoreIncomingRequest(userId): Promise<BaseOkay> 1.0.0

DELETE /incoming_requests/{user_id}

Ignores incoming friend request

Parameters

Name	Type	Description
userId	number	User identifier

Returns

Promise<BaseOkay>

Operation result

Throws

If user ID is invalid

Example

await rest.users.ignoreIncomingRequest(12345);

---

.incomingRequests(page): Promise<UserModel[]> 1.0.0

GET /incoming_requests

Gets incoming friend requests

Parameters

Name	Type	Description
page?	number	Page number

Returns

Promise<UserModel[]>

Array of UserModel objects

Throws

If page number is invalid

Example

const requests = await rest.users.incomingRequests();
const nextPage = await rest.users.incomingRequests(1);

---

.outgoingRequests(page): Promise<UserModel[]> 1.0.0

GET /outcoming_requests

Gets outgoing friend requests

Parameters

Name	Type	Description
page?	number	Page number

Returns

Promise<UserModel[]>

Array of UserModel objects

Throws

If page number is invalid

Example

const requests = await rest.users.outgoingRequests();
const nextPage = await rest.users.outgoingRequests(1);

---

.subscribe(user): Promise<RelationshipsResult> 1.0.0

PATCH /user/{user_tag}/subscribe

Subscribe to user

Parameters

Name	Type	Description
user	string | number	User ({tag}/{id}/u{id})

Returns

Promise<RelationshipsResult>

RelationshipsResult Subscribe result

Throws

If user identifier is invalid

Example

const result = await rest.users.subscribe('username');
const resultById = await rest.users.subscribe(12345);

User Gifts

.getGifts(user, page): Promise<Gift[]> 1.0.0

GET /user/{user_tag}/gifts

Gets user gifts

Parameters

Name	Type	Description
user	string | number	User ({tag}/{id}/u{id})
page?	number	Page number (default 0)

Returns

Promise<Gift[]>

Array of Gift objects

Throws

If parameters are invalid

Example

const gifts = await rest.users.getGifts('username');
const giftsById = await rest.users.getGifts(12345, 1);

---

.gifts(page): Promise<Gift[]> 1.0.0

GET /user/{user_tag}/gifts

Gets current user's gifts

Parameters

Name	Type	Description
page?	number	Page number (default 0)

Returns

Promise<Gift[]>

Array of Gift objects

Throws

If user not found in cache or page is invalid

Example

const gifts = await rest.users.gifts();
const nextPage = await rest.users.gifts(1);

Users Core

find()

find(payload, page): Promise<UserModel[]>

Find users

Parameters

Name	Type	Description
payload	FindUserPayload	Search filters
page?	number	Page number (default 0)

Returns

Promise<UserModel[]>

User list

Deprecated

Use rest.search.users() instead

Example

// Use rest.search.users() instead
const users = await rest.search.users({
  sort: 0,
  country: 0,
  region: 0,
  city: 0,
  worksAt: "",
  relationships: 0,
  online: 0,
  avatar: 0
});

---

.get(user): Promise<UserModel> 1.0.0

GET /user/{user_tag}

Gets user by identifier

Parameters

Name	Type	Description
user	string | number	User ({tag}/{id}/u{id})

Returns

Promise<UserModel>

UserModel User information

Throws

If user identifier is invalid

Example

const user = await rest.users.get('username');
const userById = await rest.users.get(12345);
const userByUid = await rest.users.get('u12345');

---

me()

me(): Promise<UserModel>

Gets current user information

Returns

Promise<UserModel>

User Current user

Example

const me = await rest.users.me();