Documentation

PlayFab API & SDK Release Notes

Unless otherwise noted, no change will ever affect an existing title. Upgrade warnings are notes about less-than-trivial changes to the sdk which may cause minor compiler errors if you change/upgrade your PlayFab SDK version.

180414 Date: 2018-04-14

Unreal Cpp Sdk HotFix:

  • Issues were discovered in the Entity API release for Unreal Cpp Sdk. These are hotfixed, and the Entity API should now work as expected.

180409 Date: 2018-04-09

API Changes:

UnitySdk Specific Changes:

  • Performance improvement for default HTTP settings (UnityWWW), for long-running processes

180403 Date: 2018-04-03

Unreal SDKs Updated to support v4.17 thru 4.19:

  • Removing support for UE 4.14 thru 4.16 (Please update!)

180329 Date: 2018-03-29

Unreal SDKs Updated to support Entity APIs:

  • Sorry for the delay!
  • This release still targets UE 4.17, and not 4.18 or 4.19. We are in-progress working on updating versions

180316 Date: 2018-03-16

API Changes:

  • Entities! Blog! Guide!
    • All Client login methods return Entity credentials if request.LoginTitlePlayerAccountEntity is set to true
  • Guilds! Blog! Guide!
  • Error Codes for many API methods updated for accuracy (Dozens!)

New API Methods:

Most SDKs Updated to support Entity APIs:

  • Full Support: UnitySdk, JavaScriptSdk, ActionScriptSdk, CSharpSdk, NodeSdk, PostmanCollection, WindowsSdk, Cocos2d-xSdk, JavaSdk, LuaSdk (Including Corona and Defold), PhpSdk, Cloud Script
  • Will Support Soon: Unreal Bb and Cpp (Sorry, delayed due to technical difficulties!)

180213 Date: 2018-02-13

API Changes:

  • SendAccountRecoveryEmail now supports custom account recovery email templates when a custom account recovery email template ID is passed in with the request parameters.
  • All Client Login Mechanisms can now optionally return Entity API credentials
    • (This is part of a coming-soon feature)

UnitySdk Specific Changes:

  • We are dropping support for older Unity versions, see our blog post
  • Build files are now published using Unity version 2017.3.0f3

180131 Date: 2018-01-31

JavaSDK Changes:

  • Java is now published to Maven

180129 Date: 2018-01-29

UnitySDK Specific Changes:

  • Fixing issues with compression
  • It should be safe to re-enable compression for all versions and all platforms

180123 Date: 2018-01-23

UnitySDK Hotfix:

  • PlayFab UnitySDK had an issue with Unity version 2017.1
  • See the forum post for details
  • This has been resolved, PlayFab UnitySDK should work for all versions again

180122 Date: 2018-01-22

API Documentation Update:

  • Error codes updated on many API methods

CSharpSDK and UnitySDK Specific Changes:

  • Adding a PlayFabException class, so that it's easier to catch PlayFab specific exceptions.

NodeSDK Specific Changes:

  • SDK Breaking Change: Require syntax for NodeSDK NPM package changed
  • Major upgrade focused on NPM package
  • Formerly require statements did not follow the NPM convention, requiring multiple nonstandard require statements
  • Now it requires a single require statement, and follows NPM conventions
  • Major version number changed, this release is now 2.0
  • 1.x to 2.x Upgrade Guide

Cloud Script Example:

  • Added TypeScript definitions for the API Error exceptions

Next Page