Client Settings API Reference
The Setttings module provides the game with the ability to manage player-related settings. Currently, it consists of two sections: Privacy Settings and Local Cache Management.
API List
| API | Description |
|---|---|
| GetPrivacySettings | Query privacy settings of the currently logged in player. |
| SetPrivacySettings | Set privacy settings of the currently logged in player (all fields must be set together). |
| SetPrivacyItem | Set privacy settings of the currently logged in player (Set one of the privacy options). |
| GetLocalCacheSize | Get total bytes of local cache files |
| ClearLocalCache | Clear local cache files |
API Details
GetPrivacySettings
Query privacy settings of the currently logged in player.
/// <summary>Query privacy settings of the currently logged in player.</summary>
public void GetPrivacySettings(SettingsDelegate0 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| callback | SettingsDelegate0 |
Return: void
SetPrivacySettings
Set privacy settings of the currently logged in player (all fields must be set together).
/// <summary>Set privacy settings of the currently logged in player (all fields must be set together).</summary>
/// <param name="settings">New settings to be set.</param>
public void SetPrivacySettings(PrivacySettingInfo settings, SettingsDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| settings | PrivacySettingInfo | New settings to be set. |
| callback | SettingsDelegate1 |
Return: void
SetPrivacyItem
Set privacy settings of the currently logged in player (Set one of the privacy options).
/// <summary>Set privacy settings of the currently logged in player (Set one of the privacy options).</summary>
/// <param name="settings">New settings to be set. Only the item corresponding to 'valid_item_type' will be modified.</param>
/// <param name="valid_item_type">Specify a privacy item for modification.</param>
public void SetPrivacyItem(PrivacySettingInfo settings, PrivacyItemType valid_item_type, SettingsDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| settings | PrivacySettingInfo | New settings to be set. Only the item corresponding to 'valid_item_type' will be modified. |
| valid_item_type | PrivacyItemType | Specify a privacy item for modification. |
| callback | SettingsDelegate1 |
Return: void
GetLocalCacheSize
Get total bytes of local cache files
/// <summary>Get total bytes of local cache files</summary>
public Int64 GetLocalCacheSize();
Parameters:
(No parameters)
Return: Int64
Bytes of local cache file
ClearLocalCache
Clear local cache files
/// <summary>Clear local cache files</summary>
public void ClearLocalCache(SettingsDelegate1 callback);
Parameters:
| Param | Type | Description |
|---|---|---|
| callback | SettingsDelegate1 |
Return: void
All Delegates
public delegate void SettingsDelegate0(PgosResult a0, PrivacySettingInfo a1);
public delegate void SettingsDelegate1(PgosResult a0);
Type Reference: