Skip to content

Commit ec4f10f

Browse files
PlayFab SDK TeamPlayFab SDK Team
PlayFab SDK Team
authored and
PlayFab SDK Team
committed
https://docs.microsoft.com/en-us/gaming/playfab/release-notes/#240913
2 parents 1baed83 + 895ce1d commit ec4f10f

27 files changed

+235
-171
lines changed

PlayFabSDK/source/PlayFabAdminModels.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -4621,7 +4621,8 @@ public enum LoginIdentityProvider
46214621
Apple,
46224622
NintendoSwitchAccount,
46234623
GooglePlayGames,
4624-
XboxMobileStore
4624+
XboxMobileStore,
4625+
King
46254626
}
46264627

46274628
public class LogStatement
@@ -8161,7 +8162,8 @@ public enum UserOrigination
81618162
Apple,
81628163
NintendoSwitchAccount,
81638164
GooglePlayGames,
8164-
XboxMobileStore
8165+
XboxMobileStore,
8166+
King
81658167
}
81668168

81678169
public class UserOriginationSegmentFilter

PlayFabSDK/source/PlayFabAuthenticationModels.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,8 @@ public enum LoginIdentityProvider
206206
Apple,
207207
NintendoSwitchAccount,
208208
GooglePlayGames,
209-
XboxMobileStore
209+
XboxMobileStore,
210+
King
210211
}
211212

212213
/// <summary>

PlayFabSDK/source/PlayFabClientModels.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -4141,7 +4141,8 @@ public enum LoginIdentityProvider
41414141
Apple,
41424142
NintendoSwitchAccount,
41434143
GooglePlayGames,
4144-
XboxMobileStore
4144+
XboxMobileStore,
4145+
King
41454146
}
41464147

41474148
public class LoginResult : PlayFabLoginResultCommon
@@ -7727,7 +7728,8 @@ public enum UserOrigination
77277728
Apple,
77287729
NintendoSwitchAccount,
77297730
GooglePlayGames,
7730-
XboxMobileStore
7731+
XboxMobileStore,
7732+
King
77317733
}
77327734

77337735
public class UserPrivateAccountInfo

PlayFabSDK/source/PlayFabCloudScriptModels.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -748,7 +748,8 @@ public enum LoginIdentityProvider
748748
Apple,
749749
NintendoSwitchAccount,
750750
GooglePlayGames,
751-
XboxMobileStore
751+
XboxMobileStore,
752+
King
752753
}
753754

754755
public class LogStatement

PlayFabSDK/source/PlayFabProfilesAPI.cs

+27
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,33 @@ public static async Task<PlayFabResult<GetTitlePlayersFromProviderIDsResponse>>
170170
return new PlayFabResult<GetTitlePlayersFromProviderIDsResponse> { Result = result, CustomData = customData };
171171
}
172172

173+
/// <summary>
174+
/// Update the display name of the entity
175+
/// </summary>
176+
public static async Task<PlayFabResult<SetDisplayNameResponse>> SetDisplayNameAsync(SetDisplayNameRequest request, object customData = null, Dictionary<string, string> extraHeaders = null)
177+
{
178+
await new PlayFabUtil.SynchronizationContextRemover();
179+
180+
var requestContext = request?.AuthenticationContext ?? PlayFabSettings.staticPlayer;
181+
var requestSettings = PlayFabSettings.staticSettings;
182+
if (requestContext.EntityToken == null) throw new PlayFabException(PlayFabExceptionCode.EntityTokenNotSet, "Must call Client Login or GetEntityToken before calling this method");
183+
184+
185+
var httpResult = await PlayFabHttp.DoPost("/Profile/SetDisplayName", request, "X-EntityToken", requestContext.EntityToken, extraHeaders);
186+
if (httpResult is PlayFabError)
187+
{
188+
var error = (PlayFabError)httpResult;
189+
PlayFabSettings.GlobalErrorHandler?.Invoke(error);
190+
return new PlayFabResult<SetDisplayNameResponse> { Error = error, CustomData = customData };
191+
}
192+
193+
var resultRawJson = (string)httpResult;
194+
var resultData = PluginManager.GetPlugin<ISerializerPlugin>(PluginContract.PlayFab_Serializer).DeserializeObject<PlayFabJsonSuccess<SetDisplayNameResponse>>(resultRawJson);
195+
var result = resultData.data;
196+
197+
return new PlayFabResult<SetDisplayNameResponse> { Result = result, CustomData = customData };
198+
}
199+
173200
/// <summary>
174201
/// Sets the global title access policy
175202
/// </summary>

