Client Blocklist API Reference
The Blocklist service provides allows developers to manage player blocklists. No notification will be pushed to blocked player when they are added to or removed from the blocklist. Each player can add any other player to the blocklist, which is used to restrict their interactive behaviors, such as chatting, friend requests, teaming up, and so on.
API List
| API | Description |
|---|---|
| GetBlocklist | Get my blocklist |
| AddToBlocklist | Add the player to my blocklist |
| RemoveFromBlocklist | Remove the player from my blocklist |
| SyncAPBlocklist | Synchronize account platform blocklist to PGOS. The result returns the all blocklist |
| SyncAPBlocklistAdded | Synchronize added account platform blocklist to PGOS. |
| SyncAPBlocklistRemoved | Synchronize removed account platform blocklist to PGOS. |
| SyncAPVoiceBlocklist | Synchronize account platform voice blocklist to PGOS. For platforms with voice blocklist such as XBOX |
API Details
GetBlocklist
Get my blocklist
/// <summary>Get my blocklist</summary>
public void GetBlocklist(BlocklistDelegate0 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| callback | BlocklistDelegate0 |
Return: void
AddToBlocklist
Add the player to my blocklist
/// <summary>Add the player to my blocklist</summary>
/// <param name="player_id">The player id to add</param>
public void AddToBlocklist(string player_id, BlocklistDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| player_id | string | The player id to add |
| callback | BlocklistDelegate1 |
Return: void
RemoveFromBlocklist
Remove the player from my blocklist
/// <summary>Remove the player from my blocklist</summary>
/// <param name="player_id">The player id to remove</param>
public void RemoveFromBlocklist(string player_id, BlocklistDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| player_id | string | The player id to remove |
| callback | BlocklistDelegate1 |
Return: void
SyncAPBlocklist
Synchronize account platform blocklist to PGOS. The result returns the all blocklist
/// <summary>Synchronize account platform blocklist to PGOS. The result returns the all blocklist</summary>
/// <param name="player_ids">The player ids to Synchronize.</param>
public void SyncAPBlocklist(List<string> player_ids, BlocklistDelegate2 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| player_ids | List<string> | The player ids to Synchronize. |
| callback | BlocklistDelegate2 |
Return: void
SyncAPBlocklistAdded
Synchronize added account platform blocklist to PGOS.
/// <summary>Synchronize added account platform blocklist to PGOS.</summary>
/// <param name="player_id">Added platform blocklist player to Synchronize.</param>
public void SyncAPBlocklistAdded(string player_id, BlocklistDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| player_id | string | Added platform blocklist player to Synchronize. |
| callback | BlocklistDelegate1 |
Return: void
SyncAPBlocklistRemoved
Synchronize removed account platform blocklist to PGOS.
/// <summary>Synchronize removed account platform blocklist to PGOS.</summary>
/// <param name="player_id">Removed platform blocklist player to Synchronize.</param>
public void SyncAPBlocklistRemoved(string player_id, BlocklistDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| player_id | string | Removed platform blocklist player to Synchronize. |
| callback | BlocklistDelegate1 |
Return: void
SyncAPVoiceBlocklist
Synchronize account platform voice blocklist to PGOS. For platforms with voice blocklist such as XBOX
/// <summary>Synchronize account platform voice blocklist to PGOS. For platforms with voice blocklist such as XBOX</summary>
/// <param name="player_ids">The player ids to Synchronize.</param>
public void SyncAPVoiceBlocklist(List<string> player_ids, BlocklistDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| player_ids | List<string> | The player ids to Synchronize. |
| callback | BlocklistDelegate1 |
Return: void
All Delegates
public delegate void BlocklistDelegate0(PgosResult a0, BlocklistInfo a1);
public delegate void BlocklistDelegate1(PgosResult a0);
public delegate void BlocklistDelegate2(PgosResult a0, SyncAccountPlatformBlocklistResult a1);
Type Reference: