Skip to content

Commit

Permalink
https://api.playfab.com/releaseNotes/#170102
Browse files Browse the repository at this point in the history
  • Loading branch information
Playfab Jenkins Bot committed Jan 2, 2017
2 parents 11b9f31 + 1ce8218 commit d572b3a
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 287 deletions.
24 changes: 0 additions & 24 deletions PlayFabClientSDK/source/PlayFabClientAPI.cs
Original file line number Diff line number Diff line change
Expand Up @@ -599,30 +599,6 @@ public static async Task<PlayFabResult<GetPlayFabIDsFromTwitchIDsResult>> GetPla
return new PlayFabResult<GetPlayFabIDsFromTwitchIDsResult> { Result = result, CustomData = customData };
}

/// <summary>
/// NOTE: This call will be deprecated soon. For fetching the data for a given user use GetPlayerCombinedInfo. For looking up users from the client api, we are in the process of adding a new api call. Once that call is ready, this one will be deprecated. Retrieves all requested data for a user in one unified request. By default, this API returns all data for the locally signed-in user. The input parameters may be used to limit the data retrieved to any subset of the available data, as well as retrieve the available data for a different user. Note that certain data, including inventory, virtual currency balances, and personally identifying information, may only be retrieved for the locally signed-in user. In the example below, a request is made for the account details, virtual currency balances, and specified user data for the locally signed-in user.
/// </summary>
[Obsolete("Use 'GetPlayerCombinedInfo' instead", true)]
public static async Task<PlayFabResult<GetUserCombinedInfoResult>> GetUserCombinedInfoAsync(GetUserCombinedInfoRequest request, object customData = null)
{
if (_authKey == null) throw new Exception ("Must be logged in to call this method");

var httpResult = await PlayFabHttp.DoPost("/Client/GetUserCombinedInfo", request, "X-Authorization", _authKey);
if(httpResult is PlayFabError)
{
var error = (PlayFabError)httpResult;
if (PlayFabSettings.GlobalErrorHandler != null)
PlayFabSettings.GlobalErrorHandler(error);
return new PlayFabResult<GetUserCombinedInfoResult> { Error = error, CustomData = customData };
}

var resultRawJson = (string)httpResult;
var resultData = JsonWrapper.DeserializeObject<PlayFabJsonSuccess<GetUserCombinedInfoResult>>(resultRawJson);
var result = resultData.data;

return new PlayFabResult<GetUserCombinedInfoResult> { Result = result, CustomData = customData };
}

/// <summary>
/// Links the Android device identifier to the user's PlayFab account
/// </summary>
Expand Down
113 changes: 1 addition & 112 deletions PlayFabClientSDK/source/PlayFabClientModels.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1579,7 +1579,7 @@ public class GetPlayerCombinedInfoRequestParams
public bool GetUserData;

/// <summary>
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if UserDataKeys is false
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false
/// </summary>
public List<string> UserDataKeys;

Expand Down Expand Up @@ -2164,117 +2164,6 @@ public class GetTradeStatusResponse : PlayFabResultCommon

}

[Obsolete("No longer available", true)]
public class GetUserCombinedInfoRequest : PlayFabRequestCommon
{
/// <summary>
/// Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no other lookup identifier set.
/// </summary>
public string PlayFabId;

/// <summary>
/// PlayFab Username for the account to find (if no PlayFabId is specified).
/// </summary>
public string Username;

/// <summary>
/// User email address for the account to find (if no Username is specified).
/// </summary>
public string Email;

/// <summary>
/// Title-specific username for the account to find (if no Email is set).
/// </summary>
public string TitleDisplayName;

/// <summary>
/// If set to false, account info will not be returned. Defaults to true.
/// </summary>
public bool? GetAccountInfo;

/// <summary>
/// If set to false, inventory will not be returned. Defaults to true. Inventory will never be returned for users other than yourself.
/// </summary>
public bool? GetInventory;

/// <summary>
/// If set to false, virtual currency balances will not be returned. Defaults to true. Currency balances will never be returned for users other than yourself.
/// </summary>
public bool? GetVirtualCurrency;

/// <summary>
/// If set to false, custom user data will not be returned. Defaults to true.
/// </summary>
public bool? GetUserData;

/// <summary>
/// User custom data keys to return. If set to null, all keys will be returned. For users other than yourself, only public data will be returned.
/// </summary>
public List<string> UserDataKeys;

/// <summary>
/// If set to false, read-only user data will not be returned. Defaults to true.
/// </summary>
public bool? GetReadOnlyData;

/// <summary>
/// User read-only custom data keys to return. If set to null, all keys will be returned. For users other than yourself, only public data will be returned.
/// </summary>
public List<string> ReadOnlyDataKeys;

}