PlayFabSDK/source/PlayFabProfilesInstanceAPI.cs

+26
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,32 @@ public async Task<PlayFabResult<GetTitlePlayersFromProviderIDsResponse>> GetTitl
183183
return new PlayFabResult<GetTitlePlayersFromProviderIDsResponse> { Result = result, CustomData = customData };
184184
}
185185

186+
/// <summary>
187+
/// Update the display name of the entity
188+
/// </summary>
189+
public async Task<PlayFabResult<SetDisplayNameResponse>> SetDisplayNameAsync(SetDisplayNameRequest request, object customData = null, Dictionary<string, string> extraHeaders = null)
190+
{
191+
await new PlayFabUtil.SynchronizationContextRemover();
192+
193+
var requestContext = request?.AuthenticationContext ?? authenticationContext;
194+
var requestSettings = apiSettings ?? PlayFabSettings.staticSettings;
195+
if (requestContext.EntityToken == null) throw new PlayFabException(PlayFabExceptionCode.EntityTokenNotSet, "Must call Client Login or GetEntityToken before calling this method");
196+
197+
var httpResult = await PlayFabHttp.DoPost("/Profile/SetDisplayName", request, "X-EntityToken", requestContext.EntityToken, extraHeaders, requestSettings);
198+
if (httpResult is PlayFabError)
199+
{
200+
var error = (PlayFabError)httpResult;
201+
PlayFabSettings.GlobalErrorHandler?.Invoke(error);
202+
return new PlayFabResult<SetDisplayNameResponse> { Error = error, CustomData = customData };
203+
}
204+
205+
var resultRawJson = (string)httpResult;
206+
var resultData = PluginManager.GetPlugin<ISerializerPlugin>(PluginContract.PlayFab_Serializer).DeserializeObject<PlayFabJsonSuccess<SetDisplayNameResponse>>(resultRawJson);
207+
var result = resultData.data;
208+
209+
return new PlayFabResult<SetDisplayNameResponse> { Result = result, CustomData = customData };
210+
}
211+
186212
/// <summary>
187213
/// Sets the global title access policy
188214
/// </summary>

PlayFabSDK/source/PlayFabProfilesModels.cs

+42
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,48 @@ public enum OperationTypes
417417
None
418418
}
419419

420+
/// <summary>
421+
/// Given an entity profile, will update its display name to the one passed in if the profile's version is equal to the
422+
/// specified value
423+
/// </summary>
424+
public class SetDisplayNameRequest : PlayFabRequestCommon
425+
{
426+
/// <summary>
427+
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
428+
/// </summary>
429+
public Dictionary<string,string> CustomTags ;
430+
431+
/// <summary>
432+
/// The new value to be set on Entity Profile's display name
433+
/// </summary>
434+
public string DisplayName ;
435+
436+
/// <summary>
437+
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
438+
/// </summary>
439+
public EntityKey Entity ;
440+
441+
/// <summary>
442+
/// The expected version of a profile to perform this update on
443+
/// </summary>
444+
public int? ExpectedVersion ;
445+
446+
}
447+
448+
public class SetDisplayNameResponse : PlayFabResultCommon
449+
{
450+
/// <summary>
451+
/// The type of operation that occured on the profile's display name
452+
/// </summary>
453+
public OperationTypes? OperationResult ;
454+
455+
/// <summary>
456+
/// The updated version of the profile after the display name update
457+
/// </summary>
458+
public int? VersionNumber ;
459+
460+
}
461+
420462
/// <summary>
421463
/// This will set the access policy statements on the given entity profile. This is not additive, any existing statements
422464
/// will be replaced with the statements in this request.

