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

Author: playfabjenkinsbot

PlayFabSdk/src/PlayFab/PlayFabAdminApi.js

@@ -20,10 +20,12 @@ if(!PlayFab.settings) {
 
 if(!PlayFab._internalSettings) {
     PlayFab._internalSettings = {
+        entityToken: null,
         sessionTicket: null,
         productionServerUrl: ".playfabapi.com",
         errorTitleId: "Must be have PlayFab.settings.titleId set to call this method",
         errorLoggedIn: "Must be logged in to call this method",
+        errorEntityToken: "You must successfully call GetEntityToken before calling this",
         errorSecretKey: "Must have PlayFab.settings.developerSecretKey set to call this method",
 
         GetServerUrl: function () {
@@ -39,7 +41,7 @@ if(!PlayFab._internalSettings) {
                 try {
                     xhr.setRequestHeader(gHeaderKey, headersObj[headerKey]);
                 } catch (e) {
-                    console.log("Failed to append header: " + headerKey + " = " + headersObj[headerKey]);
+                    console.log("Failed to append header: " + headerKey + " = " + headersObj[headerKey] + "Error: " + e);
                 }
             }
         },
@@ -58,8 +60,8 @@ if(!PlayFab._internalSettings) {
             // window.console.log("URL: " + completeUrl);
             xhr.open("POST", completeUrl, true);
 
-            xhr.setRequestHeader('Content-Type', 'application/json');
-            xhr.setRequestHeader('X-PlayFabSDK', "JavaScriptSDK-" + PlayFab._internalSettings.sdkVersion);
+            xhr.setRequestHeader("Content-Type", "application/json");
+            xhr.setRequestHeader("X-PlayFabSDK", "JavaScriptSDK-" + PlayFab._internalSettings.sdkVersion);
             if (authkey != null)
                 xhr.setRequestHeader(authkey, authValue);
             PlayFab._internalSettings.InjectHeaders(xhr, PlayFab.settings.GlobalHeaderInjection);
@@ -123,7 +125,7 @@ if(!PlayFab._internalSettings) {
 }
 
 PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
-PlayFab.sdkVersion = "1.16.171106";
+PlayFab.sdkVersion = "1.17.171127";
 PlayFab.GenerateErrorReport = function (error) {
     if (error == null)
         return "";
@@ -135,34 +137,33 @@ PlayFab.GenerateErrorReport = function (error) {
 };
 
 PlayFab.MatchmakerApi = {
+    ForgetAllCredentials: function () {
+        PlayFab._internalSettings.sessionTicket = null;
+        PlayFab._internalSettings.entityToken = null;
+    },
 
     AuthUser: function (request, callback, customData, extraHeaders) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
-
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Matchmaker/AuthUser", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback, customData, extraHeaders);
     },
 
     PlayerJoined: function (request, callback, customData, extraHeaders) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
-
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Matchmaker/PlayerJoined", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback, customData, extraHeaders);
     },
 
     PlayerLeft: function (request, callback, customData, extraHeaders) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
-
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Matchmaker/PlayerLeft", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback, customData, extraHeaders);
     },
 
     StartGame: function (request, callback, customData, extraHeaders) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
-
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Matchmaker/StartGame", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback, customData, extraHeaders);
     },
 
     UserInfo: function (request, callback, customData, extraHeaders) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
-
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Matchmaker/UserInfo", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback, customData, extraHeaders);
     },
 };

PlayFabSdk/src/PlayFab/PlayFabClientApi.js