[Obsolete("No longer available", true)]
public class GetUserCombinedInfoResult : PlayFabResultCommon
{
/// <summary>
/// Unique PlayFab identifier of the owner of the combined info.
/// </summary>
public string PlayFabId;

/// <summary>
/// Account information for the user.
/// </summary>
public UserAccountInfo AccountInfo;

/// <summary>
/// Array of inventory items in the user's current inventory.
/// </summary>
[Unordered(SortProperty="ItemInstanceId")]
public List<ItemInstance> Inventory;

/// <summary>
/// Array of virtual currency balance(s) belonging to the user.
/// </summary>
public Dictionary<string,int> VirtualCurrency;

/// <summary>
/// Array of remaining times and timestamps for virtual currencies.
/// </summary>
public Dictionary<string,VirtualCurrencyRechargeTime> VirtualCurrencyRechargeTimes;

/// <summary>
/// User specific custom data.
/// </summary>
public Dictionary<string,UserDataRecord> Data;

/// <summary>
/// The version of the UserData that was returned.
/// </summary>
public uint DataVersion;

/// <summary>
/// User specific read-only data.
/// </summary>
public Dictionary<string,UserDataRecord> ReadOnlyData;

/// <summary>
/// The version of the Read-Only UserData that was returned.
/// </summary>
public uint ReadOnlyDataVersion;

}

public class GetUserDataRequest : PlayFabRequestCommon
{
/// <summary>
Expand Down
5 changes: 4 additions & 1 deletion PlayFabClientSDK/source/PlayFabErrors.cs
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,10 @@ public enum PlayFabErrorCode
LimitNotAnUpgradeOption = 1259,
NoSecretKeyEnabledForCloudScript = 1260,
TaskNotFound = 1261,
TaskInstanceNotFound = 1262
TaskInstanceNotFound = 1262,
InvalidIdentityProviderId = 1263,
MisconfiguredIdentityProvider = 1264,
InvalidScheduledTaskType = 1265
}

