@community-fabs/playfab-web-sdk 1.193.250606-1 → 1.194.250620
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +117 -83
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +4 -2
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +51 -32
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +15 -8
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +2 -1
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +26 -16
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +5 -3
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +8 -5
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +3 -2
- package/dist/Groups.js +2 -2
- package/dist/Insights.js +2 -2
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.d.ts +3 -2
- package/dist/Matchmaker.js +2 -2
- package/dist/Multiplayer.d.ts +68 -53
- package/dist/Multiplayer.js +2 -2
- package/dist/Profiles.d.ts +6 -4
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +8 -4
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +55 -35
- package/dist/Server.js +2 -2
- package/dist/{chunk-IFBBLD7Q.js → chunk-25WD3CAR.js} +2 -2
- package/dist/{chunk-QJRCYM7I.js → chunk-2KENN6K4.js} +2 -2
- package/dist/{chunk-MHSKIHSG.js → chunk-3FN2QIKG.js} +2 -2
- package/dist/{chunk-YI4OQ74L.js → chunk-4WIXXA2D.js} +2 -2
- package/dist/{chunk-6OZSERVG.js → chunk-5VL2MDQH.js} +3 -3
- package/dist/{chunk-6OZSERVG.js.map → chunk-5VL2MDQH.js.map} +1 -1
- package/dist/{chunk-K2I6VCQK.js → chunk-6CD37OTG.js} +2 -2
- package/dist/{chunk-QHQBHTHP.js → chunk-6OSVAJM6.js} +2 -2
- package/dist/{chunk-SZJQBNVS.js → chunk-DDOQH64N.js} +2 -2
- package/dist/{chunk-P4FCADAY.js → chunk-DEKC3RGM.js} +2 -2
- package/dist/{chunk-RVBFE5D5.js → chunk-DUFJF5YI.js} +2 -2
- package/dist/{chunk-3DU2LYBT.js → chunk-EMAR3JI6.js} +2 -2
- package/dist/{chunk-WBPWV6H3.js → chunk-FJ7CVV4B.js} +2 -2
- package/dist/{chunk-BD7SF6AA.js → chunk-JHVT2GUV.js} +2 -2
- package/dist/{chunk-CPJ6FMQ3.js → chunk-KEM5M5YI.js} +2 -2
- package/dist/{chunk-SF5NNTLE.js → chunk-OGEK5XJO.js} +2 -2
- package/dist/{chunk-OZLGFCPU.js → chunk-P3PBVZBN.js} +2 -2
- package/dist/{chunk-MQZCB76F.js → chunk-PE3HZUZR.js} +2 -2
- package/dist/{chunk-J2KKGAWN.js → chunk-QNR3Z4UZ.js} +6 -6
- package/dist/{chunk-J2KKGAWN.js.map → chunk-QNR3Z4UZ.js.map} +1 -1
- package/dist/index.js +18 -18
- package/package.json +6 -5
- /package/dist/{chunk-IFBBLD7Q.js.map → chunk-25WD3CAR.js.map} +0 -0
- /package/dist/{chunk-QJRCYM7I.js.map → chunk-2KENN6K4.js.map} +0 -0
- /package/dist/{chunk-MHSKIHSG.js.map → chunk-3FN2QIKG.js.map} +0 -0
- /package/dist/{chunk-YI4OQ74L.js.map → chunk-4WIXXA2D.js.map} +0 -0
- /package/dist/{chunk-K2I6VCQK.js.map → chunk-6CD37OTG.js.map} +0 -0
- /package/dist/{chunk-QHQBHTHP.js.map → chunk-6OSVAJM6.js.map} +0 -0
- /package/dist/{chunk-SZJQBNVS.js.map → chunk-DDOQH64N.js.map} +0 -0
- /package/dist/{chunk-P4FCADAY.js.map → chunk-DEKC3RGM.js.map} +0 -0
- /package/dist/{chunk-RVBFE5D5.js.map → chunk-DUFJF5YI.js.map} +0 -0
- /package/dist/{chunk-3DU2LYBT.js.map → chunk-EMAR3JI6.js.map} +0 -0
- /package/dist/{chunk-WBPWV6H3.js.map → chunk-FJ7CVV4B.js.map} +0 -0
- /package/dist/{chunk-BD7SF6AA.js.map → chunk-JHVT2GUV.js.map} +0 -0
- /package/dist/{chunk-CPJ6FMQ3.js.map → chunk-KEM5M5YI.js.map} +0 -0
- /package/dist/{chunk-SF5NNTLE.js.map → chunk-OGEK5XJO.js.map} +0 -0
- /package/dist/{chunk-OZLGFCPU.js.map → chunk-P3PBVZBN.js.map} +0 -0
- /package/dist/{chunk-MQZCB76F.js.map → chunk-PE3HZUZR.js.map} +0 -0
package/dist/Multiplayer.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
|
|
2
2
|
|
|
3
|
+
type AccessPolicy = "Public" | "Friends" | "Private";
|
|
3
4
|
interface AssetReference {
|
|
4
5
|
/** The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. */
|
|
5
6
|
FileName?: string;
|
|
@@ -18,6 +19,11 @@ interface AssetSummary {
|
|
|
18
19
|
/** The metadata associated with the asset. */
|
|
19
20
|
Metadata?: Record<string, string | null>;
|
|
20
21
|
}
|
|
22
|
+
type AttributeMergeFunction = "Min" | "Max" | "Average";
|
|
23
|
+
type AttributeNotSpecifiedBehavior = "UseDefault" | "MatchAny";
|
|
24
|
+
type AttributeSource = "User" | "PlayerEntity";
|
|
25
|
+
type AzureVmFamily = "A" | "Av2" | "Dv2" | "Dv3" | "F" | "Fsv2" | "Dasv4" | "Dav4" | "Dadsv5" | "Eav4" | "Easv4" | "Ev4" | "Esv4" | "Dsv3" | "Dsv2" | "NCasT4_v3" | "Ddv4" | "Ddsv4" | "HBv3" | "Ddv5" | "Ddsv5";
|
|
26
|
+
type AzureVmSize = "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D2_v3" | "Standard_D4_v3" | "Standard_D8_v3" | "Standard_D16_v3" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F2s_v2" | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" | "Standard_D2as_v4" | "Standard_D4as_v4" | "Standard_D8as_v4" | "Standard_D16as_v4" | "Standard_D2a_v4" | "Standard_D4a_v4" | "Standard_D8a_v4" | "Standard_D16a_v4" | "Standard_D2ads_v5" | "Standard_D4ads_v5" | "Standard_D8ads_v5" | "Standard_D16ads_v5" | "Standard_E2a_v4" | "Standard_E4a_v4" | "Standard_E8a_v4" | "Standard_E16a_v4" | "Standard_E2as_v4" | "Standard_E4as_v4" | "Standard_E8as_v4" | "Standard_E16as_v4" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" | "Standard_D16s_v3" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_NC4as_T4_v3" | "Standard_D2d_v4" | "Standard_D4d_v4" | "Standard_D8d_v4" | "Standard_D16d_v4" | "Standard_D2ds_v4" | "Standard_D4ds_v4" | "Standard_D8ds_v4" | "Standard_D16ds_v4" | "Standard_HB120_16rs_v3" | "Standard_HB120_32rs_v3" | "Standard_HB120_64rs_v3" | "Standard_HB120_96rs_v3" | "Standard_HB120rs_v3" | "Standard_D2d_v5" | "Standard_D4d_v5" | "Standard_D8d_v5" | "Standard_D16d_v5" | "Standard_D32d_v5" | "Standard_D2ds_v5" | "Standard_D4ds_v5" | "Standard_D8ds_v5" | "Standard_D16ds_v5" | "Standard_D32ds_v5";
|
|
21
27
|
interface BatchParameters {
|
|
22
28
|
/**
|
|
23
29
|
* The initial threshold value for determining if a match result is considered anomalous enough to be ignored. If this is
|
|
@@ -100,7 +106,7 @@ interface BuildRegion {
|
|
|
100
106
|
*/
|
|
101
107
|
Status?: string;
|
|
102
108
|
/** Regional override for the VM size the build was created on. */
|
|
103
|
-
VmSize?:
|
|
109
|
+
VmSize?: AzureVmSize;
|
|
104
110
|
}
|
|
105
111
|
interface BuildRegionParams {
|
|
106
112
|
/** Optional settings to control dynamic adjustment of standby target. If not specified, dynamic standby is disabled */
|
|
@@ -116,7 +122,7 @@ interface BuildRegionParams {
|
|
|
116
122
|
/** The number of standby multiplayer servers for the region. */
|
|
117
123
|
StandbyServers: number;
|
|
118
124
|
/** Regional override for the VM size the build was created on. */
|
|
119
|
-
VmSize?:
|
|
125
|
+
VmSize?: AzureVmSize;
|
|
120
126
|
}
|
|
121
127
|
interface BuildSelectionCriterion {
|
|
122
128
|
/** Dictionary of build ids and their respective weights for distribution of allocation requests. */
|
|
@@ -154,6 +160,7 @@ interface CancelAllServerBackfillTicketsForPlayerRequest extends IPlayFabRequest
|
|
|
154
160
|
}
|
|
155
161
|
interface CancelAllServerBackfillTicketsForPlayerResult extends IPlayFabResultCommon {
|
|
156
162
|
}
|
|
163
|
+
type CancellationReason = "Requested" | "Internal" | "Timeout";
|
|
157
164
|
interface CancelMatchmakingTicketRequest extends IPlayFabRequestCommon {
|
|
158
165
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
159
166
|
CustomTags?: Record<string, string | null>;
|
|
@@ -211,6 +218,7 @@ interface CognitiveServicesLocale {
|
|
|
211
218
|
/** Short name of the locale if available */
|
|
212
219
|
ShortName?: string;
|
|
213
220
|
}
|
|
221
|
+
type CognitiveServicesType = "SpeechToText" | "SpeechToTextTranslation" | "TextToSpeech" | "TextToText";
|
|
214
222
|
interface ConditionsSet {
|
|
215
223
|
/** A map from condition names to condition values in which to get the skills of the players. */
|
|
216
224
|
Conditions?: Record<string, string | null>;
|
|
@@ -219,6 +227,7 @@ interface ConnectedPlayer {
|
|
|
219
227
|
/** The player ID of the player connected to the multiplayer server. */
|
|
220
228
|
PlayerId?: string;
|
|
221
229
|
}
|
|
230
|
+
type ContainerFlavor = "ManagedWindowsServerCore" | "CustomLinux" | "ManagedWindowsServerCorePreview" | "Invalid";
|
|
222
231
|
interface ContainerImageReference {
|
|
223
232
|
/** The container image name. */
|
|
224
233
|
ImageName: string;
|
|
@@ -233,7 +242,7 @@ interface CoreCapacity {
|
|
|
233
242
|
/** The total core capacity for the (Region, VmFamily) */
|
|
234
243
|
Total: number;
|
|
235
244
|
/** The AzureVmFamily */
|
|
236
|
-
VmFamily?:
|
|
245
|
+
VmFamily?: AzureVmFamily;
|
|
237
246
|
}
|
|
238
247
|
interface CoreCapacityChange {
|
|
239
248
|
/** New quota core limit for the given vm family/region. */
|
|
@@ -241,7 +250,7 @@ interface CoreCapacityChange {
|
|
|
241
250
|
/** Region to change. */
|
|
242
251
|
Region: string;
|
|
243
252
|
/** Virtual machine family to change. */
|
|
244
|
-
VmFamily:
|
|
253
|
+
VmFamily: AzureVmFamily;
|
|
245
254
|
}
|
|
246
255
|
interface CreateBaseModelRequest extends IPlayFabRequestCommon {
|
|
247
256
|
/** A list of condition keys and their associated affinity weights for this model. */
|
|
@@ -308,7 +317,7 @@ interface CreateBuildWithCustomContainerRequest extends IPlayFabRequestCommon {
|
|
|
308
317
|
/** The build name. */
|
|
309
318
|
BuildName: string;
|
|
310
319
|
/** The flavor of container to create a build from. */
|
|
311
|
-
ContainerFlavor?:
|
|
320
|
+
ContainerFlavor?: ContainerFlavor;
|
|
312
321
|
/** The container reference, consisting of the image name and tag. */
|
|
313
322
|
ContainerImageReference?: ContainerImageReference;
|
|
314
323
|
/**
|
|
@@ -355,7 +364,7 @@ interface CreateBuildWithCustomContainerRequest extends IPlayFabRequestCommon {
|
|
|
355
364
|
*/
|
|
356
365
|
UseStreamingForAssetDownloads?: boolean;
|
|
357
366
|
/** The VM size to create the build on. */
|
|
358
|
-
VmSize?:
|
|
367
|
+
VmSize?: AzureVmSize;
|
|
359
368
|
/** The configuration for the VmStartupScript for the build */
|
|
360
369
|
VmStartupScriptConfiguration?: VmStartupScriptParams;
|
|
361
370
|
}
|
|
@@ -370,7 +379,7 @@ interface CreateBuildWithCustomContainerResponse extends IPlayFabResultCommon {
|
|
|
370
379
|
/** The build name. */
|
|
371
380
|
BuildName?: string;
|
|
372
381
|
/** The flavor of container of the build. */
|
|
373
|
-
ContainerFlavor?:
|
|
382
|
+
ContainerFlavor?: ContainerFlavor;
|
|
374
383
|
/** The container command to run when the multiplayer server has been allocated, including any arguments. */
|
|
375
384
|
ContainerRunCommand?: string;
|
|
376
385
|
/** The time the build was created in UTC. */
|
|
@@ -407,7 +416,7 @@ interface CreateBuildWithCustomContainerResponse extends IPlayFabResultCommon {
|
|
|
407
416
|
*/
|
|
408
417
|
UseStreamingForAssetDownloads?: boolean;
|
|
409
418
|
/** The VM size the build was created on. */
|
|
410
|
-
VmSize?:
|
|
419
|
+
VmSize?: AzureVmSize;
|
|
411
420
|
/** The configuration for the VmStartupScript feature for the build */
|
|
412
421
|
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
|
413
422
|
}
|
|
@@ -420,7 +429,7 @@ interface CreateBuildWithManagedContainerRequest extends IPlayFabRequestCommon {
|
|
|
420
429
|
/** The build name. */
|
|
421
430
|
BuildName: string;
|
|
422
431
|
/** The flavor of container to create a build from. */
|
|
423
|
-
ContainerFlavor?:
|
|
432
|
+
ContainerFlavor?: ContainerFlavor;
|
|
424
433
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
425
434
|
CustomTags?: Record<string, string | null>;
|
|
426
435
|
/** The list of game assets related to the build. */
|
|
@@ -460,7 +469,7 @@ interface CreateBuildWithManagedContainerRequest extends IPlayFabRequestCommon {
|
|
|
460
469
|
*/
|
|
461
470
|
UseStreamingForAssetDownloads?: boolean;
|
|
462
471
|
/** The VM size to create the build on. */
|
|
463
|
-
VmSize?:
|
|
472
|
+
VmSize?: AzureVmSize;
|
|
464
473
|
/** The configuration for the VmStartupScript for the build */
|
|
465
474
|
VmStartupScriptConfiguration?: VmStartupScriptParams;
|
|
466
475
|
/** The crash dump configuration for the build. */
|
|
@@ -477,7 +486,7 @@ interface CreateBuildWithManagedContainerResponse extends IPlayFabResultCommon {
|
|
|
477
486
|
/** The build name. */
|
|
478
487
|
BuildName?: string;
|
|
479
488
|
/** The flavor of container of the build. */
|
|
480
|
-
ContainerFlavor?:
|
|
489
|
+
ContainerFlavor?: ContainerFlavor;
|
|
481
490
|
/** The time the build was created in UTC. */
|
|
482
491
|
CreationTime?: string;
|
|
483
492
|
/** The game assets for the build. */
|
|
@@ -517,7 +526,7 @@ interface CreateBuildWithManagedContainerResponse extends IPlayFabResultCommon {
|
|
|
517
526
|
*/
|
|
518
527
|
UseStreamingForAssetDownloads?: boolean;
|
|
519
528
|
/** The VM size the build was created on. */
|
|
520
|
-
VmSize?:
|
|
529
|
+
VmSize?: AzureVmSize;
|
|
521
530
|
/** The configuration for the VmStartupScript feature for the build */
|
|
522
531
|
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
|
523
532
|
}
|
|
@@ -578,7 +587,7 @@ interface CreateBuildWithProcessBasedServerRequest extends IPlayFabRequestCommon
|
|
|
578
587
|
*/
|
|
579
588
|
UseStreamingForAssetDownloads?: boolean;
|
|
580
589
|
/** The VM size to create the build on. */
|
|
581
|
-
VmSize?:
|
|
590
|
+
VmSize?: AzureVmSize;
|
|
582
591
|
/** The configuration for the VmStartupScript for the build */
|
|
583
592
|
VmStartupScriptConfiguration?: VmStartupScriptParams;
|
|
584
593
|
}
|
|
@@ -593,7 +602,7 @@ interface CreateBuildWithProcessBasedServerResponse extends IPlayFabResultCommon
|
|
|
593
602
|
/** The build name. */
|
|
594
603
|
BuildName?: string;
|
|
595
604
|
/** The flavor of container of the build. */
|
|
596
|
-
ContainerFlavor?:
|
|
605
|
+
ContainerFlavor?: ContainerFlavor;
|
|
597
606
|
/** The time the build was created in UTC. */
|
|
598
607
|
CreationTime?: string;
|
|
599
608
|
/** The game assets for the build. */
|
|
@@ -641,7 +650,7 @@ interface CreateBuildWithProcessBasedServerResponse extends IPlayFabResultCommon
|
|
|
641
650
|
*/
|
|
642
651
|
UseStreamingForAssetDownloads?: boolean;
|
|
643
652
|
/** The VM size the build was created on. */
|
|
644
|
-
VmSize?:
|
|
653
|
+
VmSize?: AzureVmSize;
|
|
645
654
|
/** The configuration for the VmStartupScript feature for the build */
|
|
646
655
|
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
|
647
656
|
}
|
|
@@ -653,7 +662,7 @@ interface CreateLobbyRequest extends IPlayFabRequestCommon {
|
|
|
653
662
|
* its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
|
|
654
663
|
* join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
|
|
655
664
|
*/
|
|
656
|
-
AccessPolicy?:
|
|
665
|
+
AccessPolicy?: AccessPolicy;
|
|
657
666
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
658
667
|
CustomTags?: Record<string, string | null>;
|
|
659
668
|
/**
|
|
@@ -679,7 +688,7 @@ interface CreateLobbyRequest extends IPlayFabRequestCommon {
|
|
|
679
688
|
* themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can
|
|
680
689
|
* set ownership. The useConnections property can be either true or false.
|
|
681
690
|
*/
|
|
682
|
-
OwnerMigrationPolicy?:
|
|
691
|
+
OwnerMigrationPolicy?: OwnerMigrationPolicy;
|
|
683
692
|
/**
|
|
684
693
|
* A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner
|
|
685
694
|
* can send invites. When false or not specified, any member can send invites. Defaults to false if not specified.
|
|
@@ -949,7 +958,7 @@ interface DifferenceRule {
|
|
|
949
958
|
* Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
|
|
950
959
|
* profile.
|
|
951
960
|
*/
|
|
952
|
-
AttributeNotSpecifiedBehavior:
|
|
961
|
+
AttributeNotSpecifiedBehavior: AttributeNotSpecifiedBehavior;
|
|
953
962
|
/**
|
|
954
963
|
* Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this
|
|
955
964
|
* is set, Difference is ignored.
|
|
@@ -965,7 +974,7 @@ interface DifferenceRule {
|
|
|
965
974
|
/** Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. */
|
|
966
975
|
LinearExpansion?: LinearDifferenceRuleExpansion;
|
|
967
976
|
/** How values are treated when there are multiple players in a single ticket. */
|
|
968
|
-
MergeFunction:
|
|
977
|
+
MergeFunction: AttributeMergeFunction;
|
|
969
978
|
/** Friendly name chosen by developer. */
|
|
970
979
|
Name: string;
|
|
971
980
|
/**
|
|
@@ -999,7 +1008,7 @@ interface EnableMultiplayerServersForTitleRequest extends IPlayFabRequestCommon
|
|
|
999
1008
|
}
|
|
1000
1009
|
interface EnableMultiplayerServersForTitleResponse extends IPlayFabResultCommon {
|
|
1001
1010
|
/** The enabled status for the multiplayer server features for the title. */
|
|
1002
|
-
Status?:
|
|
1011
|
+
Status?: TitleMultiplayerServerEnabledStatus;
|
|
1003
1012
|
}
|
|
1004
1013
|
interface EnablePartiesForTitleRequest extends IPlayFabRequestCommon {
|
|
1005
1014
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
@@ -1016,6 +1025,7 @@ interface EntityKey {
|
|
|
1016
1025
|
*/
|
|
1017
1026
|
TypeString?: string;
|
|
1018
1027
|
}
|
|
1028
|
+
type ExternalFriendSources = "None" | "Steam" | "Facebook" | "Xbox" | "Psn" | "All";
|
|
1019
1029
|
interface FindFriendLobbiesRequest extends IPlayFabRequestCommon {
|
|
1020
1030
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
1021
1031
|
CustomTags?: Record<string, string | null>;
|
|
@@ -1030,7 +1040,7 @@ interface FindFriendLobbiesRequest extends IPlayFabRequestCommon {
|
|
|
1030
1040
|
*/
|
|
1031
1041
|
ExcludeSteamFriends?: boolean;
|
|
1032
1042
|
/** Indicates which other platforms' friends this query should link to. */
|
|
1033
|
-
ExternalPlatformFriends?:
|
|
1043
|
+
ExternalPlatformFriends?: ExternalFriendSources;
|
|
1034
1044
|
/**
|
|
1035
1045
|
* OData style string that contains one or more filters. Only the following operators are supported: "and" (logical and),
|
|
1036
1046
|
* "eq" (equal), "ne" (not equals), "ge" (greater than or equal), "gt" (greater than), "le" (less than or equal), and "lt"
|
|
@@ -1105,7 +1115,7 @@ interface FriendLobbySummary {
|
|
|
1105
1115
|
/** The maximum number of players allowed in the lobby. */
|
|
1106
1116
|
MaxPlayers: number;
|
|
1107
1117
|
/** A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining. */
|
|
1108
|
-
MembershipLock?:
|
|
1118
|
+
MembershipLock?: MembershipLock;
|
|
1109
1119
|
/** The client or server entity which owns this lobby. */
|
|
1110
1120
|
Owner: EntityKey;
|
|
1111
1121
|
/** Search data. */
|
|
@@ -1194,7 +1204,7 @@ interface GetBuildResponse extends IPlayFabResultCommon {
|
|
|
1194
1204
|
/** The current build status. Valid values are - Deploying, Deployed, DeletingRegion, Unhealthy. */
|
|
1195
1205
|
BuildStatus?: string;
|
|
1196
1206
|
/** The flavor of container of he build. */
|
|
1197
|
-
ContainerFlavor?:
|
|
1207
|
+
ContainerFlavor?: ContainerFlavor;
|
|
1198
1208
|
/**
|
|
1199
1209
|
* The container command to run when the multiplayer server has been allocated, including any arguments. This only applies
|
|
1200
1210
|
* to custom builds. If the build is a managed build, this field will be null.
|
|
@@ -1239,13 +1249,13 @@ interface GetBuildResponse extends IPlayFabResultCommon {
|
|
|
1239
1249
|
*/
|
|
1240
1250
|
UseStreamingForAssetDownloads?: boolean;
|
|
1241
1251
|
/** The VM size the build was created on. */
|
|
1242
|
-
VmSize?:
|
|
1252
|
+
VmSize?: AzureVmSize;
|
|
1243
1253
|
/** The configuration for the VmStartupScript feature for the build */
|
|
1244
1254
|
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
|
1245
1255
|
}
|
|
1246
1256
|
interface GetCognitiveServicesLocalesRequest extends IPlayFabRequestCommon {
|
|
1247
1257
|
/** The type of the cognitive service for which locales are being requested. */
|
|
1248
|
-
CognitiveServicesType:
|
|
1258
|
+
CognitiveServicesType: CognitiveServicesType;
|
|
1249
1259
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
1250
1260
|
CustomTags?: Record<string, string | null>;
|
|
1251
1261
|
/** The region the client is closest to (A service endpoint will be provided for this region or one nearest one available). */
|
|
@@ -1257,7 +1267,7 @@ interface GetCognitiveServicesLocalesResponse extends IPlayFabResultCommon {
|
|
|
1257
1267
|
}
|
|
1258
1268
|
interface GetCognitiveServicesTokenRequest extends IPlayFabRequestCommon {
|
|
1259
1269
|
/** The type of the cognitive service for which a token is being requested. */
|
|
1260
|
-
CognitiveServicesType:
|
|
1270
|
+
CognitiveServicesType: CognitiveServicesType;
|
|
1261
1271
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
1262
1272
|
CustomTags?: Record<string, string | null>;
|
|
1263
1273
|
/** The region the client is closest to (A service endpoint will be provided for this region or one nearest one available). */
|
|
@@ -1321,7 +1331,7 @@ interface GetMatchmakingTicketResult extends IPlayFabResultCommon {
|
|
|
1321
1331
|
* The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state.
|
|
1322
1332
|
* @deprecated Please use CancellationReasonString instead.
|
|
1323
1333
|
*/
|
|
1324
|
-
CancellationReason?:
|
|
1334
|
+
CancellationReason?: CancellationReason;
|
|
1325
1335
|
/**
|
|
1326
1336
|
* The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state. Please retry
|
|
1327
1337
|
* if CancellationReason is RetryRequired.
|
|
@@ -1638,7 +1648,7 @@ interface GetServerBackfillTicketResult extends IPlayFabResultCommon {
|
|
|
1638
1648
|
* The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state.
|
|
1639
1649
|
* @deprecated Please use CancellationReasonString instead.
|
|
1640
1650
|
*/
|
|
1641
|
-
CancellationReason?:
|
|
1651
|
+
CancellationReason?: CancellationReason;
|
|
1642
1652
|
/** The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state. */
|
|
1643
1653
|
CancellationReasonString?: string;
|
|
1644
1654
|
/** The server date and time at which ticket was created. */
|
|
@@ -1664,7 +1674,7 @@ interface GetTitleEnabledForMultiplayerServersStatusRequest extends IPlayFabRequ
|
|
|
1664
1674
|
}
|
|
1665
1675
|
interface GetTitleEnabledForMultiplayerServersStatusResponse extends IPlayFabResultCommon {
|
|
1666
1676
|
/** The enabled status for the multiplayer server features for the title. */
|
|
1667
|
-
Status?:
|
|
1677
|
+
Status?: TitleMultiplayerServerEnabledStatus;
|
|
1668
1678
|
}
|
|
1669
1679
|
interface GetTitleMultiplayerServersQuotaChangeRequest extends IPlayFabRequestCommon {
|
|
1670
1680
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
@@ -1712,7 +1722,7 @@ interface JoinArrangedLobbyRequest extends IPlayFabRequestCommon {
|
|
|
1712
1722
|
* its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
|
|
1713
1723
|
* join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
|
|
1714
1724
|
*/
|
|
1715
|
-
AccessPolicy?:
|
|
1725
|
+
AccessPolicy?: AccessPolicy;
|
|
1716
1726
|
/**
|
|
1717
1727
|
* A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service
|
|
1718
1728
|
* and the creator of the arrangementString (Matchmaking). This string defines a unique identifier for the arranged lobby
|
|
@@ -1739,7 +1749,7 @@ interface JoinArrangedLobbyRequest extends IPlayFabRequestCommon {
|
|
|
1739
1749
|
* themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can
|
|
1740
1750
|
* set ownership. The useConnections property can be either true or false.
|
|
1741
1751
|
*/
|
|
1742
|
-
OwnerMigrationPolicy?:
|
|
1752
|
+
OwnerMigrationPolicy?: OwnerMigrationPolicy;
|
|
1743
1753
|
/**
|
|
1744
1754
|
* A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner
|
|
1745
1755
|
* can send invites. When false or not specified, any member can send invites. Defaults to false if not specified.
|
|
@@ -2117,7 +2127,7 @@ interface ListVirtualMachineSummariesResponse extends IPlayFabResultCommon {
|
|
|
2117
2127
|
}
|
|
2118
2128
|
interface Lobby {
|
|
2119
2129
|
/** A setting indicating who is allowed to join this lobby, as well as see it in queries. */
|
|
2120
|
-
AccessPolicy:
|
|
2130
|
+
AccessPolicy: AccessPolicy;
|
|
2121
2131
|
/** A number that increments once for each request that modifies the lobby. */
|
|
2122
2132
|
ChangeNumber: number;
|
|
2123
2133
|
/**
|
|
@@ -2134,11 +2144,11 @@ interface Lobby {
|
|
|
2134
2144
|
/** Array of all lobby members. */
|
|
2135
2145
|
Members?: Member[];
|
|
2136
2146
|
/** A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining. */
|
|
2137
|
-
MembershipLock:
|
|
2147
|
+
MembershipLock: MembershipLock;
|
|
2138
2148
|
/** The client or server entity which owns this lobby. */
|
|
2139
2149
|
Owner?: EntityKey;
|
|
2140
2150
|
/** A setting indicating the owner migration policy. If server owned, this field is not present. */
|
|
2141
|
-
OwnerMigrationPolicy?:
|
|
2151
|
+
OwnerMigrationPolicy?: OwnerMigrationPolicy;
|
|
2142
2152
|
/**
|
|
2143
2153
|
* An opaque string stored on a SubscribeToLobbyResource call, which indicates the connection an owner or member has with
|
|
2144
2154
|
* PubSub.
|
|
@@ -2179,7 +2189,7 @@ interface LobbySummary {
|
|
|
2179
2189
|
/** The maximum number of players allowed in the lobby. */
|
|
2180
2190
|
MaxPlayers: number;
|
|
2181
2191
|
/** A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining. */
|
|
2182
|
-
MembershipLock?:
|
|
2192
|
+
MembershipLock?: MembershipLock;
|
|
2183
2193
|
/** The client or server entity which owns this lobby. */
|
|
2184
2194
|
Owner: EntityKey;
|
|
2185
2195
|
/** Search data. */
|
|
@@ -2322,6 +2332,7 @@ interface Member {
|
|
|
2322
2332
|
/** Opaque string, stored on a Subscribe call, which indicates the connection an owner or member has with PubSub. */
|
|
2323
2333
|
PubSubConnectionHandle?: string;
|
|
2324
2334
|
}
|
|
2335
|
+
type MembershipLock = "Unlocked" | "Locked";
|
|
2325
2336
|
interface ModelCondition {
|
|
2326
2337
|
/** The key for this condition. */
|
|
2327
2338
|
Key: string;
|
|
@@ -2450,6 +2461,7 @@ interface OverrideUnsignedInt {
|
|
|
2450
2461
|
/** The custom expansion value. */
|
|
2451
2462
|
Value: number;
|
|
2452
2463
|
}
|
|
2464
|
+
type OwnerMigrationPolicy = "None" | "Automatic" | "Manual" | "Server";
|
|
2453
2465
|
interface PaginationRequest {
|
|
2454
2466
|
/** Continuation token returned as a result in a previous FindLobbies call. Cannot be specified by clients. */
|
|
2455
2467
|
ContinuationToken?: string;
|
|
@@ -2551,8 +2563,9 @@ interface Port {
|
|
|
2551
2563
|
/** The number for the port. */
|
|
2552
2564
|
Num: number;
|
|
2553
2565
|
/** The protocol for the port. */
|
|
2554
|
-
Protocol:
|
|
2566
|
+
Protocol: ProtocolType;
|
|
2555
2567
|
}
|
|
2568
|
+
type ProtocolType = "TCP" | "UDP";
|
|
2556
2569
|
interface PublicIpAddress {
|
|
2557
2570
|
/** FQDN of the public IP */
|
|
2558
2571
|
FQDN: string;
|
|
@@ -2571,7 +2584,7 @@ interface QueueRuleAttribute {
|
|
|
2571
2584
|
/** Specifies which attribute in a ticket to use. */
|
|
2572
2585
|
Path: string;
|
|
2573
2586
|
/** Specifies which source the attribute comes from. */
|
|
2574
|
-
Source:
|
|
2587
|
+
Source: AttributeSource;
|
|
2575
2588
|
}
|
|
2576
2589
|
interface QuotaChange {
|
|
2577
2590
|
/** A brief description of the requested changes. */
|
|
@@ -2647,8 +2660,8 @@ interface RequestMultiplayerServerAndTokenRequest extends IPlayFabRequestCommon
|
|
|
2647
2660
|
*/
|
|
2648
2661
|
PreferredRegions: string[];
|
|
2649
2662
|
/**
|
|
2650
|
-
* Data encoded as a string that is passed to the game server when requested. This can be used to
|
|
2651
|
-
*
|
|
2663
|
+
* Data encoded as a string that is passed to the game server when requested. This can be used to communicate information
|
|
2664
|
+
* such as game mode or map through the request flow. Maximum size is 8KB
|
|
2652
2665
|
*/
|
|
2653
2666
|
SessionCookie?: string;
|
|
2654
2667
|
/** A guid string session ID created track the multiplayer server session over its life. */
|
|
@@ -2702,8 +2715,8 @@ interface RequestMultiplayerServerRequest extends IPlayFabRequestCommon {
|
|
|
2702
2715
|
*/
|
|
2703
2716
|
PreferredRegions: string[];
|
|
2704
2717
|
/**
|
|
2705
|
-
* Data encoded as a string that is passed to the game server when requested. This can be used to
|
|
2706
|
-
*
|
|
2718
|
+
* Data encoded as a string that is passed to the game server when requested. This can be used to communicate information
|
|
2719
|
+
* such as game mode or map through the request flow. Maximum size is 8KB
|
|
2707
2720
|
*/
|
|
2708
2721
|
SessionCookie?: string;
|
|
2709
2722
|
/** A guid string session ID created track the multiplayer server session over its life. */
|
|
@@ -2916,7 +2929,7 @@ interface SetIntersectionRule {
|
|
|
2916
2929
|
* Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
|
|
2917
2930
|
* profile.
|
|
2918
2931
|
*/
|
|
2919
|
-
AttributeNotSpecifiedBehavior:
|
|
2932
|
+
AttributeNotSpecifiedBehavior: AttributeNotSpecifiedBehavior;
|
|
2920
2933
|
/**
|
|
2921
2934
|
* Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this
|
|
2922
2935
|
* is set, MinIntersectionSize is ignored.
|
|
@@ -3002,7 +3015,7 @@ interface StringEqualityRule {
|
|
|
3002
3015
|
* Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
|
|
3003
3016
|
* profile.
|
|
3004
3017
|
*/
|
|
3005
|
-
AttributeNotSpecifiedBehavior:
|
|
3018
|
+
AttributeNotSpecifiedBehavior: AttributeNotSpecifiedBehavior;
|
|
3006
3019
|
/**
|
|
3007
3020
|
* The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that
|
|
3008
3021
|
* AttributeNotSpecifiedBehavior is false).
|
|
@@ -3048,7 +3061,7 @@ interface SubscribeToLobbyResourceRequest extends IPlayFabRequestCommon {
|
|
|
3048
3061
|
* owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a
|
|
3049
3062
|
* member of a lobby to receive lobby invites.
|
|
3050
3063
|
*/
|
|
3051
|
-
Type:
|
|
3064
|
+
Type: SubscriptionType;
|
|
3052
3065
|
}
|
|
3053
3066
|
interface SubscribeToLobbyResourceResult extends IPlayFabResultCommon {
|
|
3054
3067
|
/** Topic will be returned in all notifications that are the result of this subscription. */
|
|
@@ -3081,6 +3094,7 @@ interface SubscribeToMatchResourceResult extends IPlayFabResultCommon {
|
|
|
3081
3094
|
/** Matchmaking resource */
|
|
3082
3095
|
Topic: string;
|
|
3083
3096
|
}
|
|
3097
|
+
type SubscriptionType = "LobbyChange" | "LobbyInvite";
|
|
3084
3098
|
interface TeamDifferenceRule {
|
|
3085
3099
|
/** Description of the attribute used by this rule to match teams. */
|
|
3086
3100
|
Attribute: QueueRuleAttribute;
|
|
@@ -3133,6 +3147,7 @@ interface TeamTicketSizeSimilarityRule {
|
|
|
3133
3147
|
*/
|
|
3134
3148
|
SecondsUntilOptional?: number;
|
|
3135
3149
|
}
|
|
3150
|
+
type TitleMultiplayerServerEnabledStatus = "Initializing" | "Enabled" | "Disabled";
|
|
3136
3151
|
interface TitleMultiplayerServersQuotas {
|
|
3137
3152
|
/** The core capacity for the various regions and VM Family */
|
|
3138
3153
|
CoreCapacities?: CoreCapacity[];
|
|
@@ -3158,7 +3173,7 @@ interface UnsubscribeFromLobbyResourceRequest extends IPlayFabRequestCommon {
|
|
|
3158
3173
|
/** Version number passed for the subscription of this resource. */
|
|
3159
3174
|
SubscriptionVersion: number;
|
|
3160
3175
|
/** Subscription type. */
|
|
3161
|
-
Type:
|
|
3176
|
+
Type: SubscriptionType;
|
|
3162
3177
|
}
|
|
3163
3178
|
interface UnsubscribeFromMatchResourceRequest extends IPlayFabRequestCommon {
|
|
3164
3179
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
@@ -3254,7 +3269,7 @@ interface UpdateLobbyRequest extends IPlayFabRequestCommon {
|
|
|
3254
3269
|
* its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
|
|
3255
3270
|
* join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
|
|
3256
3271
|
*/
|
|
3257
|
-
AccessPolicy?:
|
|
3272
|
+
AccessPolicy?: AccessPolicy;
|
|
3258
3273
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
3259
3274
|
CustomTags?: Record<string, string | null>;
|
|
3260
3275
|
/**
|
|
@@ -3294,7 +3309,7 @@ interface UpdateLobbyRequest extends IPlayFabRequestCommon {
|
|
|
3294
3309
|
* A setting indicating whether the lobby is locked. May be 'Unlocked' or 'Locked'. When Locked new members are not allowed
|
|
3295
3310
|
* to join. Defaults to 'Unlocked' on creation. Can only be changed by the lobby owner.
|
|
3296
3311
|
*/
|
|
3297
|
-
MembershipLock?:
|
|
3312
|
+
MembershipLock?: MembershipLock;
|
|
3298
3313
|
/**
|
|
3299
3314
|
* The lobby owner. Optional. Set to transfer ownership of the lobby. If client - owned and 'Automatic' - The Lobby service
|
|
3300
3315
|
* will automatically assign another connected owner when the current owner leaves or disconnects. useConnections must be
|
|
@@ -3417,13 +3432,13 @@ interface VmStartupScriptPortRequest {
|
|
|
3417
3432
|
/** The name for the port. */
|
|
3418
3433
|
Name: string;
|
|
3419
3434
|
/** The protocol for the port. */
|
|
3420
|
-
Protocol:
|
|
3435
|
+
Protocol: ProtocolType;
|
|
3421
3436
|
}
|
|
3422
3437
|
interface VmStartupScriptPortRequestParams {
|
|
3423
3438
|
/** The name for the port. */
|
|
3424
3439
|
Name: string;
|
|
3425
3440
|
/** The protocol for the port. */
|
|
3426
|
-
Protocol:
|
|
3441
|
+
Protocol: ProtocolType;
|
|
3427
3442
|
}
|
|
3428
3443
|
interface WindowsCrashDumpConfiguration {
|
|
3429
3444
|
/** See https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps for valid values. */
|
|
@@ -3542,8 +3557,8 @@ declare class PlayFabMultiplayerApi extends PlayFabCommon {
|
|
|
3542
3557
|
* "Deaths"
|
|
3543
3558
|
* ],
|
|
3544
3559
|
* "InitialSettingsModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf",
|
|
3545
|
-
* "MatchResultStartTimeUtc": "2025-06-
|
|
3546
|
-
* "MatchResultEndTimeUtc": "2025-06-
|
|
3560
|
+
* "MatchResultStartTimeUtc": "2025-06-20T13:31:18.566Z",
|
|
3561
|
+
* "MatchResultEndTimeUtc": "2025-06-20T14:01:18.566Z",
|
|
3547
3562
|
* "MaxIterations": 100,
|
|
3548
3563
|
* "AnomalousMatchResultIgnoreThreshold": -20.0
|
|
3549
3564
|
* });
|
|
@@ -5561,8 +5576,8 @@ declare class PlayFabMultiplayerApi extends PlayFabCommon {
|
|
|
5561
5576
|
* "Rank": 1
|
|
5562
5577
|
* }
|
|
5563
5578
|
* ],
|
|
5564
|
-
* "StartDateTimeUtc": "2025-06-
|
|
5565
|
-
* "EndDateTimeUtc": "2025-06-
|
|
5579
|
+
* "StartDateTimeUtc": "2025-06-20T13:31:18.556Z",
|
|
5580
|
+
* "EndDateTimeUtc": "2025-06-20T14:01:18.556Z"
|
|
5566
5581
|
* }
|
|
5567
5582
|
* });
|
|
5568
5583
|
*/
|
package/dist/Multiplayer.js
CHANGED
package/dist/Profiles.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
|
2
2
|
|
|
3
|
+
type EffectType = "Allow" | "Deny";
|
|
3
4
|
interface EntityDataObject {
|
|
4
5
|
/** Un-escaped JSON object, if DataAsObject is true. */
|
|
5
6
|
DataObject?: any;
|
|
@@ -41,7 +42,7 @@ interface EntityPermissionStatement {
|
|
|
41
42
|
/** Additional conditions to be applied for entity resources. */
|
|
42
43
|
Condition?: any;
|
|
43
44
|
/** The effect this statement will have. It may be either Allow or Deny */
|
|
44
|
-
Effect:
|
|
45
|
+
Effect: EffectType;
|
|
45
46
|
/** The principal this statement will effect. */
|
|
46
47
|
Principal: any;
|
|
47
48
|
/** The resource this statements effects. Similar to 'pfrn:data--title![Title ID]/Profile/*' */
|
|
@@ -175,6 +176,7 @@ interface GetTitlePlayersFromXboxLiveIDsRequest extends IPlayFabRequestCommon {
|
|
|
175
176
|
/** List of Xbox Live XUIDs */
|
|
176
177
|
XboxLiveIds: string[];
|
|
177
178
|
}
|
|
179
|
+
type OperationTypes = "Created" | "Updated" | "Deleted" | "None";
|
|
178
180
|
interface SetAvatarUrlRequest extends IPlayFabRequestCommon {
|
|
179
181
|
/** URL of the avatar image. If empty, it removes the existing avatar URL */
|
|
180
182
|
AvatarUrl: string;
|
|
@@ -191,7 +193,7 @@ interface SetAvatarUrlResponse extends IPlayFabResultCommon {
|
|
|
191
193
|
/** The optional entity to perform this action on. Defaults to the currently logged in entity. */
|
|
192
194
|
Entity?: EntityKey;
|
|
193
195
|
/** The type of operation that occurred on the profile's avatar URL */
|
|
194
|
-
OperationResult?:
|
|
196
|
+
OperationResult?: OperationTypes;
|
|
195
197
|
/** The updated version of the profile after the avatar URL update */
|
|
196
198
|
ProfileVersion?: number;
|
|
197
199
|
}
|
|
@@ -207,7 +209,7 @@ interface SetDisplayNameRequest extends IPlayFabRequestCommon {
|
|
|
207
209
|
}
|
|
208
210
|
interface SetDisplayNameResponse extends IPlayFabResultCommon {
|
|
209
211
|
/** The type of operation that occured on the profile's display name */
|
|
210
|
-
OperationResult?:
|
|
212
|
+
OperationResult?: OperationTypes;
|
|
211
213
|
/** The updated version of the profile after the display name update */
|
|
212
214
|
VersionNumber?: number;
|
|
213
215
|
}
|
|
@@ -246,7 +248,7 @@ interface SetProfileLanguageRequest extends IPlayFabRequestCommon {
|
|
|
246
248
|
}
|
|
247
249
|
interface SetProfileLanguageResponse extends IPlayFabResultCommon {
|
|
248
250
|
/** The type of operation that occured on the profile's language */
|
|
249
|
-
OperationResult?:
|
|
251
|
+
OperationResult?: OperationTypes;
|
|
250
252
|
/** The updated version of the profile after the language update */
|
|
251
253
|
VersionNumber?: number;
|
|
252
254
|
}
|
package/dist/Profiles.js
CHANGED
package/dist/Progression.d.ts
CHANGED
|
@@ -111,6 +111,7 @@ interface EntityStatisticValue {
|
|
|
111
111
|
/** Statistic version */
|
|
112
112
|
Version: number;
|
|
113
113
|
}
|
|
114
|
+
type ExternalFriendSources = "None" | "Steam" | "Facebook" | "Xbox" | "Psn" | "All";
|
|
114
115
|
interface GetEntityLeaderboardRequest extends IPlayFabRequestCommon {
|
|
115
116
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
116
117
|
CustomTags?: Record<string, string | null>;
|
|
@@ -144,7 +145,7 @@ interface GetFriendLeaderboardForEntityRequest extends IPlayFabRequestCommon {
|
|
|
144
145
|
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
|
145
146
|
* comma-separated list of platforms.
|
|
146
147
|
*/
|
|
147
|
-
ExternalFriendSources?:
|
|
148
|
+
ExternalFriendSources?: ExternalFriendSources;
|
|
148
149
|
/** Name of the leaderboard. */
|
|
149
150
|
LeaderboardName: string;
|
|
150
151
|
/** Optional version of the leaderboard, defaults to current version. */
|
|
@@ -308,7 +309,7 @@ interface LeaderboardColumn {
|
|
|
308
309
|
/** A name for the leaderboard column, unique per leaderboard definition. */
|
|
309
310
|
Name: string;
|
|
310
311
|
/** The sort direction for this column. */
|
|
311
|
-
SortDirection:
|
|
312
|
+
SortDirection: LeaderboardSortDirection;
|
|
312
313
|
}
|
|
313
314
|
interface LeaderboardDefinition {
|
|
314
315
|
/** Sort direction of the leaderboard columns, cannot be changed after creation. */
|
|
@@ -345,6 +346,7 @@ interface LeaderboardEntryUpdate {
|
|
|
345
346
|
*/
|
|
346
347
|
Scores?: string[];
|
|
347
348
|
}
|
|
349
|
+
type LeaderboardSortDirection = "Descending" | "Ascending";
|
|
348
350
|
interface LinkedStatisticColumn {
|
|
349
351
|
/** The name of the statistic column that this leaderboard column is sourced from. */
|
|
350
352
|
LinkedStatisticColumnName: string;
|
|
@@ -369,9 +371,11 @@ interface ListStatisticDefinitionsResponse extends IPlayFabResultCommon {
|
|
|
369
371
|
/** List of statistic definitions for the title. */
|
|
370
372
|
StatisticDefinitions?: StatisticDefinition[];
|
|
371
373
|
}
|
|
374
|
+
type ResetInterval = "Manual" | "Hour" | "Day" | "Week" | "Month";
|
|
375
|
+
type StatisticAggregationMethod = "Last" | "Min" | "Max" | "Sum";
|
|
372
376
|
interface StatisticColumn {
|
|
373
377
|
/** Aggregation method for calculating new value of a statistic. */
|
|
374
|
-
AggregationMethod:
|
|
378
|
+
AggregationMethod: StatisticAggregationMethod;
|
|
375
379
|
/** Name of the statistic column, as originally configured. */
|
|
376
380
|
Name: string;
|
|
377
381
|
}
|
|
@@ -492,7 +496,7 @@ interface VersionConfiguration {
|
|
|
492
496
|
* the reset will occur at the start ofthe next Monday in UTC time. When using Month interval the reset will occur at the
|
|
493
497
|
* start of the nextmonth in UTC time.
|
|
494
498
|
*/
|
|
495
|
-
ResetInterval:
|
|
499
|
+
ResetInterval: ResetInterval;
|
|
496
500
|
}
|
|
497
501
|
|
|
498
502
|
declare class PlayFabProgressionApi extends PlayFabCommon {
|