@@ -2,6 +2,8 @@
 
 declare module PlayFabAdminModule {
     export interface IPlayFabAdmin {
+        ForgetAllCredentials(): void;
+
         /**
          * Abort an ongoing task instance.
          * https://api.playfab.com/Documentation/Admin/method/AbortTaskInstance
@@ -39,6 +41,11 @@ declare module PlayFabAdminModule {
          * https://api.playfab.com/Documentation/Admin/method/BanUsers
          */
         BanUsers(request: PlayFabAdminModels.BanUsersRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.BanUsersResult>, customData?: any, extraHeaders?: { [key: string]: string }): void;
+        /**
+         * Checks the global count for the limited edition item.
+         * https://api.playfab.com/Documentation/Admin/method/CheckLimitedEditionItemAvailability
+         */
+        CheckLimitedEditionItemAvailability(request: PlayFabAdminModels.CheckLimitedEditionItemAvailabilityRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CheckLimitedEditionItemAvailabilityResult>, customData?: any, extraHeaders?: { [key: string]: string }): void;
         /**
          * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
          * https://api.playfab.com/Documentation/Admin/method/CreateActionsOnPlayersInSegmentTask
@@ -296,6 +303,11 @@ declare module PlayFabAdminModule {
          * https://api.playfab.com/Documentation/Admin/method/GrantItemsToUsers
          */
         GrantItemsToUsers(request: PlayFabAdminModels.GrantItemsToUsersRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GrantItemsToUsersResult>, customData?: any, extraHeaders?: { [key: string]: string }): void;
+        /**
+         * Increases the global count for the given scarce resource.
+         * https://api.playfab.com/Documentation/Admin/method/IncrementLimitedEditionItemAvailability
+         */
+        IncrementLimitedEditionItemAvailability(request: PlayFabAdminModels.IncrementLimitedEditionItemAvailabilityRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.IncrementLimitedEditionItemAvailabilityResult>, customData?: any, extraHeaders?: { [key: string]: string }): void;
         /**
          * Resets the indicated statistic, removing all player entries for it and backing up the old values.
          * https://api.playfab.com/Documentation/Admin/method/IncrementPlayerStatisticVersion
@@ -872,6 +884,22 @@ declare module PlayFabAdminModels {
 
     }
 
+    /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.CheckLimitedEditionItemAvailabilityRequest */
+    export interface CheckLimitedEditionItemAvailabilityRequest extends PlayFabModule.IPlayFabRequestCommon {
+        /** Which catalog is being updated. If null, uses the default catalog. */
+        CatalogVersion?: string;
+        /** The item to check for. */
+        ItemId: string;
+
+    }
+
+    /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.CheckLimitedEditionItemAvailabilityResult */
+    export interface CheckLimitedEditionItemAvailabilityResult extends PlayFabModule.IPlayFabResultCommon  {
+        /** The amount of the specified resource remaining. */
+        Amount: number;
+
+    }
+
     /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.CloudScriptFile */
     export interface CloudScriptFile {
         /** Contents of the Cloud Script javascript. Must be string-escaped javascript. */
@@ -1951,7 +1979,7 @@ declare module PlayFabAdminModels {
     /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.GetPublisherDataResult */
     export interface GetPublisherDataResult extends PlayFabModule.IPlayFabResultCommon  {
         /** a dictionary object of key / value pairs */
-        Data?: { [key: string]: string };
+        Data?: { [key: string]: string | null };
 
     }
 
@@ -2112,7 +2140,7 @@ declare module PlayFabAdminModels {
     /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.GetTitleDataResult */
     export interface GetTitleDataResult extends PlayFabModule.IPlayFabResultCommon  {
         /** a dictionary object of key / value pairs */
-        Data?: { [key: string]: string };
+        Data?: { [key: string]: string | null };
 
     }
 
@@ -2194,7 +2222,7 @@ declare module PlayFabAdminModels {
         /** Unique PlayFab assigned ID for a specific character owned by a user */
         CharacterId?: string;
         /** A set of custom key-value pairs on the inventory item. */
-        CustomData?: { [key: string]: string };
+        CustomData?: { [key: string]: string | null };
         /** CatalogItem.DisplayName at the time this item was purchased. */
         DisplayName?: string;
         /** Timestamp for when this instance will expire. */
@@ -2238,6 +2266,22 @@ declare module PlayFabAdminModels {
 
     }
 
+    /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.IncrementLimitedEditionItemAvailabilityRequest */
+    export interface IncrementLimitedEditionItemAvailabilityRequest extends PlayFabModule.IPlayFabRequestCommon {
+        /** Amount to increase availability by. */
+        Amount: number;
+        /** Which catalog is being updated. If null, uses the default catalog. */
+        CatalogVersion?: string;
+        /** The item which needs more availability. */
+        ItemId: string;
+
+    }
+
+    /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.IncrementLimitedEditionItemAvailabilityResult */
+    export interface IncrementLimitedEditionItemAvailabilityResult extends PlayFabModule.IPlayFabResultCommon  {
+
+    }
+
     /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.IncrementPlayerStatisticVersionRequest */
     export interface IncrementPlayerStatisticVersionRequest extends PlayFabModule.IPlayFabRequestCommon {
         /** unique name of the statistic */
@@ -2262,7 +2306,7 @@ declare module PlayFabAdminModels {
          * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
          * not begin with a '!' character or be null.
          */
-        Data?: { [key: string]: string };
+        Data?: { [key: string]: string | null };
         /** Unique identifier of the catalog item to be granted to the user. */
         ItemId: string;
         /**
@@ -2289,7 +2333,7 @@ declare module PlayFabAdminModels {
         /** Catalog version for the inventory item, when this instance was created. */
         CatalogVersion?: string;
         /** A set of custom key-value pairs on the inventory item. */
-        CustomData?: { [key: string]: string };
+        CustomData?: { [key: string]: string | null };
         /** CatalogItem.DisplayName at the time this item was purchased. */
         DisplayName?: string;
         /** Timestamp for when this instance will expire. */
@@ -2656,8 +2700,6 @@ declare module PlayFabAdminModels {
         TotalValueToDateInUSD?: number;
         /** List of the player's lifetime purchase totals, summed by real-money currency */
         ValuesToDate?: ValueToDateModel[];
-        /** List of the player's virtual currency balances */
-        VirtualCurrencyBalances?: VirtualCurrencyBalanceModel[];
 
     }
 
@@ -3499,7 +3541,7 @@ declare module PlayFabAdminModels {
          * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
          * not begin with a '!' character or be null.
          */
-        Data?: { [key: string]: string };
+        Data?: { [key: string]: string | null };
         /**
          * Optional list of Data-keys to remove from UserData.  Some SDKs cannot insert null-values into Data due to language
          * constraints.  Use this to delete the keys directly.
@@ -3528,7 +3570,7 @@ declare module PlayFabAdminModels {
          * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
          * not begin with a '!' character or be null.
          */
-        Data?: { [key: string]: string };
+        Data?: { [key: string]: string | null };
         /**
          * Optional list of Data-keys to remove from UserData.  Some SDKs cannot insert null-values into Data due to language
          * constraints.  Use this to delete the keys directly.
@@ -3774,15 +3816,6 @@ declare module PlayFabAdminModels {
 
     }
 
-    /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.VirtualCurrencyBalanceModel */
-    export interface VirtualCurrencyBalanceModel {
-        /** Name of the virtual currency */
-        Currency?: string;
-        /** Balance of the virtual currency */
-        TotalValue: number;
-
-    }
-
     /** https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.VirtualCurrencyData */
     export interface VirtualCurrencyData {
         /** unique two-character identifier for this currency type (e.g.: "CC") */