Skip to content

PlayerFriendApi

All URIs are relative to http://localhost:8080/api

Method HTTP request Description
acceptPlayerFriend POST /player/friend/accept Accept Player Friend (WIP)
cancelPlayerFriend POST /player/friend/cancel Cancel Player Friend (WIP)
getAllPlayerFriend POST /player/friend/get_all Get All Player Friend (WIP)
proposePlayerFriend POST /player/friend/propose Propose Player Friend (WIP)
refusePlayerFriend POST /player/friend/refuse Refuse Player Friend (WIP)
searchPlayerFriend POST /player/friend/search Search Player Friend (WIP)
terminatePlayerFriend POST /player/friend/terminate Terminate Player Friend (WIP)

acceptPlayerFriend

AcceptPlayerFriendResponse acceptPlayerFriend(AcceptPlayerFriendRequest)

Accept Player Friend (WIP)

Accept specified friend request sent from an another player

Parameters

Name Type Description Notes
AcceptPlayerFriendRequest AcceptPlayerFriendRequest [optional]

Return type

AcceptPlayerFriendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

cancelPlayerFriend

CancelPlayerFriendResponse cancelPlayerFriend(CancelPlayerFriendRequest)

Cancel Player Friend (WIP)

Cancel friend request made by the current player

Parameters

Name Type Description Notes
CancelPlayerFriendRequest CancelPlayerFriendRequest [optional]

Return type

CancelPlayerFriendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getAllPlayerFriend

GetAllPlayerFriendResponse getAllPlayerFriend(GetAllPlayerFriendRequest)

Get All Player Friend (WIP)

Get all current friends of the current player (includes guests if called in quest screen)

Parameters

Name Type Description Notes
GetAllPlayerFriendRequest GetAllPlayerFriendRequest [optional]

Return type

GetAllPlayerFriendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

proposePlayerFriend

ProposePlayerFriendResponse proposePlayerFriend(ProposePlayerFriendRequest)

Propose Player Friend (WIP)

Send a friend request from the current player to an another player

Parameters

Name Type Description Notes
ProposePlayerFriendRequest ProposePlayerFriendRequest [optional]

Return type

ProposePlayerFriendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

refusePlayerFriend

RefusePlayerFriendResponse refusePlayerFriend(RefusePlayerFriendRequest)

Refuse Player Friend (WIP)

Deny specified friend request sent from an another player

Parameters

Name Type Description Notes
RefusePlayerFriendRequest RefusePlayerFriendRequest [optional]

Return type

RefusePlayerFriendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

searchPlayerFriend

SearchPlayerFriendResponse searchPlayerFriend(SearchPlayerFriendRequest)

Search Player Friend (WIP)

Search a friend with uses specified friend code

Parameters

Name Type Description Notes
SearchPlayerFriendRequest SearchPlayerFriendRequest [optional]

Return type

SearchPlayerFriendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

terminatePlayerFriend

TerminatePlayerFriendResponse terminatePlayerFriend(TerminatePlayerFriendRequest)

Terminate Player Friend (WIP)

Remove the specified friend from the current player's friend list

Parameters

Name Type Description Notes
TerminatePlayerFriendRequest TerminatePlayerFriendRequest [optional]

Return type

TerminatePlayerFriendResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json