Skip to content

Commit

Permalink
https://api.playfab.com/releaseNotes/#170530
Browse files Browse the repository at this point in the history
  • Loading branch information
PlayFabJenkinsBot committed May 30, 2017
2 parents c9de2e8 + 90f77d0 commit 2aef758
Show file tree
Hide file tree
Showing 16 changed files with 73 additions and 40 deletions.
2 changes: 1 addition & 1 deletion 3rdParty/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PlayFab LuaSdk 3rdParty readme:
# PlayFab LuaSdk 3rdParty readme:

This folder is reserved for code submissions from the PlayFab community, specifically IHttps implementations that route PlayFab HTTPS calls into an engine specific HTTPS implementation.

Expand Down
15 changes: 7 additions & 8 deletions Corona/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Corona builds for LuaSdk
----
# Corona builds for LuaSdk

The Corona plugin files are available for free on the Corona marketplace. (PlayFab subscription fees still apply when relevant)

Expand All @@ -24,8 +23,8 @@ The Corona plugin files are available for free on the Corona marketplace. (Play
* https://api.playfab.com/Documentation/Matchmaker
* https://api.playfab.com/Documentation/Admin

Client Plugin Instructions:
----

## Client Plugin Instructions:

* Add the following to your build.settings:
```lua
Expand Down Expand Up @@ -53,8 +52,8 @@ PlayFabClientApi.LoginWithCustomID(loginRequest, function(result) print("Login S
* All API methods follow the same signature: PlayFabClientApi.<ApiName>(request, function(result) end, function(error) end)
* You can see a list of all available [client APIs methods](https://api.playfab.com/Documentation/Client)

Server Plugin Instructions:
----
## Server Plugin Instructions:

* Add the following to your build.settings:
```lua
Expand All @@ -79,8 +78,8 @@ PlayFabServerApi.GetTitleData(dataRequest, function(result) print("GetTitleData
* All API methods follow the same signature: PlayFabServerApi.<ApiName>(request, function(result) end, function(error) end)
* You can see a list of all available [server APIs methods](https://api.playfab.com/Documentation/Server)

Combo Plugin Instructions:
----

## Combo Plugin Instructions:

* Add the following to your build.settings:
```lua
Expand Down
Binary file modified Defold/PlayFabClientSdk.zip
Binary file not shown.
Binary file modified Defold/PlayFabClientTestExample.zip
Binary file not shown.
Binary file modified Defold/PlayFabComboSdk.zip
Binary file not shown.
Binary file modified Defold/PlayFabServerSdk.zip
Binary file not shown.
3 changes: 1 addition & 2 deletions Defold/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Defold builds for LuaSdk
----
# Defold builds for LuaSdk

Set a project dependency to one of these files in GitHub to automatically download and sync the latest PlayFab LuaSdk in your Defold project.

Expand Down
9 changes: 9 additions & 0 deletions PlayFabClientSDK/PlayFab/PlayFabClientApi.lua
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,15 @@ function PlayFabClientApi.GetPlayerCombinedInfo(request, onSuccess, onError)
IPlayFabHttps.MakePlayFabApiCall("/Client/GetPlayerCombinedInfo", request, "X-Authorization", PlayFabSettings._internalSettings.sessionTicket, onSuccess, onError)
end

-- Retrieves the player's profile
-- API Method Documentation: https://api.playfab.com/Documentation/Client/method/GetPlayerProfile
-- Request Documentation: https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayerProfileRequest
-- Result Documentation: https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayerProfileResult
function PlayFabClientApi.GetPlayerProfile(request, onSuccess, onError)
if (not PlayFabClientApi.IsClientLoggedIn()) then error("Must be logged in to call this method") end
IPlayFabHttps.MakePlayFabApiCall("/Client/GetPlayerProfile", request, "X-Authorization", PlayFabSettings._internalSettings.sessionTicket, onSuccess, onError)
end

-- Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
-- API Method Documentation: https://api.playfab.com/Documentation/Client/method/GetPlayFabIDsFromFacebookIDs
-- Request Documentation: https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayFabIDsFromFacebookIDsRequest
Expand Down
4 changes: 2 additions & 2 deletions PlayFabClientSDK/PlayFab/PlayFabSettings.lua
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
local PlayFabSettings = {
_internalSettings = {
sessionTicket = nil,
sdkVersionString = "LuaSdk_0.15.170508",
buildIdentifier = "jbuild_luasdk_0"
sdkVersionString = "LuaSdk_0.16.170530",
buildIdentifier = "jbuild_luasdk_1"
},
settings = {
disableAdvertising = false,
Expand Down
9 changes: 9 additions & 0 deletions PlayFabSDK/PlayFab/PlayFabClientApi.lua
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,15 @@ function PlayFabClientApi.GetPlayerCombinedInfo(request, onSuccess, onError)
IPlayFabHttps.MakePlayFabApiCall("/Client/GetPlayerCombinedInfo", request, "X-Authorization", PlayFabSettings._internalSettings.sessionTicket, onSuccess, onError)
end

-- Retrieves the player's profile
-- API Method Documentation: https://api.playfab.com/Documentation/Client/method/GetPlayerProfile
-- Request Documentation: https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayerProfileRequest
-- Result Documentation: https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayerProfileResult
function PlayFabClientApi.GetPlayerProfile(request, onSuccess, onError)
if (not PlayFabClientApi.IsClientLoggedIn()) then error("Must be logged in to call this method") end
IPlayFabHttps.MakePlayFabApiCall("/Client/GetPlayerProfile", request, "X-Authorization", PlayFabSettings._internalSettings.sessionTicket, onSuccess, onError)
end

-- Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
-- API Method Documentation: https://api.playfab.com/Documentation/Client/method/GetPlayFabIDsFromFacebookIDs
-- Request Documentation: https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayFabIDsFromFacebookIDsRequest
Expand Down
9 changes: 9 additions & 0 deletions PlayFabSDK/PlayFab/PlayFabServerApi.lua
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ function PlayFabServerApi.BanUsers(request, onSuccess, onError)
IPlayFabHttps.MakePlayFabApiCall("/Server/BanUsers", request, "X-SecretKey", PlayFabSettings.settings.devSecretKey, onSuccess, onError)
end

-- Retrieves the player's profile
-- API Method Documentation: https://api.playfab.com/Documentation/Server/method/GetPlayerProfile
-- Request Documentation: https://api.playfab.com/Documentation/Server/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayerProfileRequest
-- Result Documentation: https://api.playfab.com/Documentation/Server/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayerProfileResult
function PlayFabServerApi.GetPlayerProfile(request, onSuccess, onError)
if (not PlayFabSettings.settings.titleId or not PlayFabSettings.settings.devSecretKey) then error("Must have PlayFabSettings.settings.devSecretKey set to call this method") end
IPlayFabHttps.MakePlayFabApiCall("/Server/GetPlayerProfile", request, "X-SecretKey", PlayFabSettings.settings.devSecretKey, onSuccess, onError)
end

-- Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
-- API Method Documentation: https://api.playfab.com/Documentation/Server/method/GetPlayFabIDsFromFacebookIDs
-- Request Documentation: https://api.playfab.com/Documentation/Server/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayFabIDsFromFacebookIDsRequest
Expand Down
4 changes: 2 additions & 2 deletions PlayFabSDK/PlayFab/PlayFabSettings.lua
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
local PlayFabSettings = {
_internalSettings = {
sessionTicket = nil,
sdkVersionString = "LuaSdk_0.15.170508",
buildIdentifier = "jbuild_luasdk_0"
sdkVersionString = "LuaSdk_0.16.170530",
buildIdentifier = "jbuild_luasdk_1"
},
settings = {
devSecretKey = nil, -- This should never be assigned in a client distribution
Expand Down
9 changes: 9 additions & 0 deletions PlayFabServerSDK/PlayFab/PlayFabServerApi.lua
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ function PlayFabServerApi.BanUsers(request, onSuccess, onError)
IPlayFabHttps.MakePlayFabApiCall("/Server/BanUsers", request, "X-SecretKey", PlayFabSettings.settings.devSecretKey, onSuccess, onError)
end

-- Retrieves the player's profile
-- API Method Documentation: https://api.playfab.com/Documentation/Server/method/GetPlayerProfile
-- Request Documentation: https://api.playfab.com/Documentation/Server/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayerProfileRequest
-- Result Documentation: https://api.playfab.com/Documentation/Server/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayerProfileResult
function PlayFabServerApi.GetPlayerProfile(request, onSuccess, onError)
if (not PlayFabSettings.settings.titleId or not PlayFabSettings.settings.devSecretKey) then error("Must have PlayFabSettings.settings.devSecretKey set to call this method") end
IPlayFabHttps.MakePlayFabApiCall("/Server/GetPlayerProfile", request, "X-SecretKey", PlayFabSettings.settings.devSecretKey, onSuccess, onError)
end

-- Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
-- API Method Documentation: https://api.playfab.com/Documentation/Server/method/GetPlayFabIDsFromFacebookIDs
-- Request Documentation: https://api.playfab.com/Documentation/Server/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayFabIDsFromFacebookIDsRequest
Expand Down
4 changes: 2 additions & 2 deletions PlayFabServerSDK/PlayFab/PlayFabSettings.lua
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@

local PlayFabSettings = {
_internalSettings = {
sdkVersionString = "LuaSdk_0.15.170508",
buildIdentifier = "jbuild_luasdk_0"
sdkVersionString = "LuaSdk_0.16.170530",
buildIdentifier = "jbuild_luasdk_1"
},
settings = {
devSecretKey = nil, -- This should never be assigned in a client distribution
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
LuaSdk README
========
1. Overview:
----
# LuaSdk README


## 1. Overview:

The PlayFab LuaSdk includes the files needed to make PlayFab HTTPS API calls within a Lua Project.

Current supported platforms:
Expand All @@ -10,17 +11,18 @@ Current supported platforms:
* Corona - See our [Corona Readme](https://github.com/PlayFab/LuaSdk/tree/master/Corona)
* If your favorite Lua-engine/environment is not listed, let us know on the [Forums](https://community.playfab.com/index.html).

2. Prerequisites:
----

## 2. Prerequisites:

* Users should be very familiar with the topics covered in our [getting started guide](https://playfab.com/docs/getting-started-with-playfab/).

To connect to the PlayFab service, your machine must be running TLS v1.2 or better.
* For Windows, this means Windows 7 and above
* [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. Contents:
----

## 3. Contents:

* PlayFabClientSDK - All files neccessary to make API calls to the PlayFab Client API
* This is the SDK you should include in your game, and distribute to your players
Expand All @@ -31,8 +33,8 @@ To connect to the PlayFab service, your machine must be running TLS v1.2 or bett
* Generally for evaluation or debugging, and some special case live-servers
* For the security of your title, do not distribute any build which contains your devSecretKey

4. LuaDist Example Instructions:
----

## 4. LuaDist Example Instructions:

* Download PlayFab LuaSdk, copy PlayFabClientSDK/PlayFab into your project folder
* Specifically, your PlayFabClientApi.lua file should be located: {YourLuaProjectFolder}/PlayFab/PlayFabClientApi.lua
Expand Down Expand Up @@ -61,8 +63,7 @@ lua PlayFabTesting/TestPlayFabConsole.lua
```


5. Defold Example Instructions:
----
## 5. Defold Example Instructions:

* Download and install defold
* Set a project-dependency to our Defold Client Example
Expand Down Expand Up @@ -92,8 +93,8 @@ end
* Link the file to a gui script and run!


6. Troubleshooting:
----
## 6. Troubleshooting:

For a complete list of available APIs, check out the [online documentation](http://api.playfab.com/Documentation/).

#### Contact Us
Expand All @@ -105,10 +106,9 @@ Our Developer Success Team can assist with answering any questions as well as pr
[Forums, Support and Knowledge Base](https://community.playfab.com/index.html)


7. Copyright and Licensing Information:
----
## 7. Copyright and Licensing Information:

Apache License --
Version 2.0, August 2016
http://www.apache.org/licenses/

Full details available within the LICENSE file.
11 changes: 5 additions & 6 deletions licenses/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
PlayFab LuaSdk external licenses
----
# PlayFab LuaSdk external licenses

This is a description of all the software included in, and referenced by the PlayFab LuaSdk

Distributed with PlayFab LuaSdk
----

## Distributed with PlayFab LuaSdk

Json.lua 0.1.0 is included with the PlayFab LuaSdk
* https://github.com/rxi/json.lua
* https://github.com/rxi/json.lua/blob/master/LICENSE

Not Distributed with PlayFab LuaSdk
----

## Not Distributed with PlayFab LuaSdk

LuaSec 0.4 is automatically included in LuaDist (LuaSec not required). LuaSec is not suggested for actual game development, as the HTTPS calls block the program while executing (this is not ideal)
* https://github.com/brunoos/luasec
Expand Down

0 comments on commit 2aef758

Please sign in to comment.