Skip to content

Commit 724cb77

Browse files
PlayFabJenkinsBotPlayFabJenkinsBot
committed
https://api.playfab.com/releaseNotes/#170530
2 parents 873319e + 5e037f8 commit 724cb77

15 files changed

+249
-70
lines changed

‎PlayFabSdk/src/PlayFab/PlayFabAdminApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ if(!PlayFab._internalSettings) {
9999
}
100100
}
101101

102-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
103-
PlayFab.sdkVersion = "1.5.170508";
102+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
103+
PlayFab.sdkVersion = "1.6.170530";
104104

105105
PlayFab.AdminApi = {
106106

‎PlayFabSdk/src/PlayFab/PlayFabClientApi.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ if(!PlayFab._internalSettings) {
9999
}
100100
}
101101

102-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
103-
PlayFab.sdkVersion = "1.5.170508";
102+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
103+
PlayFab.sdkVersion = "1.6.170530";
104104

105105
PlayFab.ClientApi = {
106106

@@ -339,6 +339,12 @@ PlayFab.ClientApi = {
339339
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Client/GetPlayerCombinedInfo", request, "X-Authorization", PlayFab._internalSettings.sessionTicket, callback);
340340
},
341341

342+
GetPlayerProfile: function (request, callback) {
343+
if (PlayFab._internalSettings.sessionTicket == null) throw "Must be logged in to call this method";
344+
345+
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Client/GetPlayerProfile", request, "X-Authorization", PlayFab._internalSettings.sessionTicket, callback);
346+
},
347+
342348
GetPlayFabIDsFromFacebookIDs: function (request, callback) {
343349
if (PlayFab._internalSettings.sessionTicket == null) throw "Must be logged in to call this method";
344350

‎PlayFabSdk/src/PlayFab/PlayFabMatchmakerApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ if(!PlayFab._internalSettings) {
9999
}
100100
}
101101

102-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
103-
PlayFab.sdkVersion = "1.5.170508";
102+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
103+
PlayFab.sdkVersion = "1.6.170530";
104104

105105
PlayFab.MatchmakerApi = {
106106

‎PlayFabSdk/src/PlayFab/PlayFabServerApi.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ if(!PlayFab._internalSettings) {
9999
}
100100
}
101101

102-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
103-
PlayFab.sdkVersion = "1.5.170508";
102+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
103+
PlayFab.sdkVersion = "1.6.170530";
104104

105105
PlayFab.ServerApi = {
106106

@@ -116,6 +116,12 @@ PlayFab.ServerApi = {
116116
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Server/BanUsers", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
117117
},
118118

119+
GetPlayerProfile: function (request, callback) {
120+
if (PlayFab.settings.developerSecretKey == null) throw "Must have PlayFab.settings.developerSecretKey set to call this method";
121+
122+
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Server/GetPlayerProfile", request, "X-SecretKey", PlayFab.settings.developerSecretKey, callback);
123+
},
124+
119125
GetPlayFabIDsFromFacebookIDs: function (request, callback) {
120126
if (PlayFab.settings.developerSecretKey == null) throw "Must have PlayFab.settings.developerSecretKey set to call this method";
121127

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1701,15 +1701,15 @@ declare module PlayFabAdminModels {
17011701
*/
17021702
FunctionResult?: any;
17031703
/**
1704-
/ Flag indicating if the FunctionResult was too large and was subsequently dropped from this event
1704+
/ Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if the total event size is larger than 350KB.
17051705
*/
17061706
FunctionResultTooLarge?: boolean;
17071707
/**
17081708
/ Entries logged during the function execution. These include both entries logged in the function code using log.info() and log.error() and error entries for API and HTTP request failures.
17091709
*/
17101710
Logs?: LogStatement[];
17111711
/**
1712-
/ Flag indicating if the logs were too large and were subsequently dropped from this event
1712+
/ Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total event size is larger than 350KB after the FunctionResult was removed.
17131713
*/
17141714
LogsTooLarge?: boolean;
17151715
ExecutionTimeSeconds: number;
@@ -3689,7 +3689,7 @@ declare module PlayFabAdminModels {
36893689
/**
36903690
/ Name of the task. This is a unique identifier for tasks in the title.
36913691
*/
3692-
Name?: string;
3692+
Name: string;
36933693
/**
36943694
/ Description the task
36953695
*/

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

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ declare module PlayFabClientModule {
104104
/ https://api.playfab.com/Documentation/Client/method/GetPlayerCombinedInfo
105105
*/
106106
GetPlayerCombinedInfo(request: PlayFabClientModels.GetPlayerCombinedInfoRequest, callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerCombinedInfoResult>): void;
107+
/**
108+
/ Retrieves the player's profile
109+
/ https://api.playfab.com/Documentation/Client/method/GetPlayerProfile
110+
*/
111+
GetPlayerProfile(request: PlayFabClientModels.GetPlayerProfileRequest, callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerProfileResult>): void;
107112
/**
108113
/ Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
109114
/ https://api.playfab.com/Documentation/Client/method/GetPlayFabIDsFromFacebookIDs
@@ -1764,15 +1769,15 @@ declare module PlayFabClientModels {
17641769
*/
17651770
FunctionResult?: any;
17661771
/**
1767-
/ Flag indicating if the FunctionResult was too large and was subsequently dropped from this event
1772+
/ Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if the total event size is larger than 350KB.
17681773
*/
17691774
FunctionResultTooLarge?: boolean;
17701775
/**
17711776
/ Entries logged during the function execution. These include both entries logged in the function code using log.info() and log.error() and error entries for API and HTTP request failures.
17721777
*/
17731778
Logs?: LogStatement[];
17741779
/**
1775-
/ Flag indicating if the logs were too large and were subsequently dropped from this event
1780+
/ Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total event size is larger than 350KB after the FunctionResult was removed.
17761781
*/
17771782
LogsTooLarge?: boolean;
17781783
ExecutionTimeSeconds: number;
@@ -2585,6 +2590,14 @@ declare module PlayFabClientModels {
25852590
/ Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false
25862591
*/
25872592
PlayerStatisticNames?: string[];
2593+
/**
2594+
/ Whether to get player profile. Defaults to false.
2595+
*/
2596+
GetPlayerProfile: boolean;
2597+
/**
2598+
/ Specifies the properties to return from the player profile. Defaults to returning the player's display name.
2599+
*/
2600+
ProfileConstraints?: number;
25882601

25892602
}
25902603

@@ -2655,6 +2668,36 @@ declare module PlayFabClientModels {
26552668
/ List of statistics for this player.
26562669
*/
26572670
PlayerStatistics?: StatisticValue[];
2671+
/**
2672+
/ The profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not exist.
2673+
*/
2674+
PlayerProfile?: PlayerProfileModel;
2675+
2676+
}
2677+
2678+
/**
2679+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayerProfileRequest
2680+
*/
2681+
export interface GetPlayerProfileRequest extends PlayFabModule.IPlayFabRequestCommon {
2682+
/**
2683+
/ Unique PlayFab assigned ID of the user on whom the operation will be performed.
2684+
*/
2685+
PlayFabId: string;
2686+
/**
2687+
/ 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.
2688+
*/
2689+
ProfileConstraints?: number;
2690+
2691+
}
2692+
2693+
/**
2694+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Client.Models/PlayFab.Client.Models.GetPlayerProfileResult
2695+
*/
2696+
export interface GetPlayerProfileResult extends PlayFabModule.IPlayFabResultCommon {
2697+
/**
2698+
/ The profile of the player. This profile is not guaranteed to be up-to-date. For a new player, this profile will not exist.
2699+
*/
2700+
PlayerProfile?: PlayerProfileModel;
26582701

26592702
}
26602703

@@ -2991,10 +3034,6 @@ declare module PlayFabClientModels {
29913034
/ Date and time of the purchase.
29923035
*/
29933036
PurchaseDate: string;
2994-
/**
2995-
/ Array of items purchased.
2996-
*/
2997-
Items?: ItemInstance[];
29983037

29993038
}
30003039

@@ -4936,9 +4975,9 @@ declare module PlayFabClientModels {
49364975
*/
49374976
export interface ReportPlayerClientResult extends PlayFabModule.IPlayFabResultCommon {
49384977
/**
4939-
/ Indicates whether this action completed successfully.
4978+
/ Deprecated: Always true
49404979
*/
4941-
Updated: boolean;
4980+
Updated?: boolean;
49424981
/**
49434982
/ The number of remaining reports which may be filed today.
49444983
*/

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

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ declare module PlayFabServerModule {
1212
/ https://api.playfab.com/Documentation/Server/method/BanUsers
1313
*/
1414
BanUsers(request: PlayFabServerModels.BanUsersRequest, callback: PlayFabModule.ApiCallback<PlayFabServerModels.BanUsersResult>): void;
15+
/**
16+
/ Retrieves the player's profile
17+
/ https://api.playfab.com/Documentation/Server/method/GetPlayerProfile
18+
*/
19+
GetPlayerProfile(request: PlayFabServerModels.GetPlayerProfileRequest, callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerProfileResult>): void;
1520
/**
1621
/ Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
1722
/ https://api.playfab.com/Documentation/Server/method/GetPlayFabIDsFromFacebookIDs
@@ -1720,15 +1725,15 @@ declare module PlayFabServerModels {
17201725
*/
17211726
FunctionResult?: any;
17221727
/**
1723-
/ Flag indicating if the FunctionResult was too large and was subsequently dropped from this event
1728+
/ Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if the total event size is larger than 350KB.
17241729
*/
17251730
FunctionResultTooLarge?: boolean;
17261731
/**
17271732
/ Entries logged during the function execution. These include both entries logged in the function code using log.info() and log.error() and error entries for API and HTTP request failures.
17281733
*/
17291734
Logs?: LogStatement[];
17301735
/**
1731-
/ Flag indicating if the logs were too large and were subsequently dropped from this event
1736+
/ Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total event size is larger than 350KB after the FunctionResult was removed.
17321737
*/
17331738
LogsTooLarge?: boolean;
17341739
ExecutionTimeSeconds: number;
@@ -2419,6 +2424,14 @@ declare module PlayFabServerModels {
24192424
/ Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false
24202425
*/
24212426
PlayerStatisticNames?: string[];
2427+
/**
2428+
/ Whether to get player profile. Defaults to false.
2429+
*/
2430+
GetPlayerProfile: boolean;
2431+
/**
2432+
/ Specifies the properties to return from the player profile. Defaults to returning the player's display name.
2433+
*/
2434+
ProfileConstraints?: number;
24222435

24232436
}
24242437

@@ -2489,6 +2502,36 @@ declare module PlayFabServerModels {
24892502
/ List of statistics for this player.
24902503
*/
24912504
PlayerStatistics?: StatisticValue[];
2505+
/**
2506+
/ The profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not exist.
2507+
*/
2508+
PlayerProfile?: PlayerProfileModel;
2509+
2510+
}
2511+
2512+
/**
2513+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayerProfileRequest
2514+
*/
2515+
export interface GetPlayerProfileRequest extends PlayFabModule.IPlayFabRequestCommon {
2516+
/**
2517+
/ Unique PlayFab assigned ID of the user on whom the operation will be performed.
2518+
*/
2519+
PlayFabId: string;
2520+
/**
2521+
/ 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.
2522+
*/
2523+
ProfileConstraints?: number;
2524+
2525+
}
2526+
2527+
/**
2528+
/ https://api.playfab.com/Documentation/Client/datatype/PlayFab.Server.Models/PlayFab.Server.Models.GetPlayerProfileResult
2529+
*/
2530+
export interface GetPlayerProfileResult extends PlayFabModule.IPlayFabResultCommon {
2531+
/**
2532+
/ The profile of the player. This profile is not guaranteed to be up-to-date. For a new player, this profile will not exist.
2533+
*/
2534+
PlayerProfile?: PlayerProfileModel;
24922535

24932536
}
24942537

@@ -4179,13 +4222,9 @@ declare module PlayFabServerModels {
41794222
*/
41804223
ReporterId: string;
41814224
/**
4182-
/ PlayFabId of the reported player.
4225+
/ Unique PlayFab identifier of the reported player.
41834226
*/
41844227
ReporteeId: string;
4185-
/**
4186-
/ Title player was reported in, optional if report not for specific title.
4187-
*/
4188-
TitleId?: string;
41894228
/**
41904229
/ Optional additional comment by reporting player.
41914230
*/
@@ -4198,9 +4237,9 @@ declare module PlayFabServerModels {
41984237
*/
41994238
export interface ReportPlayerServerResult extends PlayFabModule.IPlayFabResultCommon {
42004239
/**
4201-
/ Indicates whether this action completed successfully.
4240+
/ Deprecated: Always true
42024241
*/
4203-
Updated: boolean;
4242+
Updated?: boolean;
42044243
/**
42054244
/ The number of remaining reports which may be filed today by this reporting player.
42064245
*/

‎PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ if(!PlayFab._internalSettings) {
9999
}
100100
}
101101

102-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
103-
PlayFab.sdkVersion = "1.5.170508";
102+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
103+
PlayFab.sdkVersion = "1.6.170530";
104104

105105
PlayFab.AdminApi = {
106106

‎PlayFabTestingExample/src/PlayFab/PlayFabClientApi.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ if(!PlayFab._internalSettings) {
9999
}
100100
}
101101

102-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
103-
PlayFab.sdkVersion = "1.5.170508";
102+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
103+
PlayFab.sdkVersion = "1.6.170530";
104104

105105
PlayFab.ClientApi = {
106106

@@ -339,6 +339,12 @@ PlayFab.ClientApi = {
339339
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Client/GetPlayerCombinedInfo", request, "X-Authorization", PlayFab._internalSettings.sessionTicket, callback);
340340
},
341341

342+
GetPlayerProfile: function (request, callback) {
343+
if (PlayFab._internalSettings.sessionTicket == null) throw "Must be logged in to call this method";
344+
345+
PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + "/Client/GetPlayerProfile", request, "X-Authorization", PlayFab._internalSettings.sessionTicket, callback);
346+
},
347+
342348
GetPlayFabIDsFromFacebookIDs: function (request, callback) {
343349
if (PlayFab._internalSettings.sessionTicket == null) throw "Must be logged in to call this method";
344350

‎PlayFabTestingExample/src/PlayFab/PlayFabMatchmakerApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ if(!PlayFab._internalSettings) {
9999
}
100100
}
101101

102-
PlayFab.buildIdentifier = "jbuild_javascriptsdk_0";
103-
PlayFab.sdkVersion = "1.5.170508";
102+
PlayFab.buildIdentifier = "jbuild_javascriptsdk_1";
103+
PlayFab.sdkVersion = "1.6.170530";
104104

105105
PlayFab.MatchmakerApi = {
106106

0 commit comments

Comments
 (0)