Skip to content

Commit 63d1e16

Browse files
PlayFabJenkinsBotPlayFabJenkinsBot
committed
https://api.playfab.com/releaseNotes/#170807
2 parents 73ffa4f + 3cdf844 commit 63d1e16

17 files changed

+207
-29
lines changed

‎.arcconfig‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"phabricator.uri" : "https://phab.playfabdev.com/"
2+
"phabricator.uri" : "https://phabricator.playfab.com/"
33
}

‎PlayFabSdk/src/PlayFab/PlayFabAdminApi.js‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
102102
}
103103
}
104104

105-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
106-
PlayFab.sdkVersion = "1.8.170710";
105+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
106+
PlayFab.sdkVersion = "1.9.170807";
107107

108108
PlayFab.AdminApi = {
109109

@@ -155,6 +155,12 @@ PlayFab.AdminApi = {
155155
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/BanUsers", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
156156
},
157157

158+
DeletePlayer: function (request, callback) {
159+
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
160+
161+
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/DeletePlayer", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
162+
},
163+
158164
GetUserAccountInfo: function (request, callback) {
159165
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
160166

@@ -167,6 +173,9 @@ PlayFab.AdminApi = {
167173
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/GetUserBans", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
168174
},
169175

176+
/**
177+
* @deprecated Please use DeletePlayer instead.
178+
*/
170179
ResetUsers: function (request, callback) {
171180
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
172181

@@ -209,6 +218,9 @@ PlayFab.AdminApi = {
209218
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/CreatePlayerStatisticDefinition", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
210219
},
211220

221+
/**
222+
* @deprecated Please use DeleteUser instead.
223+
*/
212224
DeleteUsers: function (request, callback) {
213225
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
214226

‎PlayFabSdk/src/PlayFab/PlayFabClientApi.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
102102
}
103103
}
104104

105-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
106-
PlayFab.sdkVersion = "1.8.170710";
105+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
106+
PlayFab.sdkVersion = "1.9.170807";
107107

108108
PlayFab.ClientApi = {
109109

‎PlayFabSdk/src/PlayFab/PlayFabMatchmakerApi.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
102102
}
103103
}
104104

105-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
106-
PlayFab.sdkVersion = "1.8.170710";
105+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
106+
PlayFab.sdkVersion = "1.9.170807";
107107

108108
PlayFab.MatchmakerApi = {
109109

‎PlayFabSdk/src/PlayFab/PlayFabServerApi.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
102102
}
103103
}
104104

105-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
106-
PlayFab.sdkVersion = "1.8.170710";
105+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
106+
PlayFab.sdkVersion = "1.9.170807";
107107