public class PlayFabError
Expand Down
6 changes: 3 additions & 3 deletions PlayFabClientSDK/source/PlayFabSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ namespace PlayFab
{
public class PlayFabSettings
{
public const string SdkVersion = "1.2.161121";
public const string BuildIdentifier = "jbuild_csharpsdk_1";
public const string SdkVersionString = "CSharpSDK-1.2.161121";
public const string SdkVersion = "1.3.170102";
public const string BuildIdentifier = "jbuild_csharpsdk_0";
public const string SdkVersionString = "CSharpSDK-1.3.170102";

/// <summary> This is for PlayFab internal debugging. Generally you shouldn't touch this </summary>
public static bool UseDevelopmentEnvironment = false;
Expand Down
24 changes: 0 additions & 24 deletions PlayFabSDK/source/PlayFabClientAPI.cs
Original file line number Diff line number Diff line change
Expand Up @@ -599,30 +599,6 @@ public static async Task<PlayFabResult<GetPlayFabIDsFromTwitchIDsResult>> GetPla
return new PlayFabResult<GetPlayFabIDsFromTwitchIDsResult> { Result = result, CustomData = customData };
}

/// <summary>
/// NOTE: This call will be deprecated soon. For fetching the data for a given user use GetPlayerCombinedInfo. For looking up users from the client api, we are in the process of adding a new api call. Once that call is ready, this one will be deprecated. Retrieves all requested data for a user in one unified request. By default, this API returns all data for the locally signed-in user. The input parameters may be used to limit the data retrieved to any subset of the available data, as well as retrieve the available data for a different user. Note that certain data, including inventory, virtual currency balances, and personally identifying information, may only be retrieved for the locally signed-in user. In the example below, a request is made for the account details, virtual currency balances, and specified user data for the locally signed-in user.
/// </summary>
[Obsolete("Use 'GetPlayerCombinedInfo' instead", true)]
public static async Task<PlayFabResult<GetUserCombinedInfoResult>> GetUserCombinedInfoAsync(GetUserCombinedInfoRequest request, object customData = null)
{
if (_authKey == null) throw new Exception ("Must be logged in to call this method");

var httpResult = await PlayFabHttp.DoPost("/Client/GetUserCombinedInfo", request, "X-Authorization", _authKey);
if(httpResult is PlayFabError)
{
var error = (PlayFabError)httpResult;
if (PlayFabSettings.GlobalErrorHandler != null)
PlayFabSettings.GlobalErrorHandler(error);
return new PlayFabResult<GetUserCombinedInfoResult> { Error = error, CustomData = customData };
}

var resultRawJson = (string)httpResult;
var resultData = JsonWrapper.DeserializeObject<PlayFabJsonSuccess<GetUserCombinedInfoResult>>(resultRawJson);
var result = resultData.data;

return new PlayFabResult<GetUserCombinedInfoResult> { Result = result, CustomData = customData };
}

/// <summary>
/// Links the Android device identifier to the user's PlayFab account
/// </summary>
Expand Down
113 changes: 1 addition & 112 deletions PlayFabSDK/source/PlayFabClientModels.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1579,7 +1579,7 @@ public class GetPlayerCombinedInfoRequestParams
public bool GetUserData;

/// <summary>
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if UserDataKeys is false
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false
/// </summary>
public List<string> UserDataKeys;

Expand Down Expand Up @@ -2164,117 +2164,6 @@ public class GetTradeStatusResponse : PlayFabResultCommon

}

[Obsolete("No longer available", true)]
public class GetUserCombinedInfoRequest : PlayFabRequestCommon
{
/// <summary>
/// Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no other lookup identifier set.
/// </summary>
public string PlayFabId;

/// <summary>
/// PlayFab Username for the account to find (if no PlayFabId is specified).
/// </summary>
public string Username;

/// <summary>
/// User email address for the account to find (if no Username is specified).
/// </summary>
public string Email;

/// <summary>
/// Title-specific username for the account to find (if no Email is set).
/// </summary>
public string TitleDisplayName;

/// <summary>
/// If set to false, account info will not be returned. Defaults to true.
/// </summary>
public bool? GetAccountInfo;

/// <summary>
/// If set to false, inventory will not be returned. Defaults to true. Inventory will never be returned for users other than yourself.
/// </summary>
public bool? GetInventory;

/// <summary>
/// If set to false, virtual currency balances will not be returned. Defaults to true. Currency balances will never be returned for users other than yourself.
/// </summary>
public bool? GetVirtualCurrency;

/// <summary>
/// If set to false, custom user data will not be returned. Defaults to true.
/// </summary>
public bool? GetUserData;

/// <summary>
/// User custom data keys to return. If set to null, all keys will be returned. For users other than yourself, only public data will be returned.
/// </summary>
public List<string> UserDataKeys;

/// <summary>
/// If set to false, read-only user data will not be returned. Defaults to true.
/// </summary>
public bool? GetReadOnlyData;

/// <summary>
/// User read-only custom data keys to return. If set to null, all keys will be returned. For users other than yourself, only public data will be returned.
/// </summary>
public List<string> ReadOnlyDataKeys;

}