PlayFabSDK/source/PlayFabProgressionAPI.cs

-27
Original file line numberDiff line numberDiff line change
@@ -358,33 +358,6 @@ public static async Task<PlayFabResult<GetStatisticDefinitionResponse>> GetStati
358358
return new PlayFabResult<GetStatisticDefinitionResponse> { Result = result, CustomData = customData };
359359
}
360360

361-
/// <summary>
362-
/// Get all current statistic definitions information
363-
/// </summary>
364-
public static async Task<PlayFabResult<GetStatisticDefinitionsResponse>> GetStatisticDefinitionsAsync(GetStatisticDefinitionsRequest request, object customData = null, Dictionary<string, string> extraHeaders = null)
365-
{
366-
await new PlayFabUtil.SynchronizationContextRemover();
367-
368-
var requestContext = request?.AuthenticationContext ?? PlayFabSettings.staticPlayer;
369-
var requestSettings = PlayFabSettings.staticSettings;
370-
if (requestContext.EntityToken == null) throw new PlayFabException(PlayFabExceptionCode.EntityTokenNotSet, "Must call Client Login or GetEntityToken before calling this method");
371-
372-
373-
var httpResult = await PlayFabHttp.DoPost("/Statistic/GetStatisticDefinitions", request, "X-EntityToken", requestContext.EntityToken, extraHeaders);
374-
if (httpResult is PlayFabError)
375-
{
376-
var error = (PlayFabError)httpResult;
377-
PlayFabSettings.GlobalErrorHandler?.Invoke(error);
378-
return new PlayFabResult<GetStatisticDefinitionsResponse> { Error = error, CustomData = customData };
379-
}
380-
381-
var resultRawJson = (string)httpResult;
382-
var resultData = PluginManager.GetPlugin<ISerializerPlugin>(PluginContract.PlayFab_Serializer).DeserializeObject<PlayFabJsonSuccess<GetStatisticDefinitionsResponse>>(resultRawJson);
383-
var result = resultData.data;
384-
385-
return new PlayFabResult<GetStatisticDefinitionsResponse> { Result = result, CustomData = customData };
386-
}
387-
388361
/// <summary>
389362
/// Gets statistics for the specified entity.
390363
/// </summary>

PlayFabSDK/source/PlayFabProgressionInstanceAPI.cs

-26
Original file line numberDiff line numberDiff line change
@@ -364,32 +364,6 @@ public async Task<PlayFabResult<GetStatisticDefinitionResponse>> GetStatisticDef
364364
return new PlayFabResult<GetStatisticDefinitionResponse> { Result = result, CustomData = customData };
365365
}
366366

367-
/// <summary>
368-
/// Get all current statistic definitions information
369-
/// </summary>
370-
public async Task<PlayFabResult<GetStatisticDefinitionsResponse>> GetStatisticDefinitionsAsync(GetStatisticDefinitionsRequest request, object customData = null, Dictionary<string, string> extraHeaders = null)
371-
{
372-
await new PlayFabUtil.SynchronizationContextRemover();
373-
374-
var requestContext = request?.AuthenticationContext ?? authenticationContext;
375-
var requestSettings = apiSettings ?? PlayFabSettings.staticSettings;
376-
if (requestContext.EntityToken == null) throw new PlayFabException(PlayFabExceptionCode.EntityTokenNotSet, "Must call Client Login or GetEntityToken before calling this method");
377-
378-
var httpResult = await PlayFabHttp.DoPost("/Statistic/GetStatisticDefinitions", request, "X-EntityToken", requestContext.EntityToken, extraHeaders, requestSettings);
379-
if (httpResult is PlayFabError)
380-
{
381-
var error = (PlayFabError)httpResult;
382-
PlayFabSettings.GlobalErrorHandler?.Invoke(error);
383-
return new PlayFabResult<GetStatisticDefinitionsResponse> { Error = error, CustomData = customData };
384-
}
385-
386-
var resultRawJson = (string)httpResult;
387-
var resultData = PluginManager.GetPlugin<ISerializerPlugin>(PluginContract.PlayFab_Serializer).DeserializeObject<PlayFabJsonSuccess<GetStatisticDefinitionsResponse>>(resultRawJson);
388-
var result = resultData.data;
389-
390-
return new PlayFabResult<GetStatisticDefinitionsResponse> { Result = result, CustomData = customData };
391-
}
392-
393367
/// <summary>
394368
/// Gets statistics for the specified entity.
395369
/// </summary>

