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

PlayFab · Aug 7, 2017 · 63d1e16 · 63d1e16
2 parents 73ffa4f + 3cdf844
commit 63d1e16
Show file tree

Hide file tree

Showing 17 changed files with 207 additions and 29 deletions.
diff --git a/.arcconfig b/.arcconfig
@@ -1,3 +1,3 @@
 {
-  "phabricator.uri" : "https://phab.playfabdev.com/"
+  "phabricator.uri" : "https://phabricator.playfab.com/"
 }
diff --git a/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js b/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.AdminApi = {
 
@@ -155,6 +155,12 @@ PlayFab.AdminApi = {
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/BanUsers", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
     },
 
+    DeletePlayer: function (request, callback) {
+        if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
+
+        PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/DeletePlayer", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
+    },
+
     GetUserAccountInfo: function (request, callback) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
 
@@ -167,6 +173,9 @@ PlayFab.AdminApi = {
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/GetUserBans", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
     },
 
+    /**
+     * @deprecated Please use DeletePlayer instead. 
+     */
     ResetUsers: function (request, callback) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
 
@@ -209,6 +218,9 @@ PlayFab.AdminApi = {
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/CreatePlayerStatisticDefinition", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
     },
 
+    /**
+     * @deprecated Please use DeleteUser instead. 
+     */
     DeleteUsers: function (request, callback) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
 

diff --git a/PlayFabSdk/src/PlayFab/PlayFabClientApi.js b/PlayFabSdk/src/PlayFab/PlayFabClientApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.ClientApi = {
 

diff --git a/PlayFabSdk/src/PlayFab/PlayFabMatchmakerApi.js b/PlayFabSdk/src/PlayFab/PlayFabMatchmakerApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.MatchmakerApi = {
 

diff --git a/PlayFabSdk/src/PlayFab/PlayFabServerApi.js b/PlayFabSdk/src/PlayFab/PlayFabServerApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.ServerApi = {
 

diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts
@@ -42,6 +42,11 @@ declare module PlayFabAdminModule {
          / https://api.playfab.com/Documentation/Admin/method/BanUsers
          */
         BanUsers(request: PlayFabAdminModels.BanUsersRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.BanUsersResult>): void;
+        /**
+         / Removes a user's player account from a title and deletes all associated data
+         / https://api.playfab.com/Documentation/Admin/method/DeletePlayer
+         */
+        DeletePlayer(request: PlayFabAdminModels.DeletePlayerRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeletePlayerResult>): void;
         /**
          / Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
          / https://api.playfab.com/Documentation/Admin/method/GetUserAccountInfo
@@ -1098,6 +1103,25 @@ declare module PlayFabAdminModels {
         | "True"
         | "False";
 
+    /**
+     / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.ContactEmailInfo
+     */
+    export interface ContactEmailInfo {
+        /**
+         / The name of the email info data
+         */
+        Name?: string;
+        /**
+         / The email address
+         */
+        EmailAddress?: string;
+        /**
+         / The verification status of the email
+         */
+        VerificationStatus?: string;
+
+    }
+
     /**
      / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.ContentInfo
      */
@@ -1666,6 +1690,24 @@ declare module PlayFabAdminModels {
 
     }
 
+    /**
+     / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.DeletePlayerRequest
+     */
+    export interface DeletePlayerRequest extends PlayFabModule.IPlayFabRequestCommon {
+        /**
+         / Unique PlayFab assigned ID of the user on whom the operation will be performed.
+         */
+        PlayFabId: string;
+
+    }
+
+    /**
+     / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.DeletePlayerResult
+     */
+    export interface DeletePlayerResult extends PlayFabModule.IPlayFabResultCommon  {
+
+    }
+
     /**
      / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.DeletePlayerSharedSecretRequest
      */
@@ -1742,6 +1784,10 @@ declare module PlayFabAdminModels {
     type EffectType = "Allow"
         | "Deny";
 
+    type EmailVerificationStatus = "Unverified"
+        | "Pending"
+        | "Confirmed";
+
     /**
      / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.EmptyResult
      */
@@ -3329,6 +3375,10 @@ declare module PlayFabAdminModels {
          / Array of player statistics
          */
         PlayerStatistics?: PlayerStatistic[];
+        /**
+         / Array of contact email addresses associated with the player
+         */
+        ContactEmailAddresses?: ContactEmailInfo[];
 
     }
 

diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts
@@ -470,7 +470,7 @@ declare module PlayFabClientModule {
          */
         GetGameServerRegions(request: PlayFabClientModels.GameServerRegionsRequest, callback: PlayFabModule.ApiCallback<PlayFabClientModels.GameServerRegionsResult>): void;
         /**
-         / Attempts to locate a game session matching the given parameters. If the goal is to match the player into a specific active session, only the LobbyId is required. Otherwise, the BuildVersion, GameMode, and Region are all required parameters. Note that parameters specified in the search are required (they are not weighting factors). If a slot is found in a server instance matching the parameters, the slot will be assigned to that player, removing it from the availabe set. In that case, the information on the game session will be returned, otherwise the Status returned will be GameNotFound. Note that EnableQueue is deprecated at this time.
+         / Attempts to locate a game session matching the given parameters. If the goal is to match the player into a specific active session, only the LobbyId is required. Otherwise, the BuildVersion, GameMode, and Region are all required parameters. Note that parameters specified in the search are required (they are not weighting factors). If a slot is found in a server instance matching the parameters, the slot will be assigned to that player, removing it from the availabe set. In that case, the information on the game session will be returned, otherwise the Status returned will be GameNotFound.
          / https://api.playfab.com/Documentation/Client/method/Matchmake
          */
         Matchmake(request: PlayFabClientModels.MatchmakeRequest, callback: PlayFabModule.ApiCallback<PlayFabClientModels.MatchmakeResult>): void;

diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabMatchmakerApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabMatchmakerApi.d.ts
@@ -148,11 +148,11 @@ declare module PlayFabMatchmakerModels {
      */
     export interface PlayerJoinedRequest extends PlayFabModule.IPlayFabRequestCommon {
         /**
-         / Unique identifier of the Game Server Instance the user is joining.
+         / Unique identifier of the Game Server Instance the user is joining. This must be a Game Server Instance started with the Matchmaker/StartGame API.
          */
         LobbyId: string;
         /**
-         / PlayFab unique identifier for the user joining.
+         / PlayFab unique identifier for the player joining.
          */
         PlayFabId: string;
 
@@ -170,11 +170,11 @@ declare module PlayFabMatchmakerModels {
      */
     export interface PlayerLeftRequest extends PlayFabModule.IPlayFabRequestCommon {
         /**
-         / Unique identifier of the Game Server Instance the user is leaving.
+         / Unique identifier of the Game Server Instance the user is leaving. This must be a Game Server Instance started with the Matchmaker/StartGame API.
          */
         LobbyId: string;
         /**
-         / PlayFab unique identifier for the user leaving.
+         / PlayFab unique identifier for the player leaving.
          */
         PlayFabId: string;
 

diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts
@@ -493,7 +493,7 @@ declare module PlayFabServerModule {
          */
         GetCharacterReadOnlyData(request: PlayFabServerModels.GetCharacterDataRequest, callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetCharacterDataResult>): void;
         /**
-         / Updates the title-specific custom data for the user's chjaracter which is readable and writable by the client
+         / Updates the title-specific custom data for the user's character which is readable and writable by the client
          / https://api.playfab.com/Documentation/Server/method/UpdateCharacterData
          */
         UpdateCharacterData(request: PlayFabServerModels.UpdateCharacterDataRequest, callback: PlayFabModule.ApiCallback<PlayFabServerModels.UpdateCharacterDataResult>): void;
@@ -1160,6 +1160,25 @@ declare module PlayFabServerModels {
 
     }
 
+    /**
+     / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Server.Models/PlayFab.Server.Models.ContactEmailInfo
+     */
+    export interface ContactEmailInfo {
+        /**
+         / The name of the email info data
+         */
+        Name?: string;
+        /**
+         / The email address
+         */
+        EmailAddress?: string;
+        /**
+         / The verification status of the email
+         */
+        VerificationStatus?: string;
+
+    }
+
     type ContinentCode = "AF"
         | "AN"
         | "AS"
@@ -1680,6 +1699,10 @@ declare module PlayFabServerModels {
 
     }
 
+    type EmailVerificationStatus = "Unverified"
+        | "Pending"
+        | "Confirmed";
+
     /**
      / https://api.playfab.com/Documentation/Client/datatype/PlayFab.Server.Models/PlayFab.Server.Models.EmptyResult
      */
@@ -3760,6 +3783,10 @@ declare module PlayFabServerModels {
          / Array of player statistics
          */
         PlayerStatistics?: PlayerStatistic[];
+        /**
+         / Array of contact email addresses associated with the player
+         */
+        ContactEmailAddresses?: ContactEmailInfo[];
 
     }
 

diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.AdminApi = {
 
@@ -155,6 +155,12 @@ PlayFab.AdminApi = {
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/BanUsers", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
     },
 
+    DeletePlayer: function (request, callback) {
+        if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
+
+        PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/DeletePlayer", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
+    },
+
     GetUserAccountInfo: function (request, callback) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
 
@@ -167,6 +173,9 @@ PlayFab.AdminApi = {
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/GetUserBans", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
     },
 
+    /**
+     * @deprecated Please use DeletePlayer instead. 
+     */
     ResetUsers: function (request, callback) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
 
@@ -209,6 +218,9 @@ PlayFab.AdminApi = {
         PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/CreatePlayerStatisticDefinition", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
     },
 
+    /**
+     * @deprecated Please use DeleteUser instead. 
+     */
     DeleteUsers: function (request, callback) {
         if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
 

diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabClientApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabClientApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.ClientApi = {
 

diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabMatchmakerApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabMatchmakerApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.MatchmakerApi = {
 

diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
     }
 }
 
-PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
-PlayFab.sdkVersion = "1.8.170710";
+PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
+PlayFab.sdkVersion = "1.9.170807";
 
 PlayFab.ServerApi = {