[Obsolete("No longer available", true)]
public class GetUserCombinedInfoResult : PlayFabResultCommon
{
/// <summary>
/// Unique PlayFab identifier of the owner of the combined info.
/// </summary>
public string PlayFabId;

/// <summary>
/// Account information for the user.
/// </summary>
public UserAccountInfo AccountInfo;

/// <summary>
/// Array of inventory items in the user's current inventory.
/// </summary>
[Unordered(SortProperty="ItemInstanceId")]
public List<ItemInstance> Inventory;

/// <summary>
/// Array of virtual currency balance(s) belonging to the user.
/// </summary>
public Dictionary<string,int> VirtualCurrency;

/// <summary>
/// Array of remaining times and timestamps for virtual currencies.
/// </summary>
public Dictionary<string,VirtualCurrencyRechargeTime> VirtualCurrencyRechargeTimes;

/// <summary>
/// User specific custom data.
/// </summary>
public Dictionary<string,UserDataRecord> Data;

/// <summary>
/// The version of the UserData that was returned.
/// </summary>
public uint DataVersion;

/// <summary>
/// User specific read-only data.
/// </summary>
public Dictionary<string,UserDataRecord> ReadOnlyData;

/// <summary>
/// The version of the Read-Only UserData that was returned.
/// </summary>
public uint ReadOnlyDataVersion;

}

public class GetUserDataRequest : PlayFabRequestCommon
{
/// <summary>
Expand Down
5 changes: 4 additions & 1 deletion PlayFabSDK/source/PlayFabErrors.cs
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,10 @@ public enum PlayFabErrorCode
LimitNotAnUpgradeOption = 1259,
NoSecretKeyEnabledForCloudScript = 1260,
TaskNotFound = 1261,
TaskInstanceNotFound = 1262
TaskInstanceNotFound = 1262,
InvalidIdentityProviderId = 1263,
MisconfiguredIdentityProvider = 1264,
InvalidScheduledTaskType = 1265
}

public class PlayFabError
Expand Down
2 changes: 1 addition & 1 deletion PlayFabSDK/source/PlayFabServerModels.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1803,7 +1803,7 @@ public class GetPlayerCombinedInfoRequestParams
public bool GetUserData;

/// <summary>
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if UserDataKeys is false
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false
/// </summary>
public List<string> UserDataKeys;

Expand Down
6 changes: 3 additions & 3 deletions PlayFabSDK/source/PlayFabSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ namespace PlayFab
{
public class PlayFabSettings
{
public const string SdkVersion = "1.2.161121";
public const string BuildIdentifier = "jbuild_csharpsdk_1";
public const string SdkVersionString = "CSharpSDK-1.2.161121";
public const string SdkVersion = "1.3.170102";
public const string BuildIdentifier = "jbuild_csharpsdk_0";
public const string SdkVersionString = "CSharpSDK-1.3.170102";

/// <summary> This is for PlayFab internal debugging. Generally you shouldn't touch this </summary>
public static bool UseDevelopmentEnvironment = false;
Expand Down
5 changes: 4 additions & 1 deletion PlayFabServerSDK/source/PlayFabErrors.cs
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,10 @@ public enum PlayFabErrorCode
LimitNotAnUpgradeOption = 1259,
NoSecretKeyEnabledForCloudScript = 1260,
TaskNotFound = 1261,
TaskInstanceNotFound = 1262
TaskInstanceNotFound = 1262,
InvalidIdentityProviderId = 1263,
MisconfiguredIdentityProvider = 1264,
InvalidScheduledTaskType = 1265
}

public class PlayFabError
Expand Down
2 changes: 1 addition & 1 deletion PlayFabServerSDK/source/PlayFabServerModels.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1803,7 +1803,7 @@ public class GetPlayerCombinedInfoRequestParams
public bool GetUserData;

/// <summary>
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if UserDataKeys is false
/// Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false
/// </summary>
public List<string> UserDataKeys;

Expand Down
Loading

0 comments on commit d572b3a

Please sign in to comment.