From 33ab71adae48111442459f35d4b72f004b1159c5 Mon Sep 17 00:00:00 2001 From: Paul Gilmore Date: Mon, 23 May 2016 18:31:43 -0700 Subject: [PATCH] https://api.playfab.com/releaseNotes#160523 (#57) * Readme testTitleData.json update * https://api.playfab.com/releaseNotes#160523 (#56) * Automated build from Jenkins * Automated build from Jenkins * Automated build from Jenkins * Automated build from Jenkins * Automated build from Jenkins * Automated build from Jenkins * Automated build from Jenkins --- PlayFabSDK/PlayFabAdminApi.js | 8 +------ PlayFabSDK/PlayFabClientApi.js | 2 +- PlayFabSDK/PlayFabMatchmakerApi.js | 2 +- PlayFabSDK/PlayFabServerApi.js | 8 ++++++- README.md | 34 +++++++++++++++++++++++++++--- 5 files changed, 41 insertions(+), 13 deletions(-) diff --git a/PlayFabSDK/PlayFabAdminApi.js b/PlayFabSDK/PlayFabAdminApi.js index 194f8e20..accc140f 100644 --- a/PlayFabSDK/PlayFabAdminApi.js +++ b/PlayFabSDK/PlayFabAdminApi.js @@ -18,7 +18,7 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { sessionTicket: null, - sdkVersion: "0.17.160502", + sdkVersion: "0.18.160523", productionServerUrl: ".playfabapi.com", logicServerUrl: null, @@ -308,12 +308,6 @@ PlayFab.AdminApi = { PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/SetStoreItems", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback); }, - SetStoreSegmentOverrides: function (request, callback) { - if (PlayFab.settings.developerSecretKey == null) throw "Must have PlayFab.settings.developerSecretKey set to call this method"; - - PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/SetStoreSegmentOverrides", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback); - }, - SetTitleData: function (request, callback) { if (PlayFab.settings.developerSecretKey == null) throw "Must have PlayFab.settings.developerSecretKey set to call this method"; diff --git a/PlayFabSDK/PlayFabClientApi.js b/PlayFabSDK/PlayFabClientApi.js index c4293ebf..12584ad4 100644 --- a/PlayFabSDK/PlayFabClientApi.js +++ b/PlayFabSDK/PlayFabClientApi.js @@ -18,7 +18,7 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { sessionTicket: null, - sdkVersion: "0.17.160502", + sdkVersion: "0.18.160523", productionServerUrl: ".playfabapi.com", logicServerUrl: null, diff --git a/PlayFabSDK/PlayFabMatchmakerApi.js b/PlayFabSDK/PlayFabMatchmakerApi.js index 16be47f4..c6627b94 100644 --- a/PlayFabSDK/PlayFabMatchmakerApi.js +++ b/PlayFabSDK/PlayFabMatchmakerApi.js @@ -18,7 +18,7 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { sessionTicket: null, - sdkVersion: "0.17.160502", + sdkVersion: "0.18.160523", productionServerUrl: ".playfabapi.com", logicServerUrl: null, diff --git a/PlayFabSDK/PlayFabServerApi.js b/PlayFabSDK/PlayFabServerApi.js index c98c4223..aa01c0c6 100644 --- a/PlayFabSDK/PlayFabServerApi.js +++ b/PlayFabSDK/PlayFabServerApi.js @@ -18,7 +18,7 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { sessionTicket: null, - sdkVersion: "0.17.160502", + sdkVersion: "0.18.160523", productionServerUrl: ".playfabapi.com", logicServerUrl: null, @@ -440,6 +440,12 @@ PlayFab.ServerApi = { PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Server/RedeemMatchmakerTicket", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback); }, + SetGameServerInstanceState: function (request, callback) { + if (PlayFab.settings.developerSecretKey == null) throw "Must have PlayFab.settings.developerSecretKey set to call this method"; + + PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Server/SetGameServerInstanceState", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback); + }, + AwardSteamAchievement: function (request, callback) { if (PlayFab.settings.developerSecretKey == null) throw "Must have PlayFab.settings.developerSecretKey set to call this method"; diff --git a/README.md b/README.md index 618eb821..9dc149ae 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,36 @@ To connect to the PlayFab service, your machine must be running TLS v1.2 or bett * [Official Microsoft Documentation](https://msdn.microsoft.com/en-us/library/windows/desktop/aa380516%28v=vs.85%29.aspx) * [Support for SSL/TLS protocols on Windows](http://blogs.msdn.com/b/kaushal/archive/2011/10/02/support-for-ssl-tls-protocols-on-windows.aspx) -3. Troubleshooting: + +3. Example Project: PlayFabApiTest.html & PlayFabApiTest.js: +---- + +These files are an internal PlayFab testing project, which activates and tests the core functionality of the sdk. They are not part of the sdk. You should delete these two files before integrating the sdk with your project. + +They require a testTitleData.json file to exist, which is described below. + + +4. testTitleData.json file required for example test files. +---- + +This sdk includes an optional example project that is used by PlayFab to verify sdk features are fully functional. The testTitleData.json file provides your secret title information to the unit-test project, so it can execute tests in your own PlayFab title. + +The format is as follows: + + { + "titleId": "your Game Title ID, found in the settings/credentials section of your dashboard on the website", + "developerSecretKey": "your PlayFab API Secret Key, found in the settings/credentials section of your dashboard on the website - NEVER SHARE THIS KEY WITH PLAYERS", + "titleCanUpdateSettings": "false", // "true" or "false", based on your Allow Client to Post Player Statistics option, found in the settings/general section of your dashboard on the website + "userName": "testUser", // Arbitrary username, you can change this to any valid username + "userEmail": "your@email.com", // This email address will be bound to the username above + "userPassword": "testPassword", // This must be the correct password for the testUser above (if that user does not exist yet, this will be the new password) + "characterName": "testCharacter" // Arbitrary characterName, you can change this to any valid characterName + } + +This file must be created and placed in the root of the sdk (beside PlayFabApiTest.html & PlayFabApiTest.js), and must be named "testTitleData.json" + + +5. Troubleshooting: ---- For a complete list of available APIs, check out the [online documentation](http://api.playfab.com/Documentation/). @@ -27,11 +56,10 @@ Our Developer Success Team can assist with answering any questions as well as pr [Forums, Support and Knowledge Base](https://community.playfab.com/hc/en-us) -4. Copyright and Licensing Information: +6. Copyright and Licensing Information: ---- Apache License -- Version 2.0, January 2004 http://www.apache.org/licenses/ Full details available within the LICENSE file. -