108108
PlayFab.ServerApi = {
109109

‎PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ declare module PlayFabAdminModule {
4242
/ https://api.playfab.com/Documentation/Admin/method/BanUsers
4343
*/
4444
BanUsers(request: PlayFabAdminModels.BanUsersRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.BanUsersResult>): void;
45+
/**
46+
/ Removes a user's player account from a title and deletes all associated data
47+
/ https://api.playfab.com/Documentation/Admin/method/DeletePlayer
48+
*/
49+
DeletePlayer(request: PlayFabAdminModels.DeletePlayerRequest, callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeletePlayerResult>): void;
4550
/**
4651
/ Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
4752
/ https://api.playfab.com/Documentation/Admin/method/GetUserAccountInfo
@@ -1098,6 +1103,25 @@ declare module PlayFabAdminModels {
10981103
| "True"
10991104
| "False";
11001105

1106+
/**
1107+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.ContactEmailInfo
1108+
*/
1109+
export interface ContactEmailInfo {
1110+
/**
1111+
/ The name of the email info data
1112+
*/
1113+
Name?: string;
1114+
/**
1115+
/ The email address
1116+
*/
1117+
EmailAddress?: string;
1118+
/**
1119+
/ The verification status of the email
1120+
*/
1121+
VerificationStatus?: string;
1122+
1123+
}
1124+
11011125
/**
11021126
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.ContentInfo
11031127
*/
@@ -1666,6 +1690,24 @@ declare module PlayFabAdminModels {
16661690

16671691
}
16681692

1693+
/**
1694+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.DeletePlayerRequest
1695+
*/
1696+
export interface DeletePlayerRequest extends PlayFabModule.IPlayFabRequestCommon {
1697+
/**
1698+
/ Unique PlayFab assigned ID of the user on whom the operation will be performed.
1699+
*/
1700+
PlayFabId: string;
1701+
1702+
}
1703+
1704+
/**
1705+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.DeletePlayerResult
1706+
*/
1707+
export interface DeletePlayerResult extends PlayFabModule.IPlayFabResultCommon {
1708+
1709+
}
1710+
16691711
/**
16701712
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.DeletePlayerSharedSecretRequest
16711713
*/
@@ -1742,6 +1784,10 @@ declare module PlayFabAdminModels {
17421784
type EffectType = "Allow"
17431785
| "Deny";
17441786

1787+
type EmailVerificationStatus = "Unverified"
1788+
| "Pending"
1789+
| "Confirmed";
1790+
17451791
/**
17461792
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Admin.Models/PlayFab.Admin.Models.EmptyResult
17471793
*/
@@ -3329,6 +3375,10 @@ declare module PlayFabAdminModels {
33293375
/ Array of player statistics
33303376
*/
33313377
PlayerStatistics?: PlayerStatistic[];
3378+
/**
3379+
/ Array of contact email addresses associated with the player
3380+
*/
3381+
ContactEmailAddresses?: ContactEmailInfo[];
33323382

33333383
}
33343384

‎PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ declare module PlayFabClientModule {
470470
*/
471471
GetGameServerRegions(request: PlayFabClientModels.GameServerRegionsRequest, callback: PlayFabModule.ApiCallback<PlayFabClientModels.GameServerRegionsResult>): void;
472472
/**
473-
/ 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.
473+
/ 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.
474474
/ https://api.playfab.com/Documentation/Client/method/Matchmake
475475
*/
476476
Matchmake(request: PlayFabClientModels.MatchmakeRequest, callback: PlayFabModule.ApiCallback<PlayFabClientModels.MatchmakeResult>): void;

‎PlayFabSdk/src/Typings/PlayFab/PlayFabMatchmakerApi.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,11 @@ declare module PlayFabMatchmakerModels {
148148
*/
149149
export interface PlayerJoinedRequest extends PlayFabModule.IPlayFabRequestCommon {
150150
/**
151-
/ Unique identifier of the Game Server Instance the user is joining.
151+
/ Unique identifier of the Game Server Instance the user is joining. This must be a Game Server Instance started with the Matchmaker/StartGame API.
152152
*/
153153
LobbyId: string;
154154
/**
155-
/ PlayFab unique identifier for the user joining.
155+
/ PlayFab unique identifier for the player joining.
156156
*/
157157
PlayFabId: string;
158158

@@ -170,11 +170,11 @@ declare module PlayFabMatchmakerModels {
170170
*/
171171
export interface PlayerLeftRequest extends PlayFabModule.IPlayFabRequestCommon {
172172
/**
173-
/ Unique identifier of the Game Server Instance the user is leaving.
173+
/ Unique identifier of the Game Server Instance the user is leaving. This must be a Game Server Instance started with the Matchmaker/StartGame API.
174174
*/
175175
LobbyId: string;
176176
/**
177-
/ PlayFab unique identifier for the user leaving.
177+
/ PlayFab unique identifier for the player leaving.
178178
*/
179179
PlayFabId: string;
180180

‎PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ declare module PlayFabServerModule {
493493
*/
494494
GetCharacterReadOnlyData(request: PlayFabServerModels.GetCharacterDataRequest, callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetCharacterDataResult>): void;
495495
/**
496-
/ Updates the title-specific custom data for the user's chjaracter which is readable and writable by the client
496+
/ Updates the title-specific custom data for the user's character which is readable and writable by the client
497497
/ https://api.playfab.com/Documentation/Server/method/UpdateCharacterData
498498
*/
499499
UpdateCharacterData(request: PlayFabServerModels.UpdateCharacterDataRequest, callback: PlayFabModule.ApiCallback<PlayFabServerModels.UpdateCharacterDataResult>): void;
@@ -1160,6 +1160,25 @@ declare module PlayFabServerModels {
11601160

11611161
}
11621162

1163+
/**
1164+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Server.Models/PlayFab.Server.Models.ContactEmailInfo
1165+
*/
1166+
export interface ContactEmailInfo {
1167+
/**
1168+
/ The name of the email info data
1169+
*/
1170+
Name?: string;
1171+
/**
1172+
/ The email address
1173+
*/
1174+
EmailAddress?: string;
1175+
/**
1176+
/ The verification status of the email
1177+
*/
1178+
VerificationStatus?: string;
1179+
1180+
}
1181+
11631182
type ContinentCode = "AF"
11641183
| "AN"
11651184
| "AS"
@@ -1680,6 +1699,10 @@ declare module PlayFabServerModels {
16801699

16811700
}
16821701

1702+
type EmailVerificationStatus = "Unverified"
1703+
| "Pending"
1704+
| "Confirmed";
1705+
16831706
/**
16841707
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Server.Models/PlayFab.Server.Models.EmptyResult
16851708
*/
@@ -3760,6 +3783,10 @@ declare module PlayFabServerModels {
37603783
/ Array of player statistics
37613784
*/
37623785
PlayerStatistics?: PlayerStatistic[];
3786+
/**
3787+
/ Array of contact email addresses associated with the player
3788+
*/
3789+
ContactEmailAddresses?: ContactEmailInfo[];
37633790

37643791
}
37653792

‎PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ if(!PlayFab._internalSettings) {
102102
}
103103
}
104104

105-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_2";
106-
PlayFab.sdkVersion = "1.8.170710";
105+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
106+
PlayFab.sdkVersion = "1.9.170807";
107107

108108
PlayFab.AdminApi = {
109109

@@ -155,6 +155,12 @@ PlayFab.AdminApi = {
155155
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/BanUsers", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
156156
},
157157

158+
DeletePlayer: function (request, callback) {
159+
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
160+
161+
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/DeletePlayer", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
162+
},
163+
158164
GetUserAccountInfo: function (request, callback) {
159165
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
160166

@@ -167,6 +173,9 @@ PlayFab.AdminApi = {
167173
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/GetUserBans", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
168174
},
169175

176+
/**
177+
* @deprecated Please use DeletePlayer instead.
178+
*/
170179
ResetUsers: function (request, callback) {
171180
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
172181

@@ -209,6 +218,9 @@ PlayFab.AdminApi = {
209218
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Admin/CreatePlayerStatisticDefinition", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
210219
},
211220

221+
/**
222+
* @deprecated Please use DeleteUser instead.
223+
*/
212224
DeleteUsers: function (request, callback) {
213225
if (!PlayFab.settings.developerSecretKey) throw PlayFab._internalSettings.errorSecretKey;
214226

0 commit comments

Comments
 (0)