Friend
Definitions
Friend
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
user | User? | user object |
nick | string? | friend nickname |
API
Get Friend List
POST /friend.list| FIELD | TYPE | DESCRIPTION |
|---|---|---|
next | string? | pagination token |
Get the friend list. Returns a paginated list of Friend objects.
Delete Friend
POST /friend.delete| FIELD | TYPE | DESCRIPTION |
|---|---|---|
user_id | string | user id |
Delete a friend.
Handle Friend Request
POST /friend.approve| FIELD | TYPE | DESCRIPTION |
|---|---|---|
message_id | string | request id |
approve | boolean | whether to approve the request |
comment | string? | comment |
Handle a friend request.
Events
friend-request
Triggered when a new friend request is received. Required resources: user.