Class: FriendsEndpoint

Defined in: endpoints/friends.ts:15

Constructors

Constructor

new FriendsEndpoint(client): FriendsEndpoint;

Defined in: endpoints/friends.ts:16

Parameters

Parameter	Type
client	RESTClient

Returns

FriendsEndpoint

Methods

acceptFriendRequest()

acceptFriendRequest(friendshipId): Promise<IAcceptFriendRequestResponse>;

Defined in: endpoints/friends.ts:40

Parameters

Parameter	Type
friendshipId	number

Returns

Promise<IAcceptFriendRequestResponse>

---

blockUser()

blockUser(userId): Promise<IBlockUserResponse>;

Defined in: endpoints/friends.ts:52

Parameters

Parameter	Type
userId	number

Returns

Promise<IBlockUserResponse>

---

getBlockedUsers()

getBlockedUsers(): Promise<IGetBlockedUsersResponse>;

Defined in: endpoints/friends.ts:30

Returns

Promise<IGetBlockedUsersResponse>

---

getFriends()

getFriends(): Promise<IGetUserFriendsResponse>;

Defined in: endpoints/friends.ts:18

Returns

Promise<IGetUserFriendsResponse>

---

getIncomingFriendRequests()

getIncomingFriendRequests(): Promise<IGetIncomingFriendsResponse>;

Defined in: endpoints/friends.ts:22

Returns

Promise<IGetIncomingFriendsResponse>

---

getOutgoingFriendRequests()

getOutgoingFriendRequests(): Promise<IGetOutgoingFriendsResponse>;

Defined in: endpoints/friends.ts:26

Returns

Promise<IGetOutgoingFriendsResponse>

---

rejectFriendRequest()

rejectFriendRequest(friendshipId): Promise<IRejectFriendRequestResponse>;

Defined in: endpoints/friends.ts:44

Parameters

Parameter	Type
friendshipId	number

Returns

Promise<IRejectFriendRequestResponse>

---

removeFriendship()

removeFriendship(friendshipId): Promise<IRemoveFriendshipResponse>;

Defined in: endpoints/friends.ts:48

Parameters

Parameter	Type
friendshipId	number

Returns

Promise<IRemoveFriendshipResponse>

---

sendFriendRequest()

sendFriendRequest(recipientId): Promise<ISendFriendRequestResponse>;

Defined in: endpoints/friends.ts:34

Parameters

Parameter	Type
recipientId	number

Returns

Promise<ISendFriendRequestResponse>

---

unblockUser()

unblockUser(blockedId): Promise<IUnblockUserResponse>;

Defined in: endpoints/friends.ts:60

Parameters

Parameter	Type
blockedId	number

Returns

Promise<IUnblockUserResponse>