PlayFabSDK/source/PlayFabProgressionModels.cs

-18
Original file line numberDiff line numberDiff line change
@@ -518,24 +518,6 @@ public class GetStatisticDefinitionResponse : PlayFabResultCommon
518518

519519
}
520520

521-
public class GetStatisticDefinitionsRequest : PlayFabRequestCommon
522-
{
523-
/// <summary>
524-
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
525-
/// </summary>
526-
public Dictionary<string,string> CustomTags ;
527-
528-
}
529-
530-
public class GetStatisticDefinitionsResponse : PlayFabResultCommon
531-
{
532-
/// <summary>
533-
/// List of statistic definitions for the title.
534-
/// </summary>
535-
public List<StatisticDefinition> StatisticDefinitions ;
536-
537-
}
538-
539521
public class GetStatisticsForEntitiesRequest : PlayFabRequestCommon
540522
{
541523
/// <summary>

PlayFabSDK/source/PlayFabSDK.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<FileAlignment>512</FileAlignment>
99

1010
<PackageId>PlayFabAllSDK</PackageId>
11-
<Version>1.188.240830</Version>
11+
<Version>1.189.240913</Version>
1212
<Title>PlayFab CSharp Sdk</Title>
1313
<Authors>Microsoft</Authors>
1414
<Owners>Microsoft</Owners>
@@ -21,7 +21,7 @@
2121
<Company>PlayFab</Company>
2222
<Product>PlayFabSDK</Product>
2323
<PackageTags>PlayFab, Baas, Paas, JSON, REST, HTTP, SSL, API, cloud, liveops, game, gamedev, native</PackageTags>
24-
<PackageReleaseNotes>https://docs.microsoft.com/gaming/playfab/release-notes#240830</PackageReleaseNotes>
24+
<PackageReleaseNotes>https://docs.microsoft.com/gaming/playfab/release-notes#240913</PackageReleaseNotes>
2525
<NeutralLanguage>en</NeutralLanguage>
2626
<AssemblyVersion>1</AssemblyVersion>
2727
<FileVersion>1</FileVersion>

PlayFabSDK/source/PlayFabServerModels.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -4775,7 +4775,8 @@ public enum LoginIdentityProvider
47754775
Apple,
47764776
NintendoSwitchAccount,
47774777
GooglePlayGames,
4778-
XboxMobileStore
4778+
XboxMobileStore,
4779+
King
47794780
}
47804781

47814782
/// <summary>
@@ -7684,7 +7685,8 @@ public enum UserOrigination
76847685
Apple,
76857686
NintendoSwitchAccount,
76867687
GooglePlayGames,
7687-
XboxMobileStore
7688+
XboxMobileStore,
7689+
King
76887690
}
76897691

76907692
public class UserPrivateAccountInfo

