https://api.playfab.com/releaseNotes/#160912

PlayFab · Sep 13, 2016 · ab6e396 · ab6e396
2 parents 0f6a7af + b745fff
commit ab6e396
Show file tree

Hide file tree

Showing 21 changed files with 493 additions and 116 deletions.
diff --git a/PlayFabClientSDK/source/PlayFabClientAPI.cs b/PlayFabClientSDK/source/PlayFabClientAPI.cs
@@ -263,7 +263,7 @@ public static async Task<PlayFabResult<LoginResult>> LoginWithKongregateAsync(Lo
         }
 
         /// <summary>
-        /// Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user
+        /// Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email accounts must be created using the RegisterPlayFabUser API or added to existing accounts using AddUsernamePassword.
         /// </summary>
         public static async Task<PlayFabResult<LoginResult>> LoginWithPlayFabAsync(LoginWithPlayFabRequest request)
         {
@@ -1252,7 +1252,7 @@ public static async Task<PlayFabResult<GetLeaderboardResult>> GetFriendLeaderboa
         /// <summary>
         /// Retrieves a list of ranked friends of the current player for the given statistic, centered on the currently signed-in user
         /// </summary>
-        [Obsolete("Use 'GetFriendLeaderboardAroundPlayer' instead", false)]
+        [Obsolete("Use 'GetFriendLeaderboardAroundPlayer' instead", true)]
         public static async Task<PlayFabResult<GetFriendLeaderboardAroundCurrentUserResult>> GetFriendLeaderboardAroundCurrentUserAsync(GetFriendLeaderboardAroundCurrentUserRequest request)
         {
             if (_authKey == null) throw new Exception ("Must be logged in to call this method");
@@ -1328,7 +1328,7 @@ public static async Task<PlayFabResult<GetLeaderboardResult>> GetLeaderboardAsyn
         /// <summary>
         /// Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
         /// </summary>
-        [Obsolete("Use 'GetLeaderboardAroundPlayer' instead", false)]
+        [Obsolete("Use 'GetLeaderboardAroundPlayer' instead", true)]
         public static async Task<PlayFabResult<GetLeaderboardAroundCurrentUserResult>> GetLeaderboardAroundCurrentUserAsync(GetLeaderboardAroundCurrentUserRequest request)
         {
             if (_authKey == null) throw new Exception ("Must be logged in to call this method");
@@ -1529,7 +1529,7 @@ public static async Task<PlayFabResult<GetUserDataResult>> GetUserReadOnlyDataAs
         /// <summary>
         /// Retrieves the details of all title-specific statistics for the user
         /// </summary>
-        [Obsolete("Use 'GetPlayerStatistics' instead", false)]
+        [Obsolete("Use 'GetPlayerStatistics' instead", true)]
         public static async Task<PlayFabResult<GetUserStatisticsResult>> GetUserStatisticsAsync(GetUserStatisticsRequest request)
         {
             if (_authKey == null) throw new Exception ("Must be logged in to call this method");
@@ -1630,7 +1630,7 @@ public static async Task<PlayFabResult<UpdateUserDataResult>> UpdateUserPublishe
         /// <summary>
         /// Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
         /// </summary>
-        [Obsolete("Use 'UpdatePlayerStatistics' instead", false)]
+        [Obsolete("Use 'UpdatePlayerStatistics' instead", true)]
         public static async Task<PlayFabResult<UpdateUserStatisticsResult>> UpdateUserStatisticsAsync(UpdateUserStatisticsRequest request)
         {
             if (_authKey == null) throw new Exception ("Must be logged in to call this method");
@@ -2431,7 +2431,7 @@ public static async Task<PlayFabResult<ValidateGooglePlayPurchaseResult>> Valida
         /// <summary>
         /// Logs a custom analytics event
         /// </summary>
-        [Obsolete("Use 'WritePlayerEvent' instead", false)]
+        [Obsolete("Use 'WritePlayerEvent' instead", true)]
         public static async Task<PlayFabResult<LogEventResult>> LogEventAsync(LogEventRequest request)
         {
             if (_authKey == null) throw new Exception ("Must be logged in to call this method");
@@ -2682,7 +2682,7 @@ public static async Task<PlayFabResult<ExecuteCloudScriptResult>> ExecuteCloudSc
         /// <summary>
         /// Retrieves the title-specific URL for Cloud Script servers. This must be queried once, prior  to making any calls to RunCloudScript.
         /// </summary>
-        [Obsolete("Use 'ExecuteCloudScript' instead", false)]
+        [Obsolete("Use 'ExecuteCloudScript' instead", true)]
         public static async Task<PlayFabResult<GetCloudScriptUrlResult>> GetCloudScriptUrlAsync(GetCloudScriptUrlRequest request)
         {
             if (_authKey == null) throw new Exception ("Must be logged in to call this method");
@@ -2709,7 +2709,7 @@ public static async Task<PlayFabResult<GetCloudScriptUrlResult>> GetCloudScriptU
         /// <summary>
         /// Triggers a particular server action, passing the provided inputs to the hosted Cloud Script. An action in this context is a handler in the JavaScript. NOTE: Before calling this API, you must call GetCloudScriptUrl to be assigned a Cloud Script server URL. When using an official PlayFab SDK, this URL is stored internally in the SDK, but GetCloudScriptUrl must still be manually called.
         /// </summary>
-        [Obsolete("Use 'ExecuteCloudScript' instead", false)]
+        [Obsolete("Use 'ExecuteCloudScript' instead", true)]
         public static async Task<PlayFabResult<RunCloudScriptResult>> RunCloudScriptAsync(RunCloudScriptRequest request)
         {
             if (_authKey == null) throw new Exception ("Must be logged in to call this method");

diff --git a/PlayFabClientSDK/source/PlayFabClientModels.cs b/PlayFabClientSDK/source/PlayFabClientModels.cs
@@ -330,10 +330,15 @@ public class CatalogItem : IComparable<CatalogItem>
         public string ItemImageUrl;
 
         /// <summary>
-        /// if true, then only a fixed number can ever be granted.
+        /// BETA: If true, then only a fixed number can ever be granted.
         /// </summary>
         public bool IsLimitedEdition;
 
+        /// <summary>
+        /// BETA: If IsLImitedEdition is true, then this determines amount of the item initially available. Note that this fieldis ignored if the catalog item already existed in this catalog, or the field is less than 1.
+        /// </summary>
+        public int InitialLimitedEditionCount;
+
         public int CompareTo(CatalogItem other)
         {
             if (other == null || other.ItemId == null) return 1;
@@ -874,6 +879,11 @@ public class ExecuteCloudScriptResult : PlayFabResultCommon
 
         public double ExecutionTimeSeconds;
 
+        /// <summary>
+        /// Processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP requests.
+        /// </summary>
+        public double ProcessorTimeSeconds;
+
         public uint MemoryConsumedBytes;
 
         /// <summary>
@@ -1274,7 +1284,7 @@ public class GetCharacterStatisticsResult : PlayFabResultCommon
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetCloudScriptUrlRequest
     {
         /// <summary>
@@ -1289,7 +1299,7 @@ public class GetCloudScriptUrlRequest
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetCloudScriptUrlResult : PlayFabResultCommon
     {
         /// <summary>
@@ -1327,7 +1337,7 @@ public class GetContentDownloadUrlResult : PlayFabResultCommon
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetFriendLeaderboardAroundCurrentUserRequest
     {
         /// <summary>
@@ -1352,7 +1362,7 @@ public class GetFriendLeaderboardAroundCurrentUserRequest
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetFriendLeaderboardAroundCurrentUserResult : PlayFabResultCommon
     {
         /// <summary>
@@ -1485,7 +1495,7 @@ public class GetLeaderboardAroundCharacterResult : PlayFabResultCommon
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetLeaderboardAroundCurrentUserRequest
     {
         /// <summary>
@@ -1500,7 +1510,7 @@ public class GetLeaderboardAroundCurrentUserRequest
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetLeaderboardAroundCurrentUserResult : PlayFabResultCommon
     {
         /// <summary>
@@ -1970,7 +1980,7 @@ public class GetPlayFabIDsFromSteamIDsRequest
         /// <summary>
         /// Deprecated: Please use SteamStringIDs
         /// </summary>
-        [Obsolete("Use 'SteamStringIDs' instead", false)]
+        [Obsolete("Use 'SteamStringIDs' instead", true)]
         public List<ulong> SteamIDs;
 
         /// <summary>
@@ -2392,12 +2402,12 @@ public class GetUserInventoryResult : PlayFabResultCommon
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetUserStatisticsRequest
     {
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class GetUserStatisticsResult : PlayFabResultCommon
     {
         /// <summary>
@@ -2603,6 +2613,11 @@ public class LinkAndroidDeviceIDRequest
         /// </summary>
         public string AndroidDevice;
 
+        /// <summary>
+        /// If another user is already linked to the device, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkAndroidDeviceIDResult : PlayFabResultCommon
@@ -2616,6 +2631,11 @@ public class LinkCustomIDRequest
         /// </summary>
         public string CustomId;
 
+        /// <summary>
+        /// If another user is already linked to the custom ID, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkCustomIDResult : PlayFabResultCommon
@@ -2629,6 +2649,11 @@ public class LinkFacebookAccountRequest
         /// </summary>
         public string AccessToken;
 
+        /// <summary>
+        /// If another user is already linked to the account, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkFacebookAccountResult : PlayFabResultCommon
@@ -2642,6 +2667,11 @@ public class LinkGameCenterAccountRequest
         /// </summary>
         public string GameCenterId;
 
+        /// <summary>
+        /// If another user is already linked to the account, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkGameCenterAccountResult : PlayFabResultCommon
@@ -2655,6 +2685,11 @@ public class LinkGoogleAccountRequest
         /// </summary>
         public string AccessToken;
 
+        /// <summary>
+        /// If another user is already linked to the account, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkGoogleAccountResult : PlayFabResultCommon
@@ -2678,6 +2713,11 @@ public class LinkIOSDeviceIDRequest
         /// </summary>
         public string DeviceModel;
 
+        /// <summary>
+        /// If another user is already linked to the device, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkIOSDeviceIDResult : PlayFabResultCommon
@@ -2696,6 +2736,11 @@ public class LinkKongregateAccountRequest
         /// </summary>
         public string AuthTicket;
 
+        /// <summary>
+        /// If another user is already linked to the account, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkKongregateAccountResult : PlayFabResultCommon
@@ -2709,6 +2754,11 @@ public class LinkSteamAccountRequest
         /// </summary>
         public string SteamTicket;
 
+        /// <summary>
+        /// If another user is already linked to the account, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkSteamAccountResult : PlayFabResultCommon
@@ -2722,6 +2772,11 @@ public class LinkTwitchAccountRequest
         /// </summary>
         public string AccessToken;
 
+        /// <summary>
+        /// If another user is already linked to the account, unlink the other user and re-link.
+        /// </summary>
+        public bool? ForceLink;
+
     }
 
     public class LinkTwitchAccountResult : PlayFabResultCommon
@@ -2746,7 +2801,7 @@ public class ListUsersCharactersResult : PlayFabResultCommon
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class LogEventRequest
     {
         /// <summary>
@@ -2771,7 +2826,7 @@ public class LogEventRequest
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class LogEventResult : PlayFabResultCommon
     {
     }
@@ -2960,7 +3015,7 @@ public class LoginWithGoogleAccountRequest
         /// <summary>
         /// Deprecated - Do not use
         /// </summary>
-        [Obsolete("No longer available", false)]
+        [Obsolete("No longer available", true)]
         public string PublisherId;
 
         /// <summary>
@@ -3167,7 +3222,7 @@ public class MatchmakeRequest
         /// <summary>
         /// Deprecated - Do not use
         /// </summary>
-        [Obsolete("No longer available", false)]
+        [Obsolete("No longer available", true)]
         public bool? EnableQueue;
 
     }
@@ -3591,7 +3646,7 @@ public class RegisterPlayFabUserRequest
         /// <summary>
         /// The Origination of a user is determined by the API call used to create the account. In the case of RegisterPlayFabUser, it will be Organic.
         /// </summary>
-        [Obsolete("No longer available", false)]
+        [Obsolete("No longer available", true)]
         public string Origination;
 
     }
@@ -3705,7 +3760,7 @@ public class RestoreIOSPurchasesResult : PlayFabResultCommon
     {
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class RunCloudScriptRequest
     {
         /// <summary>
@@ -3725,7 +3780,7 @@ public class RunCloudScriptRequest
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class RunCloudScriptResult : PlayFabResultCommon
     {
         /// <summary>
@@ -3799,7 +3854,7 @@ public class SendAccountRecoveryEmailRequest
         /// <summary>
         /// Deprecated - Do not use
         /// </summary>
-        [Obsolete("No longer available", false)]
+        [Obsolete("No longer available", true)]
         public string PublisherId;
 
     }
@@ -4031,7 +4086,7 @@ public class SteamPlayFabIdPair
         /// <summary>
         /// Deprecated: Please use SteamStringId
         /// </summary>
-        [Obsolete("Use 'SteamStringId' instead", false)]
+        [Obsolete("Use 'SteamStringId' instead", true)]
         public ulong SteamId;
 
         /// <summary>
@@ -4553,7 +4608,7 @@ public class UpdateUserDataResult : PlayFabResultCommon
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class UpdateUserStatisticsRequest
     {
         /// <summary>
@@ -4563,7 +4618,7 @@ public class UpdateUserStatisticsRequest
 
     }
 
-    [Obsolete("No longer available", false)]
+    [Obsolete("No longer available", true)]
     public class UpdateUserStatisticsResult : PlayFabResultCommon
     {
     }

diff --git a/PlayFabClientSDK/source/PlayFabErrors.cs b/PlayFabClientSDK/source/PlayFabErrors.cs
@@ -250,7 +250,10 @@ public enum PlayFabErrorCode
         TwoFactorAuthenticationTokenRequired = 1246,
         GameServerHostCountLimitExceeded = 1247,
         PlayerTagCountLimitExceeded = 1248,
-        RequestAlreadyRunning = 1249
+        RequestAlreadyRunning = 1249,
+        ActionGroupNotFound = 1250,
+        MaximumSegmentBulkActionJobsRunning = 1251,
+        NoActionsOnPlayersInSegmentJob = 1252
     }
 
     public class PlayFabError