From c300a21d09083f8a4d3dcccb5efd5415a5ac8766 Mon Sep 17 00:00:00 2001 From: Playfab Jenkins Bot Date: Tue, 4 Apr 2017 02:40:35 +0000 Subject: [PATCH] https://api.playfab.com/releaseNotes/#170403 --- .../java/com/playfab/PlayFabClientAPI.java | 550 +++++++++++++++++- .../java/com/playfab/PlayFabClientModels.java | 82 ++- .../main/java/com/playfab/PlayFabErrors.java | 10 +- .../java/com/playfab/PlayFabSettings.java | 6 +- .../java/com/playfab/test/PlayFabApiTest.java | 4 +- PlayFabClientSDK/pom.xml | 72 ++- PlayFabClientSDK/pom.xml.asc | 11 + .../java/com/playfab/PlayFabClientAPI.java | 550 +++++++++++++++++- .../java/com/playfab/PlayFabClientModels.java | 82 ++- .../main/java/com/playfab/PlayFabErrors.java | 10 +- .../java/com/playfab/PlayFabSettings.java | 6 +- .../java/com/playfab/test/PlayFabApiTest.java | 4 +- PlayFabSDK/pom.xml | 72 ++- .../java/com/playfab/PlayFabAdminAPI.java | 368 ++++++++++++ .../java/com/playfab/PlayFabAdminModels.java | 14 +- .../java/com/playfab/PlayFabClientAPI.java | 550 +++++++++++++++++- .../java/com/playfab/PlayFabClientModels.java | 82 ++- .../main/java/com/playfab/PlayFabErrors.java | 10 +- .../com/playfab/PlayFabMatchmakerAPI.java | 20 + .../com/playfab/PlayFabMatchmakerModels.java | 2 +- .../java/com/playfab/PlayFabServerAPI.java | 446 +++++++++++++- .../java/com/playfab/PlayFabServerModels.java | 28 +- .../java/com/playfab/PlayFabSettings.java | 6 +- .../java/com/playfab/test/PlayFabApiTest.java | 4 +- PlayFabServerSDK/pom.xml | 72 ++- .../java/com/playfab/PlayFabAdminAPI.java | 368 ++++++++++++ .../java/com/playfab/PlayFabAdminModels.java | 14 +- .../main/java/com/playfab/PlayFabErrors.java | 10 +- .../com/playfab/PlayFabMatchmakerAPI.java | 20 + .../com/playfab/PlayFabMatchmakerModels.java | 2 +- .../java/com/playfab/PlayFabServerAPI.java | 446 +++++++++++++- .../java/com/playfab/PlayFabServerModels.java | 28 +- .../java/com/playfab/PlayFabSettings.java | 6 +- 33 files changed, 3688 insertions(+), 267 deletions(-) create mode 100644 PlayFabClientSDK/pom.xml.asc diff --git a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientAPI.java b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientAPI.java index 398aa48a0..580d0f10b 100644 --- a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientAPI.java +++ b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientAPI.java @@ -19,6 +19,8 @@ public class PlayFabClientAPI { /** * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://api.playfab.com/docs/using-photon-with-playfab/ for more details. + * @param request GetPhotonAuthenticationTokenRequest + * @return Async Task will return GetPhotonAuthenticationTokenResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPhotonAuthenticationTokenAsync(final GetPhotonAuthenticationTokenRequest request) { @@ -31,6 +33,8 @@ public PlayFabResult call() throws Exception /** * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://api.playfab.com/docs/using-photon-with-playfab/ for more details. + * @param request GetPhotonAuthenticationTokenRequest + * @return GetPhotonAuthenticationTokenResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPhotonAuthenticationToken(final GetPhotonAuthenticationTokenRequest request) { @@ -77,6 +81,8 @@ private static PlayFabResult privateGetPhoto /** * Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate. + * @param request GetWindowsHelloChallengeRequest + * @return Async Task will return GetWindowsHelloChallengeResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetWindowsHelloChallengeAsync(final GetWindowsHelloChallengeRequest request) { @@ -89,6 +95,8 @@ public PlayFabResult call() throws Exception { /** * Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate. + * @param request GetWindowsHelloChallengeRequest + * @return GetWindowsHelloChallengeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetWindowsHelloChallenge(final GetWindowsHelloChallengeRequest request) { @@ -134,6 +142,8 @@ private static PlayFabResult privateGetWindows /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithAndroidDeviceIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithAndroidDeviceIDAsync(final LoginWithAndroidDeviceIDRequest request) { @@ -146,6 +156,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithAndroidDeviceIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithAndroidDeviceID(final LoginWithAndroidDeviceIDRequest request) { @@ -195,6 +207,8 @@ private static PlayFabResult privateLoginWithAndroidDeviceIDAsync(f /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithCustomIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithCustomIDAsync(final LoginWithCustomIDRequest request) { @@ -207,6 +221,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithCustomIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithCustomID(final LoginWithCustomIDRequest request) { @@ -256,6 +272,8 @@ private static PlayFabResult privateLoginWithCustomIDAsync(final Lo /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser. + * @param request LoginWithEmailAddressRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithEmailAddressAsync(final LoginWithEmailAddressRequest request) { @@ -268,6 +286,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser. + * @param request LoginWithEmailAddressRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithEmailAddress(final LoginWithEmailAddressRequest request) { @@ -317,6 +337,8 @@ private static PlayFabResult privateLoginWithEmailAddressAsync(fina /** * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithFacebookRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithFacebookAsync(final LoginWithFacebookRequest request) { @@ -329,6 +351,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithFacebookRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithFacebook(final LoginWithFacebookRequest request) { @@ -378,6 +402,8 @@ private static PlayFabResult privateLoginWithFacebookAsync(final Lo /** * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithGameCenterRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithGameCenterAsync(final LoginWithGameCenterRequest request) { @@ -390,6 +416,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithGameCenterRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithGameCenter(final LoginWithGameCenterRequest request) { @@ -439,6 +467,8 @@ private static PlayFabResult privateLoginWithGameCenterAsync(final /** * Signs the user in using their Google account credentials + * @param request LoginWithGoogleAccountRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithGoogleAccountAsync(final LoginWithGoogleAccountRequest request) { @@ -451,6 +481,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using their Google account credentials + * @param request LoginWithGoogleAccountRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithGoogleAccount(final LoginWithGoogleAccountRequest request) { @@ -500,6 +532,8 @@ private static PlayFabResult privateLoginWithGoogleAccountAsync(fin /** * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithIOSDeviceIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithIOSDeviceIDAsync(final LoginWithIOSDeviceIDRequest request) { @@ -512,6 +546,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithIOSDeviceIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithIOSDeviceID(final LoginWithIOSDeviceIDRequest request) { @@ -561,6 +597,8 @@ private static PlayFabResult privateLoginWithIOSDeviceIDAsync(final /** * Signs the user in using a Kongregate player account. + * @param request LoginWithKongregateRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithKongregateAsync(final LoginWithKongregateRequest request) { @@ -573,6 +611,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Kongregate player account. + * @param request LoginWithKongregateRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithKongregate(final LoginWithKongregateRequest request) { @@ -622,6 +662,8 @@ private static PlayFabResult privateLoginWithKongregateAsync(final /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword. + * @param request LoginWithPlayFabRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithPlayFabAsync(final LoginWithPlayFabRequest request) { @@ -634,6 +676,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword. + * @param request LoginWithPlayFabRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithPlayFab(final LoginWithPlayFabRequest request) { @@ -683,6 +727,8 @@ private static PlayFabResult privateLoginWithPlayFabAsync(final Log /** * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithSteamRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithSteamAsync(final LoginWithSteamRequest request) { @@ -695,6 +741,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithSteamRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithSteam(final LoginWithSteamRequest request) { @@ -744,6 +792,8 @@ private static PlayFabResult privateLoginWithSteamAsync(final Login /** * Signs the user in using a Twitch access token. + * @param request LoginWithTwitchRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithTwitchAsync(final LoginWithTwitchRequest request) { @@ -756,6 +806,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Twitch access token. + * @param request LoginWithTwitchRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithTwitch(final LoginWithTwitchRequest request) { @@ -804,7 +856,9 @@ private static PlayFabResult privateLoginWithTwitchAsync(final Logi } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * @param request LoginWithWindowsHelloRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithWindowsHelloAsync(final LoginWithWindowsHelloRequest request) { @@ -816,7 +870,9 @@ public PlayFabResult call() throws Exception { } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * @param request LoginWithWindowsHelloRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithWindowsHello(final LoginWithWindowsHelloRequest request) { @@ -834,7 +890,7 @@ public PlayFabResult call() throws Exception { } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. */ @SuppressWarnings("unchecked") private static PlayFabResult privateLoginWithWindowsHelloAsync(final LoginWithWindowsHelloRequest request) throws Exception { @@ -866,6 +922,8 @@ private static PlayFabResult privateLoginWithWindowsHelloAsync(fina /** * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address. + * @param request RegisterPlayFabUserRequest + * @return Async Task will return RegisterPlayFabUserResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterPlayFabUserAsync(final RegisterPlayFabUserRequest request) { @@ -878,6 +936,8 @@ public PlayFabResult call() throws Exception { /** * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address. + * @param request RegisterPlayFabUserRequest + * @return RegisterPlayFabUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterPlayFabUser(final RegisterPlayFabUserRequest request) { @@ -927,6 +987,8 @@ private static PlayFabResult privateRegisterPlayFabUs /** * Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user + * @param request RegisterWithWindowsHelloRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterWithWindowsHelloAsync(final RegisterWithWindowsHelloRequest request) { @@ -939,6 +1001,8 @@ public PlayFabResult call() throws Exception { /** * Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user + * @param request RegisterWithWindowsHelloRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterWithWindowsHello(final RegisterWithWindowsHelloRequest request) { @@ -988,6 +1052,8 @@ private static PlayFabResult privateRegisterWithWindowsHelloAsync(f /** * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players. + * @param request AddGenericIDRequest + * @return Async Task will return AddGenericIDResult */ @SuppressWarnings("unchecked") public static FutureTask> AddGenericIDAsync(final AddGenericIDRequest request) { @@ -1000,6 +1066,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players. + * @param request AddGenericIDRequest + * @return AddGenericIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddGenericID(final AddGenericIDRequest request) { @@ -1046,6 +1114,8 @@ private static PlayFabResult privateAddGenericIDAsync(final /** * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login. + * @param request AddUsernamePasswordRequest + * @return Async Task will return AddUsernamePasswordResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUsernamePasswordAsync(final AddUsernamePasswordRequest request) { @@ -1058,6 +1128,8 @@ public PlayFabResult call() throws Exception { /** * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login. + * @param request AddUsernamePasswordRequest + * @return AddUsernamePasswordResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUsernamePassword(final AddUsernamePasswordRequest request) { @@ -1104,6 +1176,8 @@ private static PlayFabResult privateAddUsernamePasswo /** * Retrieves the user's PlayFab account details + * @param request GetAccountInfoRequest + * @return Async Task will return GetAccountInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAccountInfoAsync(final GetAccountInfoRequest request) { @@ -1116,6 +1190,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the user's PlayFab account details + * @param request GetAccountInfoRequest + * @return GetAccountInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAccountInfo(final GetAccountInfoRequest request) { @@ -1162,6 +1238,8 @@ private static PlayFabResult privateGetAccountInfoAsync(fi /** * Retrieves all of the user's different kinds of info. + * @param request GetPlayerCombinedInfoRequest + * @return Async Task will return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerCombinedInfoAsync(final GetPlayerCombinedInfoRequest request) { @@ -1174,6 +1252,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves all of the user's different kinds of info. + * @param request GetPlayerCombinedInfoRequest + * @return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerCombinedInfo(final GetPlayerCombinedInfoRequest request) { @@ -1220,6 +1300,8 @@ private static PlayFabResult privateGetPlayerCombin /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return Async Task will return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromFacebookIDsAsync(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -1232,6 +1314,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromFacebookIDs(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -1278,6 +1362,8 @@ private static PlayFabResult privateGetPlayF /** * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier). + * @param request GetPlayFabIDsFromGameCenterIDsRequest + * @return Async Task will return GetPlayFabIDsFromGameCenterIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGameCenterIDsAsync(final GetPlayFabIDsFromGameCenterIDsRequest request) { @@ -1290,6 +1376,8 @@ public PlayFabResult call() throws Excepti /** * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier). + * @param request GetPlayFabIDsFromGameCenterIDsRequest + * @return GetPlayFabIDsFromGameCenterIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGameCenterIDs(final GetPlayFabIDsFromGameCenterIDsRequest request) { @@ -1336,6 +1424,8 @@ private static PlayFabResult privateGetPla /** * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account. + * @param request GetPlayFabIDsFromGenericIDsRequest + * @return Async Task will return GetPlayFabIDsFromGenericIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGenericIDsAsync(final GetPlayFabIDsFromGenericIDsRequest request) { @@ -1348,6 +1438,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account. + * @param request GetPlayFabIDsFromGenericIDsRequest + * @return GetPlayFabIDsFromGenericIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGenericIDs(final GetPlayFabIDsFromGenericIDsRequest request) { @@ -1394,6 +1486,8 @@ private static PlayFabResult privateGetPlayFa /** * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls. + * @param request GetPlayFabIDsFromGoogleIDsRequest + * @return Async Task will return GetPlayFabIDsFromGoogleIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGoogleIDsAsync(final GetPlayFabIDsFromGoogleIDsRequest request) { @@ -1406,6 +1500,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls. + * @param request GetPlayFabIDsFromGoogleIDsRequest + * @return GetPlayFabIDsFromGoogleIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGoogleIDs(final GetPlayFabIDsFromGoogleIDsRequest request) { @@ -1452,6 +1548,8 @@ private static PlayFabResult privateGetPlayFab /** * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId). + * @param request GetPlayFabIDsFromKongregateIDsRequest + * @return Async Task will return GetPlayFabIDsFromKongregateIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromKongregateIDsAsync(final GetPlayFabIDsFromKongregateIDsRequest request) { @@ -1464,6 +1562,8 @@ public PlayFabResult call() throws Excepti /** * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId). + * @param request GetPlayFabIDsFromKongregateIDsRequest + * @return GetPlayFabIDsFromKongregateIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromKongregateIDs(final GetPlayFabIDsFromKongregateIDsRequest request) { @@ -1510,6 +1610,8 @@ private static PlayFabResult privateGetPla /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return Async Task will return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromSteamIDsAsync(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -1522,6 +1624,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromSteamIDs(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -1568,6 +1672,8 @@ private static PlayFabResult privateGetPlayFabI /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser). + * @param request GetPlayFabIDsFromTwitchIDsRequest + * @return Async Task will return GetPlayFabIDsFromTwitchIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromTwitchIDsAsync(final GetPlayFabIDsFromTwitchIDsRequest request) { @@ -1580,6 +1686,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser). + * @param request GetPlayFabIDsFromTwitchIDsRequest + * @return GetPlayFabIDsFromTwitchIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromTwitchIDs(final GetPlayFabIDsFromTwitchIDsRequest request) { @@ -1626,6 +1734,8 @@ private static PlayFabResult privateGetPlayFab /** * Links the Android device identifier to the user's PlayFab account + * @param request LinkAndroidDeviceIDRequest + * @return Async Task will return LinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkAndroidDeviceIDAsync(final LinkAndroidDeviceIDRequest request) { @@ -1638,6 +1748,8 @@ public PlayFabResult call() throws Exception { /** * Links the Android device identifier to the user's PlayFab account + * @param request LinkAndroidDeviceIDRequest + * @return LinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkAndroidDeviceID(final LinkAndroidDeviceIDRequest request) { @@ -1684,6 +1796,8 @@ private static PlayFabResult privateLinkAndroidDevice /** * Links the custom identifier, generated by the title, to the user's PlayFab account + * @param request LinkCustomIDRequest + * @return Async Task will return LinkCustomIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkCustomIDAsync(final LinkCustomIDRequest request) { @@ -1696,6 +1810,8 @@ public PlayFabResult call() throws Exception { /** * Links the custom identifier, generated by the title, to the user's PlayFab account + * @param request LinkCustomIDRequest + * @return LinkCustomIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkCustomID(final LinkCustomIDRequest request) { @@ -1742,6 +1858,8 @@ private static PlayFabResult privateLinkCustomIDAsync(final /** * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account + * @param request LinkFacebookAccountRequest + * @return Async Task will return LinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkFacebookAccountAsync(final LinkFacebookAccountRequest request) { @@ -1754,6 +1872,8 @@ public PlayFabResult call() throws Exception { /** * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account + * @param request LinkFacebookAccountRequest + * @return LinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkFacebookAccount(final LinkFacebookAccountRequest request) { @@ -1800,6 +1920,8 @@ private static PlayFabResult privateLinkFacebookAccou /** * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account + * @param request LinkGameCenterAccountRequest + * @return Async Task will return LinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkGameCenterAccountAsync(final LinkGameCenterAccountRequest request) { @@ -1812,6 +1934,8 @@ public PlayFabResult call() throws Exception { /** * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account + * @param request LinkGameCenterAccountRequest + * @return LinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkGameCenterAccount(final LinkGameCenterAccountRequest request) { @@ -1858,6 +1982,8 @@ private static PlayFabResult privateLinkGameCenterA /** * Links the currently signed-in user account to their Google account, using their Google account credentials + * @param request LinkGoogleAccountRequest + * @return Async Task will return LinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkGoogleAccountAsync(final LinkGoogleAccountRequest request) { @@ -1870,6 +1996,8 @@ public PlayFabResult call() throws Exception { /** * Links the currently signed-in user account to their Google account, using their Google account credentials + * @param request LinkGoogleAccountRequest + * @return LinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkGoogleAccount(final LinkGoogleAccountRequest request) { @@ -1916,6 +2044,8 @@ private static PlayFabResult privateLinkGoogleAccountAs /** * Links the vendor-specific iOS device identifier to the user's PlayFab account + * @param request LinkIOSDeviceIDRequest + * @return Async Task will return LinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkIOSDeviceIDAsync(final LinkIOSDeviceIDRequest request) { @@ -1928,6 +2058,8 @@ public PlayFabResult call() throws Exception { /** * Links the vendor-specific iOS device identifier to the user's PlayFab account + * @param request LinkIOSDeviceIDRequest + * @return LinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkIOSDeviceID(final LinkIOSDeviceIDRequest request) { @@ -1974,6 +2106,8 @@ private static PlayFabResult privateLinkIOSDeviceIDAsync( /** * Links the Kongregate identifier to the user's PlayFab account + * @param request LinkKongregateAccountRequest + * @return Async Task will return LinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkKongregateAsync(final LinkKongregateAccountRequest request) { @@ -1986,6 +2120,8 @@ public PlayFabResult call() throws Exception { /** * Links the Kongregate identifier to the user's PlayFab account + * @param request LinkKongregateAccountRequest + * @return LinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkKongregate(final LinkKongregateAccountRequest request) { @@ -2032,6 +2168,8 @@ private static PlayFabResult privateLinkKongregateA /** * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account + * @param request LinkSteamAccountRequest + * @return Async Task will return LinkSteamAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkSteamAccountAsync(final LinkSteamAccountRequest request) { @@ -2044,6 +2182,8 @@ public PlayFabResult call() throws Exception { /** * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account + * @param request LinkSteamAccountRequest + * @return LinkSteamAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkSteamAccount(final LinkSteamAccountRequest request) { @@ -2090,6 +2230,8 @@ private static PlayFabResult privateLinkSteamAccountAsyn /** * Links the Twitch account associated with the token to the user's PlayFab account. + * @param request LinkTwitchAccountRequest + * @return Async Task will return LinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkTwitchAsync(final LinkTwitchAccountRequest request) { @@ -2102,6 +2244,8 @@ public PlayFabResult call() throws Exception { /** * Links the Twitch account associated with the token to the user's PlayFab account. + * @param request LinkTwitchAccountRequest + * @return LinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkTwitch(final LinkTwitchAccountRequest request) { @@ -2148,6 +2292,8 @@ private static PlayFabResult privateLinkTwitchAsync(fin /** * Link Windows Hello authentication to the current PlayFab Account + * @param request LinkWindowsHelloAccountRequest + * @return Async Task will return LinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static FutureTask> LinkWindowsHelloAsync(final LinkWindowsHelloAccountRequest request) { @@ -2160,6 +2306,8 @@ public PlayFabResult call() throws Exception { /** * Link Windows Hello authentication to the current PlayFab Account + * @param request LinkWindowsHelloAccountRequest + * @return LinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static PlayFabResult LinkWindowsHello(final LinkWindowsHelloAccountRequest request) { @@ -2205,6 +2353,8 @@ private static PlayFabResult privateLinkWindows /** * Removes the specified generic service identifier from the player's PlayFab account. + * @param request RemoveGenericIDRequest + * @return Async Task will return RemoveGenericIDResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveGenericIDAsync(final RemoveGenericIDRequest request) { @@ -2217,6 +2367,8 @@ public PlayFabResult call() throws Exception { /** * Removes the specified generic service identifier from the player's PlayFab account. + * @param request RemoveGenericIDRequest + * @return RemoveGenericIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveGenericID(final RemoveGenericIDRequest request) { @@ -2263,6 +2415,8 @@ private static PlayFabResult privateRemoveGenericIDAsync( /** * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerClientRequest + * @return Async Task will return ReportPlayerClientResult */ @SuppressWarnings("unchecked") public static FutureTask> ReportPlayerAsync(final ReportPlayerClientRequest request) { @@ -2275,6 +2429,8 @@ public PlayFabResult call() throws Exception { /** * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerClientRequest + * @return ReportPlayerClientResult */ @SuppressWarnings("unchecked") public static PlayFabResult ReportPlayer(final ReportPlayerClientRequest request) { @@ -2321,6 +2477,8 @@ private static PlayFabResult privateReportPlayerAsync( /** * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return Async Task will return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static FutureTask> SendAccountRecoveryEmailAsync(final SendAccountRecoveryEmailRequest request) { @@ -2333,6 +2491,8 @@ public PlayFabResult call() throws Exception { /** * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static PlayFabResult SendAccountRecoveryEmail(final SendAccountRecoveryEmailRequest request) { @@ -2378,6 +2538,8 @@ private static PlayFabResult privateSendAccountR /** * Unlinks the related Android device identifier from the user's PlayFab account + * @param request UnlinkAndroidDeviceIDRequest + * @return Async Task will return UnlinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkAndroidDeviceIDAsync(final UnlinkAndroidDeviceIDRequest request) { @@ -2390,6 +2552,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Android device identifier from the user's PlayFab account + * @param request UnlinkAndroidDeviceIDRequest + * @return UnlinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkAndroidDeviceID(final UnlinkAndroidDeviceIDRequest request) { @@ -2436,6 +2600,8 @@ private static PlayFabResult privateUnlinkAndroidDe /** * Unlinks the related custom identifier from the user's PlayFab account + * @param request UnlinkCustomIDRequest + * @return Async Task will return UnlinkCustomIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkCustomIDAsync(final UnlinkCustomIDRequest request) { @@ -2448,6 +2614,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related custom identifier from the user's PlayFab account + * @param request UnlinkCustomIDRequest + * @return UnlinkCustomIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkCustomID(final UnlinkCustomIDRequest request) { @@ -2494,6 +2662,8 @@ private static PlayFabResult privateUnlinkCustomIDAsync(fi /** * Unlinks the related Facebook account from the user's PlayFab account + * @param request UnlinkFacebookAccountRequest + * @return Async Task will return UnlinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkFacebookAccountAsync(final UnlinkFacebookAccountRequest request) { @@ -2506,6 +2676,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Facebook account from the user's PlayFab account + * @param request UnlinkFacebookAccountRequest + * @return UnlinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkFacebookAccount(final UnlinkFacebookAccountRequest request) { @@ -2552,6 +2724,8 @@ private static PlayFabResult privateUnlinkFacebookA /** * Unlinks the related Game Center account from the user's PlayFab account + * @param request UnlinkGameCenterAccountRequest + * @return Async Task will return UnlinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkGameCenterAccountAsync(final UnlinkGameCenterAccountRequest request) { @@ -2564,6 +2738,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Game Center account from the user's PlayFab account + * @param request UnlinkGameCenterAccountRequest + * @return UnlinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkGameCenterAccount(final UnlinkGameCenterAccountRequest request) { @@ -2610,6 +2786,8 @@ private static PlayFabResult privateUnlinkGameCen /** * Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods). + * @param request UnlinkGoogleAccountRequest + * @return Async Task will return UnlinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkGoogleAccountAsync(final UnlinkGoogleAccountRequest request) { @@ -2622,6 +2800,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods). + * @param request UnlinkGoogleAccountRequest + * @return UnlinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkGoogleAccount(final UnlinkGoogleAccountRequest request) { @@ -2668,6 +2848,8 @@ private static PlayFabResult privateUnlinkGoogleAccou /** * Unlinks the related iOS device identifier from the user's PlayFab account + * @param request UnlinkIOSDeviceIDRequest + * @return Async Task will return UnlinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkIOSDeviceIDAsync(final UnlinkIOSDeviceIDRequest request) { @@ -2680,6 +2862,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related iOS device identifier from the user's PlayFab account + * @param request UnlinkIOSDeviceIDRequest + * @return UnlinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkIOSDeviceID(final UnlinkIOSDeviceIDRequest request) { @@ -2726,6 +2910,8 @@ private static PlayFabResult privateUnlinkIOSDeviceIDAs /** * Unlinks the related Kongregate identifier from the user's PlayFab account + * @param request UnlinkKongregateAccountRequest + * @return Async Task will return UnlinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkKongregateAsync(final UnlinkKongregateAccountRequest request) { @@ -2738,6 +2924,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Kongregate identifier from the user's PlayFab account + * @param request UnlinkKongregateAccountRequest + * @return UnlinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkKongregate(final UnlinkKongregateAccountRequest request) { @@ -2784,6 +2972,8 @@ private static PlayFabResult privateUnlinkKongreg /** * Unlinks the related Steam account from the user's PlayFab account + * @param request UnlinkSteamAccountRequest + * @return Async Task will return UnlinkSteamAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkSteamAccountAsync(final UnlinkSteamAccountRequest request) { @@ -2796,6 +2986,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Steam account from the user's PlayFab account + * @param request UnlinkSteamAccountRequest + * @return UnlinkSteamAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkSteamAccount(final UnlinkSteamAccountRequest request) { @@ -2842,6 +3034,8 @@ private static PlayFabResult privateUnlinkSteamAccount /** * Unlinks the related Twitch account from the user's PlayFab account. + * @param request UnlinkTwitchAccountRequest + * @return Async Task will return UnlinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkTwitchAsync(final UnlinkTwitchAccountRequest request) { @@ -2854,6 +3048,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Twitch account from the user's PlayFab account. + * @param request UnlinkTwitchAccountRequest + * @return UnlinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkTwitch(final UnlinkTwitchAccountRequest request) { @@ -2900,6 +3096,8 @@ private static PlayFabResult privateUnlinkTwitchAsync /** * Unlink Windows Hello authentication from the current PlayFab Account + * @param request UnlinkWindowsHelloAccountRequest + * @return Async Task will return UnlinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkWindowsHelloAsync(final UnlinkWindowsHelloAccountRequest request) { @@ -2912,6 +3110,8 @@ public PlayFabResult call() throws Exception /** * Unlink Windows Hello authentication from the current PlayFab Account + * @param request UnlinkWindowsHelloAccountRequest + * @return UnlinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkWindowsHello(final UnlinkWindowsHelloAccountRequest request) { @@ -2957,6 +3157,8 @@ private static PlayFabResult privateUnlinkWin /** * Update the avatar URL of the player + * @param request UpdateAvatarUrlRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateAvatarUrlAsync(final UpdateAvatarUrlRequest request) { @@ -2969,6 +3171,8 @@ public PlayFabResult call() throws Exception { /** * Update the avatar URL of the player + * @param request UpdateAvatarUrlRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateAvatarUrl(final UpdateAvatarUrlRequest request) { @@ -3015,6 +3219,8 @@ private static PlayFabResult privateUpdateAvatarUrlAsync(final Upda /** * Updates the title specific display name for the user + * @param request UpdateUserTitleDisplayNameRequest + * @return Async Task will return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserTitleDisplayNameAsync(final UpdateUserTitleDisplayNameRequest request) { @@ -3027,6 +3233,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title specific display name for the user + * @param request UpdateUserTitleDisplayNameRequest + * @return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserTitleDisplayName(final UpdateUserTitleDisplayNameRequest request) { @@ -3073,6 +3281,8 @@ private static PlayFabResult privateUpdateUser /** * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAsync(final GetFriendLeaderboardRequest request) { @@ -3085,6 +3295,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboard(final GetFriendLeaderboardRequest request) { @@ -3131,6 +3343,8 @@ private static PlayFabResult privateGetFriendLeaderboardAs /** * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user. + * @param request GetFriendLeaderboardAroundPlayerRequest + * @return Async Task will return GetFriendLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAroundPlayerAsync(final GetFriendLeaderboardAroundPlayerRequest request) { @@ -3143,6 +3357,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user. + * @param request GetFriendLeaderboardAroundPlayerRequest + * @return GetFriendLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboardAroundPlayer(final GetFriendLeaderboardAroundPlayerRequest request) { @@ -3189,6 +3405,8 @@ private static PlayFabResult privateGetF /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAsync(final GetLeaderboardRequest request) { @@ -3201,6 +3419,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboard(final GetLeaderboardRequest request) { @@ -3247,6 +3467,8 @@ private static PlayFabResult privateGetLeaderboardAsync(fi /** * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user. + * @param request GetLeaderboardAroundPlayerRequest + * @return Async Task will return GetLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundPlayerAsync(final GetLeaderboardAroundPlayerRequest request) { @@ -3259,6 +3481,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user. + * @param request GetLeaderboardAroundPlayerRequest + * @return GetLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundPlayer(final GetLeaderboardAroundPlayerRequest request) { @@ -3305,6 +3529,8 @@ private static PlayFabResult privateGetLeaderb /** * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player. + * @param request GetPlayerStatisticsRequest + * @return Async Task will return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticsAsync(final GetPlayerStatisticsRequest request) { @@ -3317,6 +3543,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player. + * @param request GetPlayerStatisticsRequest + * @return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatistics(final GetPlayerStatisticsRequest request) { @@ -3363,6 +3591,8 @@ private static PlayFabResult privateGetPlayerStatisti /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return Async Task will return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticVersionsAsync(final GetPlayerStatisticVersionsRequest request) { @@ -3375,6 +3605,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticVersions(final GetPlayerStatisticVersionsRequest request) { @@ -3421,6 +3653,8 @@ private static PlayFabResult privateGetPlayerS /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserDataAsync(final GetUserDataRequest request) { @@ -3433,6 +3667,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserData(final GetUserDataRequest request) { @@ -3479,6 +3715,8 @@ private static PlayFabResult privateGetUserDataAsync(final Ge /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherDataAsync(final GetUserDataRequest request) { @@ -3491,6 +3729,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherData(final GetUserDataRequest request) { @@ -3537,6 +3777,8 @@ private static PlayFabResult privateGetUserPublisherDataAsync /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherReadOnlyDataAsync(final GetUserDataRequest request) { @@ -3549,6 +3791,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherReadOnlyData(final GetUserDataRequest request) { @@ -3595,6 +3839,8 @@ private static PlayFabResult privateGetUserPublisherReadOnlyD /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserReadOnlyDataAsync(final GetUserDataRequest request) { @@ -3607,6 +3853,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserReadOnlyData(final GetUserDataRequest request) { @@ -3652,7 +3900,9 @@ private static PlayFabResult privateGetUserReadOnlyDataAsync( } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdatePlayerStatisticsRequest + * @return Async Task will return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) { @@ -3664,7 +3914,9 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdatePlayerStatisticsRequest + * @return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePlayerStatistics(final UpdatePlayerStatisticsRequest request) { @@ -3682,7 +3934,7 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) throws Exception { @@ -3711,6 +3963,8 @@ private static PlayFabResult privateUpdatePlayerSt /** * Creates and updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserDataAsync(final UpdateUserDataRequest request) { @@ -3723,6 +3977,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserData(final UpdateUserDataRequest request) { @@ -3769,6 +4025,8 @@ private static PlayFabResult privateUpdateUserDataAsync(fi /** * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherDataAsync(final UpdateUserDataRequest request) { @@ -3781,6 +4039,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherData(final UpdateUserDataRequest request) { @@ -3827,6 +4087,8 @@ private static PlayFabResult privateUpdateUserPublisherDat /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return Async Task will return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCatalogItemsAsync(final GetCatalogItemsRequest request) { @@ -3839,6 +4101,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCatalogItems(final GetCatalogItemsRequest request) { @@ -3885,6 +4149,8 @@ private static PlayFabResult privateGetCatalogItemsAsync( /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return Async Task will return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPublisherDataAsync(final GetPublisherDataRequest request) { @@ -3897,6 +4163,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPublisherData(final GetPublisherDataRequest request) { @@ -3943,6 +4211,8 @@ private static PlayFabResult privateGetPublisherDataAsyn /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return Async Task will return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetStoreItemsAsync(final GetStoreItemsRequest request) { @@ -3955,6 +4225,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetStoreItems(final GetStoreItemsRequest request) { @@ -4001,6 +4273,8 @@ private static PlayFabResult privateGetStoreItemsAsync(fina /** * Retrieves the current server time + * @param request GetTimeRequest + * @return Async Task will return GetTimeResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTimeAsync(final GetTimeRequest request) { @@ -4013,6 +4287,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current server time + * @param request GetTimeRequest + * @return GetTimeResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTime(final GetTimeRequest request) { @@ -4059,6 +4335,8 @@ private static PlayFabResult privateGetTimeAsync(final GetTimeReq /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleDataAsync(final GetTitleDataRequest request) { @@ -4071,6 +4349,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleData(final GetTitleDataRequest request) { @@ -4117,6 +4397,8 @@ private static PlayFabResult privateGetTitleDataAsync(final /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return Async Task will return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleNewsAsync(final GetTitleNewsRequest request) { @@ -4129,6 +4411,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleNews(final GetTitleNewsRequest request) { @@ -4175,6 +4459,8 @@ private static PlayFabResult privateGetTitleNewsAsync(final /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUserVirtualCurrencyAsync(final AddUserVirtualCurrencyRequest request) { @@ -4187,6 +4473,8 @@ public PlayFabResult call() throws Exception { /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUserVirtualCurrency(final AddUserVirtualCurrencyRequest request) { @@ -4233,6 +4521,8 @@ private static PlayFabResult privateAddUserVirt /** * Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate + * @param request ConfirmPurchaseRequest + * @return Async Task will return ConfirmPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> ConfirmPurchaseAsync(final ConfirmPurchaseRequest request) { @@ -4245,6 +4535,8 @@ public PlayFabResult call() throws Exception { /** * Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate + * @param request ConfirmPurchaseRequest + * @return ConfirmPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConfirmPurchase(final ConfirmPurchaseRequest request) { @@ -4291,6 +4583,8 @@ private static PlayFabResult privateConfirmPurchaseAsync( /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return Async Task will return ConsumeItemResult */ @SuppressWarnings("unchecked") public static FutureTask> ConsumeItemAsync(final ConsumeItemRequest request) { @@ -4303,6 +4597,8 @@ public PlayFabResult call() throws Exception { /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return ConsumeItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConsumeItem(final ConsumeItemRequest request) { @@ -4349,6 +4645,8 @@ private static PlayFabResult privateConsumeItemAsync(final Co /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return Async Task will return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterInventoryAsync(final GetCharacterInventoryRequest request) { @@ -4361,6 +4659,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterInventory(final GetCharacterInventoryRequest request) { @@ -4407,6 +4707,8 @@ private static PlayFabResult privateGetCharacterInv /** * Retrieves a purchase along with its current PlayFab status. + * @param request GetPurchaseRequest + * @return Async Task will return GetPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPurchaseAsync(final GetPurchaseRequest request) { @@ -4419,6 +4721,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a purchase along with its current PlayFab status. + * @param request GetPurchaseRequest + * @return GetPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPurchase(final GetPurchaseRequest request) { @@ -4465,6 +4769,8 @@ private static PlayFabResult privateGetPurchaseAsync(final Ge /** * Retrieves the user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return Async Task will return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInventoryAsync(final GetUserInventoryRequest request) { @@ -4477,6 +4783,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInventory(final GetUserInventoryRequest request) { @@ -4523,6 +4831,8 @@ private static PlayFabResult privateGetUserInventoryAsyn /** * Selects a payment option for purchase order created via StartPurchase + * @param request PayForPurchaseRequest + * @return Async Task will return PayForPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> PayForPurchaseAsync(final PayForPurchaseRequest request) { @@ -4535,6 +4845,8 @@ public PlayFabResult call() throws Exception { /** * Selects a payment option for purchase order created via StartPurchase + * @param request PayForPurchaseRequest + * @return PayForPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult PayForPurchase(final PayForPurchaseRequest request) { @@ -4581,6 +4893,8 @@ private static PlayFabResult privatePayForPurchaseAsync(fi /** * Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed. + * @param request PurchaseItemRequest + * @return Async Task will return PurchaseItemResult */ @SuppressWarnings("unchecked") public static FutureTask> PurchaseItemAsync(final PurchaseItemRequest request) { @@ -4593,6 +4907,8 @@ public PlayFabResult call() throws Exception { /** * Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed. + * @param request PurchaseItemRequest + * @return PurchaseItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult PurchaseItem(final PurchaseItemRequest request) { @@ -4638,7 +4954,9 @@ private static PlayFabResult privatePurchaseItemAsync(final } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return Async Task will return RedeemCouponResult */ @SuppressWarnings("unchecked") public static FutureTask> RedeemCouponAsync(final RedeemCouponRequest request) { @@ -4650,7 +4968,9 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return RedeemCouponResult */ @SuppressWarnings("unchecked") public static PlayFabResult RedeemCoupon(final RedeemCouponRequest request) { @@ -4668,7 +4988,7 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. */ @SuppressWarnings("unchecked") private static PlayFabResult privateRedeemCouponAsync(final RedeemCouponRequest request) throws Exception { @@ -4697,6 +5017,8 @@ private static PlayFabResult privateRedeemCouponAsync(final /** * Creates an order for a list of items from the title catalog + * @param request StartPurchaseRequest + * @return Async Task will return StartPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> StartPurchaseAsync(final StartPurchaseRequest request) { @@ -4709,6 +5031,8 @@ public PlayFabResult call() throws Exception { /** * Creates an order for a list of items from the title catalog + * @param request StartPurchaseRequest + * @return StartPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult StartPurchase(final StartPurchaseRequest request) { @@ -4755,6 +5079,8 @@ private static PlayFabResult privateStartPurchaseAsync(fina /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractUserVirtualCurrencyAsync(final SubtractUserVirtualCurrencyRequest request) { @@ -4767,6 +5093,8 @@ public PlayFabResult call() throws Exception { /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractUserVirtualCurrency(final SubtractUserVirtualCurrencyRequest request) { @@ -4812,7 +5140,9 @@ private static PlayFabResult privateSubtractUse } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) { @@ -4824,7 +5154,9 @@ public PlayFabResult call() throws Exception { } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerInstance(final UnlockContainerInstanceRequest request) { @@ -4842,7 +5174,7 @@ public PlayFabResult call() throws Exception { } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) throws Exception { @@ -4870,7 +5202,9 @@ private static PlayFabResult privateUnlockContainerIn } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerItemAsync(final UnlockContainerItemRequest request) { @@ -4882,7 +5216,9 @@ public PlayFabResult call() throws Exception { } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerItem(final UnlockContainerItemRequest request) { @@ -4900,7 +5236,7 @@ public PlayFabResult call() throws Exception { } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerItemAsync(final UnlockContainerItemRequest request) throws Exception { @@ -4929,6 +5265,8 @@ private static PlayFabResult privateUnlockContainerIt /** * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return Async Task will return AddFriendResult */ @SuppressWarnings("unchecked") public static FutureTask> AddFriendAsync(final AddFriendRequest request) { @@ -4941,6 +5279,8 @@ public PlayFabResult call() throws Exception { /** * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return AddFriendResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddFriend(final AddFriendRequest request) { @@ -4987,6 +5327,8 @@ private static PlayFabResult privateAddFriendAsync(final AddFri /** * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return Async Task will return GetFriendsListResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendsListAsync(final GetFriendsListRequest request) { @@ -4999,6 +5341,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return GetFriendsListResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendsList(final GetFriendsListRequest request) { @@ -5045,6 +5389,8 @@ private static PlayFabResult privateGetFriendsListAsync(fi /** * Removes a specified user from the friend list of the local user + * @param request RemoveFriendRequest + * @return Async Task will return RemoveFriendResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveFriendAsync(final RemoveFriendRequest request) { @@ -5057,6 +5403,8 @@ public PlayFabResult call() throws Exception { /** * Removes a specified user from the friend list of the local user + * @param request RemoveFriendRequest + * @return RemoveFriendResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveFriend(final RemoveFriendRequest request) { @@ -5103,6 +5451,8 @@ private static PlayFabResult privateRemoveFriendAsync(final /** * Updates the tag list for a specified user in the friend list of the local user + * @param request SetFriendTagsRequest + * @return Async Task will return SetFriendTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetFriendTagsAsync(final SetFriendTagsRequest request) { @@ -5115,6 +5465,8 @@ public PlayFabResult call() throws Exception { /** * Updates the tag list for a specified user in the friend list of the local user + * @param request SetFriendTagsRequest + * @return SetFriendTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetFriendTags(final SetFriendTagsRequest request) { @@ -5161,6 +5513,8 @@ private static PlayFabResult privateSetFriendTagsAsync(fina /** * Registers the iOS device to receive push notifications + * @param request RegisterForIOSPushNotificationRequest + * @return Async Task will return RegisterForIOSPushNotificationResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterForIOSPushNotificationAsync(final RegisterForIOSPushNotificationRequest request) { @@ -5173,6 +5527,8 @@ public PlayFabResult call() throws Excepti /** * Registers the iOS device to receive push notifications + * @param request RegisterForIOSPushNotificationRequest + * @return RegisterForIOSPushNotificationResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterForIOSPushNotification(final RegisterForIOSPushNotificationRequest request) { @@ -5219,6 +5575,8 @@ private static PlayFabResult privateRegist /** * Restores all in-app purchases based on the given restore receipt + * @param request RestoreIOSPurchasesRequest + * @return Async Task will return RestoreIOSPurchasesResult */ @SuppressWarnings("unchecked") public static FutureTask> RestoreIOSPurchasesAsync(final RestoreIOSPurchasesRequest request) { @@ -5231,6 +5589,8 @@ public PlayFabResult call() throws Exception { /** * Restores all in-app purchases based on the given restore receipt + * @param request RestoreIOSPurchasesRequest + * @return RestoreIOSPurchasesResult */ @SuppressWarnings("unchecked") public static PlayFabResult RestoreIOSPurchases(final RestoreIOSPurchasesRequest request) { @@ -5277,6 +5637,8 @@ private static PlayFabResult privateRestoreIOSPurchas /** * Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateIOSReceiptRequest + * @return Async Task will return ValidateIOSReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateIOSReceiptAsync(final ValidateIOSReceiptRequest request) { @@ -5289,6 +5651,8 @@ public PlayFabResult call() throws Exception { /** * Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateIOSReceiptRequest + * @return ValidateIOSReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateIOSReceipt(final ValidateIOSReceiptRequest request) { @@ -5335,6 +5699,8 @@ private static PlayFabResult privateValidateIOSReceipt /** * Get details about all current running game servers matching the given parameters. + * @param request CurrentGamesRequest + * @return Async Task will return CurrentGamesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCurrentGamesAsync(final CurrentGamesRequest request) { @@ -5347,6 +5713,8 @@ public PlayFabResult call() throws Exception { /** * Get details about all current running game servers matching the given parameters. + * @param request CurrentGamesRequest + * @return CurrentGamesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCurrentGames(final CurrentGamesRequest request) { @@ -5392,7 +5760,9 @@ private static PlayFabResult privateGetCurrentGamesAsync(fin } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. + * @param request GameServerRegionsRequest + * @return Async Task will return GameServerRegionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetGameServerRegionsAsync(final GameServerRegionsRequest request) { @@ -5404,7 +5774,9 @@ public PlayFabResult call() throws Exception { } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. + * @param request GameServerRegionsRequest + * @return GameServerRegionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetGameServerRegions(final GameServerRegionsRequest request) { @@ -5422,7 +5794,7 @@ public PlayFabResult call() throws Exception { } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. */ @SuppressWarnings("unchecked") private static PlayFabResult privateGetGameServerRegionsAsync(final GameServerRegionsRequest request) throws Exception { @@ -5451,6 +5823,8 @@ private static PlayFabResult privateGetGameServerRegion /** * 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. + * @param request MatchmakeRequest + * @return Async Task will return MatchmakeResult */ @SuppressWarnings("unchecked") public static FutureTask> MatchmakeAsync(final MatchmakeRequest request) { @@ -5463,6 +5837,8 @@ public PlayFabResult call() throws Exception { /** * 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. + * @param request MatchmakeRequest + * @return MatchmakeResult */ @SuppressWarnings("unchecked") public static PlayFabResult Matchmake(final MatchmakeRequest request) { @@ -5509,6 +5885,8 @@ private static PlayFabResult privateMatchmakeAsync(final Matchm /** * Start a new game server with a given configuration, add the current player and return the connection information. + * @param request StartGameRequest + * @return Async Task will return StartGameResult */ @SuppressWarnings("unchecked") public static FutureTask> StartGameAsync(final StartGameRequest request) { @@ -5521,6 +5899,8 @@ public PlayFabResult call() throws Exception { /** * Start a new game server with a given configuration, add the current player and return the connection information. + * @param request StartGameRequest + * @return StartGameResult */ @SuppressWarnings("unchecked") public static PlayFabResult StartGame(final StartGameRequest request) { @@ -5567,6 +5947,8 @@ private static PlayFabResult privateStartGameAsync(final StartG /** * Registers the Android device to receive push notifications + * @param request AndroidDevicePushNotificationRegistrationRequest + * @return Async Task will return AndroidDevicePushNotificationRegistrationResult */ @SuppressWarnings("unchecked") public static FutureTask> AndroidDevicePushNotificationRegistrationAsync(final AndroidDevicePushNotificationRegistrationRequest request) { @@ -5579,6 +5961,8 @@ public PlayFabResult call() thr /** * Registers the Android device to receive push notifications + * @param request AndroidDevicePushNotificationRegistrationRequest + * @return AndroidDevicePushNotificationRegistrationResult */ @SuppressWarnings("unchecked") public static PlayFabResult AndroidDevicePushNotificationRegistration(final AndroidDevicePushNotificationRegistrationRequest request) { @@ -5625,6 +6009,8 @@ private static PlayFabResult pr /** * Validates a Google Play purchase and gives the corresponding item to the player. + * @param request ValidateGooglePlayPurchaseRequest + * @return Async Task will return ValidateGooglePlayPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateGooglePlayPurchaseAsync(final ValidateGooglePlayPurchaseRequest request) { @@ -5637,6 +6023,8 @@ public PlayFabResult call() throws Exception { /** * Validates a Google Play purchase and gives the corresponding item to the player. + * @param request ValidateGooglePlayPurchaseRequest + * @return ValidateGooglePlayPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateGooglePlayPurchase(final ValidateGooglePlayPurchaseRequest request) { @@ -5683,6 +6071,8 @@ private static PlayFabResult privateValidateGo /** * Writes a character-based event into PlayStream. + * @param request WriteClientCharacterEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteCharacterEventAsync(final WriteClientCharacterEventRequest request) { @@ -5695,6 +6085,8 @@ public PlayFabResult call() throws Exception { /** * Writes a character-based event into PlayStream. + * @param request WriteClientCharacterEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteCharacterEvent(final WriteClientCharacterEventRequest request) { @@ -5741,6 +6133,8 @@ private static PlayFabResult privateWriteCharacterEventAsync /** * Writes a player-based event into PlayStream. + * @param request WriteClientPlayerEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WritePlayerEventAsync(final WriteClientPlayerEventRequest request) { @@ -5753,6 +6147,8 @@ public PlayFabResult call() throws Exception { /** * Writes a player-based event into PlayStream. + * @param request WriteClientPlayerEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WritePlayerEvent(final WriteClientPlayerEventRequest request) { @@ -5799,6 +6195,8 @@ private static PlayFabResult privateWritePlayerEventAsync(fi /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteTitleEventAsync(final WriteTitleEventRequest request) { @@ -5811,6 +6209,8 @@ public PlayFabResult call() throws Exception { /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteTitleEvent(final WriteTitleEventRequest request) { @@ -5857,6 +6257,8 @@ private static PlayFabResult privateWriteTitleEventAsync(fin /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. + * @param request AddSharedGroupMembersRequest + * @return Async Task will return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> AddSharedGroupMembersAsync(final AddSharedGroupMembersRequest request) { @@ -5869,6 +6271,8 @@ public PlayFabResult call() throws Exception { /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. + * @param request AddSharedGroupMembersRequest + * @return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddSharedGroupMembers(final AddSharedGroupMembersRequest request) { @@ -5915,6 +6319,8 @@ private static PlayFabResult privateAddSharedGroupM /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. + * @param request CreateSharedGroupRequest + * @return Async Task will return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateSharedGroupAsync(final CreateSharedGroupRequest request) { @@ -5927,6 +6333,8 @@ public PlayFabResult call() throws Exception { /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. + * @param request CreateSharedGroupRequest + * @return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateSharedGroup(final CreateSharedGroupRequest request) { @@ -5973,6 +6381,8 @@ private static PlayFabResult privateCreateSharedGroupAs /** * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. + * @param request GetSharedGroupDataRequest + * @return Async Task will return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetSharedGroupDataAsync(final GetSharedGroupDataRequest request) { @@ -5985,6 +6395,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. + * @param request GetSharedGroupDataRequest + * @return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetSharedGroupData(final GetSharedGroupDataRequest request) { @@ -6031,6 +6443,8 @@ private static PlayFabResult privateGetSharedGroupData /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return Async Task will return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveSharedGroupMembersAsync(final RemoveSharedGroupMembersRequest request) { @@ -6043,6 +6457,8 @@ public PlayFabResult call() throws Exception { /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveSharedGroupMembers(final RemoveSharedGroupMembersRequest request) { @@ -6089,6 +6505,8 @@ private static PlayFabResult privateRemoveShared /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. + * @param request UpdateSharedGroupDataRequest + * @return Async Task will return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateSharedGroupDataAsync(final UpdateSharedGroupDataRequest request) { @@ -6101,6 +6519,8 @@ public PlayFabResult call() throws Exception { /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. + * @param request UpdateSharedGroupDataRequest + * @return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateSharedGroupData(final UpdateSharedGroupDataRequest request) { @@ -6147,6 +6567,8 @@ private static PlayFabResult privateUpdateSharedGro /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. + * @param request ExecuteCloudScriptRequest + * @return Async Task will return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static FutureTask> ExecuteCloudScriptAsync(final ExecuteCloudScriptRequest request) { @@ -6159,6 +6581,8 @@ public PlayFabResult call() throws Exception { /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. + * @param request ExecuteCloudScriptRequest + * @return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ExecuteCloudScript(final ExecuteCloudScriptRequest request) { @@ -6205,6 +6629,8 @@ private static PlayFabResult privateExecuteCloudScript /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return Async Task will return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentDownloadUrlAsync(final GetContentDownloadUrlRequest request) { @@ -6217,6 +6643,8 @@ public PlayFabResult call() throws Exception { /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentDownloadUrl(final GetContentDownloadUrlRequest request) { @@ -6263,6 +6691,8 @@ private static PlayFabResult privateGetContentDownl /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return Async Task will return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllUsersCharactersAsync(final ListUsersCharactersRequest request) { @@ -6275,6 +6705,8 @@ public PlayFabResult call() throws Exception { /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllUsersCharacters(final ListUsersCharactersRequest request) { @@ -6321,6 +6753,8 @@ private static PlayFabResult privateGetAllUsersCharac /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return Async Task will return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterLeaderboardAsync(final GetCharacterLeaderboardRequest request) { @@ -6333,6 +6767,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterLeaderboard(final GetCharacterLeaderboardRequest request) { @@ -6379,6 +6815,8 @@ private static PlayFabResult privateGetCharacterL /** * Retrieves the details of all title-specific statistics for the user + * @param request GetCharacterStatisticsRequest + * @return Async Task will return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterStatisticsAsync(final GetCharacterStatisticsRequest request) { @@ -6391,6 +6829,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details of all title-specific statistics for the user + * @param request GetCharacterStatisticsRequest + * @return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterStatistics(final GetCharacterStatisticsRequest request) { @@ -6437,6 +6877,8 @@ private static PlayFabResult privateGetCharacterSt /** * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID + * @param request GetLeaderboardAroundCharacterRequest + * @return Async Task will return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundCharacterAsync(final GetLeaderboardAroundCharacterRequest request) { @@ -6449,6 +6891,8 @@ public PlayFabResult call() throws Exceptio /** * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID + * @param request GetLeaderboardAroundCharacterRequest + * @return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundCharacter(final GetLeaderboardAroundCharacterRequest request) { @@ -6495,6 +6939,8 @@ private static PlayFabResult privateGetLead /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return Async Task will return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardForUserCharactersAsync(final GetLeaderboardForUsersCharactersRequest request) { @@ -6507,6 +6953,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardForUserCharacters(final GetLeaderboardForUsersCharactersRequest request) { @@ -6553,6 +7001,8 @@ private static PlayFabResult privateGetL /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return Async Task will return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantCharacterToUserAsync(final GrantCharacterToUserRequest request) { @@ -6565,6 +7015,8 @@ public PlayFabResult call() throws Exception { /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantCharacterToUser(final GrantCharacterToUserRequest request) { @@ -6610,7 +7062,9 @@ private static PlayFabResult privateGrantCharacterTo } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdateCharacterStatisticsRequest + * @return Async Task will return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) { @@ -6622,7 +7076,9 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdateCharacterStatisticsRequest + * @return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterStatistics(final UpdateCharacterStatisticsRequest request) { @@ -6640,7 +7096,7 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) throws Exception { @@ -6669,6 +7125,8 @@ private static PlayFabResult privateUpdateChara /** * Retrieves the title-specific custom data for the character which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterDataAsync(final GetCharacterDataRequest request) { @@ -6681,6 +7139,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the character which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterData(final GetCharacterDataRequest request) { @@ -6727,6 +7187,8 @@ private static PlayFabResult privateGetCharacterDataAsyn /** * Retrieves the title-specific custom data for the character which can only be read by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterReadOnlyDataAsync(final GetCharacterDataRequest request) { @@ -6739,6 +7201,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the character which can only be read by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterReadOnlyData(final GetCharacterDataRequest request) { @@ -6785,6 +7249,8 @@ private static PlayFabResult privateGetCharacterReadOnly /** * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterDataAsync(final UpdateCharacterDataRequest request) { @@ -6797,6 +7263,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterData(final UpdateCharacterDataRequest request) { @@ -6843,6 +7311,8 @@ private static PlayFabResult privateUpdateCharacterDa /** * Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateAmazonReceiptRequest + * @return Async Task will return ValidateAmazonReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateAmazonIAPReceiptAsync(final ValidateAmazonReceiptRequest request) { @@ -6855,6 +7325,8 @@ public PlayFabResult call() throws Exception { /** * Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateAmazonReceiptRequest + * @return ValidateAmazonReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateAmazonIAPReceipt(final ValidateAmazonReceiptRequest request) { @@ -6901,6 +7373,8 @@ private static PlayFabResult privateValidateAmazonI /** * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories. + * @param request AcceptTradeRequest + * @return Async Task will return AcceptTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> AcceptTradeAsync(final AcceptTradeRequest request) { @@ -6913,6 +7387,8 @@ public PlayFabResult call() throws Exception { /** * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories. + * @param request AcceptTradeRequest + * @return AcceptTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult AcceptTrade(final AcceptTradeRequest request) { @@ -6959,6 +7435,8 @@ private static PlayFabResult privateAcceptTradeAsync(final /** * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player). + * @param request CancelTradeRequest + * @return Async Task will return CancelTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> CancelTradeAsync(final CancelTradeRequest request) { @@ -6971,6 +7449,8 @@ public PlayFabResult call() throws Exception { /** * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player). + * @param request CancelTradeRequest + * @return CancelTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult CancelTrade(final CancelTradeRequest request) { @@ -7017,6 +7497,8 @@ private static PlayFabResult privateCancelTradeAsync(final /** * Gets all trades the player has either opened or accepted, optionally filtered by trade status. + * @param request GetPlayerTradesRequest + * @return Async Task will return GetPlayerTradesResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTradesAsync(final GetPlayerTradesRequest request) { @@ -7029,6 +7511,8 @@ public PlayFabResult call() throws Exception { /** * Gets all trades the player has either opened or accepted, optionally filtered by trade status. + * @param request GetPlayerTradesRequest + * @return GetPlayerTradesResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTrades(final GetPlayerTradesRequest request) { @@ -7075,6 +7559,8 @@ private static PlayFabResult privateGetPlayerTradesAsyn /** * Gets the current status of an existing trade. + * @param request GetTradeStatusRequest + * @return Async Task will return GetTradeStatusResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetTradeStatusAsync(final GetTradeStatusRequest request) { @@ -7087,6 +7573,8 @@ public PlayFabResult call() throws Exception { /** * Gets the current status of an existing trade. + * @param request GetTradeStatusRequest + * @return GetTradeStatusResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetTradeStatus(final GetTradeStatusRequest request) { @@ -7133,6 +7621,8 @@ private static PlayFabResult privateGetTradeStatusAsync( /** * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time. + * @param request OpenTradeRequest + * @return Async Task will return OpenTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> OpenTradeAsync(final OpenTradeRequest request) { @@ -7145,6 +7635,8 @@ public PlayFabResult call() throws Exception { /** * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time. + * @param request OpenTradeRequest + * @return OpenTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult OpenTrade(final OpenTradeRequest request) { @@ -7191,6 +7683,8 @@ private static PlayFabResult privateOpenTradeAsync(final Open /** * Attributes an install for advertisment. + * @param request AttributeInstallRequest + * @return Async Task will return AttributeInstallResult */ @SuppressWarnings("unchecked") public static FutureTask> AttributeInstallAsync(final AttributeInstallRequest request) { @@ -7203,6 +7697,8 @@ public PlayFabResult call() throws Exception { /** * Attributes an install for advertisment. + * @param request AttributeInstallRequest + * @return AttributeInstallResult */ @SuppressWarnings("unchecked") public static PlayFabResult AttributeInstall(final AttributeInstallRequest request) { @@ -7251,6 +7747,8 @@ private static PlayFabResult privateAttributeInstallAsyn /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayerSegmentsRequest + * @return Async Task will return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerSegmentsAsync(final GetPlayerSegmentsRequest request) { @@ -7263,6 +7761,8 @@ public PlayFabResult call() throws Exception { /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayerSegmentsRequest + * @return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerSegments(final GetPlayerSegmentsRequest request) { @@ -7309,6 +7809,8 @@ private static PlayFabResult privateGetPlayerSegmentsAs /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return Async Task will return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTagsAsync(final GetPlayerTagsRequest request) { @@ -7321,6 +7823,8 @@ public PlayFabResult call() throws Exception { /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTags(final GetPlayerTagsRequest request) { @@ -7367,6 +7871,8 @@ private static PlayFabResult privateGetPlayerTagsAsync(fina /** * Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateWindowsReceiptRequest + * @return Async Task will return ValidateWindowsReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateWindowsStoreReceiptAsync(final ValidateWindowsReceiptRequest request) { @@ -7379,6 +7885,8 @@ public PlayFabResult call() throws Exception { /** * Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateWindowsReceiptRequest + * @return ValidateWindowsReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateWindowsStoreReceipt(final ValidateWindowsReceiptRequest request) { diff --git a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientModels.java b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientModels.java index d2b0f010f..8bc68cf60 100644 --- a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientModels.java +++ b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabClientModels.java @@ -436,7 +436,7 @@ public static enum CloudScriptRevisionOption { } /** - * Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection. + * Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection. */ public static class CollectionFilter { /** @@ -1193,7 +1193,7 @@ public static class GameServerRegionsRequest { */ public String BuildVersion; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; @@ -1434,6 +1434,14 @@ public static class GetFriendLeaderboardAroundPlayerRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1478,6 +1486,14 @@ public static class GetFriendLeaderboardRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1546,6 +1562,14 @@ public static class GetLeaderboardAroundPlayerRequest { * Maximum number of entries to retrieve. Default 10, maximum 100. */ public Integer MaxResultsCount; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1602,6 +1626,14 @@ public static class GetLeaderboardRequest { * Maximum number of entries to retrieve. Default 10, maximum 100. */ public Integer MaxResultsCount; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1643,7 +1675,7 @@ public static class GetPhotonAuthenticationTokenResult { public static class GetPlayerCombinedInfoRequest { /** - * PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. + * PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. */ public String PlayFabId; /** @@ -1980,7 +2012,7 @@ public static class GetPlayFabIDsFromTwitchIDsResult { public static class GetPublisherDataRequest { /** - * array of keys to get back data from the Publisher data blob, set by the admin tools + * array of keys to get back data from the Publisher data blob, set by the admin tools */ public ArrayList Keys; @@ -2024,7 +2056,7 @@ public static class GetPurchaseResult { */ public Date PurchaseDate; /** - * @deprecated Please use instead. + * @deprecated Please use instead. */ @Deprecated public ArrayList Items; @@ -2227,7 +2259,7 @@ public static class GetUserInventoryResult { public static class GetWindowsHelloChallengeRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2688,7 +2720,7 @@ public static class LoginResult { public static class LoginWithAndroidDeviceIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2716,7 +2748,7 @@ public static class LoginWithAndroidDeviceIDRequest { public static class LoginWithCustomIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2727,6 +2759,14 @@ public static class LoginWithCustomIDRequest { * Automatically create a PlayFab account if one is not currently linked to this Custom ID. */ public Boolean CreateAccount; + /** + * Player secret that is used to verify API request signatures + */ + public String PlayerSecret; + /** + * Base64 encoded body that is encrypted with the Title's public RSA key + */ + public String EncryptedRequest; /** * Flags for which pieces of info to return for the user. */ @@ -2736,7 +2776,7 @@ public static class LoginWithCustomIDRequest { public static class LoginWithEmailAddressRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2756,7 +2796,7 @@ public static class LoginWithEmailAddressRequest { public static class LoginWithFacebookRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2776,7 +2816,7 @@ public static class LoginWithFacebookRequest { public static class LoginWithGameCenterRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2796,7 +2836,7 @@ public static class LoginWithGameCenterRequest { public static class LoginWithGoogleAccountRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2816,7 +2856,7 @@ public static class LoginWithGoogleAccountRequest { public static class LoginWithIOSDeviceIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2844,7 +2884,7 @@ public static class LoginWithIOSDeviceIDRequest { public static class LoginWithKongregateRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2868,7 +2908,7 @@ public static class LoginWithKongregateRequest { public static class LoginWithPlayFabRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2888,7 +2928,7 @@ public static class LoginWithPlayFabRequest { public static class LoginWithSteamRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2908,7 +2948,7 @@ public static class LoginWithSteamRequest { public static class LoginWithTwitchRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2928,7 +2968,7 @@ public static class LoginWithTwitchRequest { public static class LoginWithWindowsHelloRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3489,7 +3529,7 @@ public static class RegisterForIOSPushNotificationResult { public static class RegisterPlayFabUserRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3537,7 +3577,7 @@ public static class RegisterPlayFabUserResult { public static class RegisterWithWindowsHelloRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3657,7 +3697,7 @@ public static class SendAccountRecoveryEmailRequest { */ public String Email; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; diff --git a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabErrors.java b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabErrors.java index deba6e253..57673eed3 100644 --- a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabErrors.java +++ b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabErrors.java @@ -288,7 +288,15 @@ public static enum PlayFabErrorCode { ExpressionInvokeFailure(1285), ExpressionTooLong(1286), DataUpdateRateExceeded(1287), - RestrictedEmailDomain(1288); + RestrictedEmailDomain(1288), + EncryptionKeyDisabled(1289), + EncryptionKeyMissing(1290), + EncryptionKeyBroken(1291), + NoSharedSecretKeyConfigured(1292), + SecretKeyNotFound(1293), + PlayerSecretAlreadyConfigured(1294), + APIRequestsDisabledForTitle(1295), + InvalidSharedSecretKey(1296); public int id; diff --git a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabSettings.java b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabSettings.java index 80df29a3e..ae852bc86 100644 --- a/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabSettings.java +++ b/AndroidStudioExample/app/src/main/java/com/playfab/PlayFabSettings.java @@ -4,9 +4,9 @@ import com.playfab.PlayFabErrors.ErrorCallback; public class PlayFabSettings { - public static String SdkVersion = "0.46.170313"; - public static String BuildIdentifier = "javasdk_manual"; - public static String SdkVersionString = "JavaSDK-0.46.170313"; + public static String SdkVersion = "0.47.170403"; + public static String BuildIdentifier = "jbuild_javasdk_1"; + public static String SdkVersionString = "JavaSDK-0.47.170403"; public static String TitleId = null; // You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) public static ErrorCallback GlobalErrorHandler; diff --git a/AndroidStudioExample/app/src/test/java/com/playfab/test/PlayFabApiTest.java b/AndroidStudioExample/app/src/test/java/com/playfab/test/PlayFabApiTest.java index 9d1be3f36..1da088df4 100644 --- a/AndroidStudioExample/app/src/test/java/com/playfab/test/PlayFabApiTest.java +++ b/AndroidStudioExample/app/src/test/java/com/playfab/test/PlayFabApiTest.java @@ -174,7 +174,7 @@ public void LoginWithAdvertisingId() * Test a sequence of calls that modifies saved data, * and verifies that the next sequential API call contains updated data. * Verify that the data is correctly modified on the next call. - * Parameter types tested: string, Dictionary, DateTime + * Parameter types tested: string, Dictionary(string, string), DateTime */ @Test public void UserDataApi() @@ -220,7 +220,7 @@ public void UserDataApi() * Test a sequence of calls that modifies saved data, * and verifies that the next sequential API call contains updated data. * Verify that the data is saved correctly, and that specific types are tested - * Parameter types tested: Dictionary + * Parameter types tested: Dictionary(string,int) */ @Test public void PlayerStatisticsApi() diff --git a/PlayFabClientSDK/pom.xml b/PlayFabClientSDK/pom.xml index 26c17d7dd..deddd3638 100644 --- a/PlayFabClientSDK/pom.xml +++ b/PlayFabClientSDK/pom.xml @@ -4,7 +4,7 @@ 2016 com.playfab client-sdk - 0.46.170313-SNAPSHOT + 0.47.170403 PlayFab Client API PlayFab is the unified backend platform for games — everything you need to build and operate your game, all in one place, so you can focus on creating and delivering a great player experience. http://api.playfab.com/ @@ -37,29 +37,6 @@ 1.7 - - - - com.google.code.gson - gson - 2.8.0 - - - junit - junit - 4.12 - test - - - - - org.assertj - assertj-core - 3.6.2 - test - - - junit @@ -92,6 +69,11 @@ ${javaLanguage.version} + + org.apache.maven.plugins + maven-surefire-plugin + 2.19.1 + @@ -108,8 +90,28 @@ sign-artifacts verify - sign + sign-and-deploy-file + + + 4A496164 + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + pom.xml + ${project.artifactId} + ${project.groupId} + ${project.version} + target/${project.artifactId}-${project.version}.jar + + target/${project.artifactId}-${project.version}-sources.jar,target/${project.artifactId}-${project.version}-javadoc.jar + + jar,jar + sources,javadoc + ossrh + + --armor + --detach-sig + + @@ -136,9 +138,23 @@ jar + + true + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.3 + true + + ossrh + https://oss.sonatype.org/ + false + + @@ -221,8 +237,10 @@ - nexus - https://oss.sonatype.org/content/repositories/snapshots/ + ossrh + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + diff --git a/PlayFabClientSDK/pom.xml.asc b/PlayFabClientSDK/pom.xml.asc new file mode 100644 index 000000000..c5cb94551 --- /dev/null +++ b/PlayFabClientSDK/pom.xml.asc @@ -0,0 +1,11 @@ +-----BEGIN PGP SIGNATURE----- +Version: GnuPG v1 + +iQEcBAABAgAGBQJY4tnRAAoJEGKji9NKSWFk8EkH+wYT/moY/wA6dsovKasBVJh4 +nvsvbzfcKRvmoZAyvnbu8b5o4JJtxmMOkcQpLby754/4iEm5mUhbSdrr+1UOA636 +mrvk1pD30ZAH2zl5AbdrAJObyiS30r8aLCjKxqhvr6e7fGG8uAVOJl+boZFQwWI3 +4LeXRudWRH0GndLbPpKpNGNs8CE5/lpxxFvI86rCDdHPzg9fXdq8d8gI81LFKekO +Ti+flaR8XwfojwqL1j//ezAVqk/sFb/WQMFUqVOGOUnnaczWaH6fg9wgiJMH3UVE +S2Glm/0r8WR3pG6w9RpUPejgHjrd6a6eExp8EAwqrH4PZwwMrunzuQHwEzesM50= +=d3gQ +-----END PGP SIGNATURE----- diff --git a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientAPI.java b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientAPI.java index b08af48d3..0046f6d45 100644 --- a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientAPI.java +++ b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientAPI.java @@ -18,6 +18,8 @@ public class PlayFabClientAPI { /** * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://api.playfab.com/docs/using-photon-with-playfab/ for more details. + * @param request GetPhotonAuthenticationTokenRequest + * @return Async Task will return GetPhotonAuthenticationTokenResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPhotonAuthenticationTokenAsync(final GetPhotonAuthenticationTokenRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception /** * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://api.playfab.com/docs/using-photon-with-playfab/ for more details. + * @param request GetPhotonAuthenticationTokenRequest + * @return GetPhotonAuthenticationTokenResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPhotonAuthenticationToken(final GetPhotonAuthenticationTokenRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateGetPhoto /** * Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate. + * @param request GetWindowsHelloChallengeRequest + * @return Async Task will return GetWindowsHelloChallengeResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetWindowsHelloChallengeAsync(final GetWindowsHelloChallengeRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate. + * @param request GetWindowsHelloChallengeRequest + * @return GetWindowsHelloChallengeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetWindowsHelloChallenge(final GetWindowsHelloChallengeRequest request) { @@ -133,6 +141,8 @@ private static PlayFabResult privateGetWindows /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithAndroidDeviceIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithAndroidDeviceIDAsync(final LoginWithAndroidDeviceIDRequest request) { @@ -145,6 +155,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithAndroidDeviceIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithAndroidDeviceID(final LoginWithAndroidDeviceIDRequest request) { @@ -194,6 +206,8 @@ private static PlayFabResult privateLoginWithAndroidDeviceIDAsync(f /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithCustomIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithCustomIDAsync(final LoginWithCustomIDRequest request) { @@ -206,6 +220,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithCustomIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithCustomID(final LoginWithCustomIDRequest request) { @@ -255,6 +271,8 @@ private static PlayFabResult privateLoginWithCustomIDAsync(final Lo /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser. + * @param request LoginWithEmailAddressRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithEmailAddressAsync(final LoginWithEmailAddressRequest request) { @@ -267,6 +285,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser. + * @param request LoginWithEmailAddressRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithEmailAddress(final LoginWithEmailAddressRequest request) { @@ -316,6 +336,8 @@ private static PlayFabResult privateLoginWithEmailAddressAsync(fina /** * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithFacebookRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithFacebookAsync(final LoginWithFacebookRequest request) { @@ -328,6 +350,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithFacebookRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithFacebook(final LoginWithFacebookRequest request) { @@ -377,6 +401,8 @@ private static PlayFabResult privateLoginWithFacebookAsync(final Lo /** * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithGameCenterRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithGameCenterAsync(final LoginWithGameCenterRequest request) { @@ -389,6 +415,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithGameCenterRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithGameCenter(final LoginWithGameCenterRequest request) { @@ -438,6 +466,8 @@ private static PlayFabResult privateLoginWithGameCenterAsync(final /** * Signs the user in using their Google account credentials + * @param request LoginWithGoogleAccountRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithGoogleAccountAsync(final LoginWithGoogleAccountRequest request) { @@ -450,6 +480,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using their Google account credentials + * @param request LoginWithGoogleAccountRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithGoogleAccount(final LoginWithGoogleAccountRequest request) { @@ -499,6 +531,8 @@ private static PlayFabResult privateLoginWithGoogleAccountAsync(fin /** * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithIOSDeviceIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithIOSDeviceIDAsync(final LoginWithIOSDeviceIDRequest request) { @@ -511,6 +545,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithIOSDeviceIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithIOSDeviceID(final LoginWithIOSDeviceIDRequest request) { @@ -560,6 +596,8 @@ private static PlayFabResult privateLoginWithIOSDeviceIDAsync(final /** * Signs the user in using a Kongregate player account. + * @param request LoginWithKongregateRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithKongregateAsync(final LoginWithKongregateRequest request) { @@ -572,6 +610,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Kongregate player account. + * @param request LoginWithKongregateRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithKongregate(final LoginWithKongregateRequest request) { @@ -621,6 +661,8 @@ private static PlayFabResult privateLoginWithKongregateAsync(final /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword. + * @param request LoginWithPlayFabRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithPlayFabAsync(final LoginWithPlayFabRequest request) { @@ -633,6 +675,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword. + * @param request LoginWithPlayFabRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithPlayFab(final LoginWithPlayFabRequest request) { @@ -682,6 +726,8 @@ private static PlayFabResult privateLoginWithPlayFabAsync(final Log /** * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithSteamRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithSteamAsync(final LoginWithSteamRequest request) { @@ -694,6 +740,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithSteamRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithSteam(final LoginWithSteamRequest request) { @@ -743,6 +791,8 @@ private static PlayFabResult privateLoginWithSteamAsync(final Login /** * Signs the user in using a Twitch access token. + * @param request LoginWithTwitchRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithTwitchAsync(final LoginWithTwitchRequest request) { @@ -755,6 +805,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Twitch access token. + * @param request LoginWithTwitchRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithTwitch(final LoginWithTwitchRequest request) { @@ -803,7 +855,9 @@ private static PlayFabResult privateLoginWithTwitchAsync(final Logi } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * @param request LoginWithWindowsHelloRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithWindowsHelloAsync(final LoginWithWindowsHelloRequest request) { @@ -815,7 +869,9 @@ public PlayFabResult call() throws Exception { } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * @param request LoginWithWindowsHelloRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithWindowsHello(final LoginWithWindowsHelloRequest request) { @@ -833,7 +889,7 @@ public PlayFabResult call() throws Exception { } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. */ @SuppressWarnings("unchecked") private static PlayFabResult privateLoginWithWindowsHelloAsync(final LoginWithWindowsHelloRequest request) throws Exception { @@ -865,6 +921,8 @@ private static PlayFabResult privateLoginWithWindowsHelloAsync(fina /** * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address. + * @param request RegisterPlayFabUserRequest + * @return Async Task will return RegisterPlayFabUserResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterPlayFabUserAsync(final RegisterPlayFabUserRequest request) { @@ -877,6 +935,8 @@ public PlayFabResult call() throws Exception { /** * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address. + * @param request RegisterPlayFabUserRequest + * @return RegisterPlayFabUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterPlayFabUser(final RegisterPlayFabUserRequest request) { @@ -926,6 +986,8 @@ private static PlayFabResult privateRegisterPlayFabUs /** * Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user + * @param request RegisterWithWindowsHelloRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterWithWindowsHelloAsync(final RegisterWithWindowsHelloRequest request) { @@ -938,6 +1000,8 @@ public PlayFabResult call() throws Exception { /** * Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user + * @param request RegisterWithWindowsHelloRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterWithWindowsHello(final RegisterWithWindowsHelloRequest request) { @@ -987,6 +1051,8 @@ private static PlayFabResult privateRegisterWithWindowsHelloAsync(f /** * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players. + * @param request AddGenericIDRequest + * @return Async Task will return AddGenericIDResult */ @SuppressWarnings("unchecked") public static FutureTask> AddGenericIDAsync(final AddGenericIDRequest request) { @@ -999,6 +1065,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players. + * @param request AddGenericIDRequest + * @return AddGenericIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddGenericID(final AddGenericIDRequest request) { @@ -1045,6 +1113,8 @@ private static PlayFabResult privateAddGenericIDAsync(final /** * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login. + * @param request AddUsernamePasswordRequest + * @return Async Task will return AddUsernamePasswordResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUsernamePasswordAsync(final AddUsernamePasswordRequest request) { @@ -1057,6 +1127,8 @@ public PlayFabResult call() throws Exception { /** * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login. + * @param request AddUsernamePasswordRequest + * @return AddUsernamePasswordResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUsernamePassword(final AddUsernamePasswordRequest request) { @@ -1103,6 +1175,8 @@ private static PlayFabResult privateAddUsernamePasswo /** * Retrieves the user's PlayFab account details + * @param request GetAccountInfoRequest + * @return Async Task will return GetAccountInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAccountInfoAsync(final GetAccountInfoRequest request) { @@ -1115,6 +1189,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the user's PlayFab account details + * @param request GetAccountInfoRequest + * @return GetAccountInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAccountInfo(final GetAccountInfoRequest request) { @@ -1161,6 +1237,8 @@ private static PlayFabResult privateGetAccountInfoAsync(fi /** * Retrieves all of the user's different kinds of info. + * @param request GetPlayerCombinedInfoRequest + * @return Async Task will return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerCombinedInfoAsync(final GetPlayerCombinedInfoRequest request) { @@ -1173,6 +1251,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves all of the user's different kinds of info. + * @param request GetPlayerCombinedInfoRequest + * @return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerCombinedInfo(final GetPlayerCombinedInfoRequest request) { @@ -1219,6 +1299,8 @@ private static PlayFabResult privateGetPlayerCombin /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return Async Task will return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromFacebookIDsAsync(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -1231,6 +1313,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromFacebookIDs(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -1277,6 +1361,8 @@ private static PlayFabResult privateGetPlayF /** * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier). + * @param request GetPlayFabIDsFromGameCenterIDsRequest + * @return Async Task will return GetPlayFabIDsFromGameCenterIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGameCenterIDsAsync(final GetPlayFabIDsFromGameCenterIDsRequest request) { @@ -1289,6 +1375,8 @@ public PlayFabResult call() throws Excepti /** * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier). + * @param request GetPlayFabIDsFromGameCenterIDsRequest + * @return GetPlayFabIDsFromGameCenterIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGameCenterIDs(final GetPlayFabIDsFromGameCenterIDsRequest request) { @@ -1335,6 +1423,8 @@ private static PlayFabResult privateGetPla /** * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account. + * @param request GetPlayFabIDsFromGenericIDsRequest + * @return Async Task will return GetPlayFabIDsFromGenericIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGenericIDsAsync(final GetPlayFabIDsFromGenericIDsRequest request) { @@ -1347,6 +1437,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account. + * @param request GetPlayFabIDsFromGenericIDsRequest + * @return GetPlayFabIDsFromGenericIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGenericIDs(final GetPlayFabIDsFromGenericIDsRequest request) { @@ -1393,6 +1485,8 @@ private static PlayFabResult privateGetPlayFa /** * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls. + * @param request GetPlayFabIDsFromGoogleIDsRequest + * @return Async Task will return GetPlayFabIDsFromGoogleIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGoogleIDsAsync(final GetPlayFabIDsFromGoogleIDsRequest request) { @@ -1405,6 +1499,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls. + * @param request GetPlayFabIDsFromGoogleIDsRequest + * @return GetPlayFabIDsFromGoogleIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGoogleIDs(final GetPlayFabIDsFromGoogleIDsRequest request) { @@ -1451,6 +1547,8 @@ private static PlayFabResult privateGetPlayFab /** * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId). + * @param request GetPlayFabIDsFromKongregateIDsRequest + * @return Async Task will return GetPlayFabIDsFromKongregateIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromKongregateIDsAsync(final GetPlayFabIDsFromKongregateIDsRequest request) { @@ -1463,6 +1561,8 @@ public PlayFabResult call() throws Excepti /** * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId). + * @param request GetPlayFabIDsFromKongregateIDsRequest + * @return GetPlayFabIDsFromKongregateIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromKongregateIDs(final GetPlayFabIDsFromKongregateIDsRequest request) { @@ -1509,6 +1609,8 @@ private static PlayFabResult privateGetPla /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return Async Task will return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromSteamIDsAsync(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -1521,6 +1623,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromSteamIDs(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -1567,6 +1671,8 @@ private static PlayFabResult privateGetPlayFabI /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser). + * @param request GetPlayFabIDsFromTwitchIDsRequest + * @return Async Task will return GetPlayFabIDsFromTwitchIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromTwitchIDsAsync(final GetPlayFabIDsFromTwitchIDsRequest request) { @@ -1579,6 +1685,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser). + * @param request GetPlayFabIDsFromTwitchIDsRequest + * @return GetPlayFabIDsFromTwitchIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromTwitchIDs(final GetPlayFabIDsFromTwitchIDsRequest request) { @@ -1625,6 +1733,8 @@ private static PlayFabResult privateGetPlayFab /** * Links the Android device identifier to the user's PlayFab account + * @param request LinkAndroidDeviceIDRequest + * @return Async Task will return LinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkAndroidDeviceIDAsync(final LinkAndroidDeviceIDRequest request) { @@ -1637,6 +1747,8 @@ public PlayFabResult call() throws Exception { /** * Links the Android device identifier to the user's PlayFab account + * @param request LinkAndroidDeviceIDRequest + * @return LinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkAndroidDeviceID(final LinkAndroidDeviceIDRequest request) { @@ -1683,6 +1795,8 @@ private static PlayFabResult privateLinkAndroidDevice /** * Links the custom identifier, generated by the title, to the user's PlayFab account + * @param request LinkCustomIDRequest + * @return Async Task will return LinkCustomIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkCustomIDAsync(final LinkCustomIDRequest request) { @@ -1695,6 +1809,8 @@ public PlayFabResult call() throws Exception { /** * Links the custom identifier, generated by the title, to the user's PlayFab account + * @param request LinkCustomIDRequest + * @return LinkCustomIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkCustomID(final LinkCustomIDRequest request) { @@ -1741,6 +1857,8 @@ private static PlayFabResult privateLinkCustomIDAsync(final /** * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account + * @param request LinkFacebookAccountRequest + * @return Async Task will return LinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkFacebookAccountAsync(final LinkFacebookAccountRequest request) { @@ -1753,6 +1871,8 @@ public PlayFabResult call() throws Exception { /** * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account + * @param request LinkFacebookAccountRequest + * @return LinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkFacebookAccount(final LinkFacebookAccountRequest request) { @@ -1799,6 +1919,8 @@ private static PlayFabResult privateLinkFacebookAccou /** * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account + * @param request LinkGameCenterAccountRequest + * @return Async Task will return LinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkGameCenterAccountAsync(final LinkGameCenterAccountRequest request) { @@ -1811,6 +1933,8 @@ public PlayFabResult call() throws Exception { /** * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account + * @param request LinkGameCenterAccountRequest + * @return LinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkGameCenterAccount(final LinkGameCenterAccountRequest request) { @@ -1857,6 +1981,8 @@ private static PlayFabResult privateLinkGameCenterA /** * Links the currently signed-in user account to their Google account, using their Google account credentials + * @param request LinkGoogleAccountRequest + * @return Async Task will return LinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkGoogleAccountAsync(final LinkGoogleAccountRequest request) { @@ -1869,6 +1995,8 @@ public PlayFabResult call() throws Exception { /** * Links the currently signed-in user account to their Google account, using their Google account credentials + * @param request LinkGoogleAccountRequest + * @return LinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkGoogleAccount(final LinkGoogleAccountRequest request) { @@ -1915,6 +2043,8 @@ private static PlayFabResult privateLinkGoogleAccountAs /** * Links the vendor-specific iOS device identifier to the user's PlayFab account + * @param request LinkIOSDeviceIDRequest + * @return Async Task will return LinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkIOSDeviceIDAsync(final LinkIOSDeviceIDRequest request) { @@ -1927,6 +2057,8 @@ public PlayFabResult call() throws Exception { /** * Links the vendor-specific iOS device identifier to the user's PlayFab account + * @param request LinkIOSDeviceIDRequest + * @return LinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkIOSDeviceID(final LinkIOSDeviceIDRequest request) { @@ -1973,6 +2105,8 @@ private static PlayFabResult privateLinkIOSDeviceIDAsync( /** * Links the Kongregate identifier to the user's PlayFab account + * @param request LinkKongregateAccountRequest + * @return Async Task will return LinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkKongregateAsync(final LinkKongregateAccountRequest request) { @@ -1985,6 +2119,8 @@ public PlayFabResult call() throws Exception { /** * Links the Kongregate identifier to the user's PlayFab account + * @param request LinkKongregateAccountRequest + * @return LinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkKongregate(final LinkKongregateAccountRequest request) { @@ -2031,6 +2167,8 @@ private static PlayFabResult privateLinkKongregateA /** * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account + * @param request LinkSteamAccountRequest + * @return Async Task will return LinkSteamAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkSteamAccountAsync(final LinkSteamAccountRequest request) { @@ -2043,6 +2181,8 @@ public PlayFabResult call() throws Exception { /** * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account + * @param request LinkSteamAccountRequest + * @return LinkSteamAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkSteamAccount(final LinkSteamAccountRequest request) { @@ -2089,6 +2229,8 @@ private static PlayFabResult privateLinkSteamAccountAsyn /** * Links the Twitch account associated with the token to the user's PlayFab account. + * @param request LinkTwitchAccountRequest + * @return Async Task will return LinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkTwitchAsync(final LinkTwitchAccountRequest request) { @@ -2101,6 +2243,8 @@ public PlayFabResult call() throws Exception { /** * Links the Twitch account associated with the token to the user's PlayFab account. + * @param request LinkTwitchAccountRequest + * @return LinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkTwitch(final LinkTwitchAccountRequest request) { @@ -2147,6 +2291,8 @@ private static PlayFabResult privateLinkTwitchAsync(fin /** * Link Windows Hello authentication to the current PlayFab Account + * @param request LinkWindowsHelloAccountRequest + * @return Async Task will return LinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static FutureTask> LinkWindowsHelloAsync(final LinkWindowsHelloAccountRequest request) { @@ -2159,6 +2305,8 @@ public PlayFabResult call() throws Exception { /** * Link Windows Hello authentication to the current PlayFab Account + * @param request LinkWindowsHelloAccountRequest + * @return LinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static PlayFabResult LinkWindowsHello(final LinkWindowsHelloAccountRequest request) { @@ -2204,6 +2352,8 @@ private static PlayFabResult privateLinkWindows /** * Removes the specified generic service identifier from the player's PlayFab account. + * @param request RemoveGenericIDRequest + * @return Async Task will return RemoveGenericIDResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveGenericIDAsync(final RemoveGenericIDRequest request) { @@ -2216,6 +2366,8 @@ public PlayFabResult call() throws Exception { /** * Removes the specified generic service identifier from the player's PlayFab account. + * @param request RemoveGenericIDRequest + * @return RemoveGenericIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveGenericID(final RemoveGenericIDRequest request) { @@ -2262,6 +2414,8 @@ private static PlayFabResult privateRemoveGenericIDAsync( /** * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerClientRequest + * @return Async Task will return ReportPlayerClientResult */ @SuppressWarnings("unchecked") public static FutureTask> ReportPlayerAsync(final ReportPlayerClientRequest request) { @@ -2274,6 +2428,8 @@ public PlayFabResult call() throws Exception { /** * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerClientRequest + * @return ReportPlayerClientResult */ @SuppressWarnings("unchecked") public static PlayFabResult ReportPlayer(final ReportPlayerClientRequest request) { @@ -2320,6 +2476,8 @@ private static PlayFabResult privateReportPlayerAsync( /** * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return Async Task will return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static FutureTask> SendAccountRecoveryEmailAsync(final SendAccountRecoveryEmailRequest request) { @@ -2332,6 +2490,8 @@ public PlayFabResult call() throws Exception { /** * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static PlayFabResult SendAccountRecoveryEmail(final SendAccountRecoveryEmailRequest request) { @@ -2377,6 +2537,8 @@ private static PlayFabResult privateSendAccountR /** * Unlinks the related Android device identifier from the user's PlayFab account + * @param request UnlinkAndroidDeviceIDRequest + * @return Async Task will return UnlinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkAndroidDeviceIDAsync(final UnlinkAndroidDeviceIDRequest request) { @@ -2389,6 +2551,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Android device identifier from the user's PlayFab account + * @param request UnlinkAndroidDeviceIDRequest + * @return UnlinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkAndroidDeviceID(final UnlinkAndroidDeviceIDRequest request) { @@ -2435,6 +2599,8 @@ private static PlayFabResult privateUnlinkAndroidDe /** * Unlinks the related custom identifier from the user's PlayFab account + * @param request UnlinkCustomIDRequest + * @return Async Task will return UnlinkCustomIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkCustomIDAsync(final UnlinkCustomIDRequest request) { @@ -2447,6 +2613,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related custom identifier from the user's PlayFab account + * @param request UnlinkCustomIDRequest + * @return UnlinkCustomIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkCustomID(final UnlinkCustomIDRequest request) { @@ -2493,6 +2661,8 @@ private static PlayFabResult privateUnlinkCustomIDAsync(fi /** * Unlinks the related Facebook account from the user's PlayFab account + * @param request UnlinkFacebookAccountRequest + * @return Async Task will return UnlinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkFacebookAccountAsync(final UnlinkFacebookAccountRequest request) { @@ -2505,6 +2675,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Facebook account from the user's PlayFab account + * @param request UnlinkFacebookAccountRequest + * @return UnlinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkFacebookAccount(final UnlinkFacebookAccountRequest request) { @@ -2551,6 +2723,8 @@ private static PlayFabResult privateUnlinkFacebookA /** * Unlinks the related Game Center account from the user's PlayFab account + * @param request UnlinkGameCenterAccountRequest + * @return Async Task will return UnlinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkGameCenterAccountAsync(final UnlinkGameCenterAccountRequest request) { @@ -2563,6 +2737,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Game Center account from the user's PlayFab account + * @param request UnlinkGameCenterAccountRequest + * @return UnlinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkGameCenterAccount(final UnlinkGameCenterAccountRequest request) { @@ -2609,6 +2785,8 @@ private static PlayFabResult privateUnlinkGameCen /** * Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods). + * @param request UnlinkGoogleAccountRequest + * @return Async Task will return UnlinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkGoogleAccountAsync(final UnlinkGoogleAccountRequest request) { @@ -2621,6 +2799,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods). + * @param request UnlinkGoogleAccountRequest + * @return UnlinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkGoogleAccount(final UnlinkGoogleAccountRequest request) { @@ -2667,6 +2847,8 @@ private static PlayFabResult privateUnlinkGoogleAccou /** * Unlinks the related iOS device identifier from the user's PlayFab account + * @param request UnlinkIOSDeviceIDRequest + * @return Async Task will return UnlinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkIOSDeviceIDAsync(final UnlinkIOSDeviceIDRequest request) { @@ -2679,6 +2861,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related iOS device identifier from the user's PlayFab account + * @param request UnlinkIOSDeviceIDRequest + * @return UnlinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkIOSDeviceID(final UnlinkIOSDeviceIDRequest request) { @@ -2725,6 +2909,8 @@ private static PlayFabResult privateUnlinkIOSDeviceIDAs /** * Unlinks the related Kongregate identifier from the user's PlayFab account + * @param request UnlinkKongregateAccountRequest + * @return Async Task will return UnlinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkKongregateAsync(final UnlinkKongregateAccountRequest request) { @@ -2737,6 +2923,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Kongregate identifier from the user's PlayFab account + * @param request UnlinkKongregateAccountRequest + * @return UnlinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkKongregate(final UnlinkKongregateAccountRequest request) { @@ -2783,6 +2971,8 @@ private static PlayFabResult privateUnlinkKongreg /** * Unlinks the related Steam account from the user's PlayFab account + * @param request UnlinkSteamAccountRequest + * @return Async Task will return UnlinkSteamAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkSteamAccountAsync(final UnlinkSteamAccountRequest request) { @@ -2795,6 +2985,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Steam account from the user's PlayFab account + * @param request UnlinkSteamAccountRequest + * @return UnlinkSteamAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkSteamAccount(final UnlinkSteamAccountRequest request) { @@ -2841,6 +3033,8 @@ private static PlayFabResult privateUnlinkSteamAccount /** * Unlinks the related Twitch account from the user's PlayFab account. + * @param request UnlinkTwitchAccountRequest + * @return Async Task will return UnlinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkTwitchAsync(final UnlinkTwitchAccountRequest request) { @@ -2853,6 +3047,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Twitch account from the user's PlayFab account. + * @param request UnlinkTwitchAccountRequest + * @return UnlinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkTwitch(final UnlinkTwitchAccountRequest request) { @@ -2899,6 +3095,8 @@ private static PlayFabResult privateUnlinkTwitchAsync /** * Unlink Windows Hello authentication from the current PlayFab Account + * @param request UnlinkWindowsHelloAccountRequest + * @return Async Task will return UnlinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkWindowsHelloAsync(final UnlinkWindowsHelloAccountRequest request) { @@ -2911,6 +3109,8 @@ public PlayFabResult call() throws Exception /** * Unlink Windows Hello authentication from the current PlayFab Account + * @param request UnlinkWindowsHelloAccountRequest + * @return UnlinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkWindowsHello(final UnlinkWindowsHelloAccountRequest request) { @@ -2956,6 +3156,8 @@ private static PlayFabResult privateUnlinkWin /** * Update the avatar URL of the player + * @param request UpdateAvatarUrlRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateAvatarUrlAsync(final UpdateAvatarUrlRequest request) { @@ -2968,6 +3170,8 @@ public PlayFabResult call() throws Exception { /** * Update the avatar URL of the player + * @param request UpdateAvatarUrlRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateAvatarUrl(final UpdateAvatarUrlRequest request) { @@ -3014,6 +3218,8 @@ private static PlayFabResult privateUpdateAvatarUrlAsync(final Upda /** * Updates the title specific display name for the user + * @param request UpdateUserTitleDisplayNameRequest + * @return Async Task will return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserTitleDisplayNameAsync(final UpdateUserTitleDisplayNameRequest request) { @@ -3026,6 +3232,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title specific display name for the user + * @param request UpdateUserTitleDisplayNameRequest + * @return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserTitleDisplayName(final UpdateUserTitleDisplayNameRequest request) { @@ -3072,6 +3280,8 @@ private static PlayFabResult privateUpdateUser /** * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAsync(final GetFriendLeaderboardRequest request) { @@ -3084,6 +3294,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboard(final GetFriendLeaderboardRequest request) { @@ -3130,6 +3342,8 @@ private static PlayFabResult privateGetFriendLeaderboardAs /** * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user. + * @param request GetFriendLeaderboardAroundPlayerRequest + * @return Async Task will return GetFriendLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAroundPlayerAsync(final GetFriendLeaderboardAroundPlayerRequest request) { @@ -3142,6 +3356,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user. + * @param request GetFriendLeaderboardAroundPlayerRequest + * @return GetFriendLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboardAroundPlayer(final GetFriendLeaderboardAroundPlayerRequest request) { @@ -3188,6 +3404,8 @@ private static PlayFabResult privateGetF /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAsync(final GetLeaderboardRequest request) { @@ -3200,6 +3418,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboard(final GetLeaderboardRequest request) { @@ -3246,6 +3466,8 @@ private static PlayFabResult privateGetLeaderboardAsync(fi /** * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user. + * @param request GetLeaderboardAroundPlayerRequest + * @return Async Task will return GetLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundPlayerAsync(final GetLeaderboardAroundPlayerRequest request) { @@ -3258,6 +3480,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user. + * @param request GetLeaderboardAroundPlayerRequest + * @return GetLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundPlayer(final GetLeaderboardAroundPlayerRequest request) { @@ -3304,6 +3528,8 @@ private static PlayFabResult privateGetLeaderb /** * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player. + * @param request GetPlayerStatisticsRequest + * @return Async Task will return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticsAsync(final GetPlayerStatisticsRequest request) { @@ -3316,6 +3542,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player. + * @param request GetPlayerStatisticsRequest + * @return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatistics(final GetPlayerStatisticsRequest request) { @@ -3362,6 +3590,8 @@ private static PlayFabResult privateGetPlayerStatisti /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return Async Task will return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticVersionsAsync(final GetPlayerStatisticVersionsRequest request) { @@ -3374,6 +3604,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticVersions(final GetPlayerStatisticVersionsRequest request) { @@ -3420,6 +3652,8 @@ private static PlayFabResult privateGetPlayerS /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserDataAsync(final GetUserDataRequest request) { @@ -3432,6 +3666,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserData(final GetUserDataRequest request) { @@ -3478,6 +3714,8 @@ private static PlayFabResult privateGetUserDataAsync(final Ge /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherDataAsync(final GetUserDataRequest request) { @@ -3490,6 +3728,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherData(final GetUserDataRequest request) { @@ -3536,6 +3776,8 @@ private static PlayFabResult privateGetUserPublisherDataAsync /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherReadOnlyDataAsync(final GetUserDataRequest request) { @@ -3548,6 +3790,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherReadOnlyData(final GetUserDataRequest request) { @@ -3594,6 +3838,8 @@ private static PlayFabResult privateGetUserPublisherReadOnlyD /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserReadOnlyDataAsync(final GetUserDataRequest request) { @@ -3606,6 +3852,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserReadOnlyData(final GetUserDataRequest request) { @@ -3651,7 +3899,9 @@ private static PlayFabResult privateGetUserReadOnlyDataAsync( } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdatePlayerStatisticsRequest + * @return Async Task will return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) { @@ -3663,7 +3913,9 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdatePlayerStatisticsRequest + * @return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePlayerStatistics(final UpdatePlayerStatisticsRequest request) { @@ -3681,7 +3933,7 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) throws Exception { @@ -3710,6 +3962,8 @@ private static PlayFabResult privateUpdatePlayerSt /** * Creates and updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserDataAsync(final UpdateUserDataRequest request) { @@ -3722,6 +3976,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserData(final UpdateUserDataRequest request) { @@ -3768,6 +4024,8 @@ private static PlayFabResult privateUpdateUserDataAsync(fi /** * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherDataAsync(final UpdateUserDataRequest request) { @@ -3780,6 +4038,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherData(final UpdateUserDataRequest request) { @@ -3826,6 +4086,8 @@ private static PlayFabResult privateUpdateUserPublisherDat /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return Async Task will return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCatalogItemsAsync(final GetCatalogItemsRequest request) { @@ -3838,6 +4100,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCatalogItems(final GetCatalogItemsRequest request) { @@ -3884,6 +4148,8 @@ private static PlayFabResult privateGetCatalogItemsAsync( /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return Async Task will return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPublisherDataAsync(final GetPublisherDataRequest request) { @@ -3896,6 +4162,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPublisherData(final GetPublisherDataRequest request) { @@ -3942,6 +4210,8 @@ private static PlayFabResult privateGetPublisherDataAsyn /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return Async Task will return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetStoreItemsAsync(final GetStoreItemsRequest request) { @@ -3954,6 +4224,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetStoreItems(final GetStoreItemsRequest request) { @@ -4000,6 +4272,8 @@ private static PlayFabResult privateGetStoreItemsAsync(fina /** * Retrieves the current server time + * @param request GetTimeRequest + * @return Async Task will return GetTimeResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTimeAsync(final GetTimeRequest request) { @@ -4012,6 +4286,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current server time + * @param request GetTimeRequest + * @return GetTimeResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTime(final GetTimeRequest request) { @@ -4058,6 +4334,8 @@ private static PlayFabResult privateGetTimeAsync(final GetTimeReq /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleDataAsync(final GetTitleDataRequest request) { @@ -4070,6 +4348,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleData(final GetTitleDataRequest request) { @@ -4116,6 +4396,8 @@ private static PlayFabResult privateGetTitleDataAsync(final /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return Async Task will return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleNewsAsync(final GetTitleNewsRequest request) { @@ -4128,6 +4410,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleNews(final GetTitleNewsRequest request) { @@ -4174,6 +4458,8 @@ private static PlayFabResult privateGetTitleNewsAsync(final /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUserVirtualCurrencyAsync(final AddUserVirtualCurrencyRequest request) { @@ -4186,6 +4472,8 @@ public PlayFabResult call() throws Exception { /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUserVirtualCurrency(final AddUserVirtualCurrencyRequest request) { @@ -4232,6 +4520,8 @@ private static PlayFabResult privateAddUserVirt /** * Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate + * @param request ConfirmPurchaseRequest + * @return Async Task will return ConfirmPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> ConfirmPurchaseAsync(final ConfirmPurchaseRequest request) { @@ -4244,6 +4534,8 @@ public PlayFabResult call() throws Exception { /** * Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate + * @param request ConfirmPurchaseRequest + * @return ConfirmPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConfirmPurchase(final ConfirmPurchaseRequest request) { @@ -4290,6 +4582,8 @@ private static PlayFabResult privateConfirmPurchaseAsync( /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return Async Task will return ConsumeItemResult */ @SuppressWarnings("unchecked") public static FutureTask> ConsumeItemAsync(final ConsumeItemRequest request) { @@ -4302,6 +4596,8 @@ public PlayFabResult call() throws Exception { /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return ConsumeItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConsumeItem(final ConsumeItemRequest request) { @@ -4348,6 +4644,8 @@ private static PlayFabResult privateConsumeItemAsync(final Co /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return Async Task will return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterInventoryAsync(final GetCharacterInventoryRequest request) { @@ -4360,6 +4658,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterInventory(final GetCharacterInventoryRequest request) { @@ -4406,6 +4706,8 @@ private static PlayFabResult privateGetCharacterInv /** * Retrieves a purchase along with its current PlayFab status. + * @param request GetPurchaseRequest + * @return Async Task will return GetPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPurchaseAsync(final GetPurchaseRequest request) { @@ -4418,6 +4720,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a purchase along with its current PlayFab status. + * @param request GetPurchaseRequest + * @return GetPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPurchase(final GetPurchaseRequest request) { @@ -4464,6 +4768,8 @@ private static PlayFabResult privateGetPurchaseAsync(final Ge /** * Retrieves the user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return Async Task will return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInventoryAsync(final GetUserInventoryRequest request) { @@ -4476,6 +4782,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInventory(final GetUserInventoryRequest request) { @@ -4522,6 +4830,8 @@ private static PlayFabResult privateGetUserInventoryAsyn /** * Selects a payment option for purchase order created via StartPurchase + * @param request PayForPurchaseRequest + * @return Async Task will return PayForPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> PayForPurchaseAsync(final PayForPurchaseRequest request) { @@ -4534,6 +4844,8 @@ public PlayFabResult call() throws Exception { /** * Selects a payment option for purchase order created via StartPurchase + * @param request PayForPurchaseRequest + * @return PayForPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult PayForPurchase(final PayForPurchaseRequest request) { @@ -4580,6 +4892,8 @@ private static PlayFabResult privatePayForPurchaseAsync(fi /** * Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed. + * @param request PurchaseItemRequest + * @return Async Task will return PurchaseItemResult */ @SuppressWarnings("unchecked") public static FutureTask> PurchaseItemAsync(final PurchaseItemRequest request) { @@ -4592,6 +4906,8 @@ public PlayFabResult call() throws Exception { /** * Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed. + * @param request PurchaseItemRequest + * @return PurchaseItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult PurchaseItem(final PurchaseItemRequest request) { @@ -4637,7 +4953,9 @@ private static PlayFabResult privatePurchaseItemAsync(final } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return Async Task will return RedeemCouponResult */ @SuppressWarnings("unchecked") public static FutureTask> RedeemCouponAsync(final RedeemCouponRequest request) { @@ -4649,7 +4967,9 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return RedeemCouponResult */ @SuppressWarnings("unchecked") public static PlayFabResult RedeemCoupon(final RedeemCouponRequest request) { @@ -4667,7 +4987,7 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. */ @SuppressWarnings("unchecked") private static PlayFabResult privateRedeemCouponAsync(final RedeemCouponRequest request) throws Exception { @@ -4696,6 +5016,8 @@ private static PlayFabResult privateRedeemCouponAsync(final /** * Creates an order for a list of items from the title catalog + * @param request StartPurchaseRequest + * @return Async Task will return StartPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> StartPurchaseAsync(final StartPurchaseRequest request) { @@ -4708,6 +5030,8 @@ public PlayFabResult call() throws Exception { /** * Creates an order for a list of items from the title catalog + * @param request StartPurchaseRequest + * @return StartPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult StartPurchase(final StartPurchaseRequest request) { @@ -4754,6 +5078,8 @@ private static PlayFabResult privateStartPurchaseAsync(fina /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractUserVirtualCurrencyAsync(final SubtractUserVirtualCurrencyRequest request) { @@ -4766,6 +5092,8 @@ public PlayFabResult call() throws Exception { /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractUserVirtualCurrency(final SubtractUserVirtualCurrencyRequest request) { @@ -4811,7 +5139,9 @@ private static PlayFabResult privateSubtractUse } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) { @@ -4823,7 +5153,9 @@ public PlayFabResult call() throws Exception { } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerInstance(final UnlockContainerInstanceRequest request) { @@ -4841,7 +5173,7 @@ public PlayFabResult call() throws Exception { } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) throws Exception { @@ -4869,7 +5201,9 @@ private static PlayFabResult privateUnlockContainerIn } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerItemAsync(final UnlockContainerItemRequest request) { @@ -4881,7 +5215,9 @@ public PlayFabResult call() throws Exception { } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerItem(final UnlockContainerItemRequest request) { @@ -4899,7 +5235,7 @@ public PlayFabResult call() throws Exception { } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerItemAsync(final UnlockContainerItemRequest request) throws Exception { @@ -4928,6 +5264,8 @@ private static PlayFabResult privateUnlockContainerIt /** * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return Async Task will return AddFriendResult */ @SuppressWarnings("unchecked") public static FutureTask> AddFriendAsync(final AddFriendRequest request) { @@ -4940,6 +5278,8 @@ public PlayFabResult call() throws Exception { /** * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return AddFriendResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddFriend(final AddFriendRequest request) { @@ -4986,6 +5326,8 @@ private static PlayFabResult privateAddFriendAsync(final AddFri /** * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return Async Task will return GetFriendsListResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendsListAsync(final GetFriendsListRequest request) { @@ -4998,6 +5340,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return GetFriendsListResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendsList(final GetFriendsListRequest request) { @@ -5044,6 +5388,8 @@ private static PlayFabResult privateGetFriendsListAsync(fi /** * Removes a specified user from the friend list of the local user + * @param request RemoveFriendRequest + * @return Async Task will return RemoveFriendResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveFriendAsync(final RemoveFriendRequest request) { @@ -5056,6 +5402,8 @@ public PlayFabResult call() throws Exception { /** * Removes a specified user from the friend list of the local user + * @param request RemoveFriendRequest + * @return RemoveFriendResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveFriend(final RemoveFriendRequest request) { @@ -5102,6 +5450,8 @@ private static PlayFabResult privateRemoveFriendAsync(final /** * Updates the tag list for a specified user in the friend list of the local user + * @param request SetFriendTagsRequest + * @return Async Task will return SetFriendTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetFriendTagsAsync(final SetFriendTagsRequest request) { @@ -5114,6 +5464,8 @@ public PlayFabResult call() throws Exception { /** * Updates the tag list for a specified user in the friend list of the local user + * @param request SetFriendTagsRequest + * @return SetFriendTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetFriendTags(final SetFriendTagsRequest request) { @@ -5160,6 +5512,8 @@ private static PlayFabResult privateSetFriendTagsAsync(fina /** * Registers the iOS device to receive push notifications + * @param request RegisterForIOSPushNotificationRequest + * @return Async Task will return RegisterForIOSPushNotificationResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterForIOSPushNotificationAsync(final RegisterForIOSPushNotificationRequest request) { @@ -5172,6 +5526,8 @@ public PlayFabResult call() throws Excepti /** * Registers the iOS device to receive push notifications + * @param request RegisterForIOSPushNotificationRequest + * @return RegisterForIOSPushNotificationResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterForIOSPushNotification(final RegisterForIOSPushNotificationRequest request) { @@ -5218,6 +5574,8 @@ private static PlayFabResult privateRegist /** * Restores all in-app purchases based on the given restore receipt + * @param request RestoreIOSPurchasesRequest + * @return Async Task will return RestoreIOSPurchasesResult */ @SuppressWarnings("unchecked") public static FutureTask> RestoreIOSPurchasesAsync(final RestoreIOSPurchasesRequest request) { @@ -5230,6 +5588,8 @@ public PlayFabResult call() throws Exception { /** * Restores all in-app purchases based on the given restore receipt + * @param request RestoreIOSPurchasesRequest + * @return RestoreIOSPurchasesResult */ @SuppressWarnings("unchecked") public static PlayFabResult RestoreIOSPurchases(final RestoreIOSPurchasesRequest request) { @@ -5276,6 +5636,8 @@ private static PlayFabResult privateRestoreIOSPurchas /** * Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateIOSReceiptRequest + * @return Async Task will return ValidateIOSReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateIOSReceiptAsync(final ValidateIOSReceiptRequest request) { @@ -5288,6 +5650,8 @@ public PlayFabResult call() throws Exception { /** * Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateIOSReceiptRequest + * @return ValidateIOSReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateIOSReceipt(final ValidateIOSReceiptRequest request) { @@ -5334,6 +5698,8 @@ private static PlayFabResult privateValidateIOSReceipt /** * Get details about all current running game servers matching the given parameters. + * @param request CurrentGamesRequest + * @return Async Task will return CurrentGamesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCurrentGamesAsync(final CurrentGamesRequest request) { @@ -5346,6 +5712,8 @@ public PlayFabResult call() throws Exception { /** * Get details about all current running game servers matching the given parameters. + * @param request CurrentGamesRequest + * @return CurrentGamesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCurrentGames(final CurrentGamesRequest request) { @@ -5391,7 +5759,9 @@ private static PlayFabResult privateGetCurrentGamesAsync(fin } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. + * @param request GameServerRegionsRequest + * @return Async Task will return GameServerRegionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetGameServerRegionsAsync(final GameServerRegionsRequest request) { @@ -5403,7 +5773,9 @@ public PlayFabResult call() throws Exception { } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. + * @param request GameServerRegionsRequest + * @return GameServerRegionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetGameServerRegions(final GameServerRegionsRequest request) { @@ -5421,7 +5793,7 @@ public PlayFabResult call() throws Exception { } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. */ @SuppressWarnings("unchecked") private static PlayFabResult privateGetGameServerRegionsAsync(final GameServerRegionsRequest request) throws Exception { @@ -5450,6 +5822,8 @@ private static PlayFabResult privateGetGameServerRegion /** * 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. + * @param request MatchmakeRequest + * @return Async Task will return MatchmakeResult */ @SuppressWarnings("unchecked") public static FutureTask> MatchmakeAsync(final MatchmakeRequest request) { @@ -5462,6 +5836,8 @@ public PlayFabResult call() throws Exception { /** * 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. + * @param request MatchmakeRequest + * @return MatchmakeResult */ @SuppressWarnings("unchecked") public static PlayFabResult Matchmake(final MatchmakeRequest request) { @@ -5508,6 +5884,8 @@ private static PlayFabResult privateMatchmakeAsync(final Matchm /** * Start a new game server with a given configuration, add the current player and return the connection information. + * @param request StartGameRequest + * @return Async Task will return StartGameResult */ @SuppressWarnings("unchecked") public static FutureTask> StartGameAsync(final StartGameRequest request) { @@ -5520,6 +5898,8 @@ public PlayFabResult call() throws Exception { /** * Start a new game server with a given configuration, add the current player and return the connection information. + * @param request StartGameRequest + * @return StartGameResult */ @SuppressWarnings("unchecked") public static PlayFabResult StartGame(final StartGameRequest request) { @@ -5566,6 +5946,8 @@ private static PlayFabResult privateStartGameAsync(final StartG /** * Registers the Android device to receive push notifications + * @param request AndroidDevicePushNotificationRegistrationRequest + * @return Async Task will return AndroidDevicePushNotificationRegistrationResult */ @SuppressWarnings("unchecked") public static FutureTask> AndroidDevicePushNotificationRegistrationAsync(final AndroidDevicePushNotificationRegistrationRequest request) { @@ -5578,6 +5960,8 @@ public PlayFabResult call() thr /** * Registers the Android device to receive push notifications + * @param request AndroidDevicePushNotificationRegistrationRequest + * @return AndroidDevicePushNotificationRegistrationResult */ @SuppressWarnings("unchecked") public static PlayFabResult AndroidDevicePushNotificationRegistration(final AndroidDevicePushNotificationRegistrationRequest request) { @@ -5624,6 +6008,8 @@ private static PlayFabResult pr /** * Validates a Google Play purchase and gives the corresponding item to the player. + * @param request ValidateGooglePlayPurchaseRequest + * @return Async Task will return ValidateGooglePlayPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateGooglePlayPurchaseAsync(final ValidateGooglePlayPurchaseRequest request) { @@ -5636,6 +6022,8 @@ public PlayFabResult call() throws Exception { /** * Validates a Google Play purchase and gives the corresponding item to the player. + * @param request ValidateGooglePlayPurchaseRequest + * @return ValidateGooglePlayPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateGooglePlayPurchase(final ValidateGooglePlayPurchaseRequest request) { @@ -5682,6 +6070,8 @@ private static PlayFabResult privateValidateGo /** * Writes a character-based event into PlayStream. + * @param request WriteClientCharacterEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteCharacterEventAsync(final WriteClientCharacterEventRequest request) { @@ -5694,6 +6084,8 @@ public PlayFabResult call() throws Exception { /** * Writes a character-based event into PlayStream. + * @param request WriteClientCharacterEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteCharacterEvent(final WriteClientCharacterEventRequest request) { @@ -5740,6 +6132,8 @@ private static PlayFabResult privateWriteCharacterEventAsync /** * Writes a player-based event into PlayStream. + * @param request WriteClientPlayerEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WritePlayerEventAsync(final WriteClientPlayerEventRequest request) { @@ -5752,6 +6146,8 @@ public PlayFabResult call() throws Exception { /** * Writes a player-based event into PlayStream. + * @param request WriteClientPlayerEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WritePlayerEvent(final WriteClientPlayerEventRequest request) { @@ -5798,6 +6194,8 @@ private static PlayFabResult privateWritePlayerEventAsync(fi /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteTitleEventAsync(final WriteTitleEventRequest request) { @@ -5810,6 +6208,8 @@ public PlayFabResult call() throws Exception { /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteTitleEvent(final WriteTitleEventRequest request) { @@ -5856,6 +6256,8 @@ private static PlayFabResult privateWriteTitleEventAsync(fin /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. + * @param request AddSharedGroupMembersRequest + * @return Async Task will return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> AddSharedGroupMembersAsync(final AddSharedGroupMembersRequest request) { @@ -5868,6 +6270,8 @@ public PlayFabResult call() throws Exception { /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. + * @param request AddSharedGroupMembersRequest + * @return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddSharedGroupMembers(final AddSharedGroupMembersRequest request) { @@ -5914,6 +6318,8 @@ private static PlayFabResult privateAddSharedGroupM /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. + * @param request CreateSharedGroupRequest + * @return Async Task will return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateSharedGroupAsync(final CreateSharedGroupRequest request) { @@ -5926,6 +6332,8 @@ public PlayFabResult call() throws Exception { /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. + * @param request CreateSharedGroupRequest + * @return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateSharedGroup(final CreateSharedGroupRequest request) { @@ -5972,6 +6380,8 @@ private static PlayFabResult privateCreateSharedGroupAs /** * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. + * @param request GetSharedGroupDataRequest + * @return Async Task will return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetSharedGroupDataAsync(final GetSharedGroupDataRequest request) { @@ -5984,6 +6394,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. + * @param request GetSharedGroupDataRequest + * @return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetSharedGroupData(final GetSharedGroupDataRequest request) { @@ -6030,6 +6442,8 @@ private static PlayFabResult privateGetSharedGroupData /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return Async Task will return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveSharedGroupMembersAsync(final RemoveSharedGroupMembersRequest request) { @@ -6042,6 +6456,8 @@ public PlayFabResult call() throws Exception { /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveSharedGroupMembers(final RemoveSharedGroupMembersRequest request) { @@ -6088,6 +6504,8 @@ private static PlayFabResult privateRemoveShared /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. + * @param request UpdateSharedGroupDataRequest + * @return Async Task will return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateSharedGroupDataAsync(final UpdateSharedGroupDataRequest request) { @@ -6100,6 +6518,8 @@ public PlayFabResult call() throws Exception { /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. + * @param request UpdateSharedGroupDataRequest + * @return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateSharedGroupData(final UpdateSharedGroupDataRequest request) { @@ -6146,6 +6566,8 @@ private static PlayFabResult privateUpdateSharedGro /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. + * @param request ExecuteCloudScriptRequest + * @return Async Task will return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static FutureTask> ExecuteCloudScriptAsync(final ExecuteCloudScriptRequest request) { @@ -6158,6 +6580,8 @@ public PlayFabResult call() throws Exception { /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. + * @param request ExecuteCloudScriptRequest + * @return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ExecuteCloudScript(final ExecuteCloudScriptRequest request) { @@ -6204,6 +6628,8 @@ private static PlayFabResult privateExecuteCloudScript /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return Async Task will return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentDownloadUrlAsync(final GetContentDownloadUrlRequest request) { @@ -6216,6 +6642,8 @@ public PlayFabResult call() throws Exception { /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentDownloadUrl(final GetContentDownloadUrlRequest request) { @@ -6262,6 +6690,8 @@ private static PlayFabResult privateGetContentDownl /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return Async Task will return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllUsersCharactersAsync(final ListUsersCharactersRequest request) { @@ -6274,6 +6704,8 @@ public PlayFabResult call() throws Exception { /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllUsersCharacters(final ListUsersCharactersRequest request) { @@ -6320,6 +6752,8 @@ private static PlayFabResult privateGetAllUsersCharac /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return Async Task will return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterLeaderboardAsync(final GetCharacterLeaderboardRequest request) { @@ -6332,6 +6766,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterLeaderboard(final GetCharacterLeaderboardRequest request) { @@ -6378,6 +6814,8 @@ private static PlayFabResult privateGetCharacterL /** * Retrieves the details of all title-specific statistics for the user + * @param request GetCharacterStatisticsRequest + * @return Async Task will return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterStatisticsAsync(final GetCharacterStatisticsRequest request) { @@ -6390,6 +6828,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details of all title-specific statistics for the user + * @param request GetCharacterStatisticsRequest + * @return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterStatistics(final GetCharacterStatisticsRequest request) { @@ -6436,6 +6876,8 @@ private static PlayFabResult privateGetCharacterSt /** * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID + * @param request GetLeaderboardAroundCharacterRequest + * @return Async Task will return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundCharacterAsync(final GetLeaderboardAroundCharacterRequest request) { @@ -6448,6 +6890,8 @@ public PlayFabResult call() throws Exceptio /** * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID + * @param request GetLeaderboardAroundCharacterRequest + * @return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundCharacter(final GetLeaderboardAroundCharacterRequest request) { @@ -6494,6 +6938,8 @@ private static PlayFabResult privateGetLead /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return Async Task will return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardForUserCharactersAsync(final GetLeaderboardForUsersCharactersRequest request) { @@ -6506,6 +6952,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardForUserCharacters(final GetLeaderboardForUsersCharactersRequest request) { @@ -6552,6 +7000,8 @@ private static PlayFabResult privateGetL /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return Async Task will return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantCharacterToUserAsync(final GrantCharacterToUserRequest request) { @@ -6564,6 +7014,8 @@ public PlayFabResult call() throws Exception { /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantCharacterToUser(final GrantCharacterToUserRequest request) { @@ -6609,7 +7061,9 @@ private static PlayFabResult privateGrantCharacterTo } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdateCharacterStatisticsRequest + * @return Async Task will return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) { @@ -6621,7 +7075,9 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdateCharacterStatisticsRequest + * @return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterStatistics(final UpdateCharacterStatisticsRequest request) { @@ -6639,7 +7095,7 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) throws Exception { @@ -6668,6 +7124,8 @@ private static PlayFabResult privateUpdateChara /** * Retrieves the title-specific custom data for the character which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterDataAsync(final GetCharacterDataRequest request) { @@ -6680,6 +7138,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the character which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterData(final GetCharacterDataRequest request) { @@ -6726,6 +7186,8 @@ private static PlayFabResult privateGetCharacterDataAsyn /** * Retrieves the title-specific custom data for the character which can only be read by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterReadOnlyDataAsync(final GetCharacterDataRequest request) { @@ -6738,6 +7200,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the character which can only be read by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterReadOnlyData(final GetCharacterDataRequest request) { @@ -6784,6 +7248,8 @@ private static PlayFabResult privateGetCharacterReadOnly /** * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterDataAsync(final UpdateCharacterDataRequest request) { @@ -6796,6 +7262,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterData(final UpdateCharacterDataRequest request) { @@ -6842,6 +7310,8 @@ private static PlayFabResult privateUpdateCharacterDa /** * Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateAmazonReceiptRequest + * @return Async Task will return ValidateAmazonReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateAmazonIAPReceiptAsync(final ValidateAmazonReceiptRequest request) { @@ -6854,6 +7324,8 @@ public PlayFabResult call() throws Exception { /** * Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateAmazonReceiptRequest + * @return ValidateAmazonReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateAmazonIAPReceipt(final ValidateAmazonReceiptRequest request) { @@ -6900,6 +7372,8 @@ private static PlayFabResult privateValidateAmazonI /** * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories. + * @param request AcceptTradeRequest + * @return Async Task will return AcceptTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> AcceptTradeAsync(final AcceptTradeRequest request) { @@ -6912,6 +7386,8 @@ public PlayFabResult call() throws Exception { /** * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories. + * @param request AcceptTradeRequest + * @return AcceptTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult AcceptTrade(final AcceptTradeRequest request) { @@ -6958,6 +7434,8 @@ private static PlayFabResult privateAcceptTradeAsync(final /** * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player). + * @param request CancelTradeRequest + * @return Async Task will return CancelTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> CancelTradeAsync(final CancelTradeRequest request) { @@ -6970,6 +7448,8 @@ public PlayFabResult call() throws Exception { /** * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player). + * @param request CancelTradeRequest + * @return CancelTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult CancelTrade(final CancelTradeRequest request) { @@ -7016,6 +7496,8 @@ private static PlayFabResult privateCancelTradeAsync(final /** * Gets all trades the player has either opened or accepted, optionally filtered by trade status. + * @param request GetPlayerTradesRequest + * @return Async Task will return GetPlayerTradesResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTradesAsync(final GetPlayerTradesRequest request) { @@ -7028,6 +7510,8 @@ public PlayFabResult call() throws Exception { /** * Gets all trades the player has either opened or accepted, optionally filtered by trade status. + * @param request GetPlayerTradesRequest + * @return GetPlayerTradesResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTrades(final GetPlayerTradesRequest request) { @@ -7074,6 +7558,8 @@ private static PlayFabResult privateGetPlayerTradesAsyn /** * Gets the current status of an existing trade. + * @param request GetTradeStatusRequest + * @return Async Task will return GetTradeStatusResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetTradeStatusAsync(final GetTradeStatusRequest request) { @@ -7086,6 +7572,8 @@ public PlayFabResult call() throws Exception { /** * Gets the current status of an existing trade. + * @param request GetTradeStatusRequest + * @return GetTradeStatusResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetTradeStatus(final GetTradeStatusRequest request) { @@ -7132,6 +7620,8 @@ private static PlayFabResult privateGetTradeStatusAsync( /** * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time. + * @param request OpenTradeRequest + * @return Async Task will return OpenTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> OpenTradeAsync(final OpenTradeRequest request) { @@ -7144,6 +7634,8 @@ public PlayFabResult call() throws Exception { /** * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time. + * @param request OpenTradeRequest + * @return OpenTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult OpenTrade(final OpenTradeRequest request) { @@ -7190,6 +7682,8 @@ private static PlayFabResult privateOpenTradeAsync(final Open /** * Attributes an install for advertisment. + * @param request AttributeInstallRequest + * @return Async Task will return AttributeInstallResult */ @SuppressWarnings("unchecked") public static FutureTask> AttributeInstallAsync(final AttributeInstallRequest request) { @@ -7202,6 +7696,8 @@ public PlayFabResult call() throws Exception { /** * Attributes an install for advertisment. + * @param request AttributeInstallRequest + * @return AttributeInstallResult */ @SuppressWarnings("unchecked") public static PlayFabResult AttributeInstall(final AttributeInstallRequest request) { @@ -7250,6 +7746,8 @@ private static PlayFabResult privateAttributeInstallAsyn /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayerSegmentsRequest + * @return Async Task will return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerSegmentsAsync(final GetPlayerSegmentsRequest request) { @@ -7262,6 +7760,8 @@ public PlayFabResult call() throws Exception { /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayerSegmentsRequest + * @return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerSegments(final GetPlayerSegmentsRequest request) { @@ -7308,6 +7808,8 @@ private static PlayFabResult privateGetPlayerSegmentsAs /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return Async Task will return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTagsAsync(final GetPlayerTagsRequest request) { @@ -7320,6 +7822,8 @@ public PlayFabResult call() throws Exception { /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTags(final GetPlayerTagsRequest request) { @@ -7366,6 +7870,8 @@ private static PlayFabResult privateGetPlayerTagsAsync(fina /** * Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateWindowsReceiptRequest + * @return Async Task will return ValidateWindowsReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateWindowsStoreReceiptAsync(final ValidateWindowsReceiptRequest request) { @@ -7378,6 +7884,8 @@ public PlayFabResult call() throws Exception { /** * Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateWindowsReceiptRequest + * @return ValidateWindowsReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateWindowsStoreReceipt(final ValidateWindowsReceiptRequest request) { diff --git a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientModels.java b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientModels.java index d2b0f010f..8bc68cf60 100644 --- a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientModels.java +++ b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabClientModels.java @@ -436,7 +436,7 @@ public static enum CloudScriptRevisionOption { } /** - * Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection. + * Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection. */ public static class CollectionFilter { /** @@ -1193,7 +1193,7 @@ public static class GameServerRegionsRequest { */ public String BuildVersion; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; @@ -1434,6 +1434,14 @@ public static class GetFriendLeaderboardAroundPlayerRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1478,6 +1486,14 @@ public static class GetFriendLeaderboardRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1546,6 +1562,14 @@ public static class GetLeaderboardAroundPlayerRequest { * Maximum number of entries to retrieve. Default 10, maximum 100. */ public Integer MaxResultsCount; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1602,6 +1626,14 @@ public static class GetLeaderboardRequest { * Maximum number of entries to retrieve. Default 10, maximum 100. */ public Integer MaxResultsCount; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1643,7 +1675,7 @@ public static class GetPhotonAuthenticationTokenResult { public static class GetPlayerCombinedInfoRequest { /** - * PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. + * PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. */ public String PlayFabId; /** @@ -1980,7 +2012,7 @@ public static class GetPlayFabIDsFromTwitchIDsResult { public static class GetPublisherDataRequest { /** - * array of keys to get back data from the Publisher data blob, set by the admin tools + * array of keys to get back data from the Publisher data blob, set by the admin tools */ public ArrayList Keys; @@ -2024,7 +2056,7 @@ public static class GetPurchaseResult { */ public Date PurchaseDate; /** - * @deprecated Please use instead. + * @deprecated Please use instead. */ @Deprecated public ArrayList Items; @@ -2227,7 +2259,7 @@ public static class GetUserInventoryResult { public static class GetWindowsHelloChallengeRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2688,7 +2720,7 @@ public static class LoginResult { public static class LoginWithAndroidDeviceIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2716,7 +2748,7 @@ public static class LoginWithAndroidDeviceIDRequest { public static class LoginWithCustomIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2727,6 +2759,14 @@ public static class LoginWithCustomIDRequest { * Automatically create a PlayFab account if one is not currently linked to this Custom ID. */ public Boolean CreateAccount; + /** + * Player secret that is used to verify API request signatures + */ + public String PlayerSecret; + /** + * Base64 encoded body that is encrypted with the Title's public RSA key + */ + public String EncryptedRequest; /** * Flags for which pieces of info to return for the user. */ @@ -2736,7 +2776,7 @@ public static class LoginWithCustomIDRequest { public static class LoginWithEmailAddressRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2756,7 +2796,7 @@ public static class LoginWithEmailAddressRequest { public static class LoginWithFacebookRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2776,7 +2816,7 @@ public static class LoginWithFacebookRequest { public static class LoginWithGameCenterRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2796,7 +2836,7 @@ public static class LoginWithGameCenterRequest { public static class LoginWithGoogleAccountRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2816,7 +2856,7 @@ public static class LoginWithGoogleAccountRequest { public static class LoginWithIOSDeviceIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2844,7 +2884,7 @@ public static class LoginWithIOSDeviceIDRequest { public static class LoginWithKongregateRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2868,7 +2908,7 @@ public static class LoginWithKongregateRequest { public static class LoginWithPlayFabRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2888,7 +2928,7 @@ public static class LoginWithPlayFabRequest { public static class LoginWithSteamRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2908,7 +2948,7 @@ public static class LoginWithSteamRequest { public static class LoginWithTwitchRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2928,7 +2968,7 @@ public static class LoginWithTwitchRequest { public static class LoginWithWindowsHelloRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3489,7 +3529,7 @@ public static class RegisterForIOSPushNotificationResult { public static class RegisterPlayFabUserRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3537,7 +3577,7 @@ public static class RegisterPlayFabUserResult { public static class RegisterWithWindowsHelloRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3657,7 +3697,7 @@ public static class SendAccountRecoveryEmailRequest { */ public String Email; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; diff --git a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabErrors.java b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabErrors.java index deba6e253..57673eed3 100644 --- a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabErrors.java +++ b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabErrors.java @@ -288,7 +288,15 @@ public static enum PlayFabErrorCode { ExpressionInvokeFailure(1285), ExpressionTooLong(1286), DataUpdateRateExceeded(1287), - RestrictedEmailDomain(1288); + RestrictedEmailDomain(1288), + EncryptionKeyDisabled(1289), + EncryptionKeyMissing(1290), + EncryptionKeyBroken(1291), + NoSharedSecretKeyConfigured(1292), + SecretKeyNotFound(1293), + PlayerSecretAlreadyConfigured(1294), + APIRequestsDisabledForTitle(1295), + InvalidSharedSecretKey(1296); public int id; diff --git a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabSettings.java b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabSettings.java index f0652fead..d928c3594 100644 --- a/PlayFabClientSDK/src/main/java/com/playfab/PlayFabSettings.java +++ b/PlayFabClientSDK/src/main/java/com/playfab/PlayFabSettings.java @@ -3,9 +3,9 @@ import com.playfab.PlayFabErrors.ErrorCallback; public class PlayFabSettings { - public static String SdkVersion = "0.46.170313"; - public static String BuildIdentifier = "javasdk_manual"; - public static String SdkVersionString = "JavaSDK-0.46.170313"; + public static String SdkVersion = "0.47.170403"; + public static String BuildIdentifier = "jbuild_javasdk_1"; + public static String SdkVersionString = "JavaSDK-0.47.170403"; public static String TitleId = null; // You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) public static ErrorCallback GlobalErrorHandler; diff --git a/PlayFabClientSDK/src/test/java/com/playfab/test/PlayFabApiTest.java b/PlayFabClientSDK/src/test/java/com/playfab/test/PlayFabApiTest.java index 9d1be3f36..1da088df4 100644 --- a/PlayFabClientSDK/src/test/java/com/playfab/test/PlayFabApiTest.java +++ b/PlayFabClientSDK/src/test/java/com/playfab/test/PlayFabApiTest.java @@ -174,7 +174,7 @@ public void LoginWithAdvertisingId() * Test a sequence of calls that modifies saved data, * and verifies that the next sequential API call contains updated data. * Verify that the data is correctly modified on the next call. - * Parameter types tested: string, Dictionary, DateTime + * Parameter types tested: string, Dictionary(string, string), DateTime */ @Test public void UserDataApi() @@ -220,7 +220,7 @@ public void UserDataApi() * Test a sequence of calls that modifies saved data, * and verifies that the next sequential API call contains updated data. * Verify that the data is saved correctly, and that specific types are tested - * Parameter types tested: Dictionary + * Parameter types tested: Dictionary(string,int) */ @Test public void PlayerStatisticsApi() diff --git a/PlayFabSDK/pom.xml b/PlayFabSDK/pom.xml index 3080deb3c..b8b4e2c70 100644 --- a/PlayFabSDK/pom.xml +++ b/PlayFabSDK/pom.xml @@ -4,7 +4,7 @@ 2016 com.playfab combo-sdk - 0.46.170313-SNAPSHOT + 0.47.170403 PlayFab Combo API PlayFab is the unified backend platform for games — everything you need to build and operate your game, all in one place, so you can focus on creating and delivering a great player experience. http://api.playfab.com/ @@ -37,29 +37,6 @@ 1.7 - - - - com.google.code.gson - gson - 2.8.0 - - - junit - junit - 4.12 - test - - - - - org.assertj - assertj-core - 3.6.2 - test - - - junit @@ -92,6 +69,11 @@ ${javaLanguage.version} + + org.apache.maven.plugins + maven-surefire-plugin + 2.19.1 + @@ -108,8 +90,28 @@ sign-artifacts verify - sign + sign-and-deploy-file + + + 4A496164 + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + pom.xml + ${project.artifactId} + ${project.groupId} + ${project.version} + target/${project.artifactId}-${project.version}.jar + + target/${project.artifactId}-${project.version}-sources.jar,target/${project.artifactId}-${project.version}-javadoc.jar + + jar,jar + sources,javadoc + ossrh + + --armor + --detach-sig + + @@ -136,9 +138,23 @@ jar + + true + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.3 + true + + ossrh + https://oss.sonatype.org/ + false + + @@ -221,8 +237,10 @@ - nexus - https://oss.sonatype.org/content/repositories/snapshots/ + ossrh + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminAPI.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminAPI.java index a480c1326..68d2fc299 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminAPI.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminAPI.java @@ -18,6 +18,8 @@ public class PlayFabAdminAPI { /** * Gets the requested policy. + * @param request GetPolicyRequest + * @return Async Task will return GetPolicyResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetPolicyAsync(final GetPolicyRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception { /** * Gets the requested policy. + * @param request GetPolicyRequest + * @return GetPolicyResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetPolicy(final GetPolicyRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateGetPolicyAsync(final GetP /** * Changes a policy for a title + * @param request UpdatePolicyRequest + * @return Async Task will return UpdatePolicyResponse */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePolicyAsync(final UpdatePolicyRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Changes a policy for a title + * @param request UpdatePolicyRequest + * @return UpdatePolicyResponse */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePolicy(final UpdatePolicyRequest request) { @@ -134,6 +142,8 @@ private static PlayFabResult privateUpdatePolicyAsync(fina /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return Async Task will return BanUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> BanUsersAsync(final BanUsersRequest request) { @@ -146,6 +156,8 @@ public PlayFabResult call() throws Exception { /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return BanUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult BanUsers(final BanUsersRequest request) { @@ -192,6 +204,8 @@ private static PlayFabResult privateBanUsersAsync(final BanUsers /** * Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier + * @param request LookupUserAccountInfoRequest + * @return Async Task will return LookupUserAccountInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserAccountInfoAsync(final LookupUserAccountInfoRequest request) { @@ -204,6 +218,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier + * @param request LookupUserAccountInfoRequest + * @return LookupUserAccountInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserAccountInfo(final LookupUserAccountInfoRequest request) { @@ -250,6 +266,8 @@ private static PlayFabResult privateGetUserAccountI /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return Async Task will return GetUserBansResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserBansAsync(final GetUserBansRequest request) { @@ -262,6 +280,8 @@ public PlayFabResult call() throws Exception { /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return GetUserBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserBans(final GetUserBansRequest request) { @@ -308,6 +328,8 @@ private static PlayFabResult privateGetUserBansAsync(final Ge /** * Resets all title-specific information about a particular account, including user data, virtual currency balances, inventory, purchase history, and statistics + * @param request ResetUsersRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> ResetUsersAsync(final ResetUsersRequest request) { @@ -320,6 +342,8 @@ public PlayFabResult call() throws Exception { /** * Resets all title-specific information about a particular account, including user data, virtual currency balances, inventory, purchase history, and statistics + * @param request ResetUsersRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult ResetUsers(final ResetUsersRequest request) { @@ -366,6 +390,8 @@ private static PlayFabResult privateResetUsersAsync(final ResetUser /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return Async Task will return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeAllBansForUserAsync(final RevokeAllBansForUserRequest request) { @@ -378,6 +404,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeAllBansForUser(final RevokeAllBansForUserRequest request) { @@ -424,6 +452,8 @@ private static PlayFabResult privateRevokeAllBansFor /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return Async Task will return RevokeBansResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeBansAsync(final RevokeBansRequest request) { @@ -436,6 +466,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return RevokeBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeBans(final RevokeBansRequest request) { @@ -482,6 +514,8 @@ private static PlayFabResult privateRevokeBansAsync(final Revo /** * Forces an email to be sent to the registered email address for the specified account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return Async Task will return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static FutureTask> SendAccountRecoveryEmailAsync(final SendAccountRecoveryEmailRequest request) { @@ -494,6 +528,8 @@ public PlayFabResult call() throws Exception { /** * Forces an email to be sent to the registered email address for the specified account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static PlayFabResult SendAccountRecoveryEmail(final SendAccountRecoveryEmailRequest request) { @@ -540,6 +576,8 @@ private static PlayFabResult privateSendAccountR /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return Async Task will return UpdateBansResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateBansAsync(final UpdateBansRequest request) { @@ -552,6 +590,8 @@ public PlayFabResult call() throws Exception { /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return UpdateBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateBans(final UpdateBansRequest request) { @@ -598,6 +638,8 @@ private static PlayFabResult privateUpdateBansAsync(final Upda /** * Updates the title specific display name for a user + * @param request UpdateUserTitleDisplayNameRequest + * @return Async Task will return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserTitleDisplayNameAsync(final UpdateUserTitleDisplayNameRequest request) { @@ -610,6 +652,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title specific display name for a user + * @param request UpdateUserTitleDisplayNameRequest + * @return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserTitleDisplayName(final UpdateUserTitleDisplayNameRequest request) { @@ -656,6 +700,8 @@ private static PlayFabResult privateUpdateUser /** * Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method. + * @param request CreatePlayerStatisticDefinitionRequest + * @return Async Task will return CreatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static FutureTask> CreatePlayerStatisticDefinitionAsync(final CreatePlayerStatisticDefinitionRequest request) { @@ -668,6 +714,8 @@ public PlayFabResult call() throws Except /** * Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method. + * @param request CreatePlayerStatisticDefinitionRequest + * @return CreatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreatePlayerStatisticDefinition(final CreatePlayerStatisticDefinitionRequest request) { @@ -714,6 +762,8 @@ private static PlayFabResult privateCreat /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not remove the player's event history, login history, inventory items, nor virtual currencies. + * @param request DeleteUsersRequest + * @return Async Task will return DeleteUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteUsersAsync(final DeleteUsersRequest request) { @@ -726,6 +776,8 @@ public PlayFabResult call() throws Exception { /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not remove the player's event history, login history, inventory items, nor virtual currencies. + * @param request DeleteUsersRequest + * @return DeleteUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteUsers(final DeleteUsersRequest request) { @@ -772,6 +824,8 @@ private static PlayFabResult privateDeleteUsersAsync(final De /** * Retrieves a download URL for the requested report + * @param request GetDataReportRequest + * @return Async Task will return GetDataReportResult */ @SuppressWarnings("unchecked") public static FutureTask> GetDataReportAsync(final GetDataReportRequest request) { @@ -784,6 +838,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a download URL for the requested report + * @param request GetDataReportRequest + * @return GetDataReportResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetDataReport(final GetDataReportRequest request) { @@ -830,6 +886,8 @@ private static PlayFabResult privateGetDataReportAsync(fina /** * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval. + * @param request GetPlayerStatisticDefinitionsRequest + * @return Async Task will return GetPlayerStatisticDefinitionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticDefinitionsAsync(final GetPlayerStatisticDefinitionsRequest request) { @@ -842,6 +900,8 @@ public PlayFabResult call() throws Exceptio /** * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval. + * @param request GetPlayerStatisticDefinitionsRequest + * @return GetPlayerStatisticDefinitionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticDefinitions(final GetPlayerStatisticDefinitionsRequest request) { @@ -888,6 +948,8 @@ private static PlayFabResult privateGetPlay /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return Async Task will return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticVersionsAsync(final GetPlayerStatisticVersionsRequest request) { @@ -900,6 +962,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticVersions(final GetPlayerStatisticVersionsRequest request) { @@ -946,6 +1010,8 @@ private static PlayFabResult privateGetPlayerS /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserDataAsync(final GetUserDataRequest request) { @@ -958,6 +1024,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserData(final GetUserDataRequest request) { @@ -1004,6 +1072,8 @@ private static PlayFabResult privateGetUserDataAsync(final Ge /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInternalDataAsync(final GetUserDataRequest request) { @@ -1016,6 +1086,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInternalData(final GetUserDataRequest request) { @@ -1062,6 +1134,8 @@ private static PlayFabResult privateGetUserInternalDataAsync( /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherDataAsync(final GetUserDataRequest request) { @@ -1074,6 +1148,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherData(final GetUserDataRequest request) { @@ -1120,6 +1196,8 @@ private static PlayFabResult privateGetUserPublisherDataAsync /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherInternalDataAsync(final GetUserDataRequest request) { @@ -1132,6 +1210,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherInternalData(final GetUserDataRequest request) { @@ -1178,6 +1258,8 @@ private static PlayFabResult privateGetUserPublisherInternalD /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1190,6 +1272,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherReadOnlyData(final GetUserDataRequest request) { @@ -1236,6 +1320,8 @@ private static PlayFabResult privateGetUserPublisherReadOnlyD /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1248,6 +1334,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserReadOnlyData(final GetUserDataRequest request) { @@ -1294,6 +1382,8 @@ private static PlayFabResult privateGetUserReadOnlyDataAsync( /** * Resets the indicated statistic, removing all player entries for it and backing up the old values. + * @param request IncrementPlayerStatisticVersionRequest + * @return Async Task will return IncrementPlayerStatisticVersionResult */ @SuppressWarnings("unchecked") public static FutureTask> IncrementPlayerStatisticVersionAsync(final IncrementPlayerStatisticVersionRequest request) { @@ -1306,6 +1396,8 @@ public PlayFabResult call() throws Except /** * Resets the indicated statistic, removing all player entries for it and backing up the old values. + * @param request IncrementPlayerStatisticVersionRequest + * @return IncrementPlayerStatisticVersionResult */ @SuppressWarnings("unchecked") public static PlayFabResult IncrementPlayerStatisticVersion(final IncrementPlayerStatisticVersionRequest request) { @@ -1352,6 +1444,8 @@ private static PlayFabResult privateIncre /** * Attempts to process an order refund through the original real money payment provider. + * @param request RefundPurchaseRequest + * @return Async Task will return RefundPurchaseResponse */ @SuppressWarnings("unchecked") public static FutureTask> RefundPurchaseAsync(final RefundPurchaseRequest request) { @@ -1364,6 +1458,8 @@ public PlayFabResult call() throws Exception { /** * Attempts to process an order refund through the original real money payment provider. + * @param request RefundPurchaseRequest + * @return RefundPurchaseResponse */ @SuppressWarnings("unchecked") public static PlayFabResult RefundPurchase(final RefundPurchaseRequest request) { @@ -1410,6 +1506,8 @@ private static PlayFabResult privateRefundPurchaseAsync( /** * Completely removes all statistics for the specified user, for the current game + * @param request ResetUserStatisticsRequest + * @return Async Task will return ResetUserStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> ResetUserStatisticsAsync(final ResetUserStatisticsRequest request) { @@ -1422,6 +1520,8 @@ public PlayFabResult call() throws Exception { /** * Completely removes all statistics for the specified user, for the current game + * @param request ResetUserStatisticsRequest + * @return ResetUserStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult ResetUserStatistics(final ResetUserStatisticsRequest request) { @@ -1468,6 +1568,8 @@ private static PlayFabResult privateResetUserStatisti /** * Attempts to resolve a dispute with the original order's payment provider. + * @param request ResolvePurchaseDisputeRequest + * @return Async Task will return ResolvePurchaseDisputeResponse */ @SuppressWarnings("unchecked") public static FutureTask> ResolvePurchaseDisputeAsync(final ResolvePurchaseDisputeRequest request) { @@ -1480,6 +1582,8 @@ public PlayFabResult call() throws Exception { /** * Attempts to resolve a dispute with the original order's payment provider. + * @param request ResolvePurchaseDisputeRequest + * @return ResolvePurchaseDisputeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult ResolvePurchaseDispute(final ResolvePurchaseDisputeRequest request) { @@ -1526,6 +1630,8 @@ private static PlayFabResult privateResolvePurch /** * Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval. + * @param request UpdatePlayerStatisticDefinitionRequest + * @return Async Task will return UpdatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePlayerStatisticDefinitionAsync(final UpdatePlayerStatisticDefinitionRequest request) { @@ -1538,6 +1644,8 @@ public PlayFabResult call() throws Except /** * Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval. + * @param request UpdatePlayerStatisticDefinitionRequest + * @return UpdatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePlayerStatisticDefinition(final UpdatePlayerStatisticDefinitionRequest request) { @@ -1584,6 +1692,8 @@ private static PlayFabResult privateUpdat /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserDataAsync(final UpdateUserDataRequest request) { @@ -1596,6 +1706,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserData(final UpdateUserDataRequest request) { @@ -1642,6 +1754,8 @@ private static PlayFabResult privateUpdateUserDataAsync(fi /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1654,6 +1768,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserInternalData(final UpdateUserInternalDataRequest request) { @@ -1700,6 +1816,8 @@ private static PlayFabResult privateUpdateUserInternalData /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherDataAsync(final UpdateUserDataRequest request) { @@ -1712,6 +1830,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherData(final UpdateUserDataRequest request) { @@ -1758,6 +1878,8 @@ private static PlayFabResult privateUpdateUserPublisherDat /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1770,6 +1892,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherInternalData(final UpdateUserInternalDataRequest request) { @@ -1816,6 +1940,8 @@ private static PlayFabResult privateUpdateUserPublisherInt /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1828,6 +1954,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherReadOnlyData(final UpdateUserDataRequest request) { @@ -1874,6 +2002,8 @@ private static PlayFabResult privateUpdateUserPublisherRea /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1886,6 +2016,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserReadOnlyData(final UpdateUserDataRequest request) { @@ -1932,6 +2064,8 @@ private static PlayFabResult privateUpdateUserReadOnlyData /** * Adds a new news item to the title's news feed + * @param request AddNewsRequest + * @return Async Task will return AddNewsResult */ @SuppressWarnings("unchecked") public static FutureTask> AddNewsAsync(final AddNewsRequest request) { @@ -1944,6 +2078,8 @@ public PlayFabResult call() throws Exception { /** * Adds a new news item to the title's news feed + * @param request AddNewsRequest + * @return AddNewsResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddNews(final AddNewsRequest request) { @@ -1990,6 +2126,8 @@ private static PlayFabResult privateAddNewsAsync(final AddNewsReq /** * Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded. + * @param request AddVirtualCurrencyTypesRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> AddVirtualCurrencyTypesAsync(final AddVirtualCurrencyTypesRequest request) { @@ -2002,6 +2140,8 @@ public PlayFabResult call() throws Exception { /** * Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded. + * @param request AddVirtualCurrencyTypesRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddVirtualCurrencyTypes(final AddVirtualCurrencyTypesRequest request) { @@ -2048,6 +2188,8 @@ private static PlayFabResult privateAddVirtualCurrencyTypesAsync(fi /** * Deletes an existing virtual item store + * @param request DeleteStoreRequest + * @return Async Task will return DeleteStoreResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteStoreAsync(final DeleteStoreRequest request) { @@ -2060,6 +2202,8 @@ public PlayFabResult call() throws Exception { /** * Deletes an existing virtual item store + * @param request DeleteStoreRequest + * @return DeleteStoreResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteStore(final DeleteStoreRequest request) { @@ -2106,6 +2250,8 @@ private static PlayFabResult privateDeleteStoreAsync(final De /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return Async Task will return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCatalogItemsAsync(final GetCatalogItemsRequest request) { @@ -2118,6 +2264,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCatalogItems(final GetCatalogItemsRequest request) { @@ -2164,6 +2312,8 @@ private static PlayFabResult privateGetCatalogItemsAsync( /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return Async Task will return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPublisherDataAsync(final GetPublisherDataRequest request) { @@ -2176,6 +2326,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPublisherData(final GetPublisherDataRequest request) { @@ -2222,6 +2374,8 @@ private static PlayFabResult privateGetPublisherDataAsyn /** * Retrieves the random drop table configuration for the title + * @param request GetRandomResultTablesRequest + * @return Async Task will return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetRandomResultTablesAsync(final GetRandomResultTablesRequest request) { @@ -2234,6 +2388,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the random drop table configuration for the title + * @param request GetRandomResultTablesRequest + * @return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetRandomResultTables(final GetRandomResultTablesRequest request) { @@ -2280,6 +2436,8 @@ private static PlayFabResult privateGetRandomResult /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return Async Task will return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetStoreItemsAsync(final GetStoreItemsRequest request) { @@ -2292,6 +2450,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetStoreItems(final GetStoreItemsRequest request) { @@ -2338,6 +2498,8 @@ private static PlayFabResult privateGetStoreItemsAsync(fina /** * Retrieves the key-value store of custom title settings which can be read by the client + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleDataAsync(final GetTitleDataRequest request) { @@ -2350,6 +2512,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings which can be read by the client + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleData(final GetTitleDataRequest request) { @@ -2396,6 +2560,8 @@ private static PlayFabResult privateGetTitleDataAsync(final /** * Retrieves the key-value store of custom title settings which cannot be read by the client + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleInternalDataAsync(final GetTitleDataRequest request) { @@ -2408,6 +2574,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings which cannot be read by the client + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleInternalData(final GetTitleDataRequest request) { @@ -2454,6 +2622,8 @@ private static PlayFabResult privateGetTitleInternalDataAsyn /** * Retuns the list of all defined virtual currencies for the title + * @param request ListVirtualCurrencyTypesRequest + * @return Async Task will return ListVirtualCurrencyTypesResult */ @SuppressWarnings("unchecked") public static FutureTask> ListVirtualCurrencyTypesAsync(final ListVirtualCurrencyTypesRequest request) { @@ -2466,6 +2636,8 @@ public PlayFabResult call() throws Exception { /** * Retuns the list of all defined virtual currencies for the title + * @param request ListVirtualCurrencyTypesRequest + * @return ListVirtualCurrencyTypesResult */ @SuppressWarnings("unchecked") public static PlayFabResult ListVirtualCurrencyTypes(final ListVirtualCurrencyTypesRequest request) { @@ -2512,6 +2684,8 @@ private static PlayFabResult privateListVirtualC /** * Removes one or more virtual currencies from the set defined for the title. + * @param request RemoveVirtualCurrencyTypesRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveVirtualCurrencyTypesAsync(final RemoveVirtualCurrencyTypesRequest request) { @@ -2524,6 +2698,8 @@ public PlayFabResult call() throws Exception { /** * Removes one or more virtual currencies from the set defined for the title. + * @param request RemoveVirtualCurrencyTypesRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveVirtualCurrencyTypes(final RemoveVirtualCurrencyTypesRequest request) { @@ -2570,6 +2746,8 @@ private static PlayFabResult privateRemoveVirtualCurrencyTypesAsync /** * Creates the catalog configuration of all virtual goods for the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return Async Task will return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetCatalogItemsAsync(final UpdateCatalogItemsRequest request) { @@ -2582,6 +2760,8 @@ public PlayFabResult call() throws Exception { /** * Creates the catalog configuration of all virtual goods for the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetCatalogItems(final UpdateCatalogItemsRequest request) { @@ -2628,6 +2808,8 @@ private static PlayFabResult privateSetCatalogItemsAsy /** * Sets all the items in one virtual store + * @param request UpdateStoreItemsRequest + * @return Async Task will return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetStoreItemsAsync(final UpdateStoreItemsRequest request) { @@ -2640,6 +2822,8 @@ public PlayFabResult call() throws Exception { /** * Sets all the items in one virtual store + * @param request UpdateStoreItemsRequest + * @return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetStoreItems(final UpdateStoreItemsRequest request) { @@ -2686,6 +2870,8 @@ private static PlayFabResult privateSetStoreItemsAsync(f /** * Creates and updates the key-value store of custom title settings which can be read by the client + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleDataAsync(final SetTitleDataRequest request) { @@ -2698,6 +2884,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the key-value store of custom title settings which can be read by the client + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleData(final SetTitleDataRequest request) { @@ -2744,6 +2932,8 @@ private static PlayFabResult privateSetTitleDataAsync(final /** * Updates the key-value store of custom title settings which cannot be read by the client + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleInternalDataAsync(final SetTitleDataRequest request) { @@ -2756,6 +2946,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom title settings which cannot be read by the client + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleInternalData(final SetTitleDataRequest request) { @@ -2802,6 +2994,8 @@ private static PlayFabResult privateSetTitleInternalDataAsyn /** * Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported. + * @param request SetupPushNotificationRequest + * @return Async Task will return SetupPushNotificationResult */ @SuppressWarnings("unchecked") public static FutureTask> SetupPushNotificationAsync(final SetupPushNotificationRequest request) { @@ -2814,6 +3008,8 @@ public PlayFabResult call() throws Exception { /** * Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported. + * @param request SetupPushNotificationRequest + * @return SetupPushNotificationResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetupPushNotification(final SetupPushNotificationRequest request) { @@ -2860,6 +3056,8 @@ private static PlayFabResult privateSetupPushNotifi /** * Updates the catalog configuration for virtual goods in the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return Async Task will return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCatalogItemsAsync(final UpdateCatalogItemsRequest request) { @@ -2872,6 +3070,8 @@ public PlayFabResult call() throws Exception { /** * Updates the catalog configuration for virtual goods in the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCatalogItems(final UpdateCatalogItemsRequest request) { @@ -2918,6 +3118,8 @@ private static PlayFabResult privateUpdateCatalogItems /** * Updates the random drop table configuration for the title + * @param request UpdateRandomResultTablesRequest + * @return Async Task will return UpdateRandomResultTablesResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateRandomResultTablesAsync(final UpdateRandomResultTablesRequest request) { @@ -2930,6 +3132,8 @@ public PlayFabResult call() throws Exception { /** * Updates the random drop table configuration for the title + * @param request UpdateRandomResultTablesRequest + * @return UpdateRandomResultTablesResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateRandomResultTables(final UpdateRandomResultTablesRequest request) { @@ -2976,6 +3180,8 @@ private static PlayFabResult privateUpdateRandom /** * Updates an existing virtual item store with new or modified items + * @param request UpdateStoreItemsRequest + * @return Async Task will return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateStoreItemsAsync(final UpdateStoreItemsRequest request) { @@ -2988,6 +3194,8 @@ public PlayFabResult call() throws Exception { /** * Updates an existing virtual item store with new or modified items + * @param request UpdateStoreItemsRequest + * @return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateStoreItems(final UpdateStoreItemsRequest request) { @@ -3034,6 +3242,8 @@ private static PlayFabResult privateUpdateStoreItemsAsyn /** * Increments the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUserVirtualCurrencyAsync(final AddUserVirtualCurrencyRequest request) { @@ -3046,6 +3256,8 @@ public PlayFabResult call() throws Exception { /** * Increments the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUserVirtualCurrency(final AddUserVirtualCurrencyRequest request) { @@ -3092,6 +3304,8 @@ private static PlayFabResult privateAddUserVirt /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return Async Task will return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInventoryAsync(final GetUserInventoryRequest request) { @@ -3104,6 +3318,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInventory(final GetUserInventoryRequest request) { @@ -3150,6 +3366,8 @@ private static PlayFabResult privateGetUserInventoryAsyn /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return Async Task will return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToUsersAsync(final GrantItemsToUsersRequest request) { @@ -3162,6 +3380,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToUsers(final GrantItemsToUsersRequest request) { @@ -3208,6 +3428,8 @@ private static PlayFabResult privateGrantItemsToUsersAs /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return Async Task will return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeInventoryItemAsync(final RevokeInventoryItemRequest request) { @@ -3220,6 +3442,8 @@ public PlayFabResult call() throws Exception { /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeInventoryItem(final RevokeInventoryItemRequest request) { @@ -3266,6 +3490,8 @@ private static PlayFabResult privateRevokeInventoryItemAs /** * Decrements the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractUserVirtualCurrencyAsync(final SubtractUserVirtualCurrencyRequest request) { @@ -3278,6 +3504,8 @@ public PlayFabResult call() throws Exception { /** * Decrements the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractUserVirtualCurrency(final SubtractUserVirtualCurrencyRequest request) { @@ -3324,6 +3552,8 @@ private static PlayFabResult privateSubtractUse /** * Retrieves the details for a specific completed session, including links to standard out and standard error logs + * @param request GetMatchmakerGameInfoRequest + * @return Async Task will return GetMatchmakerGameInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetMatchmakerGameInfoAsync(final GetMatchmakerGameInfoRequest request) { @@ -3336,6 +3566,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details for a specific completed session, including links to standard out and standard error logs + * @param request GetMatchmakerGameInfoRequest + * @return GetMatchmakerGameInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetMatchmakerGameInfo(final GetMatchmakerGameInfoRequest request) { @@ -3382,6 +3614,8 @@ private static PlayFabResult privateGetMatchmakerGa /** * Retrieves the details of defined game modes for the specified game server executable + * @param request GetMatchmakerGameModesRequest + * @return Async Task will return GetMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetMatchmakerGameModesAsync(final GetMatchmakerGameModesRequest request) { @@ -3394,6 +3628,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details of defined game modes for the specified game server executable + * @param request GetMatchmakerGameModesRequest + * @return GetMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetMatchmakerGameModes(final GetMatchmakerGameModesRequest request) { @@ -3440,6 +3676,8 @@ private static PlayFabResult privateGetMatchmakerG /** * Updates the game server mode details for the specified game server executable + * @param request ModifyMatchmakerGameModesRequest + * @return Async Task will return ModifyMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static FutureTask> ModifyMatchmakerGameModesAsync(final ModifyMatchmakerGameModesRequest request) { @@ -3452,6 +3690,8 @@ public PlayFabResult call() throws Exception { /** * Updates the game server mode details for the specified game server executable + * @param request ModifyMatchmakerGameModesRequest + * @return ModifyMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static PlayFabResult ModifyMatchmakerGameModes(final ModifyMatchmakerGameModesRequest request) { @@ -3498,6 +3738,8 @@ private static PlayFabResult privateModifyMatch /** * Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a client is permitted to request in a call to StartGame + * @param request AddServerBuildRequest + * @return Async Task will return AddServerBuildResult */ @SuppressWarnings("unchecked") public static FutureTask> AddServerBuildAsync(final AddServerBuildRequest request) { @@ -3510,6 +3752,8 @@ public PlayFabResult call() throws Exception { /** * Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a client is permitted to request in a call to StartGame + * @param request AddServerBuildRequest + * @return AddServerBuildResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddServerBuild(final AddServerBuildRequest request) { @@ -3556,6 +3800,8 @@ private static PlayFabResult privateAddServerBuildAsync(fi /** * Retrieves the build details for the specified game server executable + * @param request GetServerBuildInfoRequest + * @return Async Task will return GetServerBuildInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetServerBuildInfoAsync(final GetServerBuildInfoRequest request) { @@ -3568,6 +3814,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the build details for the specified game server executable + * @param request GetServerBuildInfoRequest + * @return GetServerBuildInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetServerBuildInfo(final GetServerBuildInfoRequest request) { @@ -3614,6 +3862,8 @@ private static PlayFabResult privateGetServerBuildInfo /** * Retrieves the pre-authorized URL for uploading a game server package containing a build (does not enable the build for use - see AddServerBuild) + * @param request GetServerBuildUploadURLRequest + * @return Async Task will return GetServerBuildUploadURLResult */ @SuppressWarnings("unchecked") public static FutureTask> GetServerBuildUploadUrlAsync(final GetServerBuildUploadURLRequest request) { @@ -3626,6 +3876,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the pre-authorized URL for uploading a game server package containing a build (does not enable the build for use - see AddServerBuild) + * @param request GetServerBuildUploadURLRequest + * @return GetServerBuildUploadURLResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetServerBuildUploadUrl(final GetServerBuildUploadURLRequest request) { @@ -3672,6 +3924,8 @@ private static PlayFabResult privateGetServerBuil /** * Retrieves the build details for all game server executables which are currently defined for the title + * @param request ListBuildsRequest + * @return Async Task will return ListBuildsResult */ @SuppressWarnings("unchecked") public static FutureTask> ListServerBuildsAsync(final ListBuildsRequest request) { @@ -3684,6 +3938,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the build details for all game server executables which are currently defined for the title + * @param request ListBuildsRequest + * @return ListBuildsResult */ @SuppressWarnings("unchecked") public static PlayFabResult ListServerBuilds(final ListBuildsRequest request) { @@ -3730,6 +3986,8 @@ private static PlayFabResult privateListServerBuildsAsync(fina /** * Updates the build details for the specified game server executable + * @param request ModifyServerBuildRequest + * @return Async Task will return ModifyServerBuildResult */ @SuppressWarnings("unchecked") public static FutureTask> ModifyServerBuildAsync(final ModifyServerBuildRequest request) { @@ -3742,6 +4000,8 @@ public PlayFabResult call() throws Exception { /** * Updates the build details for the specified game server executable + * @param request ModifyServerBuildRequest + * @return ModifyServerBuildResult */ @SuppressWarnings("unchecked") public static PlayFabResult ModifyServerBuild(final ModifyServerBuildRequest request) { @@ -3788,6 +4048,8 @@ private static PlayFabResult privateModifyServerBuildAs /** * Removes the game server executable specified from the set of those a client is permitted to request in a call to StartGame + * @param request RemoveServerBuildRequest + * @return Async Task will return RemoveServerBuildResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveServerBuildAsync(final RemoveServerBuildRequest request) { @@ -3800,6 +4062,8 @@ public PlayFabResult call() throws Exception { /** * Removes the game server executable specified from the set of those a client is permitted to request in a call to StartGame + * @param request RemoveServerBuildRequest + * @return RemoveServerBuildResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveServerBuild(final RemoveServerBuildRequest request) { @@ -3846,6 +4110,8 @@ private static PlayFabResult privateRemoveServerBuildAs /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return Async Task will return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetPublisherDataAsync(final SetPublisherDataRequest request) { @@ -3858,6 +4124,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetPublisherData(final SetPublisherDataRequest request) { @@ -3904,6 +4172,8 @@ private static PlayFabResult privateSetPublisherDataAsyn /** * Gets the contents and information of a specific Cloud Script revision. + * @param request GetCloudScriptRevisionRequest + * @return Async Task will return GetCloudScriptRevisionResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCloudScriptRevisionAsync(final GetCloudScriptRevisionRequest request) { @@ -3916,6 +4186,8 @@ public PlayFabResult call() throws Exception { /** * Gets the contents and information of a specific Cloud Script revision. + * @param request GetCloudScriptRevisionRequest + * @return GetCloudScriptRevisionResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCloudScriptRevision(final GetCloudScriptRevisionRequest request) { @@ -3962,6 +4234,8 @@ private static PlayFabResult privateGetCloudScript /** * Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed. + * @param request GetCloudScriptVersionsRequest + * @return Async Task will return GetCloudScriptVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCloudScriptVersionsAsync(final GetCloudScriptVersionsRequest request) { @@ -3974,6 +4248,8 @@ public PlayFabResult call() throws Exception { /** * Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed. + * @param request GetCloudScriptVersionsRequest + * @return GetCloudScriptVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCloudScriptVersions(final GetCloudScriptVersionsRequest request) { @@ -4020,6 +4296,8 @@ private static PlayFabResult privateGetCloudScript /** * Sets the currently published revision of a title Cloud Script + * @param request SetPublishedRevisionRequest + * @return Async Task will return SetPublishedRevisionResult */ @SuppressWarnings("unchecked") public static FutureTask> SetPublishedRevisionAsync(final SetPublishedRevisionRequest request) { @@ -4032,6 +4310,8 @@ public PlayFabResult call() throws Exception { /** * Sets the currently published revision of a title Cloud Script + * @param request SetPublishedRevisionRequest + * @return SetPublishedRevisionResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetPublishedRevision(final SetPublishedRevisionRequest request) { @@ -4078,6 +4358,8 @@ private static PlayFabResult privateSetPublishedRevi /** * Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision. + * @param request UpdateCloudScriptRequest + * @return Async Task will return UpdateCloudScriptResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCloudScriptAsync(final UpdateCloudScriptRequest request) { @@ -4090,6 +4372,8 @@ public PlayFabResult call() throws Exception { /** * Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision. + * @param request UpdateCloudScriptRequest + * @return UpdateCloudScriptResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCloudScript(final UpdateCloudScriptRequest request) { @@ -4136,6 +4420,8 @@ private static PlayFabResult privateUpdateCloudScriptAs /** * Delete a content file from the title + * @param request DeleteContentRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteContentAsync(final DeleteContentRequest request) { @@ -4148,6 +4434,8 @@ public PlayFabResult call() throws Exception { /** * Delete a content file from the title + * @param request DeleteContentRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteContent(final DeleteContentRequest request) { @@ -4194,6 +4482,8 @@ private static PlayFabResult privateDeleteContentAsync(final Delete /** * List all contents of the title and get statistics such as size + * @param request GetContentListRequest + * @return Async Task will return GetContentListResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentListAsync(final GetContentListRequest request) { @@ -4206,6 +4496,8 @@ public PlayFabResult call() throws Exception { /** * List all contents of the title and get statistics such as size + * @param request GetContentListRequest + * @return GetContentListResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentList(final GetContentListRequest request) { @@ -4252,6 +4544,8 @@ private static PlayFabResult privateGetContentListAsync(fi /** * Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentUploadUrlRequest + * @return Async Task will return GetContentUploadUrlResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentUploadUrlAsync(final GetContentUploadUrlRequest request) { @@ -4264,6 +4558,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentUploadUrlRequest + * @return GetContentUploadUrlResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentUploadUrl(final GetContentUploadUrlRequest request) { @@ -4310,6 +4606,8 @@ private static PlayFabResult privateGetContentUploadU /** * Completely removes all statistics for the specified character, for the current game + * @param request ResetCharacterStatisticsRequest + * @return Async Task will return ResetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> ResetCharacterStatisticsAsync(final ResetCharacterStatisticsRequest request) { @@ -4322,6 +4620,8 @@ public PlayFabResult call() throws Exception { /** * Completely removes all statistics for the specified character, for the current game + * @param request ResetCharacterStatisticsRequest + * @return ResetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult ResetCharacterStatistics(final ResetCharacterStatisticsRequest request) { @@ -4368,6 +4668,8 @@ private static PlayFabResult privateResetCharact /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return Async Task will return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> AddPlayerTagAsync(final AddPlayerTagRequest request) { @@ -4380,6 +4682,8 @@ public PlayFabResult call() throws Exception { /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddPlayerTag(final AddPlayerTagRequest request) { @@ -4426,6 +4730,8 @@ private static PlayFabResult privateAddPlayerTagAsync(final /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return Async Task will return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllActionGroupsAsync(final GetAllActionGroupsRequest request) { @@ -4438,6 +4744,8 @@ public PlayFabResult call() throws Exception { /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllActionGroups(final GetAllActionGroupsRequest request) { @@ -4484,6 +4792,8 @@ private static PlayFabResult privateGetAllActionGroups /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return Async Task will return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllSegmentsAsync(final GetAllSegmentsRequest request) { @@ -4496,6 +4806,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllSegments(final GetAllSegmentsRequest request) { @@ -4542,6 +4854,8 @@ private static PlayFabResult privateGetAllSegmentsAsync(fi /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return Async Task will return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerSegmentsAsync(final GetPlayersSegmentsRequest request) { @@ -4554,6 +4868,8 @@ public PlayFabResult call() throws Exception { /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerSegments(final GetPlayersSegmentsRequest request) { @@ -4600,6 +4916,8 @@ private static PlayFabResult privateGetPlayerSegmentsAs /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return Async Task will return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayersInSegmentAsync(final GetPlayersInSegmentRequest request) { @@ -4612,6 +4930,8 @@ public PlayFabResult call() throws Exception { /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayersInSegment(final GetPlayersInSegmentRequest request) { @@ -4658,6 +4978,8 @@ private static PlayFabResult privateGetPlayersInSegme /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return Async Task will return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTagsAsync(final GetPlayerTagsRequest request) { @@ -4670,6 +4992,8 @@ public PlayFabResult call() throws Exception { /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTags(final GetPlayerTagsRequest request) { @@ -4716,6 +5040,8 @@ private static PlayFabResult privateGetPlayerTagsAsync(fina /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return Async Task will return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> RemovePlayerTagAsync(final RemovePlayerTagRequest request) { @@ -4728,6 +5054,8 @@ public PlayFabResult call() throws Exception { /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemovePlayerTag(final RemovePlayerTagRequest request) { @@ -4774,6 +5102,8 @@ private static PlayFabResult privateRemovePlayerTagAsync( /** * Abort an ongoing task instance. + * @param request AbortTaskInstanceRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> AbortTaskInstanceAsync(final AbortTaskInstanceRequest request) { @@ -4786,6 +5116,8 @@ public PlayFabResult call() throws Exception { /** * Abort an ongoing task instance. + * @param request AbortTaskInstanceRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AbortTaskInstance(final AbortTaskInstanceRequest request) { @@ -4832,6 +5164,8 @@ private static PlayFabResult privateAbortTaskInstanceAsync(final Ab /** * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action. + * @param request CreateActionsOnPlayerSegmentTaskRequest + * @return Async Task will return CreateTaskResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateActionsOnPlayersInSegmentTaskAsync(final CreateActionsOnPlayerSegmentTaskRequest request) { @@ -4844,6 +5178,8 @@ public PlayFabResult call() throws Exception { /** * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action. + * @param request CreateActionsOnPlayerSegmentTaskRequest + * @return CreateTaskResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateActionsOnPlayersInSegmentTask(final CreateActionsOnPlayerSegmentTaskRequest request) { @@ -4890,6 +5226,8 @@ private static PlayFabResult privateCreateActionsOnPlayersInSe /** * Create a CloudScript task, which can run a CloudScript on a schedule. + * @param request CreateCloudScriptTaskRequest + * @return Async Task will return CreateTaskResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateCloudScriptTaskAsync(final CreateCloudScriptTaskRequest request) { @@ -4902,6 +5240,8 @@ public PlayFabResult call() throws Exception { /** * Create a CloudScript task, which can run a CloudScript on a schedule. + * @param request CreateCloudScriptTaskRequest + * @return CreateTaskResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateCloudScriptTask(final CreateCloudScriptTaskRequest request) { @@ -4948,6 +5288,8 @@ private static PlayFabResult privateCreateCloudScriptTaskAsync /** * Delete a task. + * @param request DeleteTaskRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteTaskAsync(final DeleteTaskRequest request) { @@ -4960,6 +5302,8 @@ public PlayFabResult call() throws Exception { /** * Delete a task. + * @param request DeleteTaskRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteTask(final DeleteTaskRequest request) { @@ -5006,6 +5350,8 @@ private static PlayFabResult privateDeleteTaskAsync(final DeleteTas /** * Get information about a ActionsOnPlayersInSegment task instance. + * @param request GetTaskInstanceRequest + * @return Async Task will return GetActionsOnPlayersInSegmentTaskInstanceResult */ @SuppressWarnings("unchecked") public static FutureTask> GetActionsOnPlayersInSegmentTaskInstanceAsync(final GetTaskInstanceRequest request) { @@ -5018,6 +5364,8 @@ public PlayFabResult call() thro /** * Get information about a ActionsOnPlayersInSegment task instance. + * @param request GetTaskInstanceRequest + * @return GetActionsOnPlayersInSegmentTaskInstanceResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetActionsOnPlayersInSegmentTaskInstance(final GetTaskInstanceRequest request) { @@ -5064,6 +5412,8 @@ private static PlayFabResult pri /** * Get detail information about a CloudScript task instance. + * @param request GetTaskInstanceRequest + * @return Async Task will return GetCloudScriptTaskInstanceResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCloudScriptTaskInstanceAsync(final GetTaskInstanceRequest request) { @@ -5076,6 +5426,8 @@ public PlayFabResult call() throws Exception { /** * Get detail information about a CloudScript task instance. + * @param request GetTaskInstanceRequest + * @return GetCloudScriptTaskInstanceResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCloudScriptTaskInstance(final GetTaskInstanceRequest request) { @@ -5122,6 +5474,8 @@ private static PlayFabResult privateGetCloudSc /** * Query for task instances by task, status, or time range. + * @param request GetTaskInstancesRequest + * @return Async Task will return GetTaskInstancesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTaskInstancesAsync(final GetTaskInstancesRequest request) { @@ -5134,6 +5488,8 @@ public PlayFabResult call() throws Exception { /** * Query for task instances by task, status, or time range. + * @param request GetTaskInstancesRequest + * @return GetTaskInstancesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTaskInstances(final GetTaskInstancesRequest request) { @@ -5180,6 +5536,8 @@ private static PlayFabResult privateGetTaskInstancesAsyn /** * Get definition information on a specified task or all tasks within a title. + * @param request GetTasksRequest + * @return Async Task will return GetTasksResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTasksAsync(final GetTasksRequest request) { @@ -5192,6 +5550,8 @@ public PlayFabResult call() throws Exception { /** * Get definition information on a specified task or all tasks within a title. + * @param request GetTasksRequest + * @return GetTasksResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTasks(final GetTasksRequest request) { @@ -5238,6 +5598,8 @@ private static PlayFabResult privateGetTasksAsync(final GetTasks /** * Run a task immediately regardless of its schedule. + * @param request RunTaskRequest + * @return Async Task will return RunTaskResult */ @SuppressWarnings("unchecked") public static FutureTask> RunTaskAsync(final RunTaskRequest request) { @@ -5250,6 +5612,8 @@ public PlayFabResult call() throws Exception { /** * Run a task immediately regardless of its schedule. + * @param request RunTaskRequest + * @return RunTaskResult */ @SuppressWarnings("unchecked") public static PlayFabResult RunTask(final RunTaskRequest request) { @@ -5296,6 +5660,8 @@ private static PlayFabResult privateRunTaskAsync(final RunTaskReq /** * Update an existing task. + * @param request UpdateTaskRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateTaskAsync(final UpdateTaskRequest request) { @@ -5308,6 +5674,8 @@ public PlayFabResult call() throws Exception { /** * Update an existing task. + * @param request UpdateTaskRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateTask(final UpdateTaskRequest request) { diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminModels.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminModels.java index a23aa3638..f49fe101c 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminModels.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabAdminModels.java @@ -199,7 +199,7 @@ public static class AddServerBuildResult { */ public Date Timestamp; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -1104,7 +1104,7 @@ public static class DeleteUsersRequest { */ public ArrayList PlayFabIds; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; @@ -1396,7 +1396,7 @@ public static class GetMatchmakerGameInfoRequest { public static class GetMatchmakerGameInfoResult { /** - * unique identifier of the lobby + * unique identifier of the lobby */ public String LobbyId; /** @@ -1581,7 +1581,7 @@ public static class GetPolicyResponse { public static class GetPublisherDataRequest { /** - * array of keys to get back data from the Publisher data blob, set by the admin tools + * array of keys to get back data from the Publisher data blob, set by the admin tools */ public ArrayList Keys; @@ -1665,7 +1665,7 @@ public static class GetServerBuildInfoResult implements Comparable> GetPhotonAuthenticationTokenAsync(final GetPhotonAuthenticationTokenRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception /** * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://api.playfab.com/docs/using-photon-with-playfab/ for more details. + * @param request GetPhotonAuthenticationTokenRequest + * @return GetPhotonAuthenticationTokenResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPhotonAuthenticationToken(final GetPhotonAuthenticationTokenRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateGetPhoto /** * Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate. + * @param request GetWindowsHelloChallengeRequest + * @return Async Task will return GetWindowsHelloChallengeResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetWindowsHelloChallengeAsync(final GetWindowsHelloChallengeRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Requests a challenge from the server to be signed by Windows Hello Passport service to authenticate. + * @param request GetWindowsHelloChallengeRequest + * @return GetWindowsHelloChallengeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetWindowsHelloChallenge(final GetWindowsHelloChallengeRequest request) { @@ -133,6 +141,8 @@ private static PlayFabResult privateGetWindows /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithAndroidDeviceIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithAndroidDeviceIDAsync(final LoginWithAndroidDeviceIDRequest request) { @@ -145,6 +155,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithAndroidDeviceIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithAndroidDeviceID(final LoginWithAndroidDeviceIDRequest request) { @@ -194,6 +206,8 @@ private static PlayFabResult privateLoginWithAndroidDeviceIDAsync(f /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithCustomIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithCustomIDAsync(final LoginWithCustomIDRequest request) { @@ -206,6 +220,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithCustomIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithCustomID(final LoginWithCustomIDRequest request) { @@ -255,6 +271,8 @@ private static PlayFabResult privateLoginWithCustomIDAsync(final Lo /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser. + * @param request LoginWithEmailAddressRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithEmailAddressAsync(final LoginWithEmailAddressRequest request) { @@ -267,6 +285,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser. + * @param request LoginWithEmailAddressRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithEmailAddress(final LoginWithEmailAddressRequest request) { @@ -316,6 +336,8 @@ private static PlayFabResult privateLoginWithEmailAddressAsync(fina /** * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithFacebookRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithFacebookAsync(final LoginWithFacebookRequest request) { @@ -328,6 +350,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithFacebookRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithFacebook(final LoginWithFacebookRequest request) { @@ -377,6 +401,8 @@ private static PlayFabResult privateLoginWithFacebookAsync(final Lo /** * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithGameCenterRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithGameCenterAsync(final LoginWithGameCenterRequest request) { @@ -389,6 +415,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithGameCenterRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithGameCenter(final LoginWithGameCenterRequest request) { @@ -438,6 +466,8 @@ private static PlayFabResult privateLoginWithGameCenterAsync(final /** * Signs the user in using their Google account credentials + * @param request LoginWithGoogleAccountRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithGoogleAccountAsync(final LoginWithGoogleAccountRequest request) { @@ -450,6 +480,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using their Google account credentials + * @param request LoginWithGoogleAccountRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithGoogleAccount(final LoginWithGoogleAccountRequest request) { @@ -499,6 +531,8 @@ private static PlayFabResult privateLoginWithGoogleAccountAsync(fin /** * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithIOSDeviceIDRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithIOSDeviceIDAsync(final LoginWithIOSDeviceIDRequest request) { @@ -511,6 +545,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithIOSDeviceIDRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithIOSDeviceID(final LoginWithIOSDeviceIDRequest request) { @@ -560,6 +596,8 @@ private static PlayFabResult privateLoginWithIOSDeviceIDAsync(final /** * Signs the user in using a Kongregate player account. + * @param request LoginWithKongregateRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithKongregateAsync(final LoginWithKongregateRequest request) { @@ -572,6 +610,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Kongregate player account. + * @param request LoginWithKongregateRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithKongregate(final LoginWithKongregateRequest request) { @@ -621,6 +661,8 @@ private static PlayFabResult privateLoginWithKongregateAsync(final /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword. + * @param request LoginWithPlayFabRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithPlayFabAsync(final LoginWithPlayFabRequest request) { @@ -633,6 +675,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword. + * @param request LoginWithPlayFabRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithPlayFab(final LoginWithPlayFabRequest request) { @@ -682,6 +726,8 @@ private static PlayFabResult privateLoginWithPlayFabAsync(final Log /** * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithSteamRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithSteamAsync(final LoginWithSteamRequest request) { @@ -694,6 +740,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user + * @param request LoginWithSteamRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithSteam(final LoginWithSteamRequest request) { @@ -743,6 +791,8 @@ private static PlayFabResult privateLoginWithSteamAsync(final Login /** * Signs the user in using a Twitch access token. + * @param request LoginWithTwitchRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithTwitchAsync(final LoginWithTwitchRequest request) { @@ -755,6 +805,8 @@ public PlayFabResult call() throws Exception { /** * Signs the user in using a Twitch access token. + * @param request LoginWithTwitchRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithTwitch(final LoginWithTwitchRequest request) { @@ -803,7 +855,9 @@ private static PlayFabResult privateLoginWithTwitchAsync(final Logi } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * @param request LoginWithWindowsHelloRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> LoginWithWindowsHelloAsync(final LoginWithWindowsHelloRequest request) { @@ -815,7 +869,9 @@ public PlayFabResult call() throws Exception { } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * @param request LoginWithWindowsHelloRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult LoginWithWindowsHello(final LoginWithWindowsHelloRequest request) { @@ -833,7 +889,7 @@ public PlayFabResult call() throws Exception { } /** - * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. + * Completes the Windows Hello login flow by returning the signed value of the challange from GetWindowsHelloChallenge. Windows Hello has a 2 step client to server authentication scheme. Step one is to request from the server a challenge string. Step two is to request the user sign the string via Windows Hello and then send the signed value back to the server. */ @SuppressWarnings("unchecked") private static PlayFabResult privateLoginWithWindowsHelloAsync(final LoginWithWindowsHelloRequest request) throws Exception { @@ -865,6 +921,8 @@ private static PlayFabResult privateLoginWithWindowsHelloAsync(fina /** * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address. + * @param request RegisterPlayFabUserRequest + * @return Async Task will return RegisterPlayFabUserResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterPlayFabUserAsync(final RegisterPlayFabUserRequest request) { @@ -877,6 +935,8 @@ public PlayFabResult call() throws Exception { /** * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address. + * @param request RegisterPlayFabUserRequest + * @return RegisterPlayFabUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterPlayFabUser(final RegisterPlayFabUserRequest request) { @@ -926,6 +986,8 @@ private static PlayFabResult privateRegisterPlayFabUs /** * Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user + * @param request RegisterWithWindowsHelloRequest + * @return Async Task will return LoginResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterWithWindowsHelloAsync(final RegisterWithWindowsHelloRequest request) { @@ -938,6 +1000,8 @@ public PlayFabResult call() throws Exception { /** * Registers a new PlayFab user account using Windows Hello authentication, returning a session ticket that can subsequently be used for API calls which require an authenticated user + * @param request RegisterWithWindowsHelloRequest + * @return LoginResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterWithWindowsHello(final RegisterWithWindowsHelloRequest request) { @@ -987,6 +1051,8 @@ private static PlayFabResult privateRegisterWithWindowsHelloAsync(f /** * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players. + * @param request AddGenericIDRequest + * @return Async Task will return AddGenericIDResult */ @SuppressWarnings("unchecked") public static FutureTask> AddGenericIDAsync(final AddGenericIDRequest request) { @@ -999,6 +1065,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players. + * @param request AddGenericIDRequest + * @return AddGenericIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddGenericID(final AddGenericIDRequest request) { @@ -1045,6 +1113,8 @@ private static PlayFabResult privateAddGenericIDAsync(final /** * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login. + * @param request AddUsernamePasswordRequest + * @return Async Task will return AddUsernamePasswordResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUsernamePasswordAsync(final AddUsernamePasswordRequest request) { @@ -1057,6 +1127,8 @@ public PlayFabResult call() throws Exception { /** * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login. + * @param request AddUsernamePasswordRequest + * @return AddUsernamePasswordResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUsernamePassword(final AddUsernamePasswordRequest request) { @@ -1103,6 +1175,8 @@ private static PlayFabResult privateAddUsernamePasswo /** * Retrieves the user's PlayFab account details + * @param request GetAccountInfoRequest + * @return Async Task will return GetAccountInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAccountInfoAsync(final GetAccountInfoRequest request) { @@ -1115,6 +1189,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the user's PlayFab account details + * @param request GetAccountInfoRequest + * @return GetAccountInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAccountInfo(final GetAccountInfoRequest request) { @@ -1161,6 +1237,8 @@ private static PlayFabResult privateGetAccountInfoAsync(fi /** * Retrieves all of the user's different kinds of info. + * @param request GetPlayerCombinedInfoRequest + * @return Async Task will return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerCombinedInfoAsync(final GetPlayerCombinedInfoRequest request) { @@ -1173,6 +1251,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves all of the user's different kinds of info. + * @param request GetPlayerCombinedInfoRequest + * @return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerCombinedInfo(final GetPlayerCombinedInfoRequest request) { @@ -1219,6 +1299,8 @@ private static PlayFabResult privateGetPlayerCombin /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return Async Task will return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromFacebookIDsAsync(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -1231,6 +1313,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromFacebookIDs(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -1277,6 +1361,8 @@ private static PlayFabResult privateGetPlayF /** * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier). + * @param request GetPlayFabIDsFromGameCenterIDsRequest + * @return Async Task will return GetPlayFabIDsFromGameCenterIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGameCenterIDsAsync(final GetPlayFabIDsFromGameCenterIDsRequest request) { @@ -1289,6 +1375,8 @@ public PlayFabResult call() throws Excepti /** * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier). + * @param request GetPlayFabIDsFromGameCenterIDsRequest + * @return GetPlayFabIDsFromGameCenterIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGameCenterIDs(final GetPlayFabIDsFromGameCenterIDsRequest request) { @@ -1335,6 +1423,8 @@ private static PlayFabResult privateGetPla /** * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account. + * @param request GetPlayFabIDsFromGenericIDsRequest + * @return Async Task will return GetPlayFabIDsFromGenericIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGenericIDsAsync(final GetPlayFabIDsFromGenericIDsRequest request) { @@ -1347,6 +1437,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account. + * @param request GetPlayFabIDsFromGenericIDsRequest + * @return GetPlayFabIDsFromGenericIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGenericIDs(final GetPlayFabIDsFromGenericIDsRequest request) { @@ -1393,6 +1485,8 @@ private static PlayFabResult privateGetPlayFa /** * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls. + * @param request GetPlayFabIDsFromGoogleIDsRequest + * @return Async Task will return GetPlayFabIDsFromGoogleIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromGoogleIDsAsync(final GetPlayFabIDsFromGoogleIDsRequest request) { @@ -1405,6 +1499,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as "id" in the Google+ People API calls. + * @param request GetPlayFabIDsFromGoogleIDsRequest + * @return GetPlayFabIDsFromGoogleIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromGoogleIDs(final GetPlayFabIDsFromGoogleIDsRequest request) { @@ -1451,6 +1547,8 @@ private static PlayFabResult privateGetPlayFab /** * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId). + * @param request GetPlayFabIDsFromKongregateIDsRequest + * @return Async Task will return GetPlayFabIDsFromKongregateIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromKongregateIDsAsync(final GetPlayFabIDsFromKongregateIDsRequest request) { @@ -1463,6 +1561,8 @@ public PlayFabResult call() throws Excepti /** * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId). + * @param request GetPlayFabIDsFromKongregateIDsRequest + * @return GetPlayFabIDsFromKongregateIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromKongregateIDs(final GetPlayFabIDsFromKongregateIDsRequest request) { @@ -1509,6 +1609,8 @@ private static PlayFabResult privateGetPla /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return Async Task will return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromSteamIDsAsync(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -1521,6 +1623,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromSteamIDs(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -1567,6 +1671,8 @@ private static PlayFabResult privateGetPlayFabI /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser). + * @param request GetPlayFabIDsFromTwitchIDsRequest + * @return Async Task will return GetPlayFabIDsFromTwitchIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromTwitchIDsAsync(final GetPlayFabIDsFromTwitchIDsRequest request) { @@ -1579,6 +1685,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser). + * @param request GetPlayFabIDsFromTwitchIDsRequest + * @return GetPlayFabIDsFromTwitchIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromTwitchIDs(final GetPlayFabIDsFromTwitchIDsRequest request) { @@ -1625,6 +1733,8 @@ private static PlayFabResult privateGetPlayFab /** * Links the Android device identifier to the user's PlayFab account + * @param request LinkAndroidDeviceIDRequest + * @return Async Task will return LinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkAndroidDeviceIDAsync(final LinkAndroidDeviceIDRequest request) { @@ -1637,6 +1747,8 @@ public PlayFabResult call() throws Exception { /** * Links the Android device identifier to the user's PlayFab account + * @param request LinkAndroidDeviceIDRequest + * @return LinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkAndroidDeviceID(final LinkAndroidDeviceIDRequest request) { @@ -1683,6 +1795,8 @@ private static PlayFabResult privateLinkAndroidDevice /** * Links the custom identifier, generated by the title, to the user's PlayFab account + * @param request LinkCustomIDRequest + * @return Async Task will return LinkCustomIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkCustomIDAsync(final LinkCustomIDRequest request) { @@ -1695,6 +1809,8 @@ public PlayFabResult call() throws Exception { /** * Links the custom identifier, generated by the title, to the user's PlayFab account + * @param request LinkCustomIDRequest + * @return LinkCustomIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkCustomID(final LinkCustomIDRequest request) { @@ -1741,6 +1857,8 @@ private static PlayFabResult privateLinkCustomIDAsync(final /** * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account + * @param request LinkFacebookAccountRequest + * @return Async Task will return LinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkFacebookAccountAsync(final LinkFacebookAccountRequest request) { @@ -1753,6 +1871,8 @@ public PlayFabResult call() throws Exception { /** * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account + * @param request LinkFacebookAccountRequest + * @return LinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkFacebookAccount(final LinkFacebookAccountRequest request) { @@ -1799,6 +1919,8 @@ private static PlayFabResult privateLinkFacebookAccou /** * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account + * @param request LinkGameCenterAccountRequest + * @return Async Task will return LinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkGameCenterAccountAsync(final LinkGameCenterAccountRequest request) { @@ -1811,6 +1933,8 @@ public PlayFabResult call() throws Exception { /** * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account + * @param request LinkGameCenterAccountRequest + * @return LinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkGameCenterAccount(final LinkGameCenterAccountRequest request) { @@ -1857,6 +1981,8 @@ private static PlayFabResult privateLinkGameCenterA /** * Links the currently signed-in user account to their Google account, using their Google account credentials + * @param request LinkGoogleAccountRequest + * @return Async Task will return LinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkGoogleAccountAsync(final LinkGoogleAccountRequest request) { @@ -1869,6 +1995,8 @@ public PlayFabResult call() throws Exception { /** * Links the currently signed-in user account to their Google account, using their Google account credentials + * @param request LinkGoogleAccountRequest + * @return LinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkGoogleAccount(final LinkGoogleAccountRequest request) { @@ -1915,6 +2043,8 @@ private static PlayFabResult privateLinkGoogleAccountAs /** * Links the vendor-specific iOS device identifier to the user's PlayFab account + * @param request LinkIOSDeviceIDRequest + * @return Async Task will return LinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkIOSDeviceIDAsync(final LinkIOSDeviceIDRequest request) { @@ -1927,6 +2057,8 @@ public PlayFabResult call() throws Exception { /** * Links the vendor-specific iOS device identifier to the user's PlayFab account + * @param request LinkIOSDeviceIDRequest + * @return LinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkIOSDeviceID(final LinkIOSDeviceIDRequest request) { @@ -1973,6 +2105,8 @@ private static PlayFabResult privateLinkIOSDeviceIDAsync( /** * Links the Kongregate identifier to the user's PlayFab account + * @param request LinkKongregateAccountRequest + * @return Async Task will return LinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkKongregateAsync(final LinkKongregateAccountRequest request) { @@ -1985,6 +2119,8 @@ public PlayFabResult call() throws Exception { /** * Links the Kongregate identifier to the user's PlayFab account + * @param request LinkKongregateAccountRequest + * @return LinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkKongregate(final LinkKongregateAccountRequest request) { @@ -2031,6 +2167,8 @@ private static PlayFabResult privateLinkKongregateA /** * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account + * @param request LinkSteamAccountRequest + * @return Async Task will return LinkSteamAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkSteamAccountAsync(final LinkSteamAccountRequest request) { @@ -2043,6 +2181,8 @@ public PlayFabResult call() throws Exception { /** * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account + * @param request LinkSteamAccountRequest + * @return LinkSteamAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkSteamAccount(final LinkSteamAccountRequest request) { @@ -2089,6 +2229,8 @@ private static PlayFabResult privateLinkSteamAccountAsyn /** * Links the Twitch account associated with the token to the user's PlayFab account. + * @param request LinkTwitchAccountRequest + * @return Async Task will return LinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> LinkTwitchAsync(final LinkTwitchAccountRequest request) { @@ -2101,6 +2243,8 @@ public PlayFabResult call() throws Exception { /** * Links the Twitch account associated with the token to the user's PlayFab account. + * @param request LinkTwitchAccountRequest + * @return LinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult LinkTwitch(final LinkTwitchAccountRequest request) { @@ -2147,6 +2291,8 @@ private static PlayFabResult privateLinkTwitchAsync(fin /** * Link Windows Hello authentication to the current PlayFab Account + * @param request LinkWindowsHelloAccountRequest + * @return Async Task will return LinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static FutureTask> LinkWindowsHelloAsync(final LinkWindowsHelloAccountRequest request) { @@ -2159,6 +2305,8 @@ public PlayFabResult call() throws Exception { /** * Link Windows Hello authentication to the current PlayFab Account + * @param request LinkWindowsHelloAccountRequest + * @return LinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static PlayFabResult LinkWindowsHello(final LinkWindowsHelloAccountRequest request) { @@ -2204,6 +2352,8 @@ private static PlayFabResult privateLinkWindows /** * Removes the specified generic service identifier from the player's PlayFab account. + * @param request RemoveGenericIDRequest + * @return Async Task will return RemoveGenericIDResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveGenericIDAsync(final RemoveGenericIDRequest request) { @@ -2216,6 +2366,8 @@ public PlayFabResult call() throws Exception { /** * Removes the specified generic service identifier from the player's PlayFab account. + * @param request RemoveGenericIDRequest + * @return RemoveGenericIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveGenericID(final RemoveGenericIDRequest request) { @@ -2262,6 +2414,8 @@ private static PlayFabResult privateRemoveGenericIDAsync( /** * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerClientRequest + * @return Async Task will return ReportPlayerClientResult */ @SuppressWarnings("unchecked") public static FutureTask> ReportPlayerAsync(final ReportPlayerClientRequest request) { @@ -2274,6 +2428,8 @@ public PlayFabResult call() throws Exception { /** * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerClientRequest + * @return ReportPlayerClientResult */ @SuppressWarnings("unchecked") public static PlayFabResult ReportPlayer(final ReportPlayerClientRequest request) { @@ -2320,6 +2476,8 @@ private static PlayFabResult privateReportPlayerAsync( /** * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return Async Task will return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static FutureTask> SendAccountRecoveryEmailAsync(final SendAccountRecoveryEmailRequest request) { @@ -2332,6 +2490,8 @@ public PlayFabResult call() throws Exception { /** * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static PlayFabResult SendAccountRecoveryEmail(final SendAccountRecoveryEmailRequest request) { @@ -2377,6 +2537,8 @@ private static PlayFabResult privateSendAccountR /** * Unlinks the related Android device identifier from the user's PlayFab account + * @param request UnlinkAndroidDeviceIDRequest + * @return Async Task will return UnlinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkAndroidDeviceIDAsync(final UnlinkAndroidDeviceIDRequest request) { @@ -2389,6 +2551,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Android device identifier from the user's PlayFab account + * @param request UnlinkAndroidDeviceIDRequest + * @return UnlinkAndroidDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkAndroidDeviceID(final UnlinkAndroidDeviceIDRequest request) { @@ -2435,6 +2599,8 @@ private static PlayFabResult privateUnlinkAndroidDe /** * Unlinks the related custom identifier from the user's PlayFab account + * @param request UnlinkCustomIDRequest + * @return Async Task will return UnlinkCustomIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkCustomIDAsync(final UnlinkCustomIDRequest request) { @@ -2447,6 +2613,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related custom identifier from the user's PlayFab account + * @param request UnlinkCustomIDRequest + * @return UnlinkCustomIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkCustomID(final UnlinkCustomIDRequest request) { @@ -2493,6 +2661,8 @@ private static PlayFabResult privateUnlinkCustomIDAsync(fi /** * Unlinks the related Facebook account from the user's PlayFab account + * @param request UnlinkFacebookAccountRequest + * @return Async Task will return UnlinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkFacebookAccountAsync(final UnlinkFacebookAccountRequest request) { @@ -2505,6 +2675,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Facebook account from the user's PlayFab account + * @param request UnlinkFacebookAccountRequest + * @return UnlinkFacebookAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkFacebookAccount(final UnlinkFacebookAccountRequest request) { @@ -2551,6 +2723,8 @@ private static PlayFabResult privateUnlinkFacebookA /** * Unlinks the related Game Center account from the user's PlayFab account + * @param request UnlinkGameCenterAccountRequest + * @return Async Task will return UnlinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkGameCenterAccountAsync(final UnlinkGameCenterAccountRequest request) { @@ -2563,6 +2737,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Game Center account from the user's PlayFab account + * @param request UnlinkGameCenterAccountRequest + * @return UnlinkGameCenterAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkGameCenterAccount(final UnlinkGameCenterAccountRequest request) { @@ -2609,6 +2785,8 @@ private static PlayFabResult privateUnlinkGameCen /** * Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods). + * @param request UnlinkGoogleAccountRequest + * @return Async Task will return UnlinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkGoogleAccountAsync(final UnlinkGoogleAccountRequest request) { @@ -2621,6 +2799,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Google account from the user's PlayFab account (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods). + * @param request UnlinkGoogleAccountRequest + * @return UnlinkGoogleAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkGoogleAccount(final UnlinkGoogleAccountRequest request) { @@ -2667,6 +2847,8 @@ private static PlayFabResult privateUnlinkGoogleAccou /** * Unlinks the related iOS device identifier from the user's PlayFab account + * @param request UnlinkIOSDeviceIDRequest + * @return Async Task will return UnlinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkIOSDeviceIDAsync(final UnlinkIOSDeviceIDRequest request) { @@ -2679,6 +2861,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related iOS device identifier from the user's PlayFab account + * @param request UnlinkIOSDeviceIDRequest + * @return UnlinkIOSDeviceIDResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkIOSDeviceID(final UnlinkIOSDeviceIDRequest request) { @@ -2725,6 +2909,8 @@ private static PlayFabResult privateUnlinkIOSDeviceIDAs /** * Unlinks the related Kongregate identifier from the user's PlayFab account + * @param request UnlinkKongregateAccountRequest + * @return Async Task will return UnlinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkKongregateAsync(final UnlinkKongregateAccountRequest request) { @@ -2737,6 +2923,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Kongregate identifier from the user's PlayFab account + * @param request UnlinkKongregateAccountRequest + * @return UnlinkKongregateAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkKongregate(final UnlinkKongregateAccountRequest request) { @@ -2783,6 +2971,8 @@ private static PlayFabResult privateUnlinkKongreg /** * Unlinks the related Steam account from the user's PlayFab account + * @param request UnlinkSteamAccountRequest + * @return Async Task will return UnlinkSteamAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkSteamAccountAsync(final UnlinkSteamAccountRequest request) { @@ -2795,6 +2985,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Steam account from the user's PlayFab account + * @param request UnlinkSteamAccountRequest + * @return UnlinkSteamAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkSteamAccount(final UnlinkSteamAccountRequest request) { @@ -2841,6 +3033,8 @@ private static PlayFabResult privateUnlinkSteamAccount /** * Unlinks the related Twitch account from the user's PlayFab account. + * @param request UnlinkTwitchAccountRequest + * @return Async Task will return UnlinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkTwitchAsync(final UnlinkTwitchAccountRequest request) { @@ -2853,6 +3047,8 @@ public PlayFabResult call() throws Exception { /** * Unlinks the related Twitch account from the user's PlayFab account. + * @param request UnlinkTwitchAccountRequest + * @return UnlinkTwitchAccountResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkTwitch(final UnlinkTwitchAccountRequest request) { @@ -2899,6 +3095,8 @@ private static PlayFabResult privateUnlinkTwitchAsync /** * Unlink Windows Hello authentication from the current PlayFab Account + * @param request UnlinkWindowsHelloAccountRequest + * @return Async Task will return UnlinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static FutureTask> UnlinkWindowsHelloAsync(final UnlinkWindowsHelloAccountRequest request) { @@ -2911,6 +3109,8 @@ public PlayFabResult call() throws Exception /** * Unlink Windows Hello authentication from the current PlayFab Account + * @param request UnlinkWindowsHelloAccountRequest + * @return UnlinkWindowsHelloAccountResponse */ @SuppressWarnings("unchecked") public static PlayFabResult UnlinkWindowsHello(final UnlinkWindowsHelloAccountRequest request) { @@ -2956,6 +3156,8 @@ private static PlayFabResult privateUnlinkWin /** * Update the avatar URL of the player + * @param request UpdateAvatarUrlRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateAvatarUrlAsync(final UpdateAvatarUrlRequest request) { @@ -2968,6 +3170,8 @@ public PlayFabResult call() throws Exception { /** * Update the avatar URL of the player + * @param request UpdateAvatarUrlRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateAvatarUrl(final UpdateAvatarUrlRequest request) { @@ -3014,6 +3218,8 @@ private static PlayFabResult privateUpdateAvatarUrlAsync(final Upda /** * Updates the title specific display name for the user + * @param request UpdateUserTitleDisplayNameRequest + * @return Async Task will return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserTitleDisplayNameAsync(final UpdateUserTitleDisplayNameRequest request) { @@ -3026,6 +3232,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title specific display name for the user + * @param request UpdateUserTitleDisplayNameRequest + * @return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserTitleDisplayName(final UpdateUserTitleDisplayNameRequest request) { @@ -3072,6 +3280,8 @@ private static PlayFabResult privateUpdateUser /** * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAsync(final GetFriendLeaderboardRequest request) { @@ -3084,6 +3294,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboard(final GetFriendLeaderboardRequest request) { @@ -3130,6 +3342,8 @@ private static PlayFabResult privateGetFriendLeaderboardAs /** * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user. + * @param request GetFriendLeaderboardAroundPlayerRequest + * @return Async Task will return GetFriendLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAroundPlayerAsync(final GetFriendLeaderboardAroundPlayerRequest request) { @@ -3142,6 +3356,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user. + * @param request GetFriendLeaderboardAroundPlayerRequest + * @return GetFriendLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboardAroundPlayer(final GetFriendLeaderboardAroundPlayerRequest request) { @@ -3188,6 +3404,8 @@ private static PlayFabResult privateGetF /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAsync(final GetLeaderboardRequest request) { @@ -3200,6 +3418,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboard(final GetLeaderboardRequest request) { @@ -3246,6 +3466,8 @@ private static PlayFabResult privateGetLeaderboardAsync(fi /** * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user. + * @param request GetLeaderboardAroundPlayerRequest + * @return Async Task will return GetLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundPlayerAsync(final GetLeaderboardAroundPlayerRequest request) { @@ -3258,6 +3480,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user. + * @param request GetLeaderboardAroundPlayerRequest + * @return GetLeaderboardAroundPlayerResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundPlayer(final GetLeaderboardAroundPlayerRequest request) { @@ -3304,6 +3528,8 @@ private static PlayFabResult privateGetLeaderb /** * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player. + * @param request GetPlayerStatisticsRequest + * @return Async Task will return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticsAsync(final GetPlayerStatisticsRequest request) { @@ -3316,6 +3542,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player. + * @param request GetPlayerStatisticsRequest + * @return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatistics(final GetPlayerStatisticsRequest request) { @@ -3362,6 +3590,8 @@ private static PlayFabResult privateGetPlayerStatisti /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return Async Task will return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticVersionsAsync(final GetPlayerStatisticVersionsRequest request) { @@ -3374,6 +3604,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticVersions(final GetPlayerStatisticVersionsRequest request) { @@ -3420,6 +3652,8 @@ private static PlayFabResult privateGetPlayerS /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserDataAsync(final GetUserDataRequest request) { @@ -3432,6 +3666,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserData(final GetUserDataRequest request) { @@ -3478,6 +3714,8 @@ private static PlayFabResult privateGetUserDataAsync(final Ge /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherDataAsync(final GetUserDataRequest request) { @@ -3490,6 +3728,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherData(final GetUserDataRequest request) { @@ -3536,6 +3776,8 @@ private static PlayFabResult privateGetUserPublisherDataAsync /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherReadOnlyDataAsync(final GetUserDataRequest request) { @@ -3548,6 +3790,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherReadOnlyData(final GetUserDataRequest request) { @@ -3594,6 +3838,8 @@ private static PlayFabResult privateGetUserPublisherReadOnlyD /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserReadOnlyDataAsync(final GetUserDataRequest request) { @@ -3606,6 +3852,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserReadOnlyData(final GetUserDataRequest request) { @@ -3651,7 +3899,9 @@ private static PlayFabResult privateGetUserReadOnlyDataAsync( } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdatePlayerStatisticsRequest + * @return Async Task will return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) { @@ -3663,7 +3913,9 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdatePlayerStatisticsRequest + * @return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePlayerStatistics(final UpdatePlayerStatisticsRequest request) { @@ -3681,7 +3933,7 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) throws Exception { @@ -3710,6 +3962,8 @@ private static PlayFabResult privateUpdatePlayerSt /** * Creates and updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserDataAsync(final UpdateUserDataRequest request) { @@ -3722,6 +3976,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserData(final UpdateUserDataRequest request) { @@ -3768,6 +4024,8 @@ private static PlayFabResult privateUpdateUserDataAsync(fi /** * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherDataAsync(final UpdateUserDataRequest request) { @@ -3780,6 +4038,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherData(final UpdateUserDataRequest request) { @@ -3826,6 +4086,8 @@ private static PlayFabResult privateUpdateUserPublisherDat /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return Async Task will return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCatalogItemsAsync(final GetCatalogItemsRequest request) { @@ -3838,6 +4100,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCatalogItems(final GetCatalogItemsRequest request) { @@ -3884,6 +4148,8 @@ private static PlayFabResult privateGetCatalogItemsAsync( /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return Async Task will return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPublisherDataAsync(final GetPublisherDataRequest request) { @@ -3896,6 +4162,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPublisherData(final GetPublisherDataRequest request) { @@ -3942,6 +4210,8 @@ private static PlayFabResult privateGetPublisherDataAsyn /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return Async Task will return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetStoreItemsAsync(final GetStoreItemsRequest request) { @@ -3954,6 +4224,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetStoreItems(final GetStoreItemsRequest request) { @@ -4000,6 +4272,8 @@ private static PlayFabResult privateGetStoreItemsAsync(fina /** * Retrieves the current server time + * @param request GetTimeRequest + * @return Async Task will return GetTimeResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTimeAsync(final GetTimeRequest request) { @@ -4012,6 +4286,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current server time + * @param request GetTimeRequest + * @return GetTimeResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTime(final GetTimeRequest request) { @@ -4058,6 +4334,8 @@ private static PlayFabResult privateGetTimeAsync(final GetTimeReq /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleDataAsync(final GetTitleDataRequest request) { @@ -4070,6 +4348,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleData(final GetTitleDataRequest request) { @@ -4116,6 +4396,8 @@ private static PlayFabResult privateGetTitleDataAsync(final /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return Async Task will return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleNewsAsync(final GetTitleNewsRequest request) { @@ -4128,6 +4410,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleNews(final GetTitleNewsRequest request) { @@ -4174,6 +4458,8 @@ private static PlayFabResult privateGetTitleNewsAsync(final /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUserVirtualCurrencyAsync(final AddUserVirtualCurrencyRequest request) { @@ -4186,6 +4472,8 @@ public PlayFabResult call() throws Exception { /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUserVirtualCurrency(final AddUserVirtualCurrencyRequest request) { @@ -4232,6 +4520,8 @@ private static PlayFabResult privateAddUserVirt /** * Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate + * @param request ConfirmPurchaseRequest + * @return Async Task will return ConfirmPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> ConfirmPurchaseAsync(final ConfirmPurchaseRequest request) { @@ -4244,6 +4534,8 @@ public PlayFabResult call() throws Exception { /** * Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate + * @param request ConfirmPurchaseRequest + * @return ConfirmPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConfirmPurchase(final ConfirmPurchaseRequest request) { @@ -4290,6 +4582,8 @@ private static PlayFabResult privateConfirmPurchaseAsync( /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return Async Task will return ConsumeItemResult */ @SuppressWarnings("unchecked") public static FutureTask> ConsumeItemAsync(final ConsumeItemRequest request) { @@ -4302,6 +4596,8 @@ public PlayFabResult call() throws Exception { /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return ConsumeItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConsumeItem(final ConsumeItemRequest request) { @@ -4348,6 +4644,8 @@ private static PlayFabResult privateConsumeItemAsync(final Co /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return Async Task will return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterInventoryAsync(final GetCharacterInventoryRequest request) { @@ -4360,6 +4658,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterInventory(final GetCharacterInventoryRequest request) { @@ -4406,6 +4706,8 @@ private static PlayFabResult privateGetCharacterInv /** * Retrieves a purchase along with its current PlayFab status. + * @param request GetPurchaseRequest + * @return Async Task will return GetPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPurchaseAsync(final GetPurchaseRequest request) { @@ -4418,6 +4720,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a purchase along with its current PlayFab status. + * @param request GetPurchaseRequest + * @return GetPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPurchase(final GetPurchaseRequest request) { @@ -4464,6 +4768,8 @@ private static PlayFabResult privateGetPurchaseAsync(final Ge /** * Retrieves the user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return Async Task will return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInventoryAsync(final GetUserInventoryRequest request) { @@ -4476,6 +4782,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInventory(final GetUserInventoryRequest request) { @@ -4522,6 +4830,8 @@ private static PlayFabResult privateGetUserInventoryAsyn /** * Selects a payment option for purchase order created via StartPurchase + * @param request PayForPurchaseRequest + * @return Async Task will return PayForPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> PayForPurchaseAsync(final PayForPurchaseRequest request) { @@ -4534,6 +4844,8 @@ public PlayFabResult call() throws Exception { /** * Selects a payment option for purchase order created via StartPurchase + * @param request PayForPurchaseRequest + * @return PayForPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult PayForPurchase(final PayForPurchaseRequest request) { @@ -4580,6 +4892,8 @@ private static PlayFabResult privatePayForPurchaseAsync(fi /** * Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed. + * @param request PurchaseItemRequest + * @return Async Task will return PurchaseItemResult */ @SuppressWarnings("unchecked") public static FutureTask> PurchaseItemAsync(final PurchaseItemRequest request) { @@ -4592,6 +4906,8 @@ public PlayFabResult call() throws Exception { /** * Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed. + * @param request PurchaseItemRequest + * @return PurchaseItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult PurchaseItem(final PurchaseItemRequest request) { @@ -4637,7 +4953,9 @@ private static PlayFabResult privatePurchaseItemAsync(final } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return Async Task will return RedeemCouponResult */ @SuppressWarnings("unchecked") public static FutureTask> RedeemCouponAsync(final RedeemCouponRequest request) { @@ -4649,7 +4967,9 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return RedeemCouponResult */ @SuppressWarnings("unchecked") public static PlayFabResult RedeemCoupon(final RedeemCouponRequest request) { @@ -4667,7 +4987,7 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. */ @SuppressWarnings("unchecked") private static PlayFabResult privateRedeemCouponAsync(final RedeemCouponRequest request) throws Exception { @@ -4696,6 +5016,8 @@ private static PlayFabResult privateRedeemCouponAsync(final /** * Creates an order for a list of items from the title catalog + * @param request StartPurchaseRequest + * @return Async Task will return StartPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> StartPurchaseAsync(final StartPurchaseRequest request) { @@ -4708,6 +5030,8 @@ public PlayFabResult call() throws Exception { /** * Creates an order for a list of items from the title catalog + * @param request StartPurchaseRequest + * @return StartPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult StartPurchase(final StartPurchaseRequest request) { @@ -4754,6 +5078,8 @@ private static PlayFabResult privateStartPurchaseAsync(fina /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractUserVirtualCurrencyAsync(final SubtractUserVirtualCurrencyRequest request) { @@ -4766,6 +5092,8 @@ public PlayFabResult call() throws Exception { /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractUserVirtualCurrency(final SubtractUserVirtualCurrencyRequest request) { @@ -4811,7 +5139,9 @@ private static PlayFabResult privateSubtractUse } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) { @@ -4823,7 +5153,9 @@ public PlayFabResult call() throws Exception { } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerInstance(final UnlockContainerInstanceRequest request) { @@ -4841,7 +5173,7 @@ public PlayFabResult call() throws Exception { } /** - * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) throws Exception { @@ -4869,7 +5201,9 @@ private static PlayFabResult privateUnlockContainerIn } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerItemAsync(final UnlockContainerItemRequest request) { @@ -4881,7 +5215,9 @@ public PlayFabResult call() throws Exception { } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerItem(final UnlockContainerItemRequest request) { @@ -4899,7 +5235,7 @@ public PlayFabResult call() throws Exception { } /** - * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerItemAsync(final UnlockContainerItemRequest request) throws Exception { @@ -4928,6 +5264,8 @@ private static PlayFabResult privateUnlockContainerIt /** * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return Async Task will return AddFriendResult */ @SuppressWarnings("unchecked") public static FutureTask> AddFriendAsync(final AddFriendRequest request) { @@ -4940,6 +5278,8 @@ public PlayFabResult call() throws Exception { /** * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return AddFriendResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddFriend(final AddFriendRequest request) { @@ -4986,6 +5326,8 @@ private static PlayFabResult privateAddFriendAsync(final AddFri /** * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return Async Task will return GetFriendsListResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendsListAsync(final GetFriendsListRequest request) { @@ -4998,6 +5340,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return GetFriendsListResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendsList(final GetFriendsListRequest request) { @@ -5044,6 +5388,8 @@ private static PlayFabResult privateGetFriendsListAsync(fi /** * Removes a specified user from the friend list of the local user + * @param request RemoveFriendRequest + * @return Async Task will return RemoveFriendResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveFriendAsync(final RemoveFriendRequest request) { @@ -5056,6 +5402,8 @@ public PlayFabResult call() throws Exception { /** * Removes a specified user from the friend list of the local user + * @param request RemoveFriendRequest + * @return RemoveFriendResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveFriend(final RemoveFriendRequest request) { @@ -5102,6 +5450,8 @@ private static PlayFabResult privateRemoveFriendAsync(final /** * Updates the tag list for a specified user in the friend list of the local user + * @param request SetFriendTagsRequest + * @return Async Task will return SetFriendTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetFriendTagsAsync(final SetFriendTagsRequest request) { @@ -5114,6 +5464,8 @@ public PlayFabResult call() throws Exception { /** * Updates the tag list for a specified user in the friend list of the local user + * @param request SetFriendTagsRequest + * @return SetFriendTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetFriendTags(final SetFriendTagsRequest request) { @@ -5160,6 +5512,8 @@ private static PlayFabResult privateSetFriendTagsAsync(fina /** * Registers the iOS device to receive push notifications + * @param request RegisterForIOSPushNotificationRequest + * @return Async Task will return RegisterForIOSPushNotificationResult */ @SuppressWarnings("unchecked") public static FutureTask> RegisterForIOSPushNotificationAsync(final RegisterForIOSPushNotificationRequest request) { @@ -5172,6 +5526,8 @@ public PlayFabResult call() throws Excepti /** * Registers the iOS device to receive push notifications + * @param request RegisterForIOSPushNotificationRequest + * @return RegisterForIOSPushNotificationResult */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterForIOSPushNotification(final RegisterForIOSPushNotificationRequest request) { @@ -5218,6 +5574,8 @@ private static PlayFabResult privateRegist /** * Restores all in-app purchases based on the given restore receipt + * @param request RestoreIOSPurchasesRequest + * @return Async Task will return RestoreIOSPurchasesResult */ @SuppressWarnings("unchecked") public static FutureTask> RestoreIOSPurchasesAsync(final RestoreIOSPurchasesRequest request) { @@ -5230,6 +5588,8 @@ public PlayFabResult call() throws Exception { /** * Restores all in-app purchases based on the given restore receipt + * @param request RestoreIOSPurchasesRequest + * @return RestoreIOSPurchasesResult */ @SuppressWarnings("unchecked") public static PlayFabResult RestoreIOSPurchases(final RestoreIOSPurchasesRequest request) { @@ -5276,6 +5636,8 @@ private static PlayFabResult privateRestoreIOSPurchas /** * Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateIOSReceiptRequest + * @return Async Task will return ValidateIOSReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateIOSReceiptAsync(final ValidateIOSReceiptRequest request) { @@ -5288,6 +5650,8 @@ public PlayFabResult call() throws Exception { /** * Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateIOSReceiptRequest + * @return ValidateIOSReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateIOSReceipt(final ValidateIOSReceiptRequest request) { @@ -5334,6 +5698,8 @@ private static PlayFabResult privateValidateIOSReceipt /** * Get details about all current running game servers matching the given parameters. + * @param request CurrentGamesRequest + * @return Async Task will return CurrentGamesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCurrentGamesAsync(final CurrentGamesRequest request) { @@ -5346,6 +5712,8 @@ public PlayFabResult call() throws Exception { /** * Get details about all current running game servers matching the given parameters. + * @param request CurrentGamesRequest + * @return CurrentGamesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCurrentGames(final CurrentGamesRequest request) { @@ -5391,7 +5759,9 @@ private static PlayFabResult privateGetCurrentGamesAsync(fin } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. + * @param request GameServerRegionsRequest + * @return Async Task will return GameServerRegionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetGameServerRegionsAsync(final GameServerRegionsRequest request) { @@ -5403,7 +5773,9 @@ public PlayFabResult call() throws Exception { } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. + * @param request GameServerRegionsRequest + * @return GameServerRegionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetGameServerRegions(final GameServerRegionsRequest request) { @@ -5421,7 +5793,7 @@ public PlayFabResult call() throws Exception { } /** - * Get details about the regions hosting game servers matching the given parameters. + * Get details about the regions hosting game servers matching the given parameters. */ @SuppressWarnings("unchecked") private static PlayFabResult privateGetGameServerRegionsAsync(final GameServerRegionsRequest request) throws Exception { @@ -5450,6 +5822,8 @@ private static PlayFabResult privateGetGameServerRegion /** * 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. + * @param request MatchmakeRequest + * @return Async Task will return MatchmakeResult */ @SuppressWarnings("unchecked") public static FutureTask> MatchmakeAsync(final MatchmakeRequest request) { @@ -5462,6 +5836,8 @@ public PlayFabResult call() throws Exception { /** * 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. + * @param request MatchmakeRequest + * @return MatchmakeResult */ @SuppressWarnings("unchecked") public static PlayFabResult Matchmake(final MatchmakeRequest request) { @@ -5508,6 +5884,8 @@ private static PlayFabResult privateMatchmakeAsync(final Matchm /** * Start a new game server with a given configuration, add the current player and return the connection information. + * @param request StartGameRequest + * @return Async Task will return StartGameResult */ @SuppressWarnings("unchecked") public static FutureTask> StartGameAsync(final StartGameRequest request) { @@ -5520,6 +5898,8 @@ public PlayFabResult call() throws Exception { /** * Start a new game server with a given configuration, add the current player and return the connection information. + * @param request StartGameRequest + * @return StartGameResult */ @SuppressWarnings("unchecked") public static PlayFabResult StartGame(final StartGameRequest request) { @@ -5566,6 +5946,8 @@ private static PlayFabResult privateStartGameAsync(final StartG /** * Registers the Android device to receive push notifications + * @param request AndroidDevicePushNotificationRegistrationRequest + * @return Async Task will return AndroidDevicePushNotificationRegistrationResult */ @SuppressWarnings("unchecked") public static FutureTask> AndroidDevicePushNotificationRegistrationAsync(final AndroidDevicePushNotificationRegistrationRequest request) { @@ -5578,6 +5960,8 @@ public PlayFabResult call() thr /** * Registers the Android device to receive push notifications + * @param request AndroidDevicePushNotificationRegistrationRequest + * @return AndroidDevicePushNotificationRegistrationResult */ @SuppressWarnings("unchecked") public static PlayFabResult AndroidDevicePushNotificationRegistration(final AndroidDevicePushNotificationRegistrationRequest request) { @@ -5624,6 +6008,8 @@ private static PlayFabResult pr /** * Validates a Google Play purchase and gives the corresponding item to the player. + * @param request ValidateGooglePlayPurchaseRequest + * @return Async Task will return ValidateGooglePlayPurchaseResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateGooglePlayPurchaseAsync(final ValidateGooglePlayPurchaseRequest request) { @@ -5636,6 +6022,8 @@ public PlayFabResult call() throws Exception { /** * Validates a Google Play purchase and gives the corresponding item to the player. + * @param request ValidateGooglePlayPurchaseRequest + * @return ValidateGooglePlayPurchaseResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateGooglePlayPurchase(final ValidateGooglePlayPurchaseRequest request) { @@ -5682,6 +6070,8 @@ private static PlayFabResult privateValidateGo /** * Writes a character-based event into PlayStream. + * @param request WriteClientCharacterEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteCharacterEventAsync(final WriteClientCharacterEventRequest request) { @@ -5694,6 +6084,8 @@ public PlayFabResult call() throws Exception { /** * Writes a character-based event into PlayStream. + * @param request WriteClientCharacterEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteCharacterEvent(final WriteClientCharacterEventRequest request) { @@ -5740,6 +6132,8 @@ private static PlayFabResult privateWriteCharacterEventAsync /** * Writes a player-based event into PlayStream. + * @param request WriteClientPlayerEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WritePlayerEventAsync(final WriteClientPlayerEventRequest request) { @@ -5752,6 +6146,8 @@ public PlayFabResult call() throws Exception { /** * Writes a player-based event into PlayStream. + * @param request WriteClientPlayerEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WritePlayerEvent(final WriteClientPlayerEventRequest request) { @@ -5798,6 +6194,8 @@ private static PlayFabResult privateWritePlayerEventAsync(fi /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteTitleEventAsync(final WriteTitleEventRequest request) { @@ -5810,6 +6208,8 @@ public PlayFabResult call() throws Exception { /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteTitleEvent(final WriteTitleEventRequest request) { @@ -5856,6 +6256,8 @@ private static PlayFabResult privateWriteTitleEventAsync(fin /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. + * @param request AddSharedGroupMembersRequest + * @return Async Task will return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> AddSharedGroupMembersAsync(final AddSharedGroupMembersRequest request) { @@ -5868,6 +6270,8 @@ public PlayFabResult call() throws Exception { /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group can add new members. + * @param request AddSharedGroupMembersRequest + * @return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddSharedGroupMembers(final AddSharedGroupMembersRequest request) { @@ -5914,6 +6318,8 @@ private static PlayFabResult privateAddSharedGroupM /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. + * @param request CreateSharedGroupRequest + * @return Async Task will return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateSharedGroupAsync(final CreateSharedGroupRequest request) { @@ -5926,6 +6332,8 @@ public PlayFabResult call() throws Exception { /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. + * @param request CreateSharedGroupRequest + * @return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateSharedGroup(final CreateSharedGroupRequest request) { @@ -5972,6 +6380,8 @@ private static PlayFabResult privateCreateSharedGroupAs /** * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. + * @param request GetSharedGroupDataRequest + * @return Async Task will return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetSharedGroupDataAsync(final GetSharedGroupDataRequest request) { @@ -5984,6 +6394,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. + * @param request GetSharedGroupDataRequest + * @return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetSharedGroupData(final GetSharedGroupDataRequest request) { @@ -6030,6 +6442,8 @@ private static PlayFabResult privateGetSharedGroupData /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return Async Task will return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveSharedGroupMembersAsync(final RemoveSharedGroupMembersRequest request) { @@ -6042,6 +6456,8 @@ public PlayFabResult call() throws Exception { /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveSharedGroupMembers(final RemoveSharedGroupMembersRequest request) { @@ -6088,6 +6504,8 @@ private static PlayFabResult privateRemoveShared /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. + * @param request UpdateSharedGroupDataRequest + * @return Async Task will return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateSharedGroupDataAsync(final UpdateSharedGroupDataRequest request) { @@ -6100,6 +6518,8 @@ public PlayFabResult call() throws Exception { /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. + * @param request UpdateSharedGroupDataRequest + * @return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateSharedGroupData(final UpdateSharedGroupDataRequest request) { @@ -6146,6 +6566,8 @@ private static PlayFabResult privateUpdateSharedGro /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. + * @param request ExecuteCloudScriptRequest + * @return Async Task will return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static FutureTask> ExecuteCloudScriptAsync(final ExecuteCloudScriptRequest request) { @@ -6158,6 +6580,8 @@ public PlayFabResult call() throws Exception { /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. + * @param request ExecuteCloudScriptRequest + * @return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ExecuteCloudScript(final ExecuteCloudScriptRequest request) { @@ -6204,6 +6628,8 @@ private static PlayFabResult privateExecuteCloudScript /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return Async Task will return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentDownloadUrlAsync(final GetContentDownloadUrlRequest request) { @@ -6216,6 +6642,8 @@ public PlayFabResult call() throws Exception { /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentDownloadUrl(final GetContentDownloadUrlRequest request) { @@ -6262,6 +6690,8 @@ private static PlayFabResult privateGetContentDownl /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return Async Task will return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllUsersCharactersAsync(final ListUsersCharactersRequest request) { @@ -6274,6 +6704,8 @@ public PlayFabResult call() throws Exception { /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllUsersCharacters(final ListUsersCharactersRequest request) { @@ -6320,6 +6752,8 @@ private static PlayFabResult privateGetAllUsersCharac /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return Async Task will return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterLeaderboardAsync(final GetCharacterLeaderboardRequest request) { @@ -6332,6 +6766,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterLeaderboard(final GetCharacterLeaderboardRequest request) { @@ -6378,6 +6814,8 @@ private static PlayFabResult privateGetCharacterL /** * Retrieves the details of all title-specific statistics for the user + * @param request GetCharacterStatisticsRequest + * @return Async Task will return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterStatisticsAsync(final GetCharacterStatisticsRequest request) { @@ -6390,6 +6828,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details of all title-specific statistics for the user + * @param request GetCharacterStatisticsRequest + * @return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterStatistics(final GetCharacterStatisticsRequest request) { @@ -6436,6 +6876,8 @@ private static PlayFabResult privateGetCharacterSt /** * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID + * @param request GetLeaderboardAroundCharacterRequest + * @return Async Task will return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundCharacterAsync(final GetLeaderboardAroundCharacterRequest request) { @@ -6448,6 +6890,8 @@ public PlayFabResult call() throws Exceptio /** * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID + * @param request GetLeaderboardAroundCharacterRequest + * @return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundCharacter(final GetLeaderboardAroundCharacterRequest request) { @@ -6494,6 +6938,8 @@ private static PlayFabResult privateGetLead /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return Async Task will return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardForUserCharactersAsync(final GetLeaderboardForUsersCharactersRequest request) { @@ -6506,6 +6952,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardForUserCharacters(final GetLeaderboardForUsersCharactersRequest request) { @@ -6552,6 +7000,8 @@ private static PlayFabResult privateGetL /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return Async Task will return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantCharacterToUserAsync(final GrantCharacterToUserRequest request) { @@ -6564,6 +7014,8 @@ public PlayFabResult call() throws Exception { /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantCharacterToUser(final GrantCharacterToUserRequest request) { @@ -6609,7 +7061,9 @@ private static PlayFabResult privateGrantCharacterTo } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdateCharacterStatisticsRequest + * @return Async Task will return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) { @@ -6621,7 +7075,9 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * @param request UpdateCharacterStatisticsRequest + * @return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterStatistics(final UpdateCharacterStatisticsRequest request) { @@ -6639,7 +7095,7 @@ public PlayFabResult call() throws Exception { } /** - * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. + * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) throws Exception { @@ -6668,6 +7124,8 @@ private static PlayFabResult privateUpdateChara /** * Retrieves the title-specific custom data for the character which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterDataAsync(final GetCharacterDataRequest request) { @@ -6680,6 +7138,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the character which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterData(final GetCharacterDataRequest request) { @@ -6726,6 +7186,8 @@ private static PlayFabResult privateGetCharacterDataAsyn /** * Retrieves the title-specific custom data for the character which can only be read by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterReadOnlyDataAsync(final GetCharacterDataRequest request) { @@ -6738,6 +7200,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the character which can only be read by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterReadOnlyData(final GetCharacterDataRequest request) { @@ -6784,6 +7248,8 @@ private static PlayFabResult privateGetCharacterReadOnly /** * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterDataAsync(final UpdateCharacterDataRequest request) { @@ -6796,6 +7262,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterData(final UpdateCharacterDataRequest request) { @@ -6842,6 +7310,8 @@ private static PlayFabResult privateUpdateCharacterDa /** * Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateAmazonReceiptRequest + * @return Async Task will return ValidateAmazonReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateAmazonIAPReceiptAsync(final ValidateAmazonReceiptRequest request) { @@ -6854,6 +7324,8 @@ public PlayFabResult call() throws Exception { /** * Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateAmazonReceiptRequest + * @return ValidateAmazonReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateAmazonIAPReceipt(final ValidateAmazonReceiptRequest request) { @@ -6900,6 +7372,8 @@ private static PlayFabResult privateValidateAmazonI /** * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories. + * @param request AcceptTradeRequest + * @return Async Task will return AcceptTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> AcceptTradeAsync(final AcceptTradeRequest request) { @@ -6912,6 +7386,8 @@ public PlayFabResult call() throws Exception { /** * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories. + * @param request AcceptTradeRequest + * @return AcceptTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult AcceptTrade(final AcceptTradeRequest request) { @@ -6958,6 +7434,8 @@ private static PlayFabResult privateAcceptTradeAsync(final /** * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player). + * @param request CancelTradeRequest + * @return Async Task will return CancelTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> CancelTradeAsync(final CancelTradeRequest request) { @@ -6970,6 +7448,8 @@ public PlayFabResult call() throws Exception { /** * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player). + * @param request CancelTradeRequest + * @return CancelTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult CancelTrade(final CancelTradeRequest request) { @@ -7016,6 +7496,8 @@ private static PlayFabResult privateCancelTradeAsync(final /** * Gets all trades the player has either opened or accepted, optionally filtered by trade status. + * @param request GetPlayerTradesRequest + * @return Async Task will return GetPlayerTradesResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTradesAsync(final GetPlayerTradesRequest request) { @@ -7028,6 +7510,8 @@ public PlayFabResult call() throws Exception { /** * Gets all trades the player has either opened or accepted, optionally filtered by trade status. + * @param request GetPlayerTradesRequest + * @return GetPlayerTradesResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTrades(final GetPlayerTradesRequest request) { @@ -7074,6 +7558,8 @@ private static PlayFabResult privateGetPlayerTradesAsyn /** * Gets the current status of an existing trade. + * @param request GetTradeStatusRequest + * @return Async Task will return GetTradeStatusResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetTradeStatusAsync(final GetTradeStatusRequest request) { @@ -7086,6 +7572,8 @@ public PlayFabResult call() throws Exception { /** * Gets the current status of an existing trade. + * @param request GetTradeStatusRequest + * @return GetTradeStatusResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetTradeStatus(final GetTradeStatusRequest request) { @@ -7132,6 +7620,8 @@ private static PlayFabResult privateGetTradeStatusAsync( /** * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time. + * @param request OpenTradeRequest + * @return Async Task will return OpenTradeResponse */ @SuppressWarnings("unchecked") public static FutureTask> OpenTradeAsync(final OpenTradeRequest request) { @@ -7144,6 +7634,8 @@ public PlayFabResult call() throws Exception { /** * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time. + * @param request OpenTradeRequest + * @return OpenTradeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult OpenTrade(final OpenTradeRequest request) { @@ -7190,6 +7682,8 @@ private static PlayFabResult privateOpenTradeAsync(final Open /** * Attributes an install for advertisment. + * @param request AttributeInstallRequest + * @return Async Task will return AttributeInstallResult */ @SuppressWarnings("unchecked") public static FutureTask> AttributeInstallAsync(final AttributeInstallRequest request) { @@ -7202,6 +7696,8 @@ public PlayFabResult call() throws Exception { /** * Attributes an install for advertisment. + * @param request AttributeInstallRequest + * @return AttributeInstallResult */ @SuppressWarnings("unchecked") public static PlayFabResult AttributeInstall(final AttributeInstallRequest request) { @@ -7250,6 +7746,8 @@ private static PlayFabResult privateAttributeInstallAsyn /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayerSegmentsRequest + * @return Async Task will return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerSegmentsAsync(final GetPlayerSegmentsRequest request) { @@ -7262,6 +7760,8 @@ public PlayFabResult call() throws Exception { /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayerSegmentsRequest + * @return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerSegments(final GetPlayerSegmentsRequest request) { @@ -7308,6 +7808,8 @@ private static PlayFabResult privateGetPlayerSegmentsAs /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return Async Task will return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTagsAsync(final GetPlayerTagsRequest request) { @@ -7320,6 +7822,8 @@ public PlayFabResult call() throws Exception { /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTags(final GetPlayerTagsRequest request) { @@ -7366,6 +7870,8 @@ private static PlayFabResult privateGetPlayerTagsAsync(fina /** * Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateWindowsReceiptRequest + * @return Async Task will return ValidateWindowsReceiptResult */ @SuppressWarnings("unchecked") public static FutureTask> ValidateWindowsStoreReceiptAsync(final ValidateWindowsReceiptRequest request) { @@ -7378,6 +7884,8 @@ public PlayFabResult call() throws Exception { /** * Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item + * @param request ValidateWindowsReceiptRequest + * @return ValidateWindowsReceiptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ValidateWindowsStoreReceipt(final ValidateWindowsReceiptRequest request) { diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabClientModels.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabClientModels.java index d2b0f010f..8bc68cf60 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabClientModels.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabClientModels.java @@ -436,7 +436,7 @@ public static enum CloudScriptRevisionOption { } /** - * Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection. + * Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection. */ public static class CollectionFilter { /** @@ -1193,7 +1193,7 @@ public static class GameServerRegionsRequest { */ public String BuildVersion; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; @@ -1434,6 +1434,14 @@ public static class GetFriendLeaderboardAroundPlayerRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1478,6 +1486,14 @@ public static class GetFriendLeaderboardRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1546,6 +1562,14 @@ public static class GetLeaderboardAroundPlayerRequest { * Maximum number of entries to retrieve. Default 10, maximum 100. */ public Integer MaxResultsCount; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1602,6 +1626,14 @@ public static class GetLeaderboardRequest { * Maximum number of entries to retrieve. Default 10, maximum 100. */ public Integer MaxResultsCount; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1643,7 +1675,7 @@ public static class GetPhotonAuthenticationTokenResult { public static class GetPlayerCombinedInfoRequest { /** - * PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. + * PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. */ public String PlayFabId; /** @@ -1980,7 +2012,7 @@ public static class GetPlayFabIDsFromTwitchIDsResult { public static class GetPublisherDataRequest { /** - * array of keys to get back data from the Publisher data blob, set by the admin tools + * array of keys to get back data from the Publisher data blob, set by the admin tools */ public ArrayList Keys; @@ -2024,7 +2056,7 @@ public static class GetPurchaseResult { */ public Date PurchaseDate; /** - * @deprecated Please use instead. + * @deprecated Please use instead. */ @Deprecated public ArrayList Items; @@ -2227,7 +2259,7 @@ public static class GetUserInventoryResult { public static class GetWindowsHelloChallengeRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2688,7 +2720,7 @@ public static class LoginResult { public static class LoginWithAndroidDeviceIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2716,7 +2748,7 @@ public static class LoginWithAndroidDeviceIDRequest { public static class LoginWithCustomIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2727,6 +2759,14 @@ public static class LoginWithCustomIDRequest { * Automatically create a PlayFab account if one is not currently linked to this Custom ID. */ public Boolean CreateAccount; + /** + * Player secret that is used to verify API request signatures + */ + public String PlayerSecret; + /** + * Base64 encoded body that is encrypted with the Title's public RSA key + */ + public String EncryptedRequest; /** * Flags for which pieces of info to return for the user. */ @@ -2736,7 +2776,7 @@ public static class LoginWithCustomIDRequest { public static class LoginWithEmailAddressRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2756,7 +2796,7 @@ public static class LoginWithEmailAddressRequest { public static class LoginWithFacebookRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2776,7 +2816,7 @@ public static class LoginWithFacebookRequest { public static class LoginWithGameCenterRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2796,7 +2836,7 @@ public static class LoginWithGameCenterRequest { public static class LoginWithGoogleAccountRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2816,7 +2856,7 @@ public static class LoginWithGoogleAccountRequest { public static class LoginWithIOSDeviceIDRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2844,7 +2884,7 @@ public static class LoginWithIOSDeviceIDRequest { public static class LoginWithKongregateRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2868,7 +2908,7 @@ public static class LoginWithKongregateRequest { public static class LoginWithPlayFabRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2888,7 +2928,7 @@ public static class LoginWithPlayFabRequest { public static class LoginWithSteamRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2908,7 +2948,7 @@ public static class LoginWithSteamRequest { public static class LoginWithTwitchRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -2928,7 +2968,7 @@ public static class LoginWithTwitchRequest { public static class LoginWithWindowsHelloRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3489,7 +3529,7 @@ public static class RegisterForIOSPushNotificationResult { public static class RegisterPlayFabUserRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3537,7 +3577,7 @@ public static class RegisterPlayFabUserResult { public static class RegisterWithWindowsHelloRequest { /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -3657,7 +3697,7 @@ public static class SendAccountRecoveryEmailRequest { */ public String Email; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabErrors.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabErrors.java index deba6e253..57673eed3 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabErrors.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabErrors.java @@ -288,7 +288,15 @@ public static enum PlayFabErrorCode { ExpressionInvokeFailure(1285), ExpressionTooLong(1286), DataUpdateRateExceeded(1287), - RestrictedEmailDomain(1288); + RestrictedEmailDomain(1288), + EncryptionKeyDisabled(1289), + EncryptionKeyMissing(1290), + EncryptionKeyBroken(1291), + NoSharedSecretKeyConfigured(1292), + SecretKeyNotFound(1293), + PlayerSecretAlreadyConfigured(1294), + APIRequestsDisabledForTitle(1295), + InvalidSharedSecretKey(1296); public int id; diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerAPI.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerAPI.java index 47a138c45..1e4f3c171 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerAPI.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerAPI.java @@ -18,6 +18,8 @@ public class PlayFabMatchmakerAPI { /** * Validates a user with the PlayFab service + * @param request AuthUserRequest + * @return Async Task will return AuthUserResponse */ @SuppressWarnings("unchecked") public static FutureTask> AuthUserAsync(final AuthUserRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception { /** * Validates a user with the PlayFab service + * @param request AuthUserRequest + * @return AuthUserResponse */ @SuppressWarnings("unchecked") public static PlayFabResult AuthUser(final AuthUserRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateAuthUserAsync(final AuthUs /** * Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified + * @param request PlayerJoinedRequest + * @return Async Task will return PlayerJoinedResponse */ @SuppressWarnings("unchecked") public static FutureTask> PlayerJoinedAsync(final PlayerJoinedRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified + * @param request PlayerJoinedRequest + * @return PlayerJoinedResponse */ @SuppressWarnings("unchecked") public static PlayFabResult PlayerJoined(final PlayerJoinedRequest request) { @@ -134,6 +142,8 @@ private static PlayFabResult privatePlayerJoinedAsync(fina /** * Informs the PlayFab game server hosting service that the indicated user has left the Game Server Instance specified + * @param request PlayerLeftRequest + * @return Async Task will return PlayerLeftResponse */ @SuppressWarnings("unchecked") public static FutureTask> PlayerLeftAsync(final PlayerLeftRequest request) { @@ -146,6 +156,8 @@ public PlayFabResult call() throws Exception { /** * Informs the PlayFab game server hosting service that the indicated user has left the Game Server Instance specified + * @param request PlayerLeftRequest + * @return PlayerLeftResponse */ @SuppressWarnings("unchecked") public static PlayFabResult PlayerLeft(final PlayerLeftRequest request) { @@ -192,6 +204,8 @@ private static PlayFabResult privatePlayerLeftAsync(final Pl /** * Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance + * @param request StartGameRequest + * @return Async Task will return StartGameResponse */ @SuppressWarnings("unchecked") public static FutureTask> StartGameAsync(final StartGameRequest request) { @@ -204,6 +218,8 @@ public PlayFabResult call() throws Exception { /** * Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance + * @param request StartGameRequest + * @return StartGameResponse */ @SuppressWarnings("unchecked") public static PlayFabResult StartGame(final StartGameRequest request) { @@ -250,6 +266,8 @@ private static PlayFabResult privateStartGameAsync(final Star /** * Retrieves the relevant details for a specified user, which the external match-making service can then use to compute effective matches + * @param request UserInfoRequest + * @return Async Task will return UserInfoResponse */ @SuppressWarnings("unchecked") public static FutureTask> UserInfoAsync(final UserInfoRequest request) { @@ -262,6 +280,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the relevant details for a specified user, which the external match-making service can then use to compute effective matches + * @param request UserInfoRequest + * @return UserInfoResponse */ @SuppressWarnings("unchecked") public static PlayFabResult UserInfo(final UserInfoRequest request) { diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java index f7eb9db4f..bbbba1b78 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java @@ -205,7 +205,7 @@ public static class StartGameRequest { */ public String CustomCommandLineData; /** - * HTTP endpoint URL for receiving game status events, if using an external matchmaker. When the game ends, PlayFab will make a POST request to this URL with the X-SecretKey header set to the value of the game's secret and an application/json body of { "EventName": "game_ended", "GameID": "> AuthenticateSessionTicketAsync(final AuthenticateSessionTicketRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception { /** * Validated a client's session ticket, and if successful, returns details for that user + * @param request AuthenticateSessionTicketRequest + * @return AuthenticateSessionTicketResult */ @SuppressWarnings("unchecked") public static PlayFabResult AuthenticateSessionTicket(final AuthenticateSessionTicketRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateAuthenticat /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return Async Task will return BanUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> BanUsersAsync(final BanUsersRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return BanUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult BanUsers(final BanUsersRequest request) { @@ -134,6 +142,8 @@ private static PlayFabResult privateBanUsersAsync(final BanUsers /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return Async Task will return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromFacebookIDsAsync(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -146,6 +156,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromFacebookIDs(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -192,6 +204,8 @@ private static PlayFabResult privateGetPlayF /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return Async Task will return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromSteamIDsAsync(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -204,6 +218,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromSteamIDs(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -250,6 +266,8 @@ private static PlayFabResult privateGetPlayFabI /** * Retrieves the relevant details for a specified user + * @param request GetUserAccountInfoRequest + * @return Async Task will return GetUserAccountInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserAccountInfoAsync(final GetUserAccountInfoRequest request) { @@ -262,6 +280,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the relevant details for a specified user + * @param request GetUserAccountInfoRequest + * @return GetUserAccountInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserAccountInfo(final GetUserAccountInfoRequest request) { @@ -308,6 +328,8 @@ private static PlayFabResult privateGetUserAccountInfo /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return Async Task will return GetUserBansResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserBansAsync(final GetUserBansRequest request) { @@ -320,6 +342,8 @@ public PlayFabResult call() throws Exception { /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return GetUserBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserBans(final GetUserBansRequest request) { @@ -366,6 +390,8 @@ private static PlayFabResult privateGetUserBansAsync(final Ge /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return Async Task will return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeAllBansForUserAsync(final RevokeAllBansForUserRequest request) { @@ -378,6 +404,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeAllBansForUser(final RevokeAllBansForUserRequest request) { @@ -424,6 +452,8 @@ private static PlayFabResult privateRevokeAllBansFor /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return Async Task will return RevokeBansResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeBansAsync(final RevokeBansRequest request) { @@ -436,6 +466,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return RevokeBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeBans(final RevokeBansRequest request) { @@ -482,6 +514,8 @@ private static PlayFabResult privateRevokeBansAsync(final Revo /** * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified. + * @param request SendPushNotificationRequest + * @return Async Task will return SendPushNotificationResult */ @SuppressWarnings("unchecked") public static FutureTask> SendPushNotificationAsync(final SendPushNotificationRequest request) { @@ -494,6 +528,8 @@ public PlayFabResult call() throws Exception { /** * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified. + * @param request SendPushNotificationRequest + * @return SendPushNotificationResult */ @SuppressWarnings("unchecked") public static PlayFabResult SendPushNotification(final SendPushNotificationRequest request) { @@ -540,6 +576,8 @@ private static PlayFabResult privateSendPushNotifica /** * Update the avatar URL of the specified player + * @param request UpdateAvatarUrlRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateAvatarUrlAsync(final UpdateAvatarUrlRequest request) { @@ -552,6 +590,8 @@ public PlayFabResult call() throws Exception { /** * Update the avatar URL of the specified player + * @param request UpdateAvatarUrlRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateAvatarUrl(final UpdateAvatarUrlRequest request) { @@ -598,6 +638,8 @@ private static PlayFabResult privateUpdateAvatarUrlAsync(final Upda /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return Async Task will return UpdateBansResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateBansAsync(final UpdateBansRequest request) { @@ -610,6 +652,8 @@ public PlayFabResult call() throws Exception { /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return UpdateBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateBans(final UpdateBansRequest request) { @@ -656,6 +700,8 @@ private static PlayFabResult privateUpdateBansAsync(final Upda /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. + * @param request DeleteUsersRequest + * @return Async Task will return DeleteUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteUsersAsync(final DeleteUsersRequest request) { @@ -668,6 +714,8 @@ public PlayFabResult call() throws Exception { /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. + * @param request DeleteUsersRequest + * @return DeleteUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteUsers(final DeleteUsersRequest request) { @@ -714,6 +762,8 @@ private static PlayFabResult privateDeleteUsersAsync(final De /** * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAsync(final GetFriendLeaderboardRequest request) { @@ -726,6 +776,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboard(final GetFriendLeaderboardRequest request) { @@ -772,6 +824,8 @@ private static PlayFabResult privateGetFriendLeaderboardAs /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAsync(final GetLeaderboardRequest request) { @@ -784,6 +838,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboard(final GetLeaderboardRequest request) { @@ -830,6 +886,8 @@ private static PlayFabResult privateGetLeaderboardAsync(fi /** * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user + * @param request GetLeaderboardAroundUserRequest + * @return Async Task will return GetLeaderboardAroundUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundUserAsync(final GetLeaderboardAroundUserRequest request) { @@ -842,6 +900,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user + * @param request GetLeaderboardAroundUserRequest + * @return GetLeaderboardAroundUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundUser(final GetLeaderboardAroundUserRequest request) { @@ -888,6 +948,8 @@ private static PlayFabResult privateGetLeaderboa /** * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false. + * @param request GetPlayerCombinedInfoRequest + * @return Async Task will return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerCombinedInfoAsync(final GetPlayerCombinedInfoRequest request) { @@ -900,6 +962,8 @@ public PlayFabResult call() throws Exception { /** * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false. + * @param request GetPlayerCombinedInfoRequest + * @return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerCombinedInfo(final GetPlayerCombinedInfoRequest request) { @@ -946,6 +1010,8 @@ private static PlayFabResult privateGetPlayerCombin /** * Retrieves the current version and values for the indicated statistics, for the local player. + * @param request GetPlayerStatisticsRequest + * @return Async Task will return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticsAsync(final GetPlayerStatisticsRequest request) { @@ -958,6 +1024,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current version and values for the indicated statistics, for the local player. + * @param request GetPlayerStatisticsRequest + * @return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatistics(final GetPlayerStatisticsRequest request) { @@ -1004,6 +1072,8 @@ private static PlayFabResult privateGetPlayerStatisti /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return Async Task will return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticVersionsAsync(final GetPlayerStatisticVersionsRequest request) { @@ -1016,6 +1086,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticVersions(final GetPlayerStatisticVersionsRequest request) { @@ -1062,6 +1134,8 @@ private static PlayFabResult privateGetPlayerS /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserDataAsync(final GetUserDataRequest request) { @@ -1074,6 +1148,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserData(final GetUserDataRequest request) { @@ -1120,6 +1196,8 @@ private static PlayFabResult privateGetUserDataAsync(final Ge /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInternalDataAsync(final GetUserDataRequest request) { @@ -1132,6 +1210,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInternalData(final GetUserDataRequest request) { @@ -1178,6 +1258,8 @@ private static PlayFabResult privateGetUserInternalDataAsync( /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherDataAsync(final GetUserDataRequest request) { @@ -1190,6 +1272,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherData(final GetUserDataRequest request) { @@ -1236,6 +1320,8 @@ private static PlayFabResult privateGetUserPublisherDataAsync /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherInternalDataAsync(final GetUserDataRequest request) { @@ -1248,6 +1334,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherInternalData(final GetUserDataRequest request) { @@ -1294,6 +1382,8 @@ private static PlayFabResult privateGetUserPublisherInternalD /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1306,6 +1396,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherReadOnlyData(final GetUserDataRequest request) { @@ -1352,6 +1444,8 @@ private static PlayFabResult privateGetUserPublisherReadOnlyD /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1364,6 +1458,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserReadOnlyData(final GetUserDataRequest request) { @@ -1410,6 +1506,8 @@ private static PlayFabResult privateGetUserReadOnlyDataAsync( /** * Updates the values of the specified title-specific statistics for the user + * @param request UpdatePlayerStatisticsRequest + * @return Async Task will return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) { @@ -1422,6 +1520,8 @@ public PlayFabResult call() throws Exception { /** * Updates the values of the specified title-specific statistics for the user + * @param request UpdatePlayerStatisticsRequest + * @return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePlayerStatistics(final UpdatePlayerStatisticsRequest request) { @@ -1468,6 +1568,8 @@ private static PlayFabResult privateUpdatePlayerSt /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserDataAsync(final UpdateUserDataRequest request) { @@ -1480,6 +1582,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserData(final UpdateUserDataRequest request) { @@ -1526,6 +1630,8 @@ private static PlayFabResult privateUpdateUserDataAsync(fi /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1538,6 +1644,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserInternalData(final UpdateUserInternalDataRequest request) { @@ -1584,6 +1692,8 @@ private static PlayFabResult privateUpdateUserInternalData /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherDataAsync(final UpdateUserDataRequest request) { @@ -1596,6 +1706,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherData(final UpdateUserDataRequest request) { @@ -1642,6 +1754,8 @@ private static PlayFabResult privateUpdateUserPublisherDat /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1654,6 +1768,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherInternalData(final UpdateUserInternalDataRequest request) { @@ -1700,6 +1816,8 @@ private static PlayFabResult privateUpdateUserPublisherInt /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1712,6 +1830,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherReadOnlyData(final UpdateUserDataRequest request) { @@ -1758,6 +1878,8 @@ private static PlayFabResult privateUpdateUserPublisherRea /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1770,6 +1892,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserReadOnlyData(final UpdateUserDataRequest request) { @@ -1816,6 +1940,8 @@ private static PlayFabResult privateUpdateUserReadOnlyData /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return Async Task will return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCatalogItemsAsync(final GetCatalogItemsRequest request) { @@ -1828,6 +1954,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCatalogItems(final GetCatalogItemsRequest request) { @@ -1874,6 +2002,8 @@ private static PlayFabResult privateGetCatalogItemsAsync( /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return Async Task will return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPublisherDataAsync(final GetPublisherDataRequest request) { @@ -1886,6 +2016,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPublisherData(final GetPublisherDataRequest request) { @@ -1932,6 +2064,8 @@ private static PlayFabResult privateGetPublisherDataAsyn /** * Retrieves the current server time + * @param request GetTimeRequest + * @return Async Task will return GetTimeResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTimeAsync(final GetTimeRequest request) { @@ -1944,6 +2078,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current server time + * @param request GetTimeRequest + * @return GetTimeResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTime(final GetTimeRequest request) { @@ -1990,6 +2126,8 @@ private static PlayFabResult privateGetTimeAsync(final GetTimeReq /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleDataAsync(final GetTitleDataRequest request) { @@ -2002,6 +2140,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleData(final GetTitleDataRequest request) { @@ -2048,6 +2188,8 @@ private static PlayFabResult privateGetTitleDataAsync(final /** * Retrieves the key-value store of custom internal title settings + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleInternalDataAsync(final GetTitleDataRequest request) { @@ -2060,6 +2202,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom internal title settings + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleInternalData(final GetTitleDataRequest request) { @@ -2106,6 +2250,8 @@ private static PlayFabResult privateGetTitleInternalDataAsyn /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return Async Task will return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleNewsAsync(final GetTitleNewsRequest request) { @@ -2118,6 +2264,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleNews(final GetTitleNewsRequest request) { @@ -2164,6 +2312,8 @@ private static PlayFabResult privateGetTitleNewsAsync(final /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return Async Task will return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetPublisherDataAsync(final SetPublisherDataRequest request) { @@ -2176,6 +2326,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetPublisherData(final SetPublisherDataRequest request) { @@ -2222,6 +2374,8 @@ private static PlayFabResult privateSetPublisherDataAsyn /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleDataAsync(final SetTitleDataRequest request) { @@ -2234,6 +2388,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleData(final SetTitleDataRequest request) { @@ -2280,6 +2436,8 @@ private static PlayFabResult privateSetTitleDataAsync(final /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleInternalDataAsync(final SetTitleDataRequest request) { @@ -2292,6 +2450,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleInternalData(final SetTitleDataRequest request) { @@ -2338,6 +2498,8 @@ private static PlayFabResult privateSetTitleInternalDataAsyn /** * Increments the character's balance of the specified virtual currency by the stated amount + * @param request AddCharacterVirtualCurrencyRequest + * @return Async Task will return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddCharacterVirtualCurrencyAsync(final AddCharacterVirtualCurrencyRequest request) { @@ -2350,6 +2512,8 @@ public PlayFabResult call() throws Excepti /** * Increments the character's balance of the specified virtual currency by the stated amount + * @param request AddCharacterVirtualCurrencyRequest + * @return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddCharacterVirtualCurrency(final AddCharacterVirtualCurrencyRequest request) { @@ -2396,6 +2560,8 @@ private static PlayFabResult privateAddCha /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUserVirtualCurrencyAsync(final AddUserVirtualCurrencyRequest request) { @@ -2408,6 +2574,8 @@ public PlayFabResult call() throws Exception { /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUserVirtualCurrency(final AddUserVirtualCurrencyRequest request) { @@ -2454,6 +2622,8 @@ private static PlayFabResult privateAddUserVirt /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return Async Task will return ConsumeItemResult */ @SuppressWarnings("unchecked") public static FutureTask> ConsumeItemAsync(final ConsumeItemRequest request) { @@ -2466,6 +2636,8 @@ public PlayFabResult call() throws Exception { /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return ConsumeItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConsumeItem(final ConsumeItemRequest request) { @@ -2512,6 +2684,8 @@ private static PlayFabResult privateConsumeItemAsync(final Co /** * Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer. + * @param request EvaluateRandomResultTableRequest + * @return Async Task will return EvaluateRandomResultTableResult */ @SuppressWarnings("unchecked") public static FutureTask> EvaluateRandomResultTableAsync(final EvaluateRandomResultTableRequest request) { @@ -2524,6 +2698,8 @@ public PlayFabResult call() throws Exception { /** * Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer. + * @param request EvaluateRandomResultTableRequest + * @return EvaluateRandomResultTableResult */ @SuppressWarnings("unchecked") public static PlayFabResult EvaluateRandomResultTable(final EvaluateRandomResultTableRequest request) { @@ -2570,6 +2746,8 @@ private static PlayFabResult privateEvaluateRan /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return Async Task will return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterInventoryAsync(final GetCharacterInventoryRequest request) { @@ -2582,6 +2760,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterInventory(final GetCharacterInventoryRequest request) { @@ -2628,6 +2808,8 @@ private static PlayFabResult privateGetCharacterInv /** * Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights + * @param request GetRandomResultTablesRequest + * @return Async Task will return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetRandomResultTablesAsync(final GetRandomResultTablesRequest request) { @@ -2640,6 +2822,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights + * @param request GetRandomResultTablesRequest + * @return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetRandomResultTables(final GetRandomResultTablesRequest request) { @@ -2686,6 +2870,8 @@ private static PlayFabResult privateGetRandomResult /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return Async Task will return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInventoryAsync(final GetUserInventoryRequest request) { @@ -2698,6 +2884,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInventory(final GetUserInventoryRequest request) { @@ -2744,6 +2932,8 @@ private static PlayFabResult privateGetUserInventoryAsyn /** * Adds the specified items to the specified character's inventory + * @param request GrantItemsToCharacterRequest + * @return Async Task will return GrantItemsToCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToCharacterAsync(final GrantItemsToCharacterRequest request) { @@ -2756,6 +2946,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified character's inventory + * @param request GrantItemsToCharacterRequest + * @return GrantItemsToCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToCharacter(final GrantItemsToCharacterRequest request) { @@ -2802,6 +2994,8 @@ private static PlayFabResult privateGrantItemsToCha /** * Adds the specified items to the specified user's inventory + * @param request GrantItemsToUserRequest + * @return Async Task will return GrantItemsToUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToUserAsync(final GrantItemsToUserRequest request) { @@ -2814,6 +3008,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified user's inventory + * @param request GrantItemsToUserRequest + * @return GrantItemsToUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToUser(final GrantItemsToUserRequest request) { @@ -2860,6 +3056,8 @@ private static PlayFabResult privateGrantItemsToUserAsyn /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return Async Task will return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToUsersAsync(final GrantItemsToUsersRequest request) { @@ -2872,6 +3070,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToUsers(final GrantItemsToUsersRequest request) { @@ -2918,6 +3118,8 @@ private static PlayFabResult privateGrantItemsToUsersAs /** * Modifies the number of remaining uses of a player's inventory item + * @param request ModifyItemUsesRequest + * @return Async Task will return ModifyItemUsesResult */ @SuppressWarnings("unchecked") public static FutureTask> ModifyItemUsesAsync(final ModifyItemUsesRequest request) { @@ -2930,6 +3132,8 @@ public PlayFabResult call() throws Exception { /** * Modifies the number of remaining uses of a player's inventory item + * @param request ModifyItemUsesRequest + * @return ModifyItemUsesResult */ @SuppressWarnings("unchecked") public static PlayFabResult ModifyItemUses(final ModifyItemUsesRequest request) { @@ -2976,6 +3180,8 @@ private static PlayFabResult privateModifyItemUsesAsync(fi /** * Moves an item from a character's inventory into another of the users's character's inventory. + * @param request MoveItemToCharacterFromCharacterRequest + * @return Async Task will return MoveItemToCharacterFromCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> MoveItemToCharacterFromCharacterAsync(final MoveItemToCharacterFromCharacterRequest request) { @@ -2988,6 +3194,8 @@ public PlayFabResult call() throws Excep /** * Moves an item from a character's inventory into another of the users's character's inventory. + * @param request MoveItemToCharacterFromCharacterRequest + * @return MoveItemToCharacterFromCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult MoveItemToCharacterFromCharacter(final MoveItemToCharacterFromCharacterRequest request) { @@ -3034,6 +3242,8 @@ private static PlayFabResult privateMove /** * Moves an item from a user's inventory into their character's inventory. + * @param request MoveItemToCharacterFromUserRequest + * @return Async Task will return MoveItemToCharacterFromUserResult */ @SuppressWarnings("unchecked") public static FutureTask> MoveItemToCharacterFromUserAsync(final MoveItemToCharacterFromUserRequest request) { @@ -3046,6 +3256,8 @@ public PlayFabResult call() throws Exception /** * Moves an item from a user's inventory into their character's inventory. + * @param request MoveItemToCharacterFromUserRequest + * @return MoveItemToCharacterFromUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult MoveItemToCharacterFromUser(final MoveItemToCharacterFromUserRequest request) { @@ -3092,6 +3304,8 @@ private static PlayFabResult privateMoveItemT /** * Moves an item from a character's inventory into the owning user's inventory. + * @param request MoveItemToUserFromCharacterRequest + * @return Async Task will return MoveItemToUserFromCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> MoveItemToUserFromCharacterAsync(final MoveItemToUserFromCharacterRequest request) { @@ -3104,6 +3318,8 @@ public PlayFabResult call() throws Exception /** * Moves an item from a character's inventory into the owning user's inventory. + * @param request MoveItemToUserFromCharacterRequest + * @return MoveItemToUserFromCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult MoveItemToUserFromCharacter(final MoveItemToUserFromCharacterRequest request) { @@ -3149,7 +3365,9 @@ private static PlayFabResult privateMoveItemT } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return Async Task will return RedeemCouponResult */ @SuppressWarnings("unchecked") public static FutureTask> RedeemCouponAsync(final RedeemCouponRequest request) { @@ -3161,7 +3379,9 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return RedeemCouponResult */ @SuppressWarnings("unchecked") public static PlayFabResult RedeemCoupon(final RedeemCouponRequest request) { @@ -3179,7 +3399,7 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. */ @SuppressWarnings("unchecked") private static PlayFabResult privateRedeemCouponAsync(final RedeemCouponRequest request) throws Exception { @@ -3208,6 +3428,8 @@ private static PlayFabResult privateRedeemCouponAsync(final /** * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerServerRequest + * @return Async Task will return ReportPlayerServerResult */ @SuppressWarnings("unchecked") public static FutureTask> ReportPlayerAsync(final ReportPlayerServerRequest request) { @@ -3220,6 +3442,8 @@ public PlayFabResult call() throws Exception { /** * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerServerRequest + * @return ReportPlayerServerResult */ @SuppressWarnings("unchecked") public static PlayFabResult ReportPlayer(final ReportPlayerServerRequest request) { @@ -3266,6 +3490,8 @@ private static PlayFabResult privateReportPlayerAsync( /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return Async Task will return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeInventoryItemAsync(final RevokeInventoryItemRequest request) { @@ -3278,6 +3504,8 @@ public PlayFabResult call() throws Exception { /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeInventoryItem(final RevokeInventoryItemRequest request) { @@ -3324,6 +3552,8 @@ private static PlayFabResult privateRevokeInventoryItemAs /** * Decrements the character's balance of the specified virtual currency by the stated amount + * @param request SubtractCharacterVirtualCurrencyRequest + * @return Async Task will return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractCharacterVirtualCurrencyAsync(final SubtractCharacterVirtualCurrencyRequest request) { @@ -3336,6 +3566,8 @@ public PlayFabResult call() throws Excepti /** * Decrements the character's balance of the specified virtual currency by the stated amount + * @param request SubtractCharacterVirtualCurrencyRequest + * @return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractCharacterVirtualCurrency(final SubtractCharacterVirtualCurrencyRequest request) { @@ -3382,6 +3614,8 @@ private static PlayFabResult privateSubtra /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractUserVirtualCurrencyAsync(final SubtractUserVirtualCurrencyRequest request) { @@ -3394,6 +3628,8 @@ public PlayFabResult call() throws Exception { /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractUserVirtualCurrency(final SubtractUserVirtualCurrencyRequest request) { @@ -3439,7 +3675,9 @@ private static PlayFabResult privateSubtractUse } /** - * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) { @@ -3451,7 +3689,9 @@ public PlayFabResult call() throws Exception { } /** - * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerInstance(final UnlockContainerInstanceRequest request) { @@ -3469,7 +3709,7 @@ public PlayFabResult call() throws Exception { } /** - * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) throws Exception { @@ -3497,7 +3737,9 @@ private static PlayFabResult privateUnlockContainerIn } /** - * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerItemAsync(final UnlockContainerItemRequest request) { @@ -3509,7 +3751,9 @@ public PlayFabResult call() throws Exception { } /** - * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerItem(final UnlockContainerItemRequest request) { @@ -3527,7 +3771,7 @@ public PlayFabResult call() throws Exception { } /** - * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerItemAsync(final UnlockContainerItemRequest request) throws Exception { @@ -3556,6 +3800,8 @@ private static PlayFabResult privateUnlockContainerIt /** * Updates the key-value pair data tagged to the specified item, which is read-only from the client. + * @param request UpdateUserInventoryItemDataRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserInventoryItemCustomDataAsync(final UpdateUserInventoryItemDataRequest request) { @@ -3568,6 +3814,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value pair data tagged to the specified item, which is read-only from the client. + * @param request UpdateUserInventoryItemDataRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserInventoryItemCustomData(final UpdateUserInventoryItemDataRequest request) { @@ -3614,6 +3862,8 @@ private static PlayFabResult privateUpdateUserInventoryItemCustomDa /** * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddFriendAsync(final AddFriendRequest request) { @@ -3626,6 +3876,8 @@ public PlayFabResult call() throws Exception { /** * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddFriend(final AddFriendRequest request) { @@ -3672,6 +3924,8 @@ private static PlayFabResult privateAddFriendAsync(final AddFriendR /** * Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return Async Task will return GetFriendsListResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendsListAsync(final GetFriendsListRequest request) { @@ -3684,6 +3938,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return GetFriendsListResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendsList(final GetFriendsListRequest request) { @@ -3730,6 +3986,8 @@ private static PlayFabResult privateGetFriendsListAsync(fi /** * Removes the specified friend from the the user's friend list + * @param request RemoveFriendRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveFriendAsync(final RemoveFriendRequest request) { @@ -3742,6 +4000,8 @@ public PlayFabResult call() throws Exception { /** * Removes the specified friend from the the user's friend list + * @param request RemoveFriendRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveFriend(final RemoveFriendRequest request) { @@ -3788,6 +4048,8 @@ private static PlayFabResult privateRemoveFriendAsync(final RemoveF /** * Updates the tag list for a specified user in the friend list of another user + * @param request SetFriendTagsRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> SetFriendTagsAsync(final SetFriendTagsRequest request) { @@ -3800,6 +4062,8 @@ public PlayFabResult call() throws Exception { /** * Updates the tag list for a specified user in the friend list of another user + * @param request SetFriendTagsRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetFriendTags(final SetFriendTagsRequest request) { @@ -3846,6 +4110,8 @@ private static PlayFabResult privateSetFriendTagsAsync(final SetFri /** * Inform the matchmaker that a Game Server Instance is removed. + * @param request DeregisterGameRequest + * @return Async Task will return DeregisterGameResponse */ @SuppressWarnings("unchecked") public static FutureTask> DeregisterGameAsync(final DeregisterGameRequest request) { @@ -3858,6 +4124,8 @@ public PlayFabResult call() throws Exception { /** * Inform the matchmaker that a Game Server Instance is removed. + * @param request DeregisterGameRequest + * @return DeregisterGameResponse */ @SuppressWarnings("unchecked") public static PlayFabResult DeregisterGame(final DeregisterGameRequest request) { @@ -3904,6 +4172,8 @@ private static PlayFabResult privateDeregisterGameAsync( /** * Informs the PlayFab match-making service that the user specified has left the Game Server Instance + * @param request NotifyMatchmakerPlayerLeftRequest + * @return Async Task will return NotifyMatchmakerPlayerLeftResult */ @SuppressWarnings("unchecked") public static FutureTask> NotifyMatchmakerPlayerLeftAsync(final NotifyMatchmakerPlayerLeftRequest request) { @@ -3916,6 +4186,8 @@ public PlayFabResult call() throws Exception { /** * Informs the PlayFab match-making service that the user specified has left the Game Server Instance + * @param request NotifyMatchmakerPlayerLeftRequest + * @return NotifyMatchmakerPlayerLeftResult */ @SuppressWarnings("unchecked") public static PlayFabResult NotifyMatchmakerPlayerLeft(final NotifyMatchmakerPlayerLeftRequest request) { @@ -3962,6 +4234,8 @@ private static PlayFabResult privateNotifyMatc /** * Validates a Game Server session ticket and returns details about the user + * @param request RedeemMatchmakerTicketRequest + * @return Async Task will return RedeemMatchmakerTicketResult */ @SuppressWarnings("unchecked") public static FutureTask> RedeemMatchmakerTicketAsync(final RedeemMatchmakerTicketRequest request) { @@ -3974,6 +4248,8 @@ public PlayFabResult call() throws Exception { /** * Validates a Game Server session ticket and returns details about the user + * @param request RedeemMatchmakerTicketRequest + * @return RedeemMatchmakerTicketResult */ @SuppressWarnings("unchecked") public static PlayFabResult RedeemMatchmakerTicket(final RedeemMatchmakerTicketRequest request) { @@ -4020,6 +4296,8 @@ private static PlayFabResult privateRedeemMatchmak /** * Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance. + * @param request RefreshGameServerInstanceHeartbeatRequest + * @return Async Task will return RefreshGameServerInstanceHeartbeatResult */ @SuppressWarnings("unchecked") public static FutureTask> RefreshGameServerInstanceHeartbeatAsync(final RefreshGameServerInstanceHeartbeatRequest request) { @@ -4032,6 +4310,8 @@ public PlayFabResult call() throws Exc /** * Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance. + * @param request RefreshGameServerInstanceHeartbeatRequest + * @return RefreshGameServerInstanceHeartbeatResult */ @SuppressWarnings("unchecked") public static PlayFabResult RefreshGameServerInstanceHeartbeat(final RefreshGameServerInstanceHeartbeatRequest request) { @@ -4078,6 +4358,8 @@ private static PlayFabResult privateRe /** * Inform the matchmaker that a new Game Server Instance is added. + * @param request RegisterGameRequest + * @return Async Task will return RegisterGameResponse */ @SuppressWarnings("unchecked") public static FutureTask> RegisterGameAsync(final RegisterGameRequest request) { @@ -4090,6 +4372,8 @@ public PlayFabResult call() throws Exception { /** * Inform the matchmaker that a new Game Server Instance is added. + * @param request RegisterGameRequest + * @return RegisterGameResponse */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterGame(final RegisterGameRequest request) { @@ -4136,6 +4420,8 @@ private static PlayFabResult privateRegisterGameAsync(fina /** * Sets the custom data of the indicated Game Server Instance + * @param request SetGameServerInstanceDataRequest + * @return Async Task will return SetGameServerInstanceDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetGameServerInstanceDataAsync(final SetGameServerInstanceDataRequest request) { @@ -4148,6 +4434,8 @@ public PlayFabResult call() throws Exception { /** * Sets the custom data of the indicated Game Server Instance + * @param request SetGameServerInstanceDataRequest + * @return SetGameServerInstanceDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetGameServerInstanceData(final SetGameServerInstanceDataRequest request) { @@ -4194,6 +4482,8 @@ private static PlayFabResult privateSetGameServ /** * Set the state of the indicated Game Server Instance. + * @param request SetGameServerInstanceStateRequest + * @return Async Task will return SetGameServerInstanceStateResult */ @SuppressWarnings("unchecked") public static FutureTask> SetGameServerInstanceStateAsync(final SetGameServerInstanceStateRequest request) { @@ -4206,6 +4496,8 @@ public PlayFabResult call() throws Exception { /** * Set the state of the indicated Game Server Instance. + * @param request SetGameServerInstanceStateRequest + * @return SetGameServerInstanceStateResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetGameServerInstanceState(final SetGameServerInstanceStateRequest request) { @@ -4252,6 +4544,8 @@ private static PlayFabResult privateSetGameSer /** * Set custom tags for the specified Game Server Instance + * @param request SetGameServerInstanceTagsRequest + * @return Async Task will return SetGameServerInstanceTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetGameServerInstanceTagsAsync(final SetGameServerInstanceTagsRequest request) { @@ -4264,6 +4558,8 @@ public PlayFabResult call() throws Exception { /** * Set custom tags for the specified Game Server Instance + * @param request SetGameServerInstanceTagsRequest + * @return SetGameServerInstanceTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetGameServerInstanceTags(final SetGameServerInstanceTagsRequest request) { @@ -4310,6 +4606,8 @@ private static PlayFabResult privateSetGameServ /** * Awards the specified users the specified Steam achievements + * @param request AwardSteamAchievementRequest + * @return Async Task will return AwardSteamAchievementResult */ @SuppressWarnings("unchecked") public static FutureTask> AwardSteamAchievementAsync(final AwardSteamAchievementRequest request) { @@ -4322,6 +4620,8 @@ public PlayFabResult call() throws Exception { /** * Awards the specified users the specified Steam achievements + * @param request AwardSteamAchievementRequest + * @return AwardSteamAchievementResult */ @SuppressWarnings("unchecked") public static PlayFabResult AwardSteamAchievement(final AwardSteamAchievementRequest request) { @@ -4368,6 +4668,8 @@ private static PlayFabResult privateAwardSteamAchie /** * Writes a character-based event into PlayStream. + * @param request WriteServerCharacterEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteCharacterEventAsync(final WriteServerCharacterEventRequest request) { @@ -4380,6 +4682,8 @@ public PlayFabResult call() throws Exception { /** * Writes a character-based event into PlayStream. + * @param request WriteServerCharacterEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteCharacterEvent(final WriteServerCharacterEventRequest request) { @@ -4426,6 +4730,8 @@ private static PlayFabResult privateWriteCharacterEventAsync /** * Writes a player-based event into PlayStream. + * @param request WriteServerPlayerEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WritePlayerEventAsync(final WriteServerPlayerEventRequest request) { @@ -4438,6 +4744,8 @@ public PlayFabResult call() throws Exception { /** * Writes a player-based event into PlayStream. + * @param request WriteServerPlayerEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WritePlayerEvent(final WriteServerPlayerEventRequest request) { @@ -4484,6 +4792,8 @@ private static PlayFabResult privateWritePlayerEventAsync(fi /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteTitleEventAsync(final WriteTitleEventRequest request) { @@ -4496,6 +4806,8 @@ public PlayFabResult call() throws Exception { /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteTitleEvent(final WriteTitleEventRequest request) { @@ -4542,6 +4854,8 @@ private static PlayFabResult privateWriteTitleEventAsync(fin /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. + * @param request AddSharedGroupMembersRequest + * @return Async Task will return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> AddSharedGroupMembersAsync(final AddSharedGroupMembersRequest request) { @@ -4554,6 +4868,8 @@ public PlayFabResult call() throws Exception { /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. + * @param request AddSharedGroupMembersRequest + * @return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddSharedGroupMembers(final AddSharedGroupMembersRequest request) { @@ -4600,6 +4916,8 @@ private static PlayFabResult privateAddSharedGroupM /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. + * @param request CreateSharedGroupRequest + * @return Async Task will return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateSharedGroupAsync(final CreateSharedGroupRequest request) { @@ -4612,6 +4930,8 @@ public PlayFabResult call() throws Exception { /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. + * @param request CreateSharedGroupRequest + * @return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateSharedGroup(final CreateSharedGroupRequest request) { @@ -4658,6 +4978,8 @@ private static PlayFabResult privateCreateSharedGroupAs /** * Deletes a shared group, freeing up the shared group ID to be reused for a new group + * @param request DeleteSharedGroupRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteSharedGroupAsync(final DeleteSharedGroupRequest request) { @@ -4670,6 +4992,8 @@ public PlayFabResult call() throws Exception { /** * Deletes a shared group, freeing up the shared group ID to be reused for a new group + * @param request DeleteSharedGroupRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteSharedGroup(final DeleteSharedGroupRequest request) { @@ -4716,6 +5040,8 @@ private static PlayFabResult privateDeleteSharedGroupAsync(final De /** * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. + * @param request GetSharedGroupDataRequest + * @return Async Task will return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetSharedGroupDataAsync(final GetSharedGroupDataRequest request) { @@ -4728,6 +5054,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. + * @param request GetSharedGroupDataRequest + * @return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetSharedGroupData(final GetSharedGroupDataRequest request) { @@ -4774,6 +5102,8 @@ private static PlayFabResult privateGetSharedGroupData /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return Async Task will return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveSharedGroupMembersAsync(final RemoveSharedGroupMembersRequest request) { @@ -4786,6 +5116,8 @@ public PlayFabResult call() throws Exception { /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveSharedGroupMembers(final RemoveSharedGroupMembersRequest request) { @@ -4832,6 +5164,8 @@ private static PlayFabResult privateRemoveShared /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data. + * @param request UpdateSharedGroupDataRequest + * @return Async Task will return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateSharedGroupDataAsync(final UpdateSharedGroupDataRequest request) { @@ -4844,6 +5178,8 @@ public PlayFabResult call() throws Exception { /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data. + * @param request UpdateSharedGroupDataRequest + * @return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateSharedGroupData(final UpdateSharedGroupDataRequest request) { @@ -4890,6 +5226,8 @@ private static PlayFabResult privateUpdateSharedGro /** * Executes a CloudScript function, with the 'currentPlayerId' variable set to the specified PlayFabId parameter value. + * @param request ExecuteCloudScriptServerRequest + * @return Async Task will return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static FutureTask> ExecuteCloudScriptAsync(final ExecuteCloudScriptServerRequest request) { @@ -4902,6 +5240,8 @@ public PlayFabResult call() throws Exception { /** * Executes a CloudScript function, with the 'currentPlayerId' variable set to the specified PlayFabId parameter value. + * @param request ExecuteCloudScriptServerRequest + * @return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ExecuteCloudScript(final ExecuteCloudScriptServerRequest request) { @@ -4948,6 +5288,8 @@ private static PlayFabResult privateExecuteCloudScript /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return Async Task will return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentDownloadUrlAsync(final GetContentDownloadUrlRequest request) { @@ -4960,6 +5302,8 @@ public PlayFabResult call() throws Exception { /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentDownloadUrl(final GetContentDownloadUrlRequest request) { @@ -5006,6 +5350,8 @@ private static PlayFabResult privateGetContentDownl /** * Deletes the specific character ID from the specified user. + * @param request DeleteCharacterFromUserRequest + * @return Async Task will return DeleteCharacterFromUserResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteCharacterFromUserAsync(final DeleteCharacterFromUserRequest request) { @@ -5018,6 +5364,8 @@ public PlayFabResult call() throws Exception { /** * Deletes the specific character ID from the specified user. + * @param request DeleteCharacterFromUserRequest + * @return DeleteCharacterFromUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteCharacterFromUser(final DeleteCharacterFromUserRequest request) { @@ -5064,6 +5412,8 @@ private static PlayFabResult privateDeleteCharact /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return Async Task will return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllUsersCharactersAsync(final ListUsersCharactersRequest request) { @@ -5076,6 +5426,8 @@ public PlayFabResult call() throws Exception { /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllUsersCharacters(final ListUsersCharactersRequest request) { @@ -5122,6 +5474,8 @@ private static PlayFabResult privateGetAllUsersCharac /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return Async Task will return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterLeaderboardAsync(final GetCharacterLeaderboardRequest request) { @@ -5134,6 +5488,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterLeaderboard(final GetCharacterLeaderboardRequest request) { @@ -5180,6 +5536,8 @@ private static PlayFabResult privateGetCharacterL /** * Retrieves the details of all title-specific statistics for the specific character + * @param request GetCharacterStatisticsRequest + * @return Async Task will return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterStatisticsAsync(final GetCharacterStatisticsRequest request) { @@ -5192,6 +5550,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details of all title-specific statistics for the specific character + * @param request GetCharacterStatisticsRequest + * @return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterStatistics(final GetCharacterStatisticsRequest request) { @@ -5238,6 +5598,8 @@ private static PlayFabResult privateGetCharacterSt /** * Retrieves a list of ranked characters for the given statistic, centered on the requested user + * @param request GetLeaderboardAroundCharacterRequest + * @return Async Task will return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundCharacterAsync(final GetLeaderboardAroundCharacterRequest request) { @@ -5250,6 +5612,8 @@ public PlayFabResult call() throws Exceptio /** * Retrieves a list of ranked characters for the given statistic, centered on the requested user + * @param request GetLeaderboardAroundCharacterRequest + * @return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundCharacter(final GetLeaderboardAroundCharacterRequest request) { @@ -5296,6 +5660,8 @@ private static PlayFabResult privateGetLead /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return Async Task will return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardForUserCharactersAsync(final GetLeaderboardForUsersCharactersRequest request) { @@ -5308,6 +5674,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardForUserCharacters(final GetLeaderboardForUsersCharactersRequest request) { @@ -5354,6 +5722,8 @@ private static PlayFabResult privateGetL /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return Async Task will return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantCharacterToUserAsync(final GrantCharacterToUserRequest request) { @@ -5366,6 +5736,8 @@ public PlayFabResult call() throws Exception { /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantCharacterToUser(final GrantCharacterToUserRequest request) { @@ -5412,6 +5784,8 @@ private static PlayFabResult privateGrantCharacterTo /** * Updates the values of the specified title-specific statistics for the specific character + * @param request UpdateCharacterStatisticsRequest + * @return Async Task will return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) { @@ -5424,6 +5798,8 @@ public PlayFabResult call() throws Exception { /** * Updates the values of the specified title-specific statistics for the specific character + * @param request UpdateCharacterStatisticsRequest + * @return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterStatistics(final UpdateCharacterStatisticsRequest request) { @@ -5470,6 +5846,8 @@ private static PlayFabResult privateUpdateChara /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterDataAsync(final GetCharacterDataRequest request) { @@ -5482,6 +5860,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterData(final GetCharacterDataRequest request) { @@ -5528,6 +5908,8 @@ private static PlayFabResult privateGetCharacterDataAsyn /** * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterInternalDataAsync(final GetCharacterDataRequest request) { @@ -5540,6 +5922,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterInternalData(final GetCharacterDataRequest request) { @@ -5586,6 +5970,8 @@ private static PlayFabResult privateGetCharacterInternal /** * Retrieves the title-specific custom data for the user's character which can only be read by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterReadOnlyDataAsync(final GetCharacterDataRequest request) { @@ -5598,6 +5984,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user's character which can only be read by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterReadOnlyData(final GetCharacterDataRequest request) { @@ -5644,6 +6032,8 @@ private static PlayFabResult privateGetCharacterReadOnly /** * Updates the title-specific custom data for the user's chjaracter which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterDataAsync(final UpdateCharacterDataRequest request) { @@ -5656,6 +6046,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user's chjaracter which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterData(final UpdateCharacterDataRequest request) { @@ -5702,6 +6094,8 @@ private static PlayFabResult privateUpdateCharacterDa /** * Updates the title-specific custom data for the user's character which cannot be accessed by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterInternalDataAsync(final UpdateCharacterDataRequest request) { @@ -5714,6 +6108,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user's character which cannot be accessed by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterInternalData(final UpdateCharacterDataRequest request) { @@ -5760,6 +6156,8 @@ private static PlayFabResult privateUpdateCharacterIn /** * Updates the title-specific custom data for the user's character which can only be read by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterReadOnlyDataAsync(final UpdateCharacterDataRequest request) { @@ -5772,6 +6170,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user's character which can only be read by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterReadOnlyData(final UpdateCharacterDataRequest request) { @@ -5818,6 +6218,8 @@ private static PlayFabResult privateUpdateCharacterRe /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return Async Task will return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> AddPlayerTagAsync(final AddPlayerTagRequest request) { @@ -5830,6 +6232,8 @@ public PlayFabResult call() throws Exception { /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddPlayerTag(final AddPlayerTagRequest request) { @@ -5876,6 +6280,8 @@ private static PlayFabResult privateAddPlayerTagAsync(final /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return Async Task will return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllActionGroupsAsync(final GetAllActionGroupsRequest request) { @@ -5888,6 +6294,8 @@ public PlayFabResult call() throws Exception { /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllActionGroups(final GetAllActionGroupsRequest request) { @@ -5934,6 +6342,8 @@ private static PlayFabResult privateGetAllActionGroups /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return Async Task will return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllSegmentsAsync(final GetAllSegmentsRequest request) { @@ -5946,6 +6356,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllSegments(final GetAllSegmentsRequest request) { @@ -5992,6 +6404,8 @@ private static PlayFabResult privateGetAllSegmentsAsync(fi /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return Async Task will return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerSegmentsAsync(final GetPlayersSegmentsRequest request) { @@ -6004,6 +6418,8 @@ public PlayFabResult call() throws Exception { /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerSegments(final GetPlayersSegmentsRequest request) { @@ -6050,6 +6466,8 @@ private static PlayFabResult privateGetPlayerSegmentsAs /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return Async Task will return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayersInSegmentAsync(final GetPlayersInSegmentRequest request) { @@ -6062,6 +6480,8 @@ public PlayFabResult call() throws Exception { /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayersInSegment(final GetPlayersInSegmentRequest request) { @@ -6108,6 +6528,8 @@ private static PlayFabResult privateGetPlayersInSegme /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return Async Task will return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTagsAsync(final GetPlayerTagsRequest request) { @@ -6120,6 +6542,8 @@ public PlayFabResult call() throws Exception { /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTags(final GetPlayerTagsRequest request) { @@ -6166,6 +6590,8 @@ private static PlayFabResult privateGetPlayerTagsAsync(fina /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return Async Task will return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> RemovePlayerTagAsync(final RemovePlayerTagRequest request) { @@ -6178,6 +6604,8 @@ public PlayFabResult call() throws Exception { /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemovePlayerTag(final RemovePlayerTagRequest request) { diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabServerModels.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabServerModels.java index e9c849835..fd2fa4376 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabServerModels.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabServerModels.java @@ -1030,7 +1030,7 @@ public static class DeleteUsersRequest { */ public ArrayList PlayFabIds; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; @@ -1438,6 +1438,14 @@ public static class GetFriendLeaderboardRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1518,6 +1526,14 @@ public static class GetLeaderboardAroundUserRequest { * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ public PlayerProfileViewConstraints ProfileConstraints; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; } @@ -1578,6 +1594,14 @@ public static class GetLeaderboardRequest { * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ public PlayerProfileViewConstraints ProfileConstraints; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; } @@ -1884,7 +1908,7 @@ public static class GetPlayFabIDsFromSteamIDsResult { public static class GetPublisherDataRequest { /** - * array of keys to get back data from the Publisher data blob, set by the admin tools + * array of keys to get back data from the Publisher data blob, set by the admin tools */ public ArrayList Keys; diff --git a/PlayFabSDK/src/main/java/com/playfab/PlayFabSettings.java b/PlayFabSDK/src/main/java/com/playfab/PlayFabSettings.java index 8449f937a..412eb3926 100644 --- a/PlayFabSDK/src/main/java/com/playfab/PlayFabSettings.java +++ b/PlayFabSDK/src/main/java/com/playfab/PlayFabSettings.java @@ -3,9 +3,9 @@ import com.playfab.PlayFabErrors.ErrorCallback; public class PlayFabSettings { - public static String SdkVersion = "0.46.170313"; - public static String BuildIdentifier = "javasdk_manual"; - public static String SdkVersionString = "JavaSDK-0.46.170313"; + public static String SdkVersion = "0.47.170403"; + public static String BuildIdentifier = "jbuild_javasdk_1"; + public static String SdkVersionString = "JavaSDK-0.47.170403"; public static String TitleId = null; // You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) public static ErrorCallback GlobalErrorHandler; diff --git a/PlayFabSDK/src/test/java/com/playfab/test/PlayFabApiTest.java b/PlayFabSDK/src/test/java/com/playfab/test/PlayFabApiTest.java index 11536b0ab..c2a398fef 100644 --- a/PlayFabSDK/src/test/java/com/playfab/test/PlayFabApiTest.java +++ b/PlayFabSDK/src/test/java/com/playfab/test/PlayFabApiTest.java @@ -183,7 +183,7 @@ public void LoginWithAdvertisingId() * Test a sequence of calls that modifies saved data, * and verifies that the next sequential API call contains updated data. * Verify that the data is correctly modified on the next call. - * Parameter types tested: string, Dictionary, DateTime + * Parameter types tested: string, Dictionary(string,string), DateTime */ @Test public void UserDataApi() @@ -229,7 +229,7 @@ public void UserDataApi() * Test a sequence of calls that modifies saved data, * and verifies that the next sequential API call contains updated data. * Verify that the data is saved correctly, and that specific types are tested - * Parameter types tested: Dictionary + * Parameter types tested: Dictionary(string,int) */ @Test public void PlayerStatisticsApi() diff --git a/PlayFabServerSDK/pom.xml b/PlayFabServerSDK/pom.xml index 463783b55..6ff24efa9 100644 --- a/PlayFabServerSDK/pom.xml +++ b/PlayFabServerSDK/pom.xml @@ -4,7 +4,7 @@ 2016 com.playfab server-sdk - 0.46.170313-SNAPSHOT + 0.47.170403 PlayFab Server API PlayFab is the unified backend platform for games — everything you need to build and operate your game, all in one place, so you can focus on creating and delivering a great player experience. http://api.playfab.com/ @@ -37,29 +37,6 @@ 1.7 - - - - com.google.code.gson - gson - 2.8.0 - - - junit - junit - 4.12 - test - - - - - org.assertj - assertj-core - 3.6.2 - test - - - junit @@ -92,6 +69,11 @@ ${javaLanguage.version} + + org.apache.maven.plugins + maven-surefire-plugin + 2.19.1 + @@ -108,8 +90,28 @@ sign-artifacts verify - sign + sign-and-deploy-file + + + 4A496164 + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + pom.xml + ${project.artifactId} + ${project.groupId} + ${project.version} + target/${project.artifactId}-${project.version}.jar + + target/${project.artifactId}-${project.version}-sources.jar,target/${project.artifactId}-${project.version}-javadoc.jar + + jar,jar + sources,javadoc + ossrh + + --armor + --detach-sig + + @@ -136,9 +138,23 @@ jar + + true + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.3 + true + + ossrh + https://oss.sonatype.org/ + false + + @@ -221,8 +237,10 @@ - nexus - https://oss.sonatype.org/content/repositories/snapshots/ + ossrh + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + diff --git a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminAPI.java b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminAPI.java index a480c1326..68d2fc299 100644 --- a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminAPI.java +++ b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminAPI.java @@ -18,6 +18,8 @@ public class PlayFabAdminAPI { /** * Gets the requested policy. + * @param request GetPolicyRequest + * @return Async Task will return GetPolicyResponse */ @SuppressWarnings("unchecked") public static FutureTask> GetPolicyAsync(final GetPolicyRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception { /** * Gets the requested policy. + * @param request GetPolicyRequest + * @return GetPolicyResponse */ @SuppressWarnings("unchecked") public static PlayFabResult GetPolicy(final GetPolicyRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateGetPolicyAsync(final GetP /** * Changes a policy for a title + * @param request UpdatePolicyRequest + * @return Async Task will return UpdatePolicyResponse */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePolicyAsync(final UpdatePolicyRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Changes a policy for a title + * @param request UpdatePolicyRequest + * @return UpdatePolicyResponse */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePolicy(final UpdatePolicyRequest request) { @@ -134,6 +142,8 @@ private static PlayFabResult privateUpdatePolicyAsync(fina /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return Async Task will return BanUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> BanUsersAsync(final BanUsersRequest request) { @@ -146,6 +156,8 @@ public PlayFabResult call() throws Exception { /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return BanUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult BanUsers(final BanUsersRequest request) { @@ -192,6 +204,8 @@ private static PlayFabResult privateBanUsersAsync(final BanUsers /** * Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier + * @param request LookupUserAccountInfoRequest + * @return Async Task will return LookupUserAccountInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserAccountInfoAsync(final LookupUserAccountInfoRequest request) { @@ -204,6 +218,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier + * @param request LookupUserAccountInfoRequest + * @return LookupUserAccountInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserAccountInfo(final LookupUserAccountInfoRequest request) { @@ -250,6 +266,8 @@ private static PlayFabResult privateGetUserAccountI /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return Async Task will return GetUserBansResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserBansAsync(final GetUserBansRequest request) { @@ -262,6 +280,8 @@ public PlayFabResult call() throws Exception { /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return GetUserBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserBans(final GetUserBansRequest request) { @@ -308,6 +328,8 @@ private static PlayFabResult privateGetUserBansAsync(final Ge /** * Resets all title-specific information about a particular account, including user data, virtual currency balances, inventory, purchase history, and statistics + * @param request ResetUsersRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> ResetUsersAsync(final ResetUsersRequest request) { @@ -320,6 +342,8 @@ public PlayFabResult call() throws Exception { /** * Resets all title-specific information about a particular account, including user data, virtual currency balances, inventory, purchase history, and statistics + * @param request ResetUsersRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult ResetUsers(final ResetUsersRequest request) { @@ -366,6 +390,8 @@ private static PlayFabResult privateResetUsersAsync(final ResetUser /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return Async Task will return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeAllBansForUserAsync(final RevokeAllBansForUserRequest request) { @@ -378,6 +404,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeAllBansForUser(final RevokeAllBansForUserRequest request) { @@ -424,6 +452,8 @@ private static PlayFabResult privateRevokeAllBansFor /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return Async Task will return RevokeBansResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeBansAsync(final RevokeBansRequest request) { @@ -436,6 +466,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return RevokeBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeBans(final RevokeBansRequest request) { @@ -482,6 +514,8 @@ private static PlayFabResult privateRevokeBansAsync(final Revo /** * Forces an email to be sent to the registered email address for the specified account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return Async Task will return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static FutureTask> SendAccountRecoveryEmailAsync(final SendAccountRecoveryEmailRequest request) { @@ -494,6 +528,8 @@ public PlayFabResult call() throws Exception { /** * Forces an email to be sent to the registered email address for the specified account, with a link allowing the user to change the password + * @param request SendAccountRecoveryEmailRequest + * @return SendAccountRecoveryEmailResult */ @SuppressWarnings("unchecked") public static PlayFabResult SendAccountRecoveryEmail(final SendAccountRecoveryEmailRequest request) { @@ -540,6 +576,8 @@ private static PlayFabResult privateSendAccountR /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return Async Task will return UpdateBansResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateBansAsync(final UpdateBansRequest request) { @@ -552,6 +590,8 @@ public PlayFabResult call() throws Exception { /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return UpdateBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateBans(final UpdateBansRequest request) { @@ -598,6 +638,8 @@ private static PlayFabResult privateUpdateBansAsync(final Upda /** * Updates the title specific display name for a user + * @param request UpdateUserTitleDisplayNameRequest + * @return Async Task will return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserTitleDisplayNameAsync(final UpdateUserTitleDisplayNameRequest request) { @@ -610,6 +652,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title specific display name for a user + * @param request UpdateUserTitleDisplayNameRequest + * @return UpdateUserTitleDisplayNameResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserTitleDisplayName(final UpdateUserTitleDisplayNameRequest request) { @@ -656,6 +700,8 @@ private static PlayFabResult privateUpdateUser /** * Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method. + * @param request CreatePlayerStatisticDefinitionRequest + * @return Async Task will return CreatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static FutureTask> CreatePlayerStatisticDefinitionAsync(final CreatePlayerStatisticDefinitionRequest request) { @@ -668,6 +714,8 @@ public PlayFabResult call() throws Except /** * Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method. + * @param request CreatePlayerStatisticDefinitionRequest + * @return CreatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreatePlayerStatisticDefinition(final CreatePlayerStatisticDefinitionRequest request) { @@ -714,6 +762,8 @@ private static PlayFabResult privateCreat /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not remove the player's event history, login history, inventory items, nor virtual currencies. + * @param request DeleteUsersRequest + * @return Async Task will return DeleteUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteUsersAsync(final DeleteUsersRequest request) { @@ -726,6 +776,8 @@ public PlayFabResult call() throws Exception { /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not remove the player's event history, login history, inventory items, nor virtual currencies. + * @param request DeleteUsersRequest + * @return DeleteUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteUsers(final DeleteUsersRequest request) { @@ -772,6 +824,8 @@ private static PlayFabResult privateDeleteUsersAsync(final De /** * Retrieves a download URL for the requested report + * @param request GetDataReportRequest + * @return Async Task will return GetDataReportResult */ @SuppressWarnings("unchecked") public static FutureTask> GetDataReportAsync(final GetDataReportRequest request) { @@ -784,6 +838,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a download URL for the requested report + * @param request GetDataReportRequest + * @return GetDataReportResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetDataReport(final GetDataReportRequest request) { @@ -830,6 +886,8 @@ private static PlayFabResult privateGetDataReportAsync(fina /** * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval. + * @param request GetPlayerStatisticDefinitionsRequest + * @return Async Task will return GetPlayerStatisticDefinitionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticDefinitionsAsync(final GetPlayerStatisticDefinitionsRequest request) { @@ -842,6 +900,8 @@ public PlayFabResult call() throws Exceptio /** * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval. + * @param request GetPlayerStatisticDefinitionsRequest + * @return GetPlayerStatisticDefinitionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticDefinitions(final GetPlayerStatisticDefinitionsRequest request) { @@ -888,6 +948,8 @@ private static PlayFabResult privateGetPlay /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return Async Task will return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticVersionsAsync(final GetPlayerStatisticVersionsRequest request) { @@ -900,6 +962,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticVersions(final GetPlayerStatisticVersionsRequest request) { @@ -946,6 +1010,8 @@ private static PlayFabResult privateGetPlayerS /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserDataAsync(final GetUserDataRequest request) { @@ -958,6 +1024,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserData(final GetUserDataRequest request) { @@ -1004,6 +1072,8 @@ private static PlayFabResult privateGetUserDataAsync(final Ge /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInternalDataAsync(final GetUserDataRequest request) { @@ -1016,6 +1086,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInternalData(final GetUserDataRequest request) { @@ -1062,6 +1134,8 @@ private static PlayFabResult privateGetUserInternalDataAsync( /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherDataAsync(final GetUserDataRequest request) { @@ -1074,6 +1148,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherData(final GetUserDataRequest request) { @@ -1120,6 +1196,8 @@ private static PlayFabResult privateGetUserPublisherDataAsync /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherInternalDataAsync(final GetUserDataRequest request) { @@ -1132,6 +1210,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherInternalData(final GetUserDataRequest request) { @@ -1178,6 +1258,8 @@ private static PlayFabResult privateGetUserPublisherInternalD /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1190,6 +1272,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherReadOnlyData(final GetUserDataRequest request) { @@ -1236,6 +1320,8 @@ private static PlayFabResult privateGetUserPublisherReadOnlyD /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1248,6 +1334,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserReadOnlyData(final GetUserDataRequest request) { @@ -1294,6 +1382,8 @@ private static PlayFabResult privateGetUserReadOnlyDataAsync( /** * Resets the indicated statistic, removing all player entries for it and backing up the old values. + * @param request IncrementPlayerStatisticVersionRequest + * @return Async Task will return IncrementPlayerStatisticVersionResult */ @SuppressWarnings("unchecked") public static FutureTask> IncrementPlayerStatisticVersionAsync(final IncrementPlayerStatisticVersionRequest request) { @@ -1306,6 +1396,8 @@ public PlayFabResult call() throws Except /** * Resets the indicated statistic, removing all player entries for it and backing up the old values. + * @param request IncrementPlayerStatisticVersionRequest + * @return IncrementPlayerStatisticVersionResult */ @SuppressWarnings("unchecked") public static PlayFabResult IncrementPlayerStatisticVersion(final IncrementPlayerStatisticVersionRequest request) { @@ -1352,6 +1444,8 @@ private static PlayFabResult privateIncre /** * Attempts to process an order refund through the original real money payment provider. + * @param request RefundPurchaseRequest + * @return Async Task will return RefundPurchaseResponse */ @SuppressWarnings("unchecked") public static FutureTask> RefundPurchaseAsync(final RefundPurchaseRequest request) { @@ -1364,6 +1458,8 @@ public PlayFabResult call() throws Exception { /** * Attempts to process an order refund through the original real money payment provider. + * @param request RefundPurchaseRequest + * @return RefundPurchaseResponse */ @SuppressWarnings("unchecked") public static PlayFabResult RefundPurchase(final RefundPurchaseRequest request) { @@ -1410,6 +1506,8 @@ private static PlayFabResult privateRefundPurchaseAsync( /** * Completely removes all statistics for the specified user, for the current game + * @param request ResetUserStatisticsRequest + * @return Async Task will return ResetUserStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> ResetUserStatisticsAsync(final ResetUserStatisticsRequest request) { @@ -1422,6 +1520,8 @@ public PlayFabResult call() throws Exception { /** * Completely removes all statistics for the specified user, for the current game + * @param request ResetUserStatisticsRequest + * @return ResetUserStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult ResetUserStatistics(final ResetUserStatisticsRequest request) { @@ -1468,6 +1568,8 @@ private static PlayFabResult privateResetUserStatisti /** * Attempts to resolve a dispute with the original order's payment provider. + * @param request ResolvePurchaseDisputeRequest + * @return Async Task will return ResolvePurchaseDisputeResponse */ @SuppressWarnings("unchecked") public static FutureTask> ResolvePurchaseDisputeAsync(final ResolvePurchaseDisputeRequest request) { @@ -1480,6 +1582,8 @@ public PlayFabResult call() throws Exception { /** * Attempts to resolve a dispute with the original order's payment provider. + * @param request ResolvePurchaseDisputeRequest + * @return ResolvePurchaseDisputeResponse */ @SuppressWarnings("unchecked") public static PlayFabResult ResolvePurchaseDispute(final ResolvePurchaseDisputeRequest request) { @@ -1526,6 +1630,8 @@ private static PlayFabResult privateResolvePurch /** * Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval. + * @param request UpdatePlayerStatisticDefinitionRequest + * @return Async Task will return UpdatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePlayerStatisticDefinitionAsync(final UpdatePlayerStatisticDefinitionRequest request) { @@ -1538,6 +1644,8 @@ public PlayFabResult call() throws Except /** * Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval. + * @param request UpdatePlayerStatisticDefinitionRequest + * @return UpdatePlayerStatisticDefinitionResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePlayerStatisticDefinition(final UpdatePlayerStatisticDefinitionRequest request) { @@ -1584,6 +1692,8 @@ private static PlayFabResult privateUpdat /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserDataAsync(final UpdateUserDataRequest request) { @@ -1596,6 +1706,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserData(final UpdateUserDataRequest request) { @@ -1642,6 +1754,8 @@ private static PlayFabResult privateUpdateUserDataAsync(fi /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1654,6 +1768,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserInternalData(final UpdateUserInternalDataRequest request) { @@ -1700,6 +1816,8 @@ private static PlayFabResult privateUpdateUserInternalData /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherDataAsync(final UpdateUserDataRequest request) { @@ -1712,6 +1830,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherData(final UpdateUserDataRequest request) { @@ -1758,6 +1878,8 @@ private static PlayFabResult privateUpdateUserPublisherDat /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1770,6 +1892,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherInternalData(final UpdateUserInternalDataRequest request) { @@ -1816,6 +1940,8 @@ private static PlayFabResult privateUpdateUserPublisherInt /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1828,6 +1954,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherReadOnlyData(final UpdateUserDataRequest request) { @@ -1874,6 +2002,8 @@ private static PlayFabResult privateUpdateUserPublisherRea /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1886,6 +2016,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserReadOnlyData(final UpdateUserDataRequest request) { @@ -1932,6 +2064,8 @@ private static PlayFabResult privateUpdateUserReadOnlyData /** * Adds a new news item to the title's news feed + * @param request AddNewsRequest + * @return Async Task will return AddNewsResult */ @SuppressWarnings("unchecked") public static FutureTask> AddNewsAsync(final AddNewsRequest request) { @@ -1944,6 +2078,8 @@ public PlayFabResult call() throws Exception { /** * Adds a new news item to the title's news feed + * @param request AddNewsRequest + * @return AddNewsResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddNews(final AddNewsRequest request) { @@ -1990,6 +2126,8 @@ private static PlayFabResult privateAddNewsAsync(final AddNewsReq /** * Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded. + * @param request AddVirtualCurrencyTypesRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> AddVirtualCurrencyTypesAsync(final AddVirtualCurrencyTypesRequest request) { @@ -2002,6 +2140,8 @@ public PlayFabResult call() throws Exception { /** * Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded. + * @param request AddVirtualCurrencyTypesRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddVirtualCurrencyTypes(final AddVirtualCurrencyTypesRequest request) { @@ -2048,6 +2188,8 @@ private static PlayFabResult privateAddVirtualCurrencyTypesAsync(fi /** * Deletes an existing virtual item store + * @param request DeleteStoreRequest + * @return Async Task will return DeleteStoreResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteStoreAsync(final DeleteStoreRequest request) { @@ -2060,6 +2202,8 @@ public PlayFabResult call() throws Exception { /** * Deletes an existing virtual item store + * @param request DeleteStoreRequest + * @return DeleteStoreResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteStore(final DeleteStoreRequest request) { @@ -2106,6 +2250,8 @@ private static PlayFabResult privateDeleteStoreAsync(final De /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return Async Task will return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCatalogItemsAsync(final GetCatalogItemsRequest request) { @@ -2118,6 +2264,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCatalogItems(final GetCatalogItemsRequest request) { @@ -2164,6 +2312,8 @@ private static PlayFabResult privateGetCatalogItemsAsync( /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return Async Task will return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPublisherDataAsync(final GetPublisherDataRequest request) { @@ -2176,6 +2326,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPublisherData(final GetPublisherDataRequest request) { @@ -2222,6 +2374,8 @@ private static PlayFabResult privateGetPublisherDataAsyn /** * Retrieves the random drop table configuration for the title + * @param request GetRandomResultTablesRequest + * @return Async Task will return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetRandomResultTablesAsync(final GetRandomResultTablesRequest request) { @@ -2234,6 +2388,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the random drop table configuration for the title + * @param request GetRandomResultTablesRequest + * @return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetRandomResultTables(final GetRandomResultTablesRequest request) { @@ -2280,6 +2436,8 @@ private static PlayFabResult privateGetRandomResult /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return Async Task will return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetStoreItemsAsync(final GetStoreItemsRequest request) { @@ -2292,6 +2450,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the set of items defined for the specified store, including all prices defined + * @param request GetStoreItemsRequest + * @return GetStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetStoreItems(final GetStoreItemsRequest request) { @@ -2338,6 +2498,8 @@ private static PlayFabResult privateGetStoreItemsAsync(fina /** * Retrieves the key-value store of custom title settings which can be read by the client + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleDataAsync(final GetTitleDataRequest request) { @@ -2350,6 +2512,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings which can be read by the client + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleData(final GetTitleDataRequest request) { @@ -2396,6 +2560,8 @@ private static PlayFabResult privateGetTitleDataAsync(final /** * Retrieves the key-value store of custom title settings which cannot be read by the client + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleInternalDataAsync(final GetTitleDataRequest request) { @@ -2408,6 +2574,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings which cannot be read by the client + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleInternalData(final GetTitleDataRequest request) { @@ -2454,6 +2622,8 @@ private static PlayFabResult privateGetTitleInternalDataAsyn /** * Retuns the list of all defined virtual currencies for the title + * @param request ListVirtualCurrencyTypesRequest + * @return Async Task will return ListVirtualCurrencyTypesResult */ @SuppressWarnings("unchecked") public static FutureTask> ListVirtualCurrencyTypesAsync(final ListVirtualCurrencyTypesRequest request) { @@ -2466,6 +2636,8 @@ public PlayFabResult call() throws Exception { /** * Retuns the list of all defined virtual currencies for the title + * @param request ListVirtualCurrencyTypesRequest + * @return ListVirtualCurrencyTypesResult */ @SuppressWarnings("unchecked") public static PlayFabResult ListVirtualCurrencyTypes(final ListVirtualCurrencyTypesRequest request) { @@ -2512,6 +2684,8 @@ private static PlayFabResult privateListVirtualC /** * Removes one or more virtual currencies from the set defined for the title. + * @param request RemoveVirtualCurrencyTypesRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveVirtualCurrencyTypesAsync(final RemoveVirtualCurrencyTypesRequest request) { @@ -2524,6 +2698,8 @@ public PlayFabResult call() throws Exception { /** * Removes one or more virtual currencies from the set defined for the title. + * @param request RemoveVirtualCurrencyTypesRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveVirtualCurrencyTypes(final RemoveVirtualCurrencyTypesRequest request) { @@ -2570,6 +2746,8 @@ private static PlayFabResult privateRemoveVirtualCurrencyTypesAsync /** * Creates the catalog configuration of all virtual goods for the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return Async Task will return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetCatalogItemsAsync(final UpdateCatalogItemsRequest request) { @@ -2582,6 +2760,8 @@ public PlayFabResult call() throws Exception { /** * Creates the catalog configuration of all virtual goods for the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetCatalogItems(final UpdateCatalogItemsRequest request) { @@ -2628,6 +2808,8 @@ private static PlayFabResult privateSetCatalogItemsAsy /** * Sets all the items in one virtual store + * @param request UpdateStoreItemsRequest + * @return Async Task will return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetStoreItemsAsync(final UpdateStoreItemsRequest request) { @@ -2640,6 +2822,8 @@ public PlayFabResult call() throws Exception { /** * Sets all the items in one virtual store + * @param request UpdateStoreItemsRequest + * @return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetStoreItems(final UpdateStoreItemsRequest request) { @@ -2686,6 +2870,8 @@ private static PlayFabResult privateSetStoreItemsAsync(f /** * Creates and updates the key-value store of custom title settings which can be read by the client + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleDataAsync(final SetTitleDataRequest request) { @@ -2698,6 +2884,8 @@ public PlayFabResult call() throws Exception { /** * Creates and updates the key-value store of custom title settings which can be read by the client + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleData(final SetTitleDataRequest request) { @@ -2744,6 +2932,8 @@ private static PlayFabResult privateSetTitleDataAsync(final /** * Updates the key-value store of custom title settings which cannot be read by the client + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleInternalDataAsync(final SetTitleDataRequest request) { @@ -2756,6 +2946,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom title settings which cannot be read by the client + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleInternalData(final SetTitleDataRequest request) { @@ -2802,6 +2994,8 @@ private static PlayFabResult privateSetTitleInternalDataAsyn /** * Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported. + * @param request SetupPushNotificationRequest + * @return Async Task will return SetupPushNotificationResult */ @SuppressWarnings("unchecked") public static FutureTask> SetupPushNotificationAsync(final SetupPushNotificationRequest request) { @@ -2814,6 +3008,8 @@ public PlayFabResult call() throws Exception { /** * Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported. + * @param request SetupPushNotificationRequest + * @return SetupPushNotificationResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetupPushNotification(final SetupPushNotificationRequest request) { @@ -2860,6 +3056,8 @@ private static PlayFabResult privateSetupPushNotifi /** * Updates the catalog configuration for virtual goods in the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return Async Task will return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCatalogItemsAsync(final UpdateCatalogItemsRequest request) { @@ -2872,6 +3070,8 @@ public PlayFabResult call() throws Exception { /** * Updates the catalog configuration for virtual goods in the specified catalog version + * @param request UpdateCatalogItemsRequest + * @return UpdateCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCatalogItems(final UpdateCatalogItemsRequest request) { @@ -2918,6 +3118,8 @@ private static PlayFabResult privateUpdateCatalogItems /** * Updates the random drop table configuration for the title + * @param request UpdateRandomResultTablesRequest + * @return Async Task will return UpdateRandomResultTablesResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateRandomResultTablesAsync(final UpdateRandomResultTablesRequest request) { @@ -2930,6 +3132,8 @@ public PlayFabResult call() throws Exception { /** * Updates the random drop table configuration for the title + * @param request UpdateRandomResultTablesRequest + * @return UpdateRandomResultTablesResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateRandomResultTables(final UpdateRandomResultTablesRequest request) { @@ -2976,6 +3180,8 @@ private static PlayFabResult privateUpdateRandom /** * Updates an existing virtual item store with new or modified items + * @param request UpdateStoreItemsRequest + * @return Async Task will return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateStoreItemsAsync(final UpdateStoreItemsRequest request) { @@ -2988,6 +3194,8 @@ public PlayFabResult call() throws Exception { /** * Updates an existing virtual item store with new or modified items + * @param request UpdateStoreItemsRequest + * @return UpdateStoreItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateStoreItems(final UpdateStoreItemsRequest request) { @@ -3034,6 +3242,8 @@ private static PlayFabResult privateUpdateStoreItemsAsyn /** * Increments the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUserVirtualCurrencyAsync(final AddUserVirtualCurrencyRequest request) { @@ -3046,6 +3256,8 @@ public PlayFabResult call() throws Exception { /** * Increments the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUserVirtualCurrency(final AddUserVirtualCurrencyRequest request) { @@ -3092,6 +3304,8 @@ private static PlayFabResult privateAddUserVirt /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return Async Task will return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInventoryAsync(final GetUserInventoryRequest request) { @@ -3104,6 +3318,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInventory(final GetUserInventoryRequest request) { @@ -3150,6 +3366,8 @@ private static PlayFabResult privateGetUserInventoryAsyn /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return Async Task will return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToUsersAsync(final GrantItemsToUsersRequest request) { @@ -3162,6 +3380,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToUsers(final GrantItemsToUsersRequest request) { @@ -3208,6 +3428,8 @@ private static PlayFabResult privateGrantItemsToUsersAs /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return Async Task will return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeInventoryItemAsync(final RevokeInventoryItemRequest request) { @@ -3220,6 +3442,8 @@ public PlayFabResult call() throws Exception { /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeInventoryItem(final RevokeInventoryItemRequest request) { @@ -3266,6 +3490,8 @@ private static PlayFabResult privateRevokeInventoryItemAs /** * Decrements the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractUserVirtualCurrencyAsync(final SubtractUserVirtualCurrencyRequest request) { @@ -3278,6 +3504,8 @@ public PlayFabResult call() throws Exception { /** * Decrements the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractUserVirtualCurrency(final SubtractUserVirtualCurrencyRequest request) { @@ -3324,6 +3552,8 @@ private static PlayFabResult privateSubtractUse /** * Retrieves the details for a specific completed session, including links to standard out and standard error logs + * @param request GetMatchmakerGameInfoRequest + * @return Async Task will return GetMatchmakerGameInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetMatchmakerGameInfoAsync(final GetMatchmakerGameInfoRequest request) { @@ -3336,6 +3566,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details for a specific completed session, including links to standard out and standard error logs + * @param request GetMatchmakerGameInfoRequest + * @return GetMatchmakerGameInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetMatchmakerGameInfo(final GetMatchmakerGameInfoRequest request) { @@ -3382,6 +3614,8 @@ private static PlayFabResult privateGetMatchmakerGa /** * Retrieves the details of defined game modes for the specified game server executable + * @param request GetMatchmakerGameModesRequest + * @return Async Task will return GetMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetMatchmakerGameModesAsync(final GetMatchmakerGameModesRequest request) { @@ -3394,6 +3628,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details of defined game modes for the specified game server executable + * @param request GetMatchmakerGameModesRequest + * @return GetMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetMatchmakerGameModes(final GetMatchmakerGameModesRequest request) { @@ -3440,6 +3676,8 @@ private static PlayFabResult privateGetMatchmakerG /** * Updates the game server mode details for the specified game server executable + * @param request ModifyMatchmakerGameModesRequest + * @return Async Task will return ModifyMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static FutureTask> ModifyMatchmakerGameModesAsync(final ModifyMatchmakerGameModesRequest request) { @@ -3452,6 +3690,8 @@ public PlayFabResult call() throws Exception { /** * Updates the game server mode details for the specified game server executable + * @param request ModifyMatchmakerGameModesRequest + * @return ModifyMatchmakerGameModesResult */ @SuppressWarnings("unchecked") public static PlayFabResult ModifyMatchmakerGameModes(final ModifyMatchmakerGameModesRequest request) { @@ -3498,6 +3738,8 @@ private static PlayFabResult privateModifyMatch /** * Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a client is permitted to request in a call to StartGame + * @param request AddServerBuildRequest + * @return Async Task will return AddServerBuildResult */ @SuppressWarnings("unchecked") public static FutureTask> AddServerBuildAsync(final AddServerBuildRequest request) { @@ -3510,6 +3752,8 @@ public PlayFabResult call() throws Exception { /** * Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a client is permitted to request in a call to StartGame + * @param request AddServerBuildRequest + * @return AddServerBuildResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddServerBuild(final AddServerBuildRequest request) { @@ -3556,6 +3800,8 @@ private static PlayFabResult privateAddServerBuildAsync(fi /** * Retrieves the build details for the specified game server executable + * @param request GetServerBuildInfoRequest + * @return Async Task will return GetServerBuildInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetServerBuildInfoAsync(final GetServerBuildInfoRequest request) { @@ -3568,6 +3814,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the build details for the specified game server executable + * @param request GetServerBuildInfoRequest + * @return GetServerBuildInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetServerBuildInfo(final GetServerBuildInfoRequest request) { @@ -3614,6 +3862,8 @@ private static PlayFabResult privateGetServerBuildInfo /** * Retrieves the pre-authorized URL for uploading a game server package containing a build (does not enable the build for use - see AddServerBuild) + * @param request GetServerBuildUploadURLRequest + * @return Async Task will return GetServerBuildUploadURLResult */ @SuppressWarnings("unchecked") public static FutureTask> GetServerBuildUploadUrlAsync(final GetServerBuildUploadURLRequest request) { @@ -3626,6 +3876,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the pre-authorized URL for uploading a game server package containing a build (does not enable the build for use - see AddServerBuild) + * @param request GetServerBuildUploadURLRequest + * @return GetServerBuildUploadURLResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetServerBuildUploadUrl(final GetServerBuildUploadURLRequest request) { @@ -3672,6 +3924,8 @@ private static PlayFabResult privateGetServerBuil /** * Retrieves the build details for all game server executables which are currently defined for the title + * @param request ListBuildsRequest + * @return Async Task will return ListBuildsResult */ @SuppressWarnings("unchecked") public static FutureTask> ListServerBuildsAsync(final ListBuildsRequest request) { @@ -3684,6 +3938,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the build details for all game server executables which are currently defined for the title + * @param request ListBuildsRequest + * @return ListBuildsResult */ @SuppressWarnings("unchecked") public static PlayFabResult ListServerBuilds(final ListBuildsRequest request) { @@ -3730,6 +3986,8 @@ private static PlayFabResult privateListServerBuildsAsync(fina /** * Updates the build details for the specified game server executable + * @param request ModifyServerBuildRequest + * @return Async Task will return ModifyServerBuildResult */ @SuppressWarnings("unchecked") public static FutureTask> ModifyServerBuildAsync(final ModifyServerBuildRequest request) { @@ -3742,6 +4000,8 @@ public PlayFabResult call() throws Exception { /** * Updates the build details for the specified game server executable + * @param request ModifyServerBuildRequest + * @return ModifyServerBuildResult */ @SuppressWarnings("unchecked") public static PlayFabResult ModifyServerBuild(final ModifyServerBuildRequest request) { @@ -3788,6 +4048,8 @@ private static PlayFabResult privateModifyServerBuildAs /** * Removes the game server executable specified from the set of those a client is permitted to request in a call to StartGame + * @param request RemoveServerBuildRequest + * @return Async Task will return RemoveServerBuildResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveServerBuildAsync(final RemoveServerBuildRequest request) { @@ -3800,6 +4062,8 @@ public PlayFabResult call() throws Exception { /** * Removes the game server executable specified from the set of those a client is permitted to request in a call to StartGame + * @param request RemoveServerBuildRequest + * @return RemoveServerBuildResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveServerBuild(final RemoveServerBuildRequest request) { @@ -3846,6 +4110,8 @@ private static PlayFabResult privateRemoveServerBuildAs /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return Async Task will return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetPublisherDataAsync(final SetPublisherDataRequest request) { @@ -3858,6 +4124,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetPublisherData(final SetPublisherDataRequest request) { @@ -3904,6 +4172,8 @@ private static PlayFabResult privateSetPublisherDataAsyn /** * Gets the contents and information of a specific Cloud Script revision. + * @param request GetCloudScriptRevisionRequest + * @return Async Task will return GetCloudScriptRevisionResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCloudScriptRevisionAsync(final GetCloudScriptRevisionRequest request) { @@ -3916,6 +4186,8 @@ public PlayFabResult call() throws Exception { /** * Gets the contents and information of a specific Cloud Script revision. + * @param request GetCloudScriptRevisionRequest + * @return GetCloudScriptRevisionResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCloudScriptRevision(final GetCloudScriptRevisionRequest request) { @@ -3962,6 +4234,8 @@ private static PlayFabResult privateGetCloudScript /** * Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed. + * @param request GetCloudScriptVersionsRequest + * @return Async Task will return GetCloudScriptVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCloudScriptVersionsAsync(final GetCloudScriptVersionsRequest request) { @@ -3974,6 +4248,8 @@ public PlayFabResult call() throws Exception { /** * Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed. + * @param request GetCloudScriptVersionsRequest + * @return GetCloudScriptVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCloudScriptVersions(final GetCloudScriptVersionsRequest request) { @@ -4020,6 +4296,8 @@ private static PlayFabResult privateGetCloudScript /** * Sets the currently published revision of a title Cloud Script + * @param request SetPublishedRevisionRequest + * @return Async Task will return SetPublishedRevisionResult */ @SuppressWarnings("unchecked") public static FutureTask> SetPublishedRevisionAsync(final SetPublishedRevisionRequest request) { @@ -4032,6 +4310,8 @@ public PlayFabResult call() throws Exception { /** * Sets the currently published revision of a title Cloud Script + * @param request SetPublishedRevisionRequest + * @return SetPublishedRevisionResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetPublishedRevision(final SetPublishedRevisionRequest request) { @@ -4078,6 +4358,8 @@ private static PlayFabResult privateSetPublishedRevi /** * Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision. + * @param request UpdateCloudScriptRequest + * @return Async Task will return UpdateCloudScriptResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCloudScriptAsync(final UpdateCloudScriptRequest request) { @@ -4090,6 +4372,8 @@ public PlayFabResult call() throws Exception { /** * Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision. + * @param request UpdateCloudScriptRequest + * @return UpdateCloudScriptResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCloudScript(final UpdateCloudScriptRequest request) { @@ -4136,6 +4420,8 @@ private static PlayFabResult privateUpdateCloudScriptAs /** * Delete a content file from the title + * @param request DeleteContentRequest + * @return Async Task will return BlankResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteContentAsync(final DeleteContentRequest request) { @@ -4148,6 +4434,8 @@ public PlayFabResult call() throws Exception { /** * Delete a content file from the title + * @param request DeleteContentRequest + * @return BlankResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteContent(final DeleteContentRequest request) { @@ -4194,6 +4482,8 @@ private static PlayFabResult privateDeleteContentAsync(final Delete /** * List all contents of the title and get statistics such as size + * @param request GetContentListRequest + * @return Async Task will return GetContentListResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentListAsync(final GetContentListRequest request) { @@ -4206,6 +4496,8 @@ public PlayFabResult call() throws Exception { /** * List all contents of the title and get statistics such as size + * @param request GetContentListRequest + * @return GetContentListResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentList(final GetContentListRequest request) { @@ -4252,6 +4544,8 @@ private static PlayFabResult privateGetContentListAsync(fi /** * Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentUploadUrlRequest + * @return Async Task will return GetContentUploadUrlResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentUploadUrlAsync(final GetContentUploadUrlRequest request) { @@ -4264,6 +4558,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentUploadUrlRequest + * @return GetContentUploadUrlResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentUploadUrl(final GetContentUploadUrlRequest request) { @@ -4310,6 +4606,8 @@ private static PlayFabResult privateGetContentUploadU /** * Completely removes all statistics for the specified character, for the current game + * @param request ResetCharacterStatisticsRequest + * @return Async Task will return ResetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> ResetCharacterStatisticsAsync(final ResetCharacterStatisticsRequest request) { @@ -4322,6 +4620,8 @@ public PlayFabResult call() throws Exception { /** * Completely removes all statistics for the specified character, for the current game + * @param request ResetCharacterStatisticsRequest + * @return ResetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult ResetCharacterStatistics(final ResetCharacterStatisticsRequest request) { @@ -4368,6 +4668,8 @@ private static PlayFabResult privateResetCharact /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return Async Task will return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> AddPlayerTagAsync(final AddPlayerTagRequest request) { @@ -4380,6 +4682,8 @@ public PlayFabResult call() throws Exception { /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddPlayerTag(final AddPlayerTagRequest request) { @@ -4426,6 +4730,8 @@ private static PlayFabResult privateAddPlayerTagAsync(final /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return Async Task will return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllActionGroupsAsync(final GetAllActionGroupsRequest request) { @@ -4438,6 +4744,8 @@ public PlayFabResult call() throws Exception { /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllActionGroups(final GetAllActionGroupsRequest request) { @@ -4484,6 +4792,8 @@ private static PlayFabResult privateGetAllActionGroups /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return Async Task will return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllSegmentsAsync(final GetAllSegmentsRequest request) { @@ -4496,6 +4806,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllSegments(final GetAllSegmentsRequest request) { @@ -4542,6 +4854,8 @@ private static PlayFabResult privateGetAllSegmentsAsync(fi /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return Async Task will return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerSegmentsAsync(final GetPlayersSegmentsRequest request) { @@ -4554,6 +4868,8 @@ public PlayFabResult call() throws Exception { /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerSegments(final GetPlayersSegmentsRequest request) { @@ -4600,6 +4916,8 @@ private static PlayFabResult privateGetPlayerSegmentsAs /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return Async Task will return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayersInSegmentAsync(final GetPlayersInSegmentRequest request) { @@ -4612,6 +4930,8 @@ public PlayFabResult call() throws Exception { /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayersInSegment(final GetPlayersInSegmentRequest request) { @@ -4658,6 +4978,8 @@ private static PlayFabResult privateGetPlayersInSegme /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return Async Task will return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTagsAsync(final GetPlayerTagsRequest request) { @@ -4670,6 +4992,8 @@ public PlayFabResult call() throws Exception { /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTags(final GetPlayerTagsRequest request) { @@ -4716,6 +5040,8 @@ private static PlayFabResult privateGetPlayerTagsAsync(fina /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return Async Task will return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> RemovePlayerTagAsync(final RemovePlayerTagRequest request) { @@ -4728,6 +5054,8 @@ public PlayFabResult call() throws Exception { /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemovePlayerTag(final RemovePlayerTagRequest request) { @@ -4774,6 +5102,8 @@ private static PlayFabResult privateRemovePlayerTagAsync( /** * Abort an ongoing task instance. + * @param request AbortTaskInstanceRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> AbortTaskInstanceAsync(final AbortTaskInstanceRequest request) { @@ -4786,6 +5116,8 @@ public PlayFabResult call() throws Exception { /** * Abort an ongoing task instance. + * @param request AbortTaskInstanceRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AbortTaskInstance(final AbortTaskInstanceRequest request) { @@ -4832,6 +5164,8 @@ private static PlayFabResult privateAbortTaskInstanceAsync(final Ab /** * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action. + * @param request CreateActionsOnPlayerSegmentTaskRequest + * @return Async Task will return CreateTaskResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateActionsOnPlayersInSegmentTaskAsync(final CreateActionsOnPlayerSegmentTaskRequest request) { @@ -4844,6 +5178,8 @@ public PlayFabResult call() throws Exception { /** * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action. + * @param request CreateActionsOnPlayerSegmentTaskRequest + * @return CreateTaskResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateActionsOnPlayersInSegmentTask(final CreateActionsOnPlayerSegmentTaskRequest request) { @@ -4890,6 +5226,8 @@ private static PlayFabResult privateCreateActionsOnPlayersInSe /** * Create a CloudScript task, which can run a CloudScript on a schedule. + * @param request CreateCloudScriptTaskRequest + * @return Async Task will return CreateTaskResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateCloudScriptTaskAsync(final CreateCloudScriptTaskRequest request) { @@ -4902,6 +5240,8 @@ public PlayFabResult call() throws Exception { /** * Create a CloudScript task, which can run a CloudScript on a schedule. + * @param request CreateCloudScriptTaskRequest + * @return CreateTaskResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateCloudScriptTask(final CreateCloudScriptTaskRequest request) { @@ -4948,6 +5288,8 @@ private static PlayFabResult privateCreateCloudScriptTaskAsync /** * Delete a task. + * @param request DeleteTaskRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteTaskAsync(final DeleteTaskRequest request) { @@ -4960,6 +5302,8 @@ public PlayFabResult call() throws Exception { /** * Delete a task. + * @param request DeleteTaskRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteTask(final DeleteTaskRequest request) { @@ -5006,6 +5350,8 @@ private static PlayFabResult privateDeleteTaskAsync(final DeleteTas /** * Get information about a ActionsOnPlayersInSegment task instance. + * @param request GetTaskInstanceRequest + * @return Async Task will return GetActionsOnPlayersInSegmentTaskInstanceResult */ @SuppressWarnings("unchecked") public static FutureTask> GetActionsOnPlayersInSegmentTaskInstanceAsync(final GetTaskInstanceRequest request) { @@ -5018,6 +5364,8 @@ public PlayFabResult call() thro /** * Get information about a ActionsOnPlayersInSegment task instance. + * @param request GetTaskInstanceRequest + * @return GetActionsOnPlayersInSegmentTaskInstanceResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetActionsOnPlayersInSegmentTaskInstance(final GetTaskInstanceRequest request) { @@ -5064,6 +5412,8 @@ private static PlayFabResult pri /** * Get detail information about a CloudScript task instance. + * @param request GetTaskInstanceRequest + * @return Async Task will return GetCloudScriptTaskInstanceResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCloudScriptTaskInstanceAsync(final GetTaskInstanceRequest request) { @@ -5076,6 +5426,8 @@ public PlayFabResult call() throws Exception { /** * Get detail information about a CloudScript task instance. + * @param request GetTaskInstanceRequest + * @return GetCloudScriptTaskInstanceResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCloudScriptTaskInstance(final GetTaskInstanceRequest request) { @@ -5122,6 +5474,8 @@ private static PlayFabResult privateGetCloudSc /** * Query for task instances by task, status, or time range. + * @param request GetTaskInstancesRequest + * @return Async Task will return GetTaskInstancesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTaskInstancesAsync(final GetTaskInstancesRequest request) { @@ -5134,6 +5488,8 @@ public PlayFabResult call() throws Exception { /** * Query for task instances by task, status, or time range. + * @param request GetTaskInstancesRequest + * @return GetTaskInstancesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTaskInstances(final GetTaskInstancesRequest request) { @@ -5180,6 +5536,8 @@ private static PlayFabResult privateGetTaskInstancesAsyn /** * Get definition information on a specified task or all tasks within a title. + * @param request GetTasksRequest + * @return Async Task will return GetTasksResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTasksAsync(final GetTasksRequest request) { @@ -5192,6 +5550,8 @@ public PlayFabResult call() throws Exception { /** * Get definition information on a specified task or all tasks within a title. + * @param request GetTasksRequest + * @return GetTasksResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTasks(final GetTasksRequest request) { @@ -5238,6 +5598,8 @@ private static PlayFabResult privateGetTasksAsync(final GetTasks /** * Run a task immediately regardless of its schedule. + * @param request RunTaskRequest + * @return Async Task will return RunTaskResult */ @SuppressWarnings("unchecked") public static FutureTask> RunTaskAsync(final RunTaskRequest request) { @@ -5250,6 +5612,8 @@ public PlayFabResult call() throws Exception { /** * Run a task immediately regardless of its schedule. + * @param request RunTaskRequest + * @return RunTaskResult */ @SuppressWarnings("unchecked") public static PlayFabResult RunTask(final RunTaskRequest request) { @@ -5296,6 +5660,8 @@ private static PlayFabResult privateRunTaskAsync(final RunTaskReq /** * Update an existing task. + * @param request UpdateTaskRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateTaskAsync(final UpdateTaskRequest request) { @@ -5308,6 +5674,8 @@ public PlayFabResult call() throws Exception { /** * Update an existing task. + * @param request UpdateTaskRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateTask(final UpdateTaskRequest request) { diff --git a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminModels.java b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminModels.java index a23aa3638..f49fe101c 100644 --- a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminModels.java +++ b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabAdminModels.java @@ -199,7 +199,7 @@ public static class AddServerBuildResult { */ public Date Timestamp; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; /** @@ -1104,7 +1104,7 @@ public static class DeleteUsersRequest { */ public ArrayList PlayFabIds; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; @@ -1396,7 +1396,7 @@ public static class GetMatchmakerGameInfoRequest { public static class GetMatchmakerGameInfoResult { /** - * unique identifier of the lobby + * unique identifier of the lobby */ public String LobbyId; /** @@ -1581,7 +1581,7 @@ public static class GetPolicyResponse { public static class GetPublisherDataRequest { /** - * array of keys to get back data from the Publisher data blob, set by the admin tools + * array of keys to get back data from the Publisher data blob, set by the admin tools */ public ArrayList Keys; @@ -1665,7 +1665,7 @@ public static class GetServerBuildInfoResult implements Comparable> AuthUserAsync(final AuthUserRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception { /** * Validates a user with the PlayFab service + * @param request AuthUserRequest + * @return AuthUserResponse */ @SuppressWarnings("unchecked") public static PlayFabResult AuthUser(final AuthUserRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateAuthUserAsync(final AuthUs /** * Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified + * @param request PlayerJoinedRequest + * @return Async Task will return PlayerJoinedResponse */ @SuppressWarnings("unchecked") public static FutureTask> PlayerJoinedAsync(final PlayerJoinedRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified + * @param request PlayerJoinedRequest + * @return PlayerJoinedResponse */ @SuppressWarnings("unchecked") public static PlayFabResult PlayerJoined(final PlayerJoinedRequest request) { @@ -134,6 +142,8 @@ private static PlayFabResult privatePlayerJoinedAsync(fina /** * Informs the PlayFab game server hosting service that the indicated user has left the Game Server Instance specified + * @param request PlayerLeftRequest + * @return Async Task will return PlayerLeftResponse */ @SuppressWarnings("unchecked") public static FutureTask> PlayerLeftAsync(final PlayerLeftRequest request) { @@ -146,6 +156,8 @@ public PlayFabResult call() throws Exception { /** * Informs the PlayFab game server hosting service that the indicated user has left the Game Server Instance specified + * @param request PlayerLeftRequest + * @return PlayerLeftResponse */ @SuppressWarnings("unchecked") public static PlayFabResult PlayerLeft(final PlayerLeftRequest request) { @@ -192,6 +204,8 @@ private static PlayFabResult privatePlayerLeftAsync(final Pl /** * Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance + * @param request StartGameRequest + * @return Async Task will return StartGameResponse */ @SuppressWarnings("unchecked") public static FutureTask> StartGameAsync(final StartGameRequest request) { @@ -204,6 +218,8 @@ public PlayFabResult call() throws Exception { /** * Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance + * @param request StartGameRequest + * @return StartGameResponse */ @SuppressWarnings("unchecked") public static PlayFabResult StartGame(final StartGameRequest request) { @@ -250,6 +266,8 @@ private static PlayFabResult privateStartGameAsync(final Star /** * Retrieves the relevant details for a specified user, which the external match-making service can then use to compute effective matches + * @param request UserInfoRequest + * @return Async Task will return UserInfoResponse */ @SuppressWarnings("unchecked") public static FutureTask> UserInfoAsync(final UserInfoRequest request) { @@ -262,6 +280,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the relevant details for a specified user, which the external match-making service can then use to compute effective matches + * @param request UserInfoRequest + * @return UserInfoResponse */ @SuppressWarnings("unchecked") public static PlayFabResult UserInfo(final UserInfoRequest request) { diff --git a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java index f7eb9db4f..bbbba1b78 100644 --- a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java +++ b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabMatchmakerModels.java @@ -205,7 +205,7 @@ public static class StartGameRequest { */ public String CustomCommandLineData; /** - * HTTP endpoint URL for receiving game status events, if using an external matchmaker. When the game ends, PlayFab will make a POST request to this URL with the X-SecretKey header set to the value of the game's secret and an application/json body of { "EventName": "game_ended", "GameID": "> AuthenticateSessionTicketAsync(final AuthenticateSessionTicketRequest request) { @@ -30,6 +32,8 @@ public PlayFabResult call() throws Exception { /** * Validated a client's session ticket, and if successful, returns details for that user + * @param request AuthenticateSessionTicketRequest + * @return AuthenticateSessionTicketResult */ @SuppressWarnings("unchecked") public static PlayFabResult AuthenticateSessionTicket(final AuthenticateSessionTicketRequest request) { @@ -76,6 +80,8 @@ private static PlayFabResult privateAuthenticat /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return Async Task will return BanUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> BanUsersAsync(final BanUsersRequest request) { @@ -88,6 +94,8 @@ public PlayFabResult call() throws Exception { /** * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * @param request BanUsersRequest + * @return BanUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult BanUsers(final BanUsersRequest request) { @@ -134,6 +142,8 @@ private static PlayFabResult privateBanUsersAsync(final BanUsers /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return Async Task will return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromFacebookIDsAsync(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -146,6 +156,8 @@ public PlayFabResult call() throws Exception /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. + * @param request GetPlayFabIDsFromFacebookIDsRequest + * @return GetPlayFabIDsFromFacebookIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromFacebookIDs(final GetPlayFabIDsFromFacebookIDsRequest request) { @@ -192,6 +204,8 @@ private static PlayFabResult privateGetPlayF /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return Async Task will return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayFabIDsFromSteamIDsAsync(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -204,6 +218,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls. + * @param request GetPlayFabIDsFromSteamIDsRequest + * @return GetPlayFabIDsFromSteamIDsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayFabIDsFromSteamIDs(final GetPlayFabIDsFromSteamIDsRequest request) { @@ -250,6 +266,8 @@ private static PlayFabResult privateGetPlayFabI /** * Retrieves the relevant details for a specified user + * @param request GetUserAccountInfoRequest + * @return Async Task will return GetUserAccountInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserAccountInfoAsync(final GetUserAccountInfoRequest request) { @@ -262,6 +280,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the relevant details for a specified user + * @param request GetUserAccountInfoRequest + * @return GetUserAccountInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserAccountInfo(final GetUserAccountInfoRequest request) { @@ -308,6 +328,8 @@ private static PlayFabResult privateGetUserAccountInfo /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return Async Task will return GetUserBansResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserBansAsync(final GetUserBansRequest request) { @@ -320,6 +342,8 @@ public PlayFabResult call() throws Exception { /** * Gets all bans for a user. + * @param request GetUserBansRequest + * @return GetUserBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserBans(final GetUserBansRequest request) { @@ -366,6 +390,8 @@ private static PlayFabResult privateGetUserBansAsync(final Ge /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return Async Task will return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeAllBansForUserAsync(final RevokeAllBansForUserRequest request) { @@ -378,6 +404,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans for a user. + * @param request RevokeAllBansForUserRequest + * @return RevokeAllBansForUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeAllBansForUser(final RevokeAllBansForUserRequest request) { @@ -424,6 +452,8 @@ private static PlayFabResult privateRevokeAllBansFor /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return Async Task will return RevokeBansResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeBansAsync(final RevokeBansRequest request) { @@ -436,6 +466,8 @@ public PlayFabResult call() throws Exception { /** * Revoke all active bans specified with BanId. + * @param request RevokeBansRequest + * @return RevokeBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeBans(final RevokeBansRequest request) { @@ -482,6 +514,8 @@ private static PlayFabResult privateRevokeBansAsync(final Revo /** * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified. + * @param request SendPushNotificationRequest + * @return Async Task will return SendPushNotificationResult */ @SuppressWarnings("unchecked") public static FutureTask> SendPushNotificationAsync(final SendPushNotificationRequest request) { @@ -494,6 +528,8 @@ public PlayFabResult call() throws Exception { /** * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified. + * @param request SendPushNotificationRequest + * @return SendPushNotificationResult */ @SuppressWarnings("unchecked") public static PlayFabResult SendPushNotification(final SendPushNotificationRequest request) { @@ -540,6 +576,8 @@ private static PlayFabResult privateSendPushNotifica /** * Update the avatar URL of the specified player + * @param request UpdateAvatarUrlRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateAvatarUrlAsync(final UpdateAvatarUrlRequest request) { @@ -552,6 +590,8 @@ public PlayFabResult call() throws Exception { /** * Update the avatar URL of the specified player + * @param request UpdateAvatarUrlRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateAvatarUrl(final UpdateAvatarUrlRequest request) { @@ -598,6 +638,8 @@ private static PlayFabResult privateUpdateAvatarUrlAsync(final Upda /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return Async Task will return UpdateBansResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateBansAsync(final UpdateBansRequest request) { @@ -610,6 +652,8 @@ public PlayFabResult call() throws Exception { /** * Updates information of a list of existing bans specified with Ban Ids. + * @param request UpdateBansRequest + * @return UpdateBansResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateBans(final UpdateBansRequest request) { @@ -656,6 +700,8 @@ private static PlayFabResult privateUpdateBansAsync(final Upda /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. + * @param request DeleteUsersRequest + * @return Async Task will return DeleteUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteUsersAsync(final DeleteUsersRequest request) { @@ -668,6 +714,8 @@ public PlayFabResult call() throws Exception { /** * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. + * @param request DeleteUsersRequest + * @return DeleteUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteUsers(final DeleteUsersRequest request) { @@ -714,6 +762,8 @@ private static PlayFabResult privateDeleteUsersAsync(final De /** * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendLeaderboardAsync(final GetFriendLeaderboardRequest request) { @@ -726,6 +776,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard + * @param request GetFriendLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendLeaderboard(final GetFriendLeaderboardRequest request) { @@ -772,6 +824,8 @@ private static PlayFabResult privateGetFriendLeaderboardAs /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return Async Task will return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAsync(final GetLeaderboardRequest request) { @@ -784,6 +838,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard + * @param request GetLeaderboardRequest + * @return GetLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboard(final GetLeaderboardRequest request) { @@ -830,6 +886,8 @@ private static PlayFabResult privateGetLeaderboardAsync(fi /** * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user + * @param request GetLeaderboardAroundUserRequest + * @return Async Task will return GetLeaderboardAroundUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundUserAsync(final GetLeaderboardAroundUserRequest request) { @@ -842,6 +900,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user + * @param request GetLeaderboardAroundUserRequest + * @return GetLeaderboardAroundUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundUser(final GetLeaderboardAroundUserRequest request) { @@ -888,6 +948,8 @@ private static PlayFabResult privateGetLeaderboa /** * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false. + * @param request GetPlayerCombinedInfoRequest + * @return Async Task will return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerCombinedInfoAsync(final GetPlayerCombinedInfoRequest request) { @@ -900,6 +962,8 @@ public PlayFabResult call() throws Exception { /** * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false. + * @param request GetPlayerCombinedInfoRequest + * @return GetPlayerCombinedInfoResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerCombinedInfo(final GetPlayerCombinedInfoRequest request) { @@ -946,6 +1010,8 @@ private static PlayFabResult privateGetPlayerCombin /** * Retrieves the current version and values for the indicated statistics, for the local player. + * @param request GetPlayerStatisticsRequest + * @return Async Task will return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticsAsync(final GetPlayerStatisticsRequest request) { @@ -958,6 +1024,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current version and values for the indicated statistics, for the local player. + * @param request GetPlayerStatisticsRequest + * @return GetPlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatistics(final GetPlayerStatisticsRequest request) { @@ -1004,6 +1072,8 @@ private static PlayFabResult privateGetPlayerStatisti /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return Async Task will return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerStatisticVersionsAsync(final GetPlayerStatisticVersionsRequest request) { @@ -1016,6 +1086,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the information on the available versions of the specified statistic. + * @param request GetPlayerStatisticVersionsRequest + * @return GetPlayerStatisticVersionsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerStatisticVersions(final GetPlayerStatisticVersionsRequest request) { @@ -1062,6 +1134,8 @@ private static PlayFabResult privateGetPlayerS /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserDataAsync(final GetUserDataRequest request) { @@ -1074,6 +1148,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserData(final GetUserDataRequest request) { @@ -1120,6 +1196,8 @@ private static PlayFabResult privateGetUserDataAsync(final Ge /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInternalDataAsync(final GetUserDataRequest request) { @@ -1132,6 +1210,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInternalData(final GetUserDataRequest request) { @@ -1178,6 +1258,8 @@ private static PlayFabResult privateGetUserInternalDataAsync( /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherDataAsync(final GetUserDataRequest request) { @@ -1190,6 +1272,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which is readable and writable by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherData(final GetUserDataRequest request) { @@ -1236,6 +1320,8 @@ private static PlayFabResult privateGetUserPublisherDataAsync /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherInternalDataAsync(final GetUserDataRequest request) { @@ -1248,6 +1334,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherInternalData(final GetUserDataRequest request) { @@ -1294,6 +1382,8 @@ private static PlayFabResult privateGetUserPublisherInternalD /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserPublisherReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1306,6 +1396,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the publisher-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserPublisherReadOnlyData(final GetUserDataRequest request) { @@ -1352,6 +1444,8 @@ private static PlayFabResult privateGetUserPublisherReadOnlyD /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return Async Task will return GetUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserReadOnlyDataAsync(final GetUserDataRequest request) { @@ -1364,6 +1458,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which can only be read by the client + * @param request GetUserDataRequest + * @return GetUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserReadOnlyData(final GetUserDataRequest request) { @@ -1410,6 +1506,8 @@ private static PlayFabResult privateGetUserReadOnlyDataAsync( /** * Updates the values of the specified title-specific statistics for the user + * @param request UpdatePlayerStatisticsRequest + * @return Async Task will return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdatePlayerStatisticsAsync(final UpdatePlayerStatisticsRequest request) { @@ -1422,6 +1520,8 @@ public PlayFabResult call() throws Exception { /** * Updates the values of the specified title-specific statistics for the user + * @param request UpdatePlayerStatisticsRequest + * @return UpdatePlayerStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdatePlayerStatistics(final UpdatePlayerStatisticsRequest request) { @@ -1468,6 +1568,8 @@ private static PlayFabResult privateUpdatePlayerSt /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserDataAsync(final UpdateUserDataRequest request) { @@ -1480,6 +1582,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserData(final UpdateUserDataRequest request) { @@ -1526,6 +1630,8 @@ private static PlayFabResult privateUpdateUserDataAsync(fi /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1538,6 +1644,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserInternalData(final UpdateUserInternalDataRequest request) { @@ -1584,6 +1692,8 @@ private static PlayFabResult privateUpdateUserInternalData /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherDataAsync(final UpdateUserDataRequest request) { @@ -1596,6 +1706,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which is readable and writable by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherData(final UpdateUserDataRequest request) { @@ -1642,6 +1754,8 @@ private static PlayFabResult privateUpdateUserPublisherDat /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherInternalDataAsync(final UpdateUserInternalDataRequest request) { @@ -1654,6 +1768,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which cannot be accessed by the client + * @param request UpdateUserInternalDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherInternalData(final UpdateUserInternalDataRequest request) { @@ -1700,6 +1816,8 @@ private static PlayFabResult privateUpdateUserPublisherInt /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserPublisherReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1712,6 +1830,8 @@ public PlayFabResult call() throws Exception { /** * Updates the publisher-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserPublisherReadOnlyData(final UpdateUserDataRequest request) { @@ -1758,6 +1878,8 @@ private static PlayFabResult privateUpdateUserPublisherRea /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return Async Task will return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserReadOnlyDataAsync(final UpdateUserDataRequest request) { @@ -1770,6 +1892,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user which can only be read by the client + * @param request UpdateUserDataRequest + * @return UpdateUserDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserReadOnlyData(final UpdateUserDataRequest request) { @@ -1816,6 +1940,8 @@ private static PlayFabResult privateUpdateUserReadOnlyData /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return Async Task will return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCatalogItemsAsync(final GetCatalogItemsRequest request) { @@ -1828,6 +1954,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified version of the title's catalog of virtual goods, including all defined properties + * @param request GetCatalogItemsRequest + * @return GetCatalogItemsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCatalogItems(final GetCatalogItemsRequest request) { @@ -1874,6 +2002,8 @@ private static PlayFabResult privateGetCatalogItemsAsync( /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return Async Task will return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPublisherDataAsync(final GetPublisherDataRequest request) { @@ -1886,6 +2016,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom publisher settings + * @param request GetPublisherDataRequest + * @return GetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPublisherData(final GetPublisherDataRequest request) { @@ -1932,6 +2064,8 @@ private static PlayFabResult privateGetPublisherDataAsyn /** * Retrieves the current server time + * @param request GetTimeRequest + * @return Async Task will return GetTimeResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTimeAsync(final GetTimeRequest request) { @@ -1944,6 +2078,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current server time + * @param request GetTimeRequest + * @return GetTimeResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTime(final GetTimeRequest request) { @@ -1990,6 +2126,8 @@ private static PlayFabResult privateGetTimeAsync(final GetTimeReq /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleDataAsync(final GetTitleDataRequest request) { @@ -2002,6 +2140,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom title settings + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleData(final GetTitleDataRequest request) { @@ -2048,6 +2188,8 @@ private static PlayFabResult privateGetTitleDataAsync(final /** * Retrieves the key-value store of custom internal title settings + * @param request GetTitleDataRequest + * @return Async Task will return GetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleInternalDataAsync(final GetTitleDataRequest request) { @@ -2060,6 +2202,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the key-value store of custom internal title settings + * @param request GetTitleDataRequest + * @return GetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleInternalData(final GetTitleDataRequest request) { @@ -2106,6 +2250,8 @@ private static PlayFabResult privateGetTitleInternalDataAsyn /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return Async Task will return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetTitleNewsAsync(final GetTitleNewsRequest request) { @@ -2118,6 +2264,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title news feed, as configured in the developer portal + * @param request GetTitleNewsRequest + * @return GetTitleNewsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetTitleNews(final GetTitleNewsRequest request) { @@ -2164,6 +2312,8 @@ private static PlayFabResult privateGetTitleNewsAsync(final /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return Async Task will return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetPublisherDataAsync(final SetPublisherDataRequest request) { @@ -2176,6 +2326,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom publisher settings + * @param request SetPublisherDataRequest + * @return SetPublisherDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetPublisherData(final SetPublisherDataRequest request) { @@ -2222,6 +2374,8 @@ private static PlayFabResult privateSetPublisherDataAsyn /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleDataAsync(final SetTitleDataRequest request) { @@ -2234,6 +2388,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleData(final SetTitleDataRequest request) { @@ -2280,6 +2436,8 @@ private static PlayFabResult privateSetTitleDataAsync(final /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return Async Task will return SetTitleDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetTitleInternalDataAsync(final SetTitleDataRequest request) { @@ -2292,6 +2450,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value store of custom title settings + * @param request SetTitleDataRequest + * @return SetTitleDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetTitleInternalData(final SetTitleDataRequest request) { @@ -2338,6 +2498,8 @@ private static PlayFabResult privateSetTitleInternalDataAsyn /** * Increments the character's balance of the specified virtual currency by the stated amount + * @param request AddCharacterVirtualCurrencyRequest + * @return Async Task will return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddCharacterVirtualCurrencyAsync(final AddCharacterVirtualCurrencyRequest request) { @@ -2350,6 +2512,8 @@ public PlayFabResult call() throws Excepti /** * Increments the character's balance of the specified virtual currency by the stated amount + * @param request AddCharacterVirtualCurrencyRequest + * @return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddCharacterVirtualCurrency(final AddCharacterVirtualCurrencyRequest request) { @@ -2396,6 +2560,8 @@ private static PlayFabResult privateAddCha /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddUserVirtualCurrencyAsync(final AddUserVirtualCurrencyRequest request) { @@ -2408,6 +2574,8 @@ public PlayFabResult call() throws Exception { /** * Increments the user's balance of the specified virtual currency by the stated amount + * @param request AddUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddUserVirtualCurrency(final AddUserVirtualCurrencyRequest request) { @@ -2454,6 +2622,8 @@ private static PlayFabResult privateAddUserVirt /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return Async Task will return ConsumeItemResult */ @SuppressWarnings("unchecked") public static FutureTask> ConsumeItemAsync(final ConsumeItemRequest request) { @@ -2466,6 +2636,8 @@ public PlayFabResult call() throws Exception { /** * Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory. + * @param request ConsumeItemRequest + * @return ConsumeItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult ConsumeItem(final ConsumeItemRequest request) { @@ -2512,6 +2684,8 @@ private static PlayFabResult privateConsumeItemAsync(final Co /** * Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer. + * @param request EvaluateRandomResultTableRequest + * @return Async Task will return EvaluateRandomResultTableResult */ @SuppressWarnings("unchecked") public static FutureTask> EvaluateRandomResultTableAsync(final EvaluateRandomResultTableRequest request) { @@ -2524,6 +2698,8 @@ public PlayFabResult call() throws Exception { /** * Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer. + * @param request EvaluateRandomResultTableRequest + * @return EvaluateRandomResultTableResult */ @SuppressWarnings("unchecked") public static PlayFabResult EvaluateRandomResultTable(final EvaluateRandomResultTableRequest request) { @@ -2570,6 +2746,8 @@ private static PlayFabResult privateEvaluateRan /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return Async Task will return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterInventoryAsync(final GetCharacterInventoryRequest request) { @@ -2582,6 +2760,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified character's current inventory of virtual goods + * @param request GetCharacterInventoryRequest + * @return GetCharacterInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterInventory(final GetCharacterInventoryRequest request) { @@ -2628,6 +2808,8 @@ private static PlayFabResult privateGetCharacterInv /** * Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights + * @param request GetRandomResultTablesRequest + * @return Async Task will return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static FutureTask> GetRandomResultTablesAsync(final GetRandomResultTablesRequest request) { @@ -2640,6 +2822,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights + * @param request GetRandomResultTablesRequest + * @return GetRandomResultTablesResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetRandomResultTables(final GetRandomResultTablesRequest request) { @@ -2686,6 +2870,8 @@ private static PlayFabResult privateGetRandomResult /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return Async Task will return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> GetUserInventoryAsync(final GetUserInventoryRequest request) { @@ -2698,6 +2884,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the specified user's current inventory of virtual goods + * @param request GetUserInventoryRequest + * @return GetUserInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetUserInventory(final GetUserInventoryRequest request) { @@ -2744,6 +2932,8 @@ private static PlayFabResult privateGetUserInventoryAsyn /** * Adds the specified items to the specified character's inventory + * @param request GrantItemsToCharacterRequest + * @return Async Task will return GrantItemsToCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToCharacterAsync(final GrantItemsToCharacterRequest request) { @@ -2756,6 +2946,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified character's inventory + * @param request GrantItemsToCharacterRequest + * @return GrantItemsToCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToCharacter(final GrantItemsToCharacterRequest request) { @@ -2802,6 +2994,8 @@ private static PlayFabResult privateGrantItemsToCha /** * Adds the specified items to the specified user's inventory + * @param request GrantItemsToUserRequest + * @return Async Task will return GrantItemsToUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToUserAsync(final GrantItemsToUserRequest request) { @@ -2814,6 +3008,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified user's inventory + * @param request GrantItemsToUserRequest + * @return GrantItemsToUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToUser(final GrantItemsToUserRequest request) { @@ -2860,6 +3056,8 @@ private static PlayFabResult privateGrantItemsToUserAsyn /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return Async Task will return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantItemsToUsersAsync(final GrantItemsToUsersRequest request) { @@ -2872,6 +3070,8 @@ public PlayFabResult call() throws Exception { /** * Adds the specified items to the specified user inventories + * @param request GrantItemsToUsersRequest + * @return GrantItemsToUsersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantItemsToUsers(final GrantItemsToUsersRequest request) { @@ -2918,6 +3118,8 @@ private static PlayFabResult privateGrantItemsToUsersAs /** * Modifies the number of remaining uses of a player's inventory item + * @param request ModifyItemUsesRequest + * @return Async Task will return ModifyItemUsesResult */ @SuppressWarnings("unchecked") public static FutureTask> ModifyItemUsesAsync(final ModifyItemUsesRequest request) { @@ -2930,6 +3132,8 @@ public PlayFabResult call() throws Exception { /** * Modifies the number of remaining uses of a player's inventory item + * @param request ModifyItemUsesRequest + * @return ModifyItemUsesResult */ @SuppressWarnings("unchecked") public static PlayFabResult ModifyItemUses(final ModifyItemUsesRequest request) { @@ -2976,6 +3180,8 @@ private static PlayFabResult privateModifyItemUsesAsync(fi /** * Moves an item from a character's inventory into another of the users's character's inventory. + * @param request MoveItemToCharacterFromCharacterRequest + * @return Async Task will return MoveItemToCharacterFromCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> MoveItemToCharacterFromCharacterAsync(final MoveItemToCharacterFromCharacterRequest request) { @@ -2988,6 +3194,8 @@ public PlayFabResult call() throws Excep /** * Moves an item from a character's inventory into another of the users's character's inventory. + * @param request MoveItemToCharacterFromCharacterRequest + * @return MoveItemToCharacterFromCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult MoveItemToCharacterFromCharacter(final MoveItemToCharacterFromCharacterRequest request) { @@ -3034,6 +3242,8 @@ private static PlayFabResult privateMove /** * Moves an item from a user's inventory into their character's inventory. + * @param request MoveItemToCharacterFromUserRequest + * @return Async Task will return MoveItemToCharacterFromUserResult */ @SuppressWarnings("unchecked") public static FutureTask> MoveItemToCharacterFromUserAsync(final MoveItemToCharacterFromUserRequest request) { @@ -3046,6 +3256,8 @@ public PlayFabResult call() throws Exception /** * Moves an item from a user's inventory into their character's inventory. + * @param request MoveItemToCharacterFromUserRequest + * @return MoveItemToCharacterFromUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult MoveItemToCharacterFromUser(final MoveItemToCharacterFromUserRequest request) { @@ -3092,6 +3304,8 @@ private static PlayFabResult privateMoveItemT /** * Moves an item from a character's inventory into the owning user's inventory. + * @param request MoveItemToUserFromCharacterRequest + * @return Async Task will return MoveItemToUserFromCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> MoveItemToUserFromCharacterAsync(final MoveItemToUserFromCharacterRequest request) { @@ -3104,6 +3318,8 @@ public PlayFabResult call() throws Exception /** * Moves an item from a character's inventory into the owning user's inventory. + * @param request MoveItemToUserFromCharacterRequest + * @return MoveItemToUserFromCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult MoveItemToUserFromCharacter(final MoveItemToUserFromCharacterRequest request) { @@ -3149,7 +3365,9 @@ private static PlayFabResult privateMoveItemT } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return Async Task will return RedeemCouponResult */ @SuppressWarnings("unchecked") public static FutureTask> RedeemCouponAsync(final RedeemCouponRequest request) { @@ -3161,7 +3379,9 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * @param request RedeemCouponRequest + * @return RedeemCouponResult */ @SuppressWarnings("unchecked") public static PlayFabResult RedeemCoupon(final RedeemCouponRequest request) { @@ -3179,7 +3399,7 @@ public PlayFabResult call() throws Exception { } /** - * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. + * Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager. */ @SuppressWarnings("unchecked") private static PlayFabResult privateRedeemCouponAsync(final RedeemCouponRequest request) throws Exception { @@ -3208,6 +3428,8 @@ private static PlayFabResult privateRedeemCouponAsync(final /** * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerServerRequest + * @return Async Task will return ReportPlayerServerResult */ @SuppressWarnings("unchecked") public static FutureTask> ReportPlayerAsync(final ReportPlayerServerRequest request) { @@ -3220,6 +3442,8 @@ public PlayFabResult call() throws Exception { /** * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players. + * @param request ReportPlayerServerRequest + * @return ReportPlayerServerResult */ @SuppressWarnings("unchecked") public static PlayFabResult ReportPlayer(final ReportPlayerServerRequest request) { @@ -3266,6 +3490,8 @@ private static PlayFabResult privateReportPlayerAsync( /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return Async Task will return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static FutureTask> RevokeInventoryItemAsync(final RevokeInventoryItemRequest request) { @@ -3278,6 +3504,8 @@ public PlayFabResult call() throws Exception { /** * Revokes access to an item in a user's inventory + * @param request RevokeInventoryItemRequest + * @return RevokeInventoryResult */ @SuppressWarnings("unchecked") public static PlayFabResult RevokeInventoryItem(final RevokeInventoryItemRequest request) { @@ -3324,6 +3552,8 @@ private static PlayFabResult privateRevokeInventoryItemAs /** * Decrements the character's balance of the specified virtual currency by the stated amount + * @param request SubtractCharacterVirtualCurrencyRequest + * @return Async Task will return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractCharacterVirtualCurrencyAsync(final SubtractCharacterVirtualCurrencyRequest request) { @@ -3336,6 +3566,8 @@ public PlayFabResult call() throws Excepti /** * Decrements the character's balance of the specified virtual currency by the stated amount + * @param request SubtractCharacterVirtualCurrencyRequest + * @return ModifyCharacterVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractCharacterVirtualCurrency(final SubtractCharacterVirtualCurrencyRequest request) { @@ -3382,6 +3614,8 @@ private static PlayFabResult privateSubtra /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return Async Task will return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static FutureTask> SubtractUserVirtualCurrencyAsync(final SubtractUserVirtualCurrencyRequest request) { @@ -3394,6 +3628,8 @@ public PlayFabResult call() throws Exception { /** * Decrements the user's balance of the specified virtual currency by the stated amount + * @param request SubtractUserVirtualCurrencyRequest + * @return ModifyUserVirtualCurrencyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SubtractUserVirtualCurrency(final SubtractUserVirtualCurrencyRequest request) { @@ -3439,7 +3675,9 @@ private static PlayFabResult privateSubtractUse } /** - * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) { @@ -3451,7 +3689,9 @@ public PlayFabResult call() throws Exception { } /** - * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerInstanceRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerInstance(final UnlockContainerInstanceRequest request) { @@ -3469,7 +3709,7 @@ public PlayFabResult call() throws Exception { } /** - * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerInstanceAsync(final UnlockContainerInstanceRequest request) throws Exception { @@ -3497,7 +3737,9 @@ private static PlayFabResult privateUnlockContainerIn } /** - * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return Async Task will return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static FutureTask> UnlockContainerItemAsync(final UnlockContainerItemRequest request) { @@ -3509,7 +3751,9 @@ public PlayFabResult call() throws Exception { } /** - * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * @param request UnlockContainerItemRequest + * @return UnlockContainerItemResult */ @SuppressWarnings("unchecked") public static PlayFabResult UnlockContainerItem(final UnlockContainerItemRequest request) { @@ -3527,7 +3771,7 @@ public PlayFabResult call() throws Exception { } /** - * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. + * Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem. */ @SuppressWarnings("unchecked") private static PlayFabResult privateUnlockContainerItemAsync(final UnlockContainerItemRequest request) throws Exception { @@ -3556,6 +3800,8 @@ private static PlayFabResult privateUnlockContainerIt /** * Updates the key-value pair data tagged to the specified item, which is read-only from the client. + * @param request UpdateUserInventoryItemDataRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateUserInventoryItemCustomDataAsync(final UpdateUserInventoryItemDataRequest request) { @@ -3568,6 +3814,8 @@ public PlayFabResult call() throws Exception { /** * Updates the key-value pair data tagged to the specified item, which is read-only from the client. + * @param request UpdateUserInventoryItemDataRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateUserInventoryItemCustomData(final UpdateUserInventoryItemDataRequest request) { @@ -3614,6 +3862,8 @@ private static PlayFabResult privateUpdateUserInventoryItemCustomDa /** * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> AddFriendAsync(final AddFriendRequest request) { @@ -3626,6 +3876,8 @@ public PlayFabResult call() throws Exception { /** * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized. + * @param request AddFriendRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddFriend(final AddFriendRequest request) { @@ -3672,6 +3924,8 @@ private static PlayFabResult privateAddFriendAsync(final AddFriendR /** * Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return Async Task will return GetFriendsListResult */ @SuppressWarnings("unchecked") public static FutureTask> GetFriendsListAsync(final GetFriendsListRequest request) { @@ -3684,6 +3938,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends. + * @param request GetFriendsListRequest + * @return GetFriendsListResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetFriendsList(final GetFriendsListRequest request) { @@ -3730,6 +3986,8 @@ private static PlayFabResult privateGetFriendsListAsync(fi /** * Removes the specified friend from the the user's friend list + * @param request RemoveFriendRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveFriendAsync(final RemoveFriendRequest request) { @@ -3742,6 +4000,8 @@ public PlayFabResult call() throws Exception { /** * Removes the specified friend from the the user's friend list + * @param request RemoveFriendRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveFriend(final RemoveFriendRequest request) { @@ -3788,6 +4048,8 @@ private static PlayFabResult privateRemoveFriendAsync(final RemoveF /** * Updates the tag list for a specified user in the friend list of another user + * @param request SetFriendTagsRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> SetFriendTagsAsync(final SetFriendTagsRequest request) { @@ -3800,6 +4062,8 @@ public PlayFabResult call() throws Exception { /** * Updates the tag list for a specified user in the friend list of another user + * @param request SetFriendTagsRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetFriendTags(final SetFriendTagsRequest request) { @@ -3846,6 +4110,8 @@ private static PlayFabResult privateSetFriendTagsAsync(final SetFri /** * Inform the matchmaker that a Game Server Instance is removed. + * @param request DeregisterGameRequest + * @return Async Task will return DeregisterGameResponse */ @SuppressWarnings("unchecked") public static FutureTask> DeregisterGameAsync(final DeregisterGameRequest request) { @@ -3858,6 +4124,8 @@ public PlayFabResult call() throws Exception { /** * Inform the matchmaker that a Game Server Instance is removed. + * @param request DeregisterGameRequest + * @return DeregisterGameResponse */ @SuppressWarnings("unchecked") public static PlayFabResult DeregisterGame(final DeregisterGameRequest request) { @@ -3904,6 +4172,8 @@ private static PlayFabResult privateDeregisterGameAsync( /** * Informs the PlayFab match-making service that the user specified has left the Game Server Instance + * @param request NotifyMatchmakerPlayerLeftRequest + * @return Async Task will return NotifyMatchmakerPlayerLeftResult */ @SuppressWarnings("unchecked") public static FutureTask> NotifyMatchmakerPlayerLeftAsync(final NotifyMatchmakerPlayerLeftRequest request) { @@ -3916,6 +4186,8 @@ public PlayFabResult call() throws Exception { /** * Informs the PlayFab match-making service that the user specified has left the Game Server Instance + * @param request NotifyMatchmakerPlayerLeftRequest + * @return NotifyMatchmakerPlayerLeftResult */ @SuppressWarnings("unchecked") public static PlayFabResult NotifyMatchmakerPlayerLeft(final NotifyMatchmakerPlayerLeftRequest request) { @@ -3962,6 +4234,8 @@ private static PlayFabResult privateNotifyMatc /** * Validates a Game Server session ticket and returns details about the user + * @param request RedeemMatchmakerTicketRequest + * @return Async Task will return RedeemMatchmakerTicketResult */ @SuppressWarnings("unchecked") public static FutureTask> RedeemMatchmakerTicketAsync(final RedeemMatchmakerTicketRequest request) { @@ -3974,6 +4248,8 @@ public PlayFabResult call() throws Exception { /** * Validates a Game Server session ticket and returns details about the user + * @param request RedeemMatchmakerTicketRequest + * @return RedeemMatchmakerTicketResult */ @SuppressWarnings("unchecked") public static PlayFabResult RedeemMatchmakerTicket(final RedeemMatchmakerTicketRequest request) { @@ -4020,6 +4296,8 @@ private static PlayFabResult privateRedeemMatchmak /** * Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance. + * @param request RefreshGameServerInstanceHeartbeatRequest + * @return Async Task will return RefreshGameServerInstanceHeartbeatResult */ @SuppressWarnings("unchecked") public static FutureTask> RefreshGameServerInstanceHeartbeatAsync(final RefreshGameServerInstanceHeartbeatRequest request) { @@ -4032,6 +4310,8 @@ public PlayFabResult call() throws Exc /** * Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance. + * @param request RefreshGameServerInstanceHeartbeatRequest + * @return RefreshGameServerInstanceHeartbeatResult */ @SuppressWarnings("unchecked") public static PlayFabResult RefreshGameServerInstanceHeartbeat(final RefreshGameServerInstanceHeartbeatRequest request) { @@ -4078,6 +4358,8 @@ private static PlayFabResult privateRe /** * Inform the matchmaker that a new Game Server Instance is added. + * @param request RegisterGameRequest + * @return Async Task will return RegisterGameResponse */ @SuppressWarnings("unchecked") public static FutureTask> RegisterGameAsync(final RegisterGameRequest request) { @@ -4090,6 +4372,8 @@ public PlayFabResult call() throws Exception { /** * Inform the matchmaker that a new Game Server Instance is added. + * @param request RegisterGameRequest + * @return RegisterGameResponse */ @SuppressWarnings("unchecked") public static PlayFabResult RegisterGame(final RegisterGameRequest request) { @@ -4136,6 +4420,8 @@ private static PlayFabResult privateRegisterGameAsync(fina /** * Sets the custom data of the indicated Game Server Instance + * @param request SetGameServerInstanceDataRequest + * @return Async Task will return SetGameServerInstanceDataResult */ @SuppressWarnings("unchecked") public static FutureTask> SetGameServerInstanceDataAsync(final SetGameServerInstanceDataRequest request) { @@ -4148,6 +4434,8 @@ public PlayFabResult call() throws Exception { /** * Sets the custom data of the indicated Game Server Instance + * @param request SetGameServerInstanceDataRequest + * @return SetGameServerInstanceDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetGameServerInstanceData(final SetGameServerInstanceDataRequest request) { @@ -4194,6 +4482,8 @@ private static PlayFabResult privateSetGameServ /** * Set the state of the indicated Game Server Instance. + * @param request SetGameServerInstanceStateRequest + * @return Async Task will return SetGameServerInstanceStateResult */ @SuppressWarnings("unchecked") public static FutureTask> SetGameServerInstanceStateAsync(final SetGameServerInstanceStateRequest request) { @@ -4206,6 +4496,8 @@ public PlayFabResult call() throws Exception { /** * Set the state of the indicated Game Server Instance. + * @param request SetGameServerInstanceStateRequest + * @return SetGameServerInstanceStateResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetGameServerInstanceState(final SetGameServerInstanceStateRequest request) { @@ -4252,6 +4544,8 @@ private static PlayFabResult privateSetGameSer /** * Set custom tags for the specified Game Server Instance + * @param request SetGameServerInstanceTagsRequest + * @return Async Task will return SetGameServerInstanceTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> SetGameServerInstanceTagsAsync(final SetGameServerInstanceTagsRequest request) { @@ -4264,6 +4558,8 @@ public PlayFabResult call() throws Exception { /** * Set custom tags for the specified Game Server Instance + * @param request SetGameServerInstanceTagsRequest + * @return SetGameServerInstanceTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult SetGameServerInstanceTags(final SetGameServerInstanceTagsRequest request) { @@ -4310,6 +4606,8 @@ private static PlayFabResult privateSetGameServ /** * Awards the specified users the specified Steam achievements + * @param request AwardSteamAchievementRequest + * @return Async Task will return AwardSteamAchievementResult */ @SuppressWarnings("unchecked") public static FutureTask> AwardSteamAchievementAsync(final AwardSteamAchievementRequest request) { @@ -4322,6 +4620,8 @@ public PlayFabResult call() throws Exception { /** * Awards the specified users the specified Steam achievements + * @param request AwardSteamAchievementRequest + * @return AwardSteamAchievementResult */ @SuppressWarnings("unchecked") public static PlayFabResult AwardSteamAchievement(final AwardSteamAchievementRequest request) { @@ -4368,6 +4668,8 @@ private static PlayFabResult privateAwardSteamAchie /** * Writes a character-based event into PlayStream. + * @param request WriteServerCharacterEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteCharacterEventAsync(final WriteServerCharacterEventRequest request) { @@ -4380,6 +4682,8 @@ public PlayFabResult call() throws Exception { /** * Writes a character-based event into PlayStream. + * @param request WriteServerCharacterEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteCharacterEvent(final WriteServerCharacterEventRequest request) { @@ -4426,6 +4730,8 @@ private static PlayFabResult privateWriteCharacterEventAsync /** * Writes a player-based event into PlayStream. + * @param request WriteServerPlayerEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WritePlayerEventAsync(final WriteServerPlayerEventRequest request) { @@ -4438,6 +4744,8 @@ public PlayFabResult call() throws Exception { /** * Writes a player-based event into PlayStream. + * @param request WriteServerPlayerEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WritePlayerEvent(final WriteServerPlayerEventRequest request) { @@ -4484,6 +4792,8 @@ private static PlayFabResult privateWritePlayerEventAsync(fi /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return Async Task will return WriteEventResponse */ @SuppressWarnings("unchecked") public static FutureTask> WriteTitleEventAsync(final WriteTitleEventRequest request) { @@ -4496,6 +4806,8 @@ public PlayFabResult call() throws Exception { /** * Writes a title-based event into PlayStream. + * @param request WriteTitleEventRequest + * @return WriteEventResponse */ @SuppressWarnings("unchecked") public static PlayFabResult WriteTitleEvent(final WriteTitleEventRequest request) { @@ -4542,6 +4854,8 @@ private static PlayFabResult privateWriteTitleEventAsync(fin /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. + * @param request AddSharedGroupMembersRequest + * @return Async Task will return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> AddSharedGroupMembersAsync(final AddSharedGroupMembersRequest request) { @@ -4554,6 +4868,8 @@ public PlayFabResult call() throws Exception { /** * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. + * @param request AddSharedGroupMembersRequest + * @return AddSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddSharedGroupMembers(final AddSharedGroupMembersRequest request) { @@ -4600,6 +4916,8 @@ private static PlayFabResult privateAddSharedGroupM /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. + * @param request CreateSharedGroupRequest + * @return Async Task will return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static FutureTask> CreateSharedGroupAsync(final CreateSharedGroupRequest request) { @@ -4612,6 +4930,8 @@ public PlayFabResult call() throws Exception { /** * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. + * @param request CreateSharedGroupRequest + * @return CreateSharedGroupResult */ @SuppressWarnings("unchecked") public static PlayFabResult CreateSharedGroup(final CreateSharedGroupRequest request) { @@ -4658,6 +4978,8 @@ private static PlayFabResult privateCreateSharedGroupAs /** * Deletes a shared group, freeing up the shared group ID to be reused for a new group + * @param request DeleteSharedGroupRequest + * @return Async Task will return EmptyResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteSharedGroupAsync(final DeleteSharedGroupRequest request) { @@ -4670,6 +4992,8 @@ public PlayFabResult call() throws Exception { /** * Deletes a shared group, freeing up the shared group ID to be reused for a new group + * @param request DeleteSharedGroupRequest + * @return EmptyResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteSharedGroup(final DeleteSharedGroupRequest request) { @@ -4716,6 +5040,8 @@ private static PlayFabResult privateDeleteSharedGroupAsync(final De /** * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. + * @param request GetSharedGroupDataRequest + * @return Async Task will return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetSharedGroupDataAsync(final GetSharedGroupDataRequest request) { @@ -4728,6 +5054,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. + * @param request GetSharedGroupDataRequest + * @return GetSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetSharedGroupData(final GetSharedGroupDataRequest request) { @@ -4774,6 +5102,8 @@ private static PlayFabResult privateGetSharedGroupData /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return Async Task will return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static FutureTask> RemoveSharedGroupMembersAsync(final RemoveSharedGroupMembersRequest request) { @@ -4786,6 +5116,8 @@ public PlayFabResult call() throws Exception { /** * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. + * @param request RemoveSharedGroupMembersRequest + * @return RemoveSharedGroupMembersResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemoveSharedGroupMembers(final RemoveSharedGroupMembersRequest request) { @@ -4832,6 +5164,8 @@ private static PlayFabResult privateRemoveShared /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data. + * @param request UpdateSharedGroupDataRequest + * @return Async Task will return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateSharedGroupDataAsync(final UpdateSharedGroupDataRequest request) { @@ -4844,6 +5178,8 @@ public PlayFabResult call() throws Exception { /** * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group (and the server) can update the data. + * @param request UpdateSharedGroupDataRequest + * @return UpdateSharedGroupDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateSharedGroupData(final UpdateSharedGroupDataRequest request) { @@ -4890,6 +5226,8 @@ private static PlayFabResult privateUpdateSharedGro /** * Executes a CloudScript function, with the 'currentPlayerId' variable set to the specified PlayFabId parameter value. + * @param request ExecuteCloudScriptServerRequest + * @return Async Task will return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static FutureTask> ExecuteCloudScriptAsync(final ExecuteCloudScriptServerRequest request) { @@ -4902,6 +5240,8 @@ public PlayFabResult call() throws Exception { /** * Executes a CloudScript function, with the 'currentPlayerId' variable set to the specified PlayFabId parameter value. + * @param request ExecuteCloudScriptServerRequest + * @return ExecuteCloudScriptResult */ @SuppressWarnings("unchecked") public static PlayFabResult ExecuteCloudScript(final ExecuteCloudScriptServerRequest request) { @@ -4948,6 +5288,8 @@ private static PlayFabResult privateExecuteCloudScript /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return Async Task will return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static FutureTask> GetContentDownloadUrlAsync(final GetContentDownloadUrlRequest request) { @@ -4960,6 +5302,8 @@ public PlayFabResult call() throws Exception { /** * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/en-us/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply. + * @param request GetContentDownloadUrlRequest + * @return GetContentDownloadUrlResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetContentDownloadUrl(final GetContentDownloadUrlRequest request) { @@ -5006,6 +5350,8 @@ private static PlayFabResult privateGetContentDownl /** * Deletes the specific character ID from the specified user. + * @param request DeleteCharacterFromUserRequest + * @return Async Task will return DeleteCharacterFromUserResult */ @SuppressWarnings("unchecked") public static FutureTask> DeleteCharacterFromUserAsync(final DeleteCharacterFromUserRequest request) { @@ -5018,6 +5364,8 @@ public PlayFabResult call() throws Exception { /** * Deletes the specific character ID from the specified user. + * @param request DeleteCharacterFromUserRequest + * @return DeleteCharacterFromUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult DeleteCharacterFromUser(final DeleteCharacterFromUserRequest request) { @@ -5064,6 +5412,8 @@ private static PlayFabResult privateDeleteCharact /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return Async Task will return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllUsersCharactersAsync(final ListUsersCharactersRequest request) { @@ -5076,6 +5426,8 @@ public PlayFabResult call() throws Exception { /** * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request ListUsersCharactersRequest + * @return ListUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllUsersCharacters(final ListUsersCharactersRequest request) { @@ -5122,6 +5474,8 @@ private static PlayFabResult privateGetAllUsersCharac /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return Async Task will return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterLeaderboardAsync(final GetCharacterLeaderboardRequest request) { @@ -5134,6 +5488,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard + * @param request GetCharacterLeaderboardRequest + * @return GetCharacterLeaderboardResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterLeaderboard(final GetCharacterLeaderboardRequest request) { @@ -5180,6 +5536,8 @@ private static PlayFabResult privateGetCharacterL /** * Retrieves the details of all title-specific statistics for the specific character + * @param request GetCharacterStatisticsRequest + * @return Async Task will return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterStatisticsAsync(final GetCharacterStatisticsRequest request) { @@ -5192,6 +5550,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the details of all title-specific statistics for the specific character + * @param request GetCharacterStatisticsRequest + * @return GetCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterStatistics(final GetCharacterStatisticsRequest request) { @@ -5238,6 +5598,8 @@ private static PlayFabResult privateGetCharacterSt /** * Retrieves a list of ranked characters for the given statistic, centered on the requested user + * @param request GetLeaderboardAroundCharacterRequest + * @return Async Task will return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardAroundCharacterAsync(final GetLeaderboardAroundCharacterRequest request) { @@ -5250,6 +5612,8 @@ public PlayFabResult call() throws Exceptio /** * Retrieves a list of ranked characters for the given statistic, centered on the requested user + * @param request GetLeaderboardAroundCharacterRequest + * @return GetLeaderboardAroundCharacterResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardAroundCharacter(final GetLeaderboardAroundCharacterRequest request) { @@ -5296,6 +5660,8 @@ private static PlayFabResult privateGetLead /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return Async Task will return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static FutureTask> GetLeaderboardForUserCharactersAsync(final GetLeaderboardForUsersCharactersRequest request) { @@ -5308,6 +5674,8 @@ public PlayFabResult call() throws Excep /** * Retrieves a list of all of the user's characters for the given statistic. + * @param request GetLeaderboardForUsersCharactersRequest + * @return GetLeaderboardForUsersCharactersResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetLeaderboardForUserCharacters(final GetLeaderboardForUsersCharactersRequest request) { @@ -5354,6 +5722,8 @@ private static PlayFabResult privateGetL /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return Async Task will return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static FutureTask> GrantCharacterToUserAsync(final GrantCharacterToUserRequest request) { @@ -5366,6 +5736,8 @@ public PlayFabResult call() throws Exception { /** * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness. + * @param request GrantCharacterToUserRequest + * @return GrantCharacterToUserResult */ @SuppressWarnings("unchecked") public static PlayFabResult GrantCharacterToUser(final GrantCharacterToUserRequest request) { @@ -5412,6 +5784,8 @@ private static PlayFabResult privateGrantCharacterTo /** * Updates the values of the specified title-specific statistics for the specific character + * @param request UpdateCharacterStatisticsRequest + * @return Async Task will return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterStatisticsAsync(final UpdateCharacterStatisticsRequest request) { @@ -5424,6 +5798,8 @@ public PlayFabResult call() throws Exception { /** * Updates the values of the specified title-specific statistics for the specific character + * @param request UpdateCharacterStatisticsRequest + * @return UpdateCharacterStatisticsResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterStatistics(final UpdateCharacterStatisticsRequest request) { @@ -5470,6 +5846,8 @@ private static PlayFabResult privateUpdateChara /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterDataAsync(final GetCharacterDataRequest request) { @@ -5482,6 +5860,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user which is readable and writable by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterData(final GetCharacterDataRequest request) { @@ -5528,6 +5908,8 @@ private static PlayFabResult privateGetCharacterDataAsyn /** * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterInternalDataAsync(final GetCharacterDataRequest request) { @@ -5540,6 +5922,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterInternalData(final GetCharacterDataRequest request) { @@ -5586,6 +5970,8 @@ private static PlayFabResult privateGetCharacterInternal /** * Retrieves the title-specific custom data for the user's character which can only be read by the client + * @param request GetCharacterDataRequest + * @return Async Task will return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> GetCharacterReadOnlyDataAsync(final GetCharacterDataRequest request) { @@ -5598,6 +5984,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves the title-specific custom data for the user's character which can only be read by the client + * @param request GetCharacterDataRequest + * @return GetCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetCharacterReadOnlyData(final GetCharacterDataRequest request) { @@ -5644,6 +6032,8 @@ private static PlayFabResult privateGetCharacterReadOnly /** * Updates the title-specific custom data for the user's chjaracter which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterDataAsync(final UpdateCharacterDataRequest request) { @@ -5656,6 +6046,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user's chjaracter which is readable and writable by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterData(final UpdateCharacterDataRequest request) { @@ -5702,6 +6094,8 @@ private static PlayFabResult privateUpdateCharacterDa /** * Updates the title-specific custom data for the user's character which cannot be accessed by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterInternalDataAsync(final UpdateCharacterDataRequest request) { @@ -5714,6 +6108,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user's character which cannot be accessed by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterInternalData(final UpdateCharacterDataRequest request) { @@ -5760,6 +6156,8 @@ private static PlayFabResult privateUpdateCharacterIn /** * Updates the title-specific custom data for the user's character which can only be read by the client + * @param request UpdateCharacterDataRequest + * @return Async Task will return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static FutureTask> UpdateCharacterReadOnlyDataAsync(final UpdateCharacterDataRequest request) { @@ -5772,6 +6170,8 @@ public PlayFabResult call() throws Exception { /** * Updates the title-specific custom data for the user's character which can only be read by the client + * @param request UpdateCharacterDataRequest + * @return UpdateCharacterDataResult */ @SuppressWarnings("unchecked") public static PlayFabResult UpdateCharacterReadOnlyData(final UpdateCharacterDataRequest request) { @@ -5818,6 +6218,8 @@ private static PlayFabResult privateUpdateCharacterRe /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return Async Task will return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> AddPlayerTagAsync(final AddPlayerTagRequest request) { @@ -5830,6 +6232,8 @@ public PlayFabResult call() throws Exception { /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request AddPlayerTagRequest + * @return AddPlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult AddPlayerTag(final AddPlayerTagRequest request) { @@ -5876,6 +6280,8 @@ private static PlayFabResult privateAddPlayerTagAsync(final /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return Async Task will return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllActionGroupsAsync(final GetAllActionGroupsRequest request) { @@ -5888,6 +6294,8 @@ public PlayFabResult call() throws Exception { /** * Retrieve a list of all PlayStream actions groups. + * @param request GetAllActionGroupsRequest + * @return GetAllActionGroupsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllActionGroups(final GetAllActionGroupsRequest request) { @@ -5934,6 +6342,8 @@ private static PlayFabResult privateGetAllActionGroups /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return Async Task will return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetAllSegmentsAsync(final GetAllSegmentsRequest request) { @@ -5946,6 +6356,8 @@ public PlayFabResult call() throws Exception { /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * @param request GetAllSegmentsRequest + * @return GetAllSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetAllSegments(final GetAllSegmentsRequest request) { @@ -5992,6 +6404,8 @@ private static PlayFabResult privateGetAllSegmentsAsync(fi /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return Async Task will return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerSegmentsAsync(final GetPlayersSegmentsRequest request) { @@ -6004,6 +6418,8 @@ public PlayFabResult call() throws Exception { /** * List all segments that a player currently belongs to at this moment in time. + * @param request GetPlayersSegmentsRequest + * @return GetPlayerSegmentsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerSegments(final GetPlayersSegmentsRequest request) { @@ -6050,6 +6466,8 @@ private static PlayFabResult privateGetPlayerSegmentsAs /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return Async Task will return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayersInSegmentAsync(final GetPlayersInSegmentRequest request) { @@ -6062,6 +6480,8 @@ public PlayFabResult call() throws Exception { /** * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. + * @param request GetPlayersInSegmentRequest + * @return GetPlayersInSegmentResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayersInSegment(final GetPlayersInSegmentRequest request) { @@ -6108,6 +6528,8 @@ private static PlayFabResult privateGetPlayersInSegme /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return Async Task will return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static FutureTask> GetPlayerTagsAsync(final GetPlayerTagsRequest request) { @@ -6120,6 +6542,8 @@ public PlayFabResult call() throws Exception { /** * Get all tags with a given Namespace (optional) from a player profile. + * @param request GetPlayerTagsRequest + * @return GetPlayerTagsResult */ @SuppressWarnings("unchecked") public static PlayFabResult GetPlayerTags(final GetPlayerTagsRequest request) { @@ -6166,6 +6590,8 @@ private static PlayFabResult privateGetPlayerTagsAsync(fina /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return Async Task will return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static FutureTask> RemovePlayerTagAsync(final RemovePlayerTagRequest request) { @@ -6178,6 +6604,8 @@ public PlayFabResult call() throws Exception { /** * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag. + * @param request RemovePlayerTagRequest + * @return RemovePlayerTagResult */ @SuppressWarnings("unchecked") public static PlayFabResult RemovePlayerTag(final RemovePlayerTagRequest request) { diff --git a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabServerModels.java b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabServerModels.java index e9c849835..fd2fa4376 100644 --- a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabServerModels.java +++ b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabServerModels.java @@ -1030,7 +1030,7 @@ public static class DeleteUsersRequest { */ public ArrayList PlayFabIds; /** - * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. + * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected. */ public String TitleId; @@ -1438,6 +1438,14 @@ public static class GetFriendLeaderboardRequest { * Indicates whether Facebook friends should be included in the response. Default is true. */ public Boolean IncludeFacebookFriends; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; /** * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ @@ -1518,6 +1526,14 @@ public static class GetLeaderboardAroundUserRequest { * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ public PlayerProfileViewConstraints ProfileConstraints; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; } @@ -1578,6 +1594,14 @@ public static class GetLeaderboardRequest { * If non-null, this determines which properties of the profile to return. If null, playfab will only include display names. On client, only ShowDisplayName, ShowStatistics, ShowAvatarUrl are allowed. */ public PlayerProfileViewConstraints ProfileConstraints; + /** + * The version of the leaderboard to get, when UseSpecificVersion is true. + */ + public Integer Version; + /** + * If true, uses the specified version. If false, gets the most recent version. + */ + public Boolean UseSpecificVersion; } @@ -1884,7 +1908,7 @@ public static class GetPlayFabIDsFromSteamIDsResult { public static class GetPublisherDataRequest { /** - * array of keys to get back data from the Publisher data blob, set by the admin tools + * array of keys to get back data from the Publisher data blob, set by the admin tools */ public ArrayList Keys; diff --git a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabSettings.java b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabSettings.java index fdf9552c2..9703f150f 100644 --- a/PlayFabServerSDK/src/main/java/com/playfab/PlayFabSettings.java +++ b/PlayFabServerSDK/src/main/java/com/playfab/PlayFabSettings.java @@ -3,9 +3,9 @@ import com.playfab.PlayFabErrors.ErrorCallback; public class PlayFabSettings { - public static String SdkVersion = "0.46.170313"; - public static String BuildIdentifier = "javasdk_manual"; - public static String SdkVersionString = "JavaSDK-0.46.170313"; + public static String SdkVersion = "0.47.170403"; + public static String BuildIdentifier = "jbuild_javasdk_1"; + public static String SdkVersionString = "JavaSDK-0.47.170403"; public static String TitleId = null; // You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) public static ErrorCallback GlobalErrorHandler;