PlayFabSDK/source/PlayFabSettings.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ namespace PlayFab
66
{
77
public class PlayFabSettings
88
{
9-
public const string SdkVersion = "1.188.240830";
10-
public const string BuildIdentifier = "adobuild_csharpsdk_115";
11-
public const string SdkVersionString = "CSharpSDK-1.188.240830";
9+
public const string SdkVersion = "1.189.240913";
10+
public const string BuildIdentifier = "adobuild_csharpsdk_117";
11+
public const string SdkVersionString = "CSharpSDK-1.189.240913";
1212
/// <summary> This is only for customers running a private cluster. Generally you shouldn't touch this </summary>
1313
public static string DefaultProductionEnvironmentUrl = "playfabapi.com";
1414

Plugins/CloudScript/source/PlayFabCloudScriptPlugin.csproj

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<FileAlignment>512</FileAlignment>
99

1010
<PackageId>PlayFabCloudScriptPlugin</PackageId>
11-
<Version>1.188.240830-alpha</Version>
11+
<Version>1.189.240913-alpha</Version>
1212
<Title>PlayFab CSharp CloudScript Plugin</Title>
1313
<Authors>Microsoft</Authors>
1414
<Owners>Microsoft</Owners>
@@ -21,7 +21,7 @@
2121
<Product>PlayFabCloudScriptPlugin</Product>
2222
<Copyright>Copyright 2024</Copyright>
2323
<PackageTags>PlayFab, Baas, Paas, JSON, REST, HTTP, SSL, API, cloud, liveops, game, gamedev, native</PackageTags>
24-
<PackageReleaseNotes>https://docs.microsoft.com/gaming/playfab/release-notes#240830</PackageReleaseNotes>
24+
<PackageReleaseNotes>https://docs.microsoft.com/gaming/playfab/release-notes#240913</PackageReleaseNotes>
2525
<NeutralLanguage>en</NeutralLanguage>
2626
<AssemblyVersion>1</AssemblyVersion>
2727
<FileVersion>1</FileVersion>
@@ -45,7 +45,7 @@
4545
</PropertyGroup>
4646

4747
<ItemGroup>
48-
<PackageReference Include="PlayFabAllSDK" Version="1.188.240830" />
48+
<PackageReference Include="PlayFabAllSDK" Version="1.189.240913" />
4949
</ItemGroup>
5050

5151
</Project>

XamarinTestRunner/XamarinTestRunner/PlayFabSDK/PlayFabAdminModels.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -4621,7 +4621,8 @@ public enum LoginIdentityProvider
46214621
Apple,
46224622
NintendoSwitchAccount,
46234623
GooglePlayGames,
4624-
XboxMobileStore
4624+
XboxMobileStore,
4625+
King
46254626
}
46264627

46274628
public class LogStatement
@@ -8161,7 +8162,8 @@ public enum UserOrigination
81618162
Apple,
81628163
NintendoSwitchAccount,
81638164
GooglePlayGames,
8164-
XboxMobileStore
8165+
XboxMobileStore,
8166+
King
81658167
}
81668168

81678169
public class UserOriginationSegmentFilter

XamarinTestRunner/XamarinTestRunner/PlayFabSDK/PlayFabAuthenticationModels.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,8 @@ public enum LoginIdentityProvider
206206
Apple,
207207
NintendoSwitchAccount,
208208
GooglePlayGames,
209-
XboxMobileStore
209+
XboxMobileStore,
210+
King
210211
}
211212

212213
/// <summary>

XamarinTestRunner/XamarinTestRunner/PlayFabSDK/PlayFabClientModels.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -4141,7 +4141,8 @@ public enum LoginIdentityProvider
41414141
Apple,
41424142
NintendoSwitchAccount,
41434143
GooglePlayGames,
4144-
XboxMobileStore
4144+
XboxMobileStore,
4145+
King
41454146
}
41464147

41474148
public class LoginResult : PlayFabLoginResultCommon
@@ -7727,7 +7728,8 @@ public enum UserOrigination
77277728
Apple,
77287729
NintendoSwitchAccount,
77297730
GooglePlayGames,
7730-
XboxMobileStore
7731+
XboxMobileStore,
7732+
King
77317733
}
77327734

77337735
public class UserPrivateAccountInfo

0 commit comments

Comments
 (0)