async-playfab-web-sdk 1.192.250526-3 → 1.192.250526-5
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.d.ts +179 -39
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +2386 -195
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +32 -5
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +2235 -321
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +199 -31
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +137 -18
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +1145 -106
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +200 -13
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +164 -17
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +267 -28
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +33 -7
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +5 -2
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.d.ts +271 -0
- package/dist/Matchmaker.js +8 -0
- package/dist/Matchmaker.js.map +1 -0
- package/dist/Multiplayer.d.ts +2697 -169
- package/dist/Multiplayer.js +2 -2
- package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +3 -5
- package/dist/Profiles.d.ts +163 -19
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +287 -35
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +1904 -242
- package/dist/Server.js +2 -2
- package/dist/chunk-3I6ONUUQ.js +237 -0
- package/dist/chunk-3I6ONUUQ.js.map +1 -0
- package/dist/chunk-3O5QT4SL.js +2477 -0
- package/dist/chunk-3O5QT4SL.js.map +1 -0
- package/dist/chunk-3OBHYLBF.js +2673 -0
- package/dist/chunk-3OBHYLBF.js.map +1 -0
- package/dist/chunk-57KYHGBO.js +421 -0
- package/dist/chunk-57KYHGBO.js.map +1 -0
- package/dist/{chunk-J4QS5VX5.js → chunk-5CWZN75H.js} +6 -3
- package/dist/chunk-5CWZN75H.js.map +1 -0
- package/dist/chunk-73SVDH45.js +197 -0
- package/dist/chunk-73SVDH45.js.map +1 -0
- package/dist/chunk-ADHTNFTN.js +175 -0
- package/dist/chunk-ADHTNFTN.js.map +1 -0
- package/dist/chunk-C7U2JQNZ.js +76 -0
- package/dist/chunk-C7U2JQNZ.js.map +1 -0
- package/dist/{chunk-SGSEOIKS.js → chunk-GAZYZIK2.js} +34 -8
- package/dist/chunk-GAZYZIK2.js.map +1 -0
- package/dist/chunk-J54WY4UN.js +413 -0
- package/dist/chunk-J54WY4UN.js.map +1 -0
- package/dist/chunk-NFWQ4MMZ.js +1048 -0
- package/dist/chunk-NFWQ4MMZ.js.map +1 -0
- package/dist/{chunk-A7VD6ALV.js → chunk-P7UVG26J.js} +167 -32
- package/dist/chunk-P7UVG26J.js.map +1 -0
- package/dist/chunk-PFXZB4UN.js +2387 -0
- package/dist/chunk-PFXZB4UN.js.map +1 -0
- package/dist/{chunk-X34XZJB6.js → chunk-QNGQW3YB.js} +28 -6
- package/dist/chunk-QNGQW3YB.js.map +1 -0
- package/dist/chunk-SQWILU5T.js +270 -0
- package/dist/chunk-SQWILU5T.js.map +1 -0
- package/dist/{chunk-JGDO2ZE3.js → chunk-SR2RIRLX.js} +1482 -175
- package/dist/chunk-SR2RIRLX.js.map +1 -0
- package/dist/{chunk-62SULWOK.js → chunk-XVDYM74A.js} +17 -14
- package/dist/chunk-XVDYM74A.js.map +1 -0
- package/dist/chunk-ZW4TJ3MQ.js +225 -0
- package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
- package/dist/index.d.ts +7 -6
- package/dist/index.js +29 -25
- package/package.json +2 -2
- package/dist/chunk-3FCAP7OZ.js +0 -187
- package/dist/chunk-3FCAP7OZ.js.map +0 -1
- package/dist/chunk-62SULWOK.js.map +0 -1
- package/dist/chunk-A7VD6ALV.js.map +0 -1
- package/dist/chunk-BX65UND2.js +0 -632
- package/dist/chunk-BX65UND2.js.map +0 -1
- package/dist/chunk-J4QS5VX5.js.map +0 -1
- package/dist/chunk-JGDO2ZE3.js.map +0 -1
- package/dist/chunk-POMI7LEF.js +0 -76
- package/dist/chunk-POMI7LEF.js.map +0 -1
- package/dist/chunk-Q3OF3AOJ.js +0 -97
- package/dist/chunk-Q3OF3AOJ.js.map +0 -1
- package/dist/chunk-QUZHVSVZ.js +0 -174
- package/dist/chunk-QUZHVSVZ.js.map +0 -1
- package/dist/chunk-QVLIVSO4.js +0 -1147
- package/dist/chunk-QVLIVSO4.js.map +0 -1
- package/dist/chunk-R7V7DFCF.js +0 -103
- package/dist/chunk-R7V7DFCF.js.map +0 -1
- package/dist/chunk-SGSEOIKS.js.map +0 -1
- package/dist/chunk-UOHHNVCJ.js +0 -119
- package/dist/chunk-UOHHNVCJ.js.map +0 -1
- package/dist/chunk-USKFWNQK.js +0 -384
- package/dist/chunk-USKFWNQK.js.map +0 -1
- package/dist/chunk-UX7LFJCX.js +0 -61
- package/dist/chunk-UX7LFJCX.js.map +0 -1
- package/dist/chunk-X34XZJB6.js.map +0 -1
- package/dist/chunk-YNZF3WXS.js +0 -882
- package/dist/chunk-YNZF3WXS.js.map +0 -1
package/dist/Server.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
|
2
2
|
|
3
3
|
interface AdCampaignAttribution {
|
4
4
|
/** UTC time stamp of attribution */
|
@@ -126,8 +126,20 @@ interface BanInfo {
|
|
126
126
|
Created?: string;
|
127
127
|
/** The time when this ban expires. Permanent bans do not have expiration date. */
|
128
128
|
Expires?: string;
|
129
|
+
/**
|
130
|
+
* Whether or not the Microsoft family members are included in the ban. This property is deprecated and does not work
|
131
|
+
* anymore.
|
132
|
+
* @deprecated Please use UserFamilyType instead.
|
133
|
+
*/
|
134
|
+
IncludeMicrosoftFamily?: boolean;
|
129
135
|
/** The IP address on which the ban was applied. May affect multiple players. */
|
130
136
|
IPAddress?: string;
|
137
|
+
/**
|
138
|
+
* The MAC address on which the ban was applied. May affect multiple players. This property is deprecated and does not work
|
139
|
+
* anymore.
|
140
|
+
* @deprecated Do not use
|
141
|
+
*/
|
142
|
+
MACAddress?: string;
|
131
143
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
132
144
|
PlayFabId?: string;
|
133
145
|
/** The reason why this ban was applied. */
|
@@ -138,8 +150,19 @@ interface BanInfo {
|
|
138
150
|
interface BanRequest {
|
139
151
|
/** The duration in hours for the ban. Leave this blank for a permanent ban. */
|
140
152
|
DurationInHours?: number;
|
153
|
+
/**
|
154
|
+
* Whether the Microsoft family members should be included in the ban. May affect multiple players. This property is
|
155
|
+
* deprecated and does not work anymore.
|
156
|
+
* @deprecated Please use UserFamilyType instead.
|
157
|
+
*/
|
158
|
+
IncludeMicrosoftFamily?: boolean;
|
141
159
|
/** IP address to be banned. May affect multiple players. */
|
142
160
|
IPAddress?: string;
|
161
|
+
/**
|
162
|
+
* MAC address to be banned. May affect multiple players. This property is deprecated and does not work anymore.
|
163
|
+
* @deprecated Do not use
|
164
|
+
*/
|
165
|
+
MACAddress?: string;
|
143
166
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
144
167
|
PlayFabId: string;
|
145
168
|
/** The reason for this ban. Maximum 140 characters. */
|
@@ -216,7 +239,7 @@ interface CatalogItem {
|
|
216
239
|
RealCurrencyPrices?: Record<string, number>;
|
217
240
|
/** list of item tags */
|
218
241
|
Tags?: string[];
|
219
|
-
/** price of this item in virtual currencies and
|
242
|
+
/** price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
|
220
243
|
VirtualCurrencyPrices?: Record<string, number>;
|
221
244
|
}
|
222
245
|
interface CatalogItemBundleInfo {
|
@@ -236,7 +259,7 @@ interface CatalogItemConsumableInfo {
|
|
236
259
|
/**
|
237
260
|
* duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
|
238
261
|
* (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on
|
239
|
-
* this item
|
262
|
+
* this item's details have completed)
|
240
263
|
*/
|
241
264
|
UsagePeriod?: number;
|
242
265
|
/**
|
@@ -278,9 +301,9 @@ interface CharacterLeaderboardEntry {
|
|
278
301
|
DisplayName?: string;
|
279
302
|
/** PlayFab unique identifier of the user for this leaderboard entry. */
|
280
303
|
PlayFabId?: string;
|
281
|
-
/** User
|
304
|
+
/** User's overall position in the leaderboard. */
|
282
305
|
Position: number;
|
283
|
-
/** Specific value of the user
|
306
|
+
/** Specific value of the user's statistic. */
|
284
307
|
StatValue: number;
|
285
308
|
}
|
286
309
|
interface CharacterResult {
|
@@ -334,9 +357,9 @@ interface CreateSharedGroupResult extends IPlayFabResultCommon {
|
|
334
357
|
SharedGroupId?: string;
|
335
358
|
}
|
336
359
|
interface CustomPropertyDetails {
|
337
|
-
/** The custom property
|
360
|
+
/** The custom property's name. */
|
338
361
|
Name?: string;
|
339
|
-
/** The custom property
|
362
|
+
/** The custom property's value. */
|
340
363
|
Value?: any;
|
341
364
|
}
|
342
365
|
interface DeleteCharacterFromUserRequest extends IPlayFabRequestCommon {
|
@@ -347,7 +370,7 @@ interface DeleteCharacterFromUserRequest extends IPlayFabRequestCommon {
|
|
347
370
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
348
371
|
PlayFabId: string;
|
349
372
|
/**
|
350
|
-
* If true, the character
|
373
|
+
* If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those
|
351
374
|
* items.
|
352
375
|
*/
|
353
376
|
SaveCharacterInventory: boolean;
|
@@ -365,7 +388,7 @@ interface DeletePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
|
|
365
388
|
CustomTags?: Record<string, string | null>;
|
366
389
|
/**
|
367
390
|
* Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the
|
368
|
-
* player
|
391
|
+
* player's properties have not been updated by any other clients since the last version.
|
369
392
|
*/
|
370
393
|
ExpectedPropertiesVersion?: number;
|
371
394
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
@@ -379,7 +402,7 @@ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
|
|
379
402
|
/** PlayFab unique identifier of the user whose properties were deleted. */
|
380
403
|
PlayFabId?: string;
|
381
404
|
/**
|
382
|
-
* Indicates the current version of a player
|
405
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
383
406
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
384
407
|
*/
|
385
408
|
PropertiesVersion: number;
|
@@ -400,6 +423,26 @@ interface DeleteSharedGroupRequest extends IPlayFabRequestCommon {
|
|
400
423
|
/** Unique identifier for the shared group. */
|
401
424
|
SharedGroupId: string;
|
402
425
|
}
|
426
|
+
/** @deprecated Do not use */
|
427
|
+
interface DeleteUsersRequest extends IPlayFabRequestCommon {
|
428
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
429
|
+
CustomTags?: Record<string, string | null>;
|
430
|
+
/** An array of unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
431
|
+
PlayFabIds: string[];
|
432
|
+
}
|
433
|
+
/** @deprecated Do not use */
|
434
|
+
interface DeleteUsersResult extends IPlayFabResultCommon {
|
435
|
+
}
|
436
|
+
/** @deprecated Do not use */
|
437
|
+
interface DeregisterGameRequest extends IPlayFabRequestCommon {
|
438
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
439
|
+
CustomTags?: Record<string, string | null>;
|
440
|
+
/** Unique identifier for the Game Server Instance that is being deregistered. */
|
441
|
+
LobbyId: string;
|
442
|
+
}
|
443
|
+
/** @deprecated Do not use */
|
444
|
+
interface DeregisterGameResponse extends IPlayFabResultCommon {
|
445
|
+
}
|
403
446
|
interface EmptyResult extends IPlayFabResultCommon {
|
404
447
|
}
|
405
448
|
interface EntityKey {
|
@@ -407,6 +450,11 @@ interface EntityKey {
|
|
407
450
|
Id: string;
|
408
451
|
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
409
452
|
Type?: string;
|
453
|
+
/**
|
454
|
+
* Alternate name for Type.
|
455
|
+
* @deprecated Please use Type instead.
|
456
|
+
*/
|
457
|
+
TypeString?: string;
|
410
458
|
}
|
411
459
|
interface EntityTokenResponse {
|
412
460
|
/** The entity id and type. */
|
@@ -473,19 +521,19 @@ interface ExecuteCloudScriptServerRequest extends IPlayFabRequestCommon {
|
|
473
521
|
/** Object that is passed in to the function as the first argument */
|
474
522
|
FunctionParameter?: any;
|
475
523
|
/**
|
476
|
-
* Generate a
|
524
|
+
* Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other
|
477
525
|
* contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
|
478
526
|
*/
|
479
527
|
GeneratePlayStreamEvent?: boolean;
|
480
528
|
/** The unique user identifier for the player on whose behalf the script is being run */
|
481
529
|
PlayFabId: string;
|
482
530
|
/**
|
483
|
-
* Option for which revision of the CloudScript to execute.
|
484
|
-
* executes the current live, published revision, and
|
485
|
-
*
|
531
|
+
* Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
|
532
|
+
* executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
|
533
|
+
* 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.
|
486
534
|
*/
|
487
535
|
RevisionSelection?: string;
|
488
|
-
/** The specivic revision to execute, when RevisionSelection is set to
|
536
|
+
/** The specivic revision to execute, when RevisionSelection is set to 'Specific' */
|
489
537
|
SpecificRevision?: number;
|
490
538
|
}
|
491
539
|
interface FacebookInstantGamesPlayFabIdPair {
|
@@ -501,6 +549,11 @@ interface FacebookPlayFabIdPair {
|
|
501
549
|
PlayFabId?: string;
|
502
550
|
}
|
503
551
|
interface FriendInfo {
|
552
|
+
/**
|
553
|
+
* This field is not populated.
|
554
|
+
* @deprecated Do not use
|
555
|
+
*/
|
556
|
+
CurrentMatchmakerLobbyId?: string;
|
504
557
|
/** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */
|
505
558
|
FacebookInfo?: UserFacebookInfo;
|
506
559
|
/** PlayFab unique identifier for this friend. */
|
@@ -540,6 +593,21 @@ interface GenericServiceId {
|
|
540
593
|
/** Unique identifier of the player in that service. */
|
541
594
|
UserId: string;
|
542
595
|
}
|
596
|
+
/** @deprecated Do not use */
|
597
|
+
interface GetActionGroupResult {
|
598
|
+
/** Action Group ID */
|
599
|
+
Id?: string;
|
600
|
+
/** Action Group name */
|
601
|
+
Name: string;
|
602
|
+
}
|
603
|
+
/** @deprecated Do not use */
|
604
|
+
interface GetAllActionGroupsRequest extends IPlayFabRequestCommon {
|
605
|
+
}
|
606
|
+
/** @deprecated Do not use */
|
607
|
+
interface GetAllActionGroupsResult extends IPlayFabResultCommon {
|
608
|
+
/** List of Action Groups. */
|
609
|
+
ActionGroups: GetActionGroupResult[];
|
610
|
+
}
|
543
611
|
interface GetAllSegmentsRequest extends IPlayFabRequestCommon {
|
544
612
|
}
|
545
613
|
interface GetAllSegmentsResult extends IPlayFabResultCommon {
|
@@ -603,6 +671,11 @@ interface GetCharacterInventoryResult extends IPlayFabResultCommon {
|
|
603
671
|
VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
|
604
672
|
}
|
605
673
|
interface GetCharacterLeaderboardRequest extends IPlayFabRequestCommon {
|
674
|
+
/**
|
675
|
+
* Optional character type on which to filter the leaderboard entries.
|
676
|
+
* @deprecated Do not use
|
677
|
+
*/
|
678
|
+
CharacterType?: string;
|
606
679
|
/** Maximum number of entries to retrieve. */
|
607
680
|
MaxResultsCount: number;
|
608
681
|
/** First entry in the leaderboard to be retrieved. */
|
@@ -647,10 +720,20 @@ interface GetFriendLeaderboardRequest extends IPlayFabRequestCommon {
|
|
647
720
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
648
721
|
CustomTags?: Record<string, string | null>;
|
649
722
|
/**
|
650
|
-
* Indicates which other platforms
|
723
|
+
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
651
724
|
* comma-separated list of platforms.
|
652
725
|
*/
|
653
726
|
ExternalPlatformFriends?: string;
|
727
|
+
/**
|
728
|
+
* Indicates whether Facebook friends should be included in the response. Default is true.
|
729
|
+
* @deprecated Please use ExternalPlatformFriends instead.
|
730
|
+
*/
|
731
|
+
IncludeFacebookFriends?: boolean;
|
732
|
+
/**
|
733
|
+
* Indicates whether Steam service friends should be included in the response. Default is true.
|
734
|
+
* @deprecated Please use ExternalPlatformFriends instead.
|
735
|
+
*/
|
736
|
+
IncludeSteamFriends?: boolean;
|
654
737
|
/** Maximum number of entries to retrieve. */
|
655
738
|
MaxResultsCount: number;
|
656
739
|
/** The player whose friend leaderboard to get */
|
@@ -658,13 +741,15 @@ interface GetFriendLeaderboardRequest extends IPlayFabRequestCommon {
|
|
658
741
|
/**
|
659
742
|
* If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
|
660
743
|
* only the allowed client profile properties for the title may be requested. These allowed properties are configured in
|
661
|
-
* the Game Manager
|
744
|
+
* the Game Manager "Client Profile Options" tab in the "Settings" section.
|
662
745
|
*/
|
663
746
|
ProfileConstraints?: PlayerProfileViewConstraints;
|
664
747
|
/** Position in the leaderboard to start this listing (defaults to the first entry). */
|
665
748
|
StartPosition: number;
|
666
749
|
/** Statistic used to rank friends for this leaderboard. */
|
667
750
|
StatisticName: string;
|
751
|
+
/** If set to false, Version is considered null. If true, uses the specified Version */
|
752
|
+
UseSpecificVersion?: boolean;
|
668
753
|
/** The version of the leaderboard to get. */
|
669
754
|
Version?: number;
|
670
755
|
/** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
|
@@ -674,16 +759,26 @@ interface GetFriendsListRequest extends IPlayFabRequestCommon {
|
|
674
759
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
675
760
|
CustomTags?: Record<string, string | null>;
|
676
761
|
/**
|
677
|
-
* Indicates which other platforms
|
762
|
+
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
678
763
|
* comma-separated list of platforms.
|
679
764
|
*/
|
680
765
|
ExternalPlatformFriends?: string;
|
766
|
+
/**
|
767
|
+
* Indicates whether Facebook friends should be included in the response. Default is true.
|
768
|
+
* @deprecated Please use ExternalPlatformFriends instead.
|
769
|
+
*/
|
770
|
+
IncludeFacebookFriends?: boolean;
|
771
|
+
/**
|
772
|
+
* Indicates whether Steam service friends should be included in the response. Default is true.
|
773
|
+
* @deprecated Please use ExternalPlatformFriends instead.
|
774
|
+
*/
|
775
|
+
IncludeSteamFriends?: boolean;
|
681
776
|
/** PlayFab identifier of the player whose friend list to get. */
|
682
777
|
PlayFabId: string;
|
683
778
|
/**
|
684
779
|
* If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
|
685
780
|
* only the allowed client profile properties for the title may be requested. These allowed properties are configured in
|
686
|
-
* the Game Manager
|
781
|
+
* the Game Manager "Client Profile Options" tab in the "Settings" section.
|
687
782
|
*/
|
688
783
|
ProfileConstraints?: PlayerProfileViewConstraints;
|
689
784
|
/** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
|
@@ -696,6 +791,11 @@ interface GetFriendsListResult extends IPlayFabResultCommon {
|
|
696
791
|
interface GetLeaderboardAroundCharacterRequest extends IPlayFabRequestCommon {
|
697
792
|
/** Unique PlayFab assigned ID for a specific character owned by a user */
|
698
793
|
CharacterId: string;
|
794
|
+
/**
|
795
|
+
* Optional character type on which to filter the leaderboard entries.
|
796
|
+
* @deprecated Do not use
|
797
|
+
*/
|
798
|
+
CharacterType?: string;
|
699
799
|
/** Maximum number of entries to retrieve. */
|
700
800
|
MaxResultsCount: number;
|
701
801
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
@@ -717,11 +817,13 @@ interface GetLeaderboardAroundUserRequest extends IPlayFabRequestCommon {
|
|
717
817
|
/**
|
718
818
|
* If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
|
719
819
|
* only the allowed client profile properties for the title may be requested. These allowed properties are configured in
|
720
|
-
* the Game Manager
|
820
|
+
* the Game Manager "Client Profile Options" tab in the "Settings" section.
|
721
821
|
*/
|
722
822
|
ProfileConstraints?: PlayerProfileViewConstraints;
|
723
823
|
/** Unique identifier for the title-specific statistic for the leaderboard. */
|
724
824
|
StatisticName: string;
|
825
|
+
/** If set to false, Version is considered null. If true, uses the specified Version */
|
826
|
+
UseSpecificVersion?: boolean;
|
725
827
|
/** The version of the leaderboard to get. */
|
726
828
|
Version?: number;
|
727
829
|
}
|
@@ -734,6 +836,11 @@ interface GetLeaderboardAroundUserResult extends IPlayFabResultCommon {
|
|
734
836
|
Version: number;
|
735
837
|
}
|
736
838
|
interface GetLeaderboardForUsersCharactersRequest extends IPlayFabRequestCommon {
|
839
|
+
/**
|
840
|
+
* Maximum number of entries to retrieve.
|
841
|
+
* @deprecated Please use instead.
|
842
|
+
*/
|
843
|
+
MaxResultsCount?: number;
|
737
844
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
738
845
|
PlayFabId: string;
|
739
846
|
/** Unique identifier for the title-specific statistic for the leaderboard. */
|
@@ -751,13 +858,15 @@ interface GetLeaderboardRequest extends IPlayFabRequestCommon {
|
|
751
858
|
/**
|
752
859
|
* If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
|
753
860
|
* only the allowed client profile properties for the title may be requested. These allowed properties are configured in
|
754
|
-
* the Game Manager
|
861
|
+
* the Game Manager "Client Profile Options" tab in the "Settings" section.
|
755
862
|
*/
|
756
863
|
ProfileConstraints?: PlayerProfileViewConstraints;
|
757
864
|
/** First entry in the leaderboard to be retrieved. */
|
758
865
|
StartPosition: number;
|
759
866
|
/** Unique identifier for the title-specific statistic for the leaderboard. */
|
760
867
|
StatisticName: string;
|
868
|
+
/** If set to false, Version is considered null. If true, uses the specified Version */
|
869
|
+
UseSpecificVersion?: boolean;
|
761
870
|
/** The version of the leaderboard to get. */
|
762
871
|
Version?: number;
|
763
872
|
}
|
@@ -788,19 +897,19 @@ interface GetPlayerCombinedInfoRequestParams {
|
|
788
897
|
GetPlayerStatistics: boolean;
|
789
898
|
/** Whether to get title data. Defaults to false. */
|
790
899
|
GetTitleData: boolean;
|
791
|
-
/** Whether to get the player
|
900
|
+
/** Whether to get the player's account Info. Defaults to false */
|
792
901
|
GetUserAccountInfo: boolean;
|
793
|
-
/** Whether to get the player
|
902
|
+
/** Whether to get the player's custom data. Defaults to false */
|
794
903
|
GetUserData: boolean;
|
795
|
-
/** Whether to get the player
|
904
|
+
/** Whether to get the player's inventory. Defaults to false */
|
796
905
|
GetUserInventory: boolean;
|
797
|
-
/** Whether to get the player
|
906
|
+
/** Whether to get the player's read only data. Defaults to false */
|
798
907
|
GetUserReadOnlyData: boolean;
|
799
|
-
/** Whether to get the player
|
908
|
+
/** Whether to get the player's virtual currency balances. Defaults to false */
|
800
909
|
GetUserVirtualCurrency: boolean;
|
801
910
|
/** Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false */
|
802
911
|
PlayerStatisticNames?: string[];
|
803
|
-
/** Specifies the properties to return from the player profile. Defaults to returning the player
|
912
|
+
/** Specifies the properties to return from the player profile. Defaults to returning the player's display name. */
|
804
913
|
ProfileConstraints?: PlayerProfileViewConstraints;
|
805
914
|
/** Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false */
|
806
915
|
TitleDataKeys?: string[];
|
@@ -838,7 +947,7 @@ interface GetPlayerCombinedInfoResultPayload {
|
|
838
947
|
UserData?: Record<string, UserDataRecord>;
|
839
948
|
/** The version of the UserData that was returned. */
|
840
949
|
UserDataVersion: number;
|
841
|
-
/** Array of inventory items in the user
|
950
|
+
/** Array of inventory items in the user's current inventory. */
|
842
951
|
UserInventory?: ItemInstance[];
|
843
952
|
/** User specific read-only data. */
|
844
953
|
UserReadOnlyData?: Record<string, UserDataRecord>;
|
@@ -852,14 +961,14 @@ interface GetPlayerCombinedInfoResultPayload {
|
|
852
961
|
interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
|
853
962
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
854
963
|
PlayFabId: string;
|
855
|
-
/** Specific property name to search for in the player
|
964
|
+
/** Specific property name to search for in the player's properties. */
|
856
965
|
PropertyName: string;
|
857
966
|
}
|
858
967
|
interface GetPlayerCustomPropertyResult extends IPlayFabResultCommon {
|
859
968
|
/** PlayFab unique identifier of the user whose properties are being returned. */
|
860
969
|
PlayFabId?: string;
|
861
970
|
/**
|
862
|
-
* Indicates the current version of a player
|
971
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
863
972
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
864
973
|
*/
|
865
974
|
PropertiesVersion: number;
|
@@ -874,7 +983,7 @@ interface GetPlayerProfileRequest extends IPlayFabRequestCommon {
|
|
874
983
|
/**
|
875
984
|
* If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
|
876
985
|
* only the allowed client profile properties for the title may be requested. These allowed properties are configured in
|
877
|
-
* the Game Manager
|
986
|
+
* the Game Manager "Client Profile Options" tab in the "Settings" section.
|
878
987
|
*/
|
879
988
|
ProfileConstraints?: PlayerProfileViewConstraints;
|
880
989
|
}
|
@@ -967,7 +1076,7 @@ interface GetPlayerTagsRequest extends IPlayFabRequestCommon {
|
|
967
1076
|
interface GetPlayerTagsResult extends IPlayFabResultCommon {
|
968
1077
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
969
1078
|
PlayFabId: string;
|
970
|
-
/** Canonical tags (including namespace and tag
|
1079
|
+
/** Canonical tags (including namespace and tag's name) for the requested user */
|
971
1080
|
Tags: string[];
|
972
1081
|
}
|
973
1082
|
interface GetPlayFabIDsFromBattleNetAccountIdsRequest extends IPlayFabRequestCommon {
|
@@ -1063,6 +1172,11 @@ interface GetPlayFabIDsFromPSNOnlineIDsResult extends IPlayFabResultCommon {
|
|
1063
1172
|
Data?: PSNOnlinePlayFabIdPair[];
|
1064
1173
|
}
|
1065
1174
|
interface GetPlayFabIDsFromSteamIDsRequest extends IPlayFabRequestCommon {
|
1175
|
+
/**
|
1176
|
+
* Deprecated: Please use SteamStringIDs
|
1177
|
+
* @deprecated Please use SteamStringIDs instead.
|
1178
|
+
*/
|
1179
|
+
SteamIDs?: number[];
|
1066
1180
|
/**
|
1067
1181
|
* Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array
|
1068
1182
|
* cannot exceed 2,000 in length.
|
@@ -1086,7 +1200,7 @@ interface GetPlayFabIDsFromSteamNamesResult extends IPlayFabResultCommon {
|
|
1086
1200
|
}
|
1087
1201
|
interface GetPlayFabIDsFromTwitchIDsRequest extends IPlayFabRequestCommon {
|
1088
1202
|
/**
|
1089
|
-
* Array of unique Twitch identifiers (Twitch
|
1203
|
+
* Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot
|
1090
1204
|
* exceed 2,000 in length.
|
1091
1205
|
*/
|
1092
1206
|
TwitchIds: string[];
|
@@ -1271,6 +1385,20 @@ interface GetUserInventoryResult extends IPlayFabResultCommon {
|
|
1271
1385
|
/** Array of remaining times and timestamps for virtual currencies. */
|
1272
1386
|
VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
|
1273
1387
|
}
|
1388
|
+
/** @deprecated Do not use */
|
1389
|
+
interface GetUserStatisticsRequest extends IPlayFabRequestCommon {
|
1390
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1391
|
+
CustomTags?: Record<string, string | null>;
|
1392
|
+
/** User for whom statistics are being requested. */
|
1393
|
+
PlayFabId: string;
|
1394
|
+
}
|
1395
|
+
/** @deprecated Do not use */
|
1396
|
+
interface GetUserStatisticsResult extends IPlayFabResultCommon {
|
1397
|
+
/** PlayFab unique identifier of the user whose statistics are being returned. */
|
1398
|
+
PlayFabId?: string;
|
1399
|
+
/** User statistics for the requested user. */
|
1400
|
+
UserStatistics?: Record<string, number>;
|
1401
|
+
}
|
1274
1402
|
interface GrantCharacterToUserRequest extends IPlayFabRequestCommon {
|
1275
1403
|
/** Non-unique display name of the character being granted (1-40 characters in length). */
|
1276
1404
|
CharacterName: string;
|
@@ -1301,7 +1429,7 @@ interface GrantedItemInstance {
|
|
1301
1429
|
CharacterId?: string;
|
1302
1430
|
/**
|
1303
1431
|
* A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
|
1304
|
-
* item
|
1432
|
+
* item's custom data.
|
1305
1433
|
*/
|
1306
1434
|
CustomData?: Record<string, string | null>;
|
1307
1435
|
/** CatalogItem.DisplayName at the time this item was purchased. */
|
@@ -1382,7 +1510,7 @@ interface ItemGrant {
|
|
1382
1510
|
CharacterId?: string;
|
1383
1511
|
/**
|
1384
1512
|
* Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
|
1385
|
-
* not begin with a
|
1513
|
+
* not begin with a '!' character or be null.
|
1386
1514
|
*/
|
1387
1515
|
Data?: Record<string, string | null>;
|
1388
1516
|
/** Unique identifier of the catalog item to be granted to the user. */
|
@@ -1409,7 +1537,7 @@ interface ItemInstance {
|
|
1409
1537
|
CatalogVersion?: string;
|
1410
1538
|
/**
|
1411
1539
|
* A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
|
1412
|
-
* item
|
1540
|
+
* item's custom data.
|
1413
1541
|
*/
|
1414
1542
|
CustomData?: Record<string, string | null>;
|
1415
1543
|
/** CatalogItem.DisplayName at the time this item was purchased. */
|
@@ -1481,7 +1609,7 @@ interface LinkNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
|
|
1481
1609
|
CustomTags?: Record<string, string | null>;
|
1482
1610
|
/** If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link. */
|
1483
1611
|
ForceLink?: boolean;
|
1484
|
-
/** Nintendo Switch unique identifier for the user
|
1612
|
+
/** Nintendo Switch unique identifier for the user's device. */
|
1485
1613
|
NintendoSwitchDeviceId: string;
|
1486
1614
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
1487
1615
|
PlayFabId: string;
|
@@ -1549,7 +1677,7 @@ interface LinkXboxAccountRequest extends IPlayFabRequestCommon {
|
|
1549
1677
|
ForceLink?: boolean;
|
1550
1678
|
/** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
|
1551
1679
|
PlayFabId: string;
|
1552
|
-
/** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(
|
1680
|
+
/** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
|
1553
1681
|
XboxToken: string;
|
1554
1682
|
}
|
1555
1683
|
interface LinkXboxAccountResult extends IPlayFabResultCommon {
|
@@ -1564,7 +1692,7 @@ interface ListPlayerCustomPropertiesResult extends IPlayFabResultCommon {
|
|
1564
1692
|
/** Player specific properties and their corresponding values for this title. */
|
1565
1693
|
Properties?: CustomPropertyDetails[];
|
1566
1694
|
/**
|
1567
|
-
* Indicates the current version of a player
|
1695
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
1568
1696
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
1569
1697
|
*/
|
1570
1698
|
PropertiesVersion: number;
|
@@ -1595,10 +1723,49 @@ interface LocationModel {
|
|
1595
1723
|
/** Longitude coordinate of the geographic location. */
|
1596
1724
|
Longitude?: number;
|
1597
1725
|
}
|
1726
|
+
/** @deprecated Do not use */
|
1727
|
+
interface LogEventRequest extends IPlayFabRequestCommon {
|
1728
|
+
/**
|
1729
|
+
* Contains all the data for this event. Event Values can be strings, booleans or numerics (float, double, integer, long)
|
1730
|
+
* and must be consistent on a per-event basis (if the Value for Key 'A' in Event 'Foo' is an integer the first time it is
|
1731
|
+
* sent, it must be an integer in all subsequent 'Foo' events). As with event names, Keys must also not use reserved words
|
1732
|
+
* (see above). Finally, the size of the Body for an event must be less than 32KB (UTF-8 format).
|
1733
|
+
*/
|
1734
|
+
Body?: Record<string, any>;
|
1735
|
+
/**
|
1736
|
+
* For non player-associated events, a unique ID for the entity associated with this event. For player associated events,
|
1737
|
+
* this must be null and PlayFabId must be set.
|
1738
|
+
*/
|
1739
|
+
EntityId?: string;
|
1740
|
+
/**
|
1741
|
+
* For non player-associated events, the type of entity associated with this event. For player associated events, this must
|
1742
|
+
* be null.
|
1743
|
+
*/
|
1744
|
+
EntityType?: string;
|
1745
|
+
/**
|
1746
|
+
* A unique event name which will be used as the table name in the Redshift database. The name will be made lower case, and
|
1747
|
+
* cannot not contain spaces. The use of underscores is recommended, for readability. Events also cannot match reserved
|
1748
|
+
* terms. The PlayFab reserved terms are 'log_in' and 'purchase', 'create' and 'request', while the Redshift reserved terms
|
1749
|
+
* can be found here: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html.
|
1750
|
+
*/
|
1751
|
+
EventName?: string;
|
1752
|
+
/**
|
1753
|
+
* PlayFab User Id of the player associated with this event. For non-player associated events, this must be null and
|
1754
|
+
* EntityId must be set.
|
1755
|
+
*/
|
1756
|
+
PlayFabId?: string;
|
1757
|
+
/** Flag to set event Body as profile details in the Redshift database as well as a standard event. */
|
1758
|
+
ProfileSetEvent: boolean;
|
1759
|
+
/** Optional timestamp for this event. If null, the a timestamp is auto-assigned to the event on the server. */
|
1760
|
+
Timestamp?: string;
|
1761
|
+
}
|
1762
|
+
/** @deprecated Do not use */
|
1763
|
+
interface LogEventResult extends IPlayFabResultCommon {
|
1764
|
+
}
|
1598
1765
|
interface LoginWithAndroidDeviceIDRequest extends IPlayFabRequestCommon {
|
1599
|
-
/** Specific model of the user
|
1766
|
+
/** Specific model of the user's device. */
|
1600
1767
|
AndroidDevice?: string;
|
1601
|
-
/** Android device identifier for the user
|
1768
|
+
/** Android device identifier for the user's device. */
|
1602
1769
|
AndroidDeviceId: string;
|
1603
1770
|
/** Automatically create a PlayFab account if one is not currently linked to this ID. */
|
1604
1771
|
CreateAccount?: boolean;
|
@@ -1606,7 +1773,7 @@ interface LoginWithAndroidDeviceIDRequest extends IPlayFabRequestCommon {
|
|
1606
1773
|
CustomTags?: Record<string, string | null>;
|
1607
1774
|
/** Flags for which pieces of info to return for the user. */
|
1608
1775
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1609
|
-
/** Specific Operating System version for the user
|
1776
|
+
/** Specific Operating System version for the user's device. */
|
1610
1777
|
OS?: string;
|
1611
1778
|
}
|
1612
1779
|
interface LoginWithBattleNetRequest extends IPlayFabRequestCommon {
|
@@ -1618,6 +1785,11 @@ interface LoginWithBattleNetRequest extends IPlayFabRequestCommon {
|
|
1618
1785
|
IdentityToken: string;
|
1619
1786
|
/** Flags for which pieces of info to return for the user. */
|
1620
1787
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1788
|
+
/**
|
1789
|
+
* Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
|
1790
|
+
* @deprecated Do not use
|
1791
|
+
*/
|
1792
|
+
LoginTitlePlayerAccountEntity?: boolean;
|
1621
1793
|
}
|
1622
1794
|
interface LoginWithCustomIDRequest extends IPlayFabRequestCommon {
|
1623
1795
|
/** Automatically create a PlayFab account if one is not currently linked to this ID. */
|
@@ -1634,13 +1806,13 @@ interface LoginWithIOSDeviceIDRequest extends IPlayFabRequestCommon {
|
|
1634
1806
|
CreateAccount?: boolean;
|
1635
1807
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1636
1808
|
CustomTags?: Record<string, string | null>;
|
1637
|
-
/** Vendor-specific iOS identifier for the user
|
1809
|
+
/** Vendor-specific iOS identifier for the user's device. */
|
1638
1810
|
DeviceId: string;
|
1639
|
-
/** Specific model of the user
|
1811
|
+
/** Specific model of the user's device. */
|
1640
1812
|
DeviceModel?: string;
|
1641
1813
|
/** Flags for which pieces of info to return for the user. */
|
1642
1814
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1643
|
-
/** Specific Operating System version for the user
|
1815
|
+
/** Specific Operating System version for the user's device. */
|
1644
1816
|
OS?: string;
|
1645
1817
|
}
|
1646
1818
|
interface LoginWithPSNRequest extends IPlayFabRequestCommon {
|
@@ -1654,6 +1826,11 @@ interface LoginWithPSNRequest extends IPlayFabRequestCommon {
|
|
1654
1826
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1655
1827
|
/** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
|
1656
1828
|
IssuerId?: number;
|
1829
|
+
/**
|
1830
|
+
* Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
|
1831
|
+
* @deprecated Do not use
|
1832
|
+
*/
|
1833
|
+
LoginTitlePlayerAccountEntity?: boolean;
|
1657
1834
|
/** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
|
1658
1835
|
RedirectUri: string;
|
1659
1836
|
}
|
@@ -1664,6 +1841,11 @@ interface LoginWithServerCustomIdRequest extends IPlayFabRequestCommon {
|
|
1664
1841
|
CustomTags?: Record<string, string | null>;
|
1665
1842
|
/** Flags for which pieces of info to return for the user. */
|
1666
1843
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1844
|
+
/**
|
1845
|
+
* Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
|
1846
|
+
* @deprecated Do not use
|
1847
|
+
*/
|
1848
|
+
LoginTitlePlayerAccountEntity?: boolean;
|
1667
1849
|
/** Player secret that is used to verify API request signatures (Enterprise Only). */
|
1668
1850
|
PlayerSecret?: string;
|
1669
1851
|
/** The backend server identifier for this player. */
|
@@ -1676,6 +1858,11 @@ interface LoginWithSteamIdRequest extends IPlayFabRequestCommon {
|
|
1676
1858
|
CustomTags?: Record<string, string | null>;
|
1677
1859
|
/** Flags for which pieces of info to return for the user. */
|
1678
1860
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1861
|
+
/**
|
1862
|
+
* Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
|
1863
|
+
* @deprecated Do not use
|
1864
|
+
*/
|
1865
|
+
LoginTitlePlayerAccountEntity?: boolean;
|
1679
1866
|
/** Unique Steam identifier for a user. */
|
1680
1867
|
SteamId: string;
|
1681
1868
|
}
|
@@ -1686,6 +1873,11 @@ interface LoginWithXboxIdRequest extends IPlayFabRequestCommon {
|
|
1686
1873
|
CustomTags?: Record<string, string | null>;
|
1687
1874
|
/** Flags for which pieces of info to return for the user. */
|
1688
1875
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1876
|
+
/**
|
1877
|
+
* Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
|
1878
|
+
* @deprecated Do not use
|
1879
|
+
*/
|
1880
|
+
LoginTitlePlayerAccountEntity?: boolean;
|
1689
1881
|
/** The id of Xbox Live sandbox. */
|
1690
1882
|
Sandbox: string;
|
1691
1883
|
/** Unique Xbox identifier for a user. */
|
@@ -1698,13 +1890,18 @@ interface LoginWithXboxRequest extends IPlayFabRequestCommon {
|
|
1698
1890
|
CustomTags?: Record<string, string | null>;
|
1699
1891
|
/** Flags for which pieces of info to return for the user. */
|
1700
1892
|
InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
|
1701
|
-
/**
|
1893
|
+
/**
|
1894
|
+
* Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
|
1895
|
+
* @deprecated Do not use
|
1896
|
+
*/
|
1897
|
+
LoginTitlePlayerAccountEntity?: boolean;
|
1898
|
+
/** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
|
1702
1899
|
XboxToken: string;
|
1703
1900
|
}
|
1704
1901
|
interface LogStatement {
|
1705
1902
|
/** Optional object accompanying the message as contextual information */
|
1706
1903
|
Data?: any;
|
1707
|
-
/**
|
1904
|
+
/** 'Debug', 'Info', or 'Error' */
|
1708
1905
|
Level?: string;
|
1709
1906
|
Message?: string;
|
1710
1907
|
}
|
@@ -1720,6 +1917,8 @@ interface MembershipModel {
|
|
1720
1917
|
* overridden, this will be the new expiration time.
|
1721
1918
|
*/
|
1722
1919
|
OverrideExpiration?: string;
|
1920
|
+
/** Whether the override expiration is set. */
|
1921
|
+
OverrideIsSet?: boolean;
|
1723
1922
|
/** The list of subscriptions that this player has for this membership */
|
1724
1923
|
Subscriptions?: SubscriptionModel[];
|
1725
1924
|
}
|
@@ -1749,7 +1948,7 @@ interface ModifyUserVirtualCurrencyResult extends IPlayFabResultCommon {
|
|
1749
1948
|
/** Balance of the virtual currency after modification. */
|
1750
1949
|
Balance: number;
|
1751
1950
|
/**
|
1752
|
-
* Amount added or subtracted from the user
|
1951
|
+
* Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
|
1753
1952
|
* over this value will be discarded.
|
1754
1953
|
*/
|
1755
1954
|
BalanceChange: number;
|
@@ -1805,44 +2004,58 @@ interface NintendoSwitchPlayFabIdPair {
|
|
1805
2004
|
/** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Device identifier. */
|
1806
2005
|
PlayFabId?: string;
|
1807
2006
|
}
|
2007
|
+
/** @deprecated Do not use */
|
2008
|
+
interface NotifyMatchmakerPlayerLeftRequest extends IPlayFabRequestCommon {
|
2009
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2010
|
+
CustomTags?: Record<string, string | null>;
|
2011
|
+
/** Unique identifier of the Game Instance the user is leaving. */
|
2012
|
+
LobbyId: string;
|
2013
|
+
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
2014
|
+
PlayFabId: string;
|
2015
|
+
}
|
2016
|
+
/** @deprecated Do not use */
|
2017
|
+
interface NotifyMatchmakerPlayerLeftResult extends IPlayFabResultCommon {
|
2018
|
+
/** State of user leaving the Game Server Instance. */
|
2019
|
+
PlayerState?: string;
|
2020
|
+
}
|
1808
2021
|
interface PlayerLeaderboardEntry {
|
1809
2022
|
/** Title-specific display name of the user for this leaderboard entry. */
|
1810
2023
|
DisplayName?: string;
|
1811
2024
|
/** PlayFab unique identifier of the user for this leaderboard entry. */
|
1812
2025
|
PlayFabId?: string;
|
1813
|
-
/** User
|
2026
|
+
/** User's overall position in the leaderboard. */
|
1814
2027
|
Position: number;
|
1815
2028
|
/** The profile of the user, if requested. */
|
1816
2029
|
Profile?: PlayerProfileModel;
|
1817
|
-
/** Specific value of the user
|
2030
|
+
/** Specific value of the user's statistic. */
|
1818
2031
|
StatValue: number;
|
1819
2032
|
}
|
1820
2033
|
interface PlayerLinkedAccount {
|
1821
|
-
/** Linked account
|
2034
|
+
/** Linked account's email */
|
1822
2035
|
Email?: string;
|
1823
2036
|
/** Authentication platform */
|
1824
2037
|
Platform?: string;
|
1825
2038
|
/** Platform user identifier */
|
1826
2039
|
PlatformUserId?: string;
|
1827
|
-
/** Linked account
|
2040
|
+
/** Linked account's username */
|
1828
2041
|
Username?: string;
|
1829
2042
|
}
|
1830
2043
|
interface PlayerLocation {
|
1831
|
-
/** City of the player
|
2044
|
+
/** City of the player's geographic location. */
|
1832
2045
|
City?: string;
|
1833
2046
|
/** The two-character continent code for this location */
|
1834
2047
|
ContinentCode: string;
|
1835
2048
|
/** The two-character ISO 3166-1 country code for the country associated with the location */
|
1836
2049
|
CountryCode: string;
|
1837
|
-
/** Latitude coordinate of the player
|
2050
|
+
/** Latitude coordinate of the player's geographic location. */
|
1838
2051
|
Latitude?: number;
|
1839
|
-
/** Longitude coordinate of the player
|
2052
|
+
/** Longitude coordinate of the player's geographic location. */
|
1840
2053
|
Longitude?: number;
|
1841
2054
|
}
|
1842
2055
|
interface PlayerProfile {
|
1843
2056
|
/** Array of ad campaigns player has been attributed to */
|
1844
2057
|
AdCampaignAttributions?: AdCampaignAttribution[];
|
1845
|
-
/** Image URL of the player
|
2058
|
+
/** Image URL of the player's avatar. */
|
1846
2059
|
AvatarUrl?: string;
|
1847
2060
|
/** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */
|
1848
2061
|
BannedUntil?: string;
|
@@ -1852,7 +2065,7 @@ interface PlayerProfile {
|
|
1852
2065
|
ContactEmailAddresses?: ContactEmailInfo[];
|
1853
2066
|
/** Player record created */
|
1854
2067
|
Created?: string;
|
1855
|
-
/** Dictionary of player
|
2068
|
+
/** Dictionary of player's custom properties. */
|
1856
2069
|
CustomProperties?: Record<string, any>;
|
1857
2070
|
/** Player Display Name */
|
1858
2071
|
DisplayName?: string;
|
@@ -1860,7 +2073,7 @@ interface PlayerProfile {
|
|
1860
2073
|
LastLogin?: string;
|
1861
2074
|
/** Array of third party accounts linked to this player */
|
1862
2075
|
LinkedAccounts?: PlayerLinkedAccount[];
|
1863
|
-
/** Dictionary of player
|
2076
|
+
/** Dictionary of player's locations by type. */
|
1864
2077
|
Locations?: Record<string, PlayerLocation>;
|
1865
2078
|
/** Player account origination */
|
1866
2079
|
Origination?: string;
|
@@ -1874,23 +2087,23 @@ interface PlayerProfile {
|
|
1874
2087
|
PublisherId?: string;
|
1875
2088
|
/** Array of configured push notification end points */
|
1876
2089
|
PushNotificationRegistrations?: PushNotificationRegistration[];
|
1877
|
-
/** Dictionary of player
|
2090
|
+
/** Dictionary of player's statistics using only the latest version's value */
|
1878
2091
|
Statistics?: Record<string, number>;
|
1879
|
-
/** List of player
|
2092
|
+
/** List of player's tags for segmentation. */
|
1880
2093
|
Tags?: string[];
|
1881
2094
|
/** Title ID this profile applies to */
|
1882
2095
|
TitleId?: string;
|
1883
|
-
/** A sum of player
|
2096
|
+
/** A sum of player's total purchases in USD across all currencies. */
|
1884
2097
|
TotalValueToDateInUSD?: number;
|
1885
|
-
/** Dictionary of player
|
2098
|
+
/** Dictionary of player's total purchases by currency. */
|
1886
2099
|
ValuesToDate?: Record<string, number>;
|
1887
|
-
/** Dictionary of player
|
2100
|
+
/** Dictionary of player's virtual currency balances */
|
1888
2101
|
VirtualCurrencyBalances?: Record<string, number>;
|
1889
2102
|
}
|
1890
2103
|
interface PlayerProfileModel {
|
1891
2104
|
/** List of advertising campaigns the player has been attributed to */
|
1892
2105
|
AdCampaignAttributions?: AdCampaignAttributionModel[];
|
1893
|
-
/** URL of the player
|
2106
|
+
/** URL of the player's avatar image */
|
1894
2107
|
AvatarUrl?: string;
|
1895
2108
|
/** If the player is currently banned, the UTC Date when the ban expires */
|
1896
2109
|
BannedUntil?: string;
|
@@ -1924,20 +2137,20 @@ interface PlayerProfileModel {
|
|
1924
2137
|
PushNotificationRegistrations?: PushNotificationRegistrationModel[];
|
1925
2138
|
/** List of leaderboard statistic values for the player */
|
1926
2139
|
Statistics?: StatisticModel[];
|
1927
|
-
/** List of player
|
2140
|
+
/** List of player's tags for segmentation */
|
1928
2141
|
Tags?: TagModel[];
|
1929
2142
|
/** Title ID this player profile applies to */
|
1930
2143
|
TitleId?: string;
|
1931
2144
|
/**
|
1932
|
-
* Sum of the player
|
2145
|
+
* Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
|
1933
2146
|
* whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
|
1934
2147
|
*/
|
1935
2148
|
TotalValueToDateInUSD?: number;
|
1936
|
-
/** List of the player
|
2149
|
+
/** List of the player's lifetime purchase totals, summed by real-money currency */
|
1937
2150
|
ValuesToDate?: ValueToDateModel[];
|
1938
2151
|
}
|
1939
2152
|
interface PlayerProfileViewConstraints {
|
1940
|
-
/** Whether to show player
|
2153
|
+
/** Whether to show player's avatar URL. Defaults to false */
|
1941
2154
|
ShowAvatarUrl: boolean;
|
1942
2155
|
/** Whether to show the banned until time. Defaults to false */
|
1943
2156
|
ShowBannedUntil: boolean;
|
@@ -1949,15 +2162,15 @@ interface PlayerProfileViewConstraints {
|
|
1949
2162
|
ShowCreated: boolean;
|
1950
2163
|
/** Whether to show the display name. Defaults to false */
|
1951
2164
|
ShowDisplayName: boolean;
|
1952
|
-
/** Whether to show player
|
2165
|
+
/** Whether to show player's experiment variants. Defaults to false */
|
1953
2166
|
ShowExperimentVariants: boolean;
|
1954
2167
|
/** Whether to show the last login time. Defaults to false */
|
1955
2168
|
ShowLastLogin: boolean;
|
1956
2169
|
/** Whether to show the linked accounts. Defaults to false */
|
1957
2170
|
ShowLinkedAccounts: boolean;
|
1958
|
-
/** Whether to show player
|
2171
|
+
/** Whether to show player's locations. Defaults to false */
|
1959
2172
|
ShowLocations: boolean;
|
1960
|
-
/** Whether to show player
|
2173
|
+
/** Whether to show player's membership information. Defaults to false */
|
1961
2174
|
ShowMemberships: boolean;
|
1962
2175
|
/** Whether to show origination. Defaults to false */
|
1963
2176
|
ShowOrigination: boolean;
|
@@ -2023,6 +2236,12 @@ interface PushNotificationPackage {
|
|
2023
2236
|
Icon?: string;
|
2024
2237
|
/** Content of the message (all platforms) */
|
2025
2238
|
Message: string;
|
2239
|
+
/**
|
2240
|
+
* This field was solely for use with the PlayFab custom Push Plugin, which has been deprecated in favor of the supported
|
2241
|
+
* platform-specific fields
|
2242
|
+
* @deprecated Please use CustomData instead.
|
2243
|
+
*/
|
2244
|
+
ScheduleDate?: string;
|
2026
2245
|
/** Sound file to play with the message (all platforms) */
|
2027
2246
|
Sound?: string;
|
2028
2247
|
/** Title/Subject of the message. Not supported for iOS */
|
@@ -2064,6 +2283,74 @@ interface RedeemCouponResult extends IPlayFabResultCommon {
|
|
2064
2283
|
/** Items granted to the player as a result of redeeming the coupon. */
|
2065
2284
|
GrantedItems?: ItemInstance[];
|
2066
2285
|
}
|
2286
|
+
/** @deprecated Do not use */
|
2287
|
+
interface RedeemMatchmakerTicketRequest extends IPlayFabRequestCommon {
|
2288
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2289
|
+
CustomTags?: Record<string, string | null>;
|
2290
|
+
/** Unique identifier of the Game Server Instance that is asking for validation of the authorization ticket. */
|
2291
|
+
LobbyId: string;
|
2292
|
+
/** Server authorization ticket passed back from a call to Matchmake or StartGame. */
|
2293
|
+
Ticket: string;
|
2294
|
+
}
|
2295
|
+
/** @deprecated Do not use */
|
2296
|
+
interface RedeemMatchmakerTicketResult extends IPlayFabResultCommon {
|
2297
|
+
/** Error value if the ticket was not validated. */
|
2298
|
+
Error?: string;
|
2299
|
+
/** Boolean indicating whether the ticket was validated by the PlayFab service. */
|
2300
|
+
TicketIsValid: boolean;
|
2301
|
+
/** User account information for the user validated. */
|
2302
|
+
UserInfo?: UserAccountInfo;
|
2303
|
+
}
|
2304
|
+
/** @deprecated Do not use */
|
2305
|
+
interface RefreshGameServerInstanceHeartbeatRequest extends IPlayFabRequestCommon {
|
2306
|
+
/** Unique identifier of the Game Server Instance for which the heartbeat is updated. */
|
2307
|
+
LobbyId: string;
|
2308
|
+
}
|
2309
|
+
/** @deprecated Do not use */
|
2310
|
+
interface RefreshGameServerInstanceHeartbeatResult extends IPlayFabResultCommon {
|
2311
|
+
}
|
2312
|
+
/** @deprecated Do not use */
|
2313
|
+
interface RegisterGameRequest extends IPlayFabRequestCommon {
|
2314
|
+
/** Unique identifier of the build running on the Game Server Instance. */
|
2315
|
+
Build: string;
|
2316
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2317
|
+
CustomTags?: Record<string, string | null>;
|
2318
|
+
/**
|
2319
|
+
* Game Mode the Game Server instance is running. Note that this must be defined in the Game Modes tab in the PlayFab Game
|
2320
|
+
* Manager, along with the Build ID (the same Game Mode can be defined for multiple Build IDs).
|
2321
|
+
*/
|
2322
|
+
GameMode: string;
|
2323
|
+
/** Previous lobby id if re-registering an existing game. */
|
2324
|
+
LobbyId?: string;
|
2325
|
+
/**
|
2326
|
+
* Region in which the Game Server Instance is running. For matchmaking using non-AWS region names, set this to any AWS
|
2327
|
+
* region and use Tags (below) to specify your custom region.
|
2328
|
+
*/
|
2329
|
+
Region: string;
|
2330
|
+
/**
|
2331
|
+
* IPV4 address of the Game Server Instance.
|
2332
|
+
* @deprecated Please use ServerIPV4Address instead.
|
2333
|
+
*/
|
2334
|
+
ServerHost?: string;
|
2335
|
+
/** IPV4 address of the game server instance. */
|
2336
|
+
ServerIPV4Address?: string;
|
2337
|
+
/** IPV6 address (if any) of the game server instance. */
|
2338
|
+
ServerIPV6Address?: string;
|
2339
|
+
/** Port number for communication with the Game Server Instance. */
|
2340
|
+
ServerPort: string;
|
2341
|
+
/** Public DNS name (if any) of the server */
|
2342
|
+
ServerPublicDNSName?: string;
|
2343
|
+
/** Tags for the Game Server Instance */
|
2344
|
+
Tags?: Record<string, string | null>;
|
2345
|
+
}
|
2346
|
+
/** @deprecated Do not use */
|
2347
|
+
interface RegisterGameResponse extends IPlayFabResultCommon {
|
2348
|
+
/**
|
2349
|
+
* Unique identifier generated for the Game Server Instance that is registered. If LobbyId is specified in request and the
|
2350
|
+
* game still exists in PlayFab, the LobbyId in request is returned. Otherwise a new lobby id will be returned.
|
2351
|
+
*/
|
2352
|
+
LobbyId?: string;
|
2353
|
+
}
|
2067
2354
|
interface RemoveFriendRequest extends IPlayFabRequestCommon {
|
2068
2355
|
/** PlayFab identifier of the friend account which is to be removed. */
|
2069
2356
|
FriendPlayFabId: string;
|
@@ -2107,6 +2394,11 @@ interface ReportPlayerServerRequest extends IPlayFabRequestCommon {
|
|
2107
2394
|
interface ReportPlayerServerResult extends IPlayFabResultCommon {
|
2108
2395
|
/** The number of remaining reports which may be filed today by this reporting player. */
|
2109
2396
|
SubmissionsRemaining: number;
|
2397
|
+
/**
|
2398
|
+
* Deprecated: Always true
|
2399
|
+
* @deprecated Do not use
|
2400
|
+
*/
|
2401
|
+
Updated?: boolean;
|
2110
2402
|
}
|
2111
2403
|
interface ResultTableNode {
|
2112
2404
|
/** Either an ItemId, or the TableId of another random result table */
|
@@ -2198,7 +2490,7 @@ interface SendCustomAccountRecoveryEmailRequest extends IPlayFabRequestCommon {
|
|
2198
2490
|
Email?: string;
|
2199
2491
|
/** The email template id of the account recovery email template to send. */
|
2200
2492
|
EmailTemplateId: string;
|
2201
|
-
/** The user
|
2493
|
+
/** The user's username requesting an account recovery. */
|
2202
2494
|
Username?: string;
|
2203
2495
|
}
|
2204
2496
|
interface SendCustomAccountRecoveryEmailResult extends IPlayFabResultCommon {
|
@@ -2259,11 +2551,11 @@ interface ServerLoginResult extends IPlayFabResultCommon {
|
|
2259
2551
|
EntityToken?: EntityTokenResponse;
|
2260
2552
|
/** Results for requested info. */
|
2261
2553
|
InfoResultPayload?: GetPlayerCombinedInfoResultPayload;
|
2262
|
-
/** The time of this user
|
2554
|
+
/** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */
|
2263
2555
|
LastLoginTime?: string;
|
2264
2556
|
/** True if the master_player_account was newly created on this login. */
|
2265
2557
|
NewlyCreated: boolean;
|
2266
|
-
/** Player
|
2558
|
+
/** Player's unique PlayFabId. */
|
2267
2559
|
PlayFabId?: string;
|
2268
2560
|
/** Unique token authorizing the user and game at the server level, for the current session. */
|
2269
2561
|
SessionTicket?: string;
|
@@ -2280,6 +2572,39 @@ interface SetFriendTagsRequest extends IPlayFabRequestCommon {
|
|
2280
2572
|
/** Array of tags to set on the friend account. */
|
2281
2573
|
Tags: string[];
|
2282
2574
|
}
|
2575
|
+
/** @deprecated Do not use */
|
2576
|
+
interface SetGameServerInstanceDataRequest extends IPlayFabRequestCommon {
|
2577
|
+
/** Custom data to set for the specified game server instance. */
|
2578
|
+
GameServerData: string;
|
2579
|
+
/** Unique identifier of the Game Instance to be updated, in decimal format. */
|
2580
|
+
LobbyId: string;
|
2581
|
+
}
|
2582
|
+
/** @deprecated Do not use */
|
2583
|
+
interface SetGameServerInstanceDataResult extends IPlayFabResultCommon {
|
2584
|
+
}
|
2585
|
+
/** @deprecated Do not use */
|
2586
|
+
interface SetGameServerInstanceStateRequest extends IPlayFabRequestCommon {
|
2587
|
+
/** Unique identifier of the Game Instance to be updated, in decimal format. */
|
2588
|
+
LobbyId: string;
|
2589
|
+
/** State to set for the specified game server instance. */
|
2590
|
+
State: string;
|
2591
|
+
}
|
2592
|
+
/** @deprecated Do not use */
|
2593
|
+
interface SetGameServerInstanceStateResult extends IPlayFabResultCommon {
|
2594
|
+
}
|
2595
|
+
/** @deprecated Do not use */
|
2596
|
+
interface SetGameServerInstanceTagsRequest extends IPlayFabRequestCommon {
|
2597
|
+
/** Unique identifier of the Game Server Instance to be updated. */
|
2598
|
+
LobbyId: string;
|
2599
|
+
/**
|
2600
|
+
* Tags to set for the specified Game Server Instance. Note that this is the complete list of tags to be associated with
|
2601
|
+
* the Game Server Instance.
|
2602
|
+
*/
|
2603
|
+
Tags: Record<string, string | null>;
|
2604
|
+
}
|
2605
|
+
/** @deprecated Do not use */
|
2606
|
+
interface SetGameServerInstanceTagsResult extends IPlayFabResultCommon {
|
2607
|
+
}
|
2283
2608
|
interface SetPlayerSecretRequest extends IPlayFabRequestCommon {
|
2284
2609
|
/** Player secret that is used to verify API request signatures (Enterprise Only). */
|
2285
2610
|
PlayerSecret?: string;
|
@@ -2290,8 +2615,8 @@ interface SetPlayerSecretResult extends IPlayFabResultCommon {
|
|
2290
2615
|
}
|
2291
2616
|
interface SetPublisherDataRequest extends IPlayFabRequestCommon {
|
2292
2617
|
/**
|
2293
|
-
* key we want to set a value on (note, this is additive - will only replace an existing key
|
2294
|
-
* name.) Keys are trimmed of whitespace. Keys may not begin with the
|
2618
|
+
* key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same
|
2619
|
+
* name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
|
2295
2620
|
*/
|
2296
2621
|
Key: string;
|
2297
2622
|
/** new value to set. Set to null to remove a value */
|
@@ -2301,8 +2626,8 @@ interface SetPublisherDataResult extends IPlayFabResultCommon {
|
|
2301
2626
|
}
|
2302
2627
|
interface SetTitleDataRequest extends IPlayFabRequestCommon {
|
2303
2628
|
/**
|
2304
|
-
* key we want to set a value on (note, this is additive - will only replace an existing key
|
2305
|
-
* name.) Keys are trimmed of whitespace. Keys may not begin with the
|
2629
|
+
* key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same
|
2630
|
+
* name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
|
2306
2631
|
*/
|
2307
2632
|
Key: string;
|
2308
2633
|
/** new value to set. Set to null to remove a value */
|
@@ -2362,6 +2687,11 @@ interface SteamNamePlayFabIdPair {
|
|
2362
2687
|
interface SteamPlayFabIdPair {
|
2363
2688
|
/** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */
|
2364
2689
|
PlayFabId?: string;
|
2690
|
+
/**
|
2691
|
+
* Deprecated: Please use SteamStringId
|
2692
|
+
* @deprecated Please use SteamStringId instead.
|
2693
|
+
*/
|
2694
|
+
SteamId?: number;
|
2365
2695
|
/** Unique Steam identifier for a user. */
|
2366
2696
|
SteamStringId?: string;
|
2367
2697
|
}
|
@@ -2377,7 +2707,7 @@ interface StoreItem {
|
|
2377
2707
|
ItemId: string;
|
2378
2708
|
/** Override prices for this item for specific currencies */
|
2379
2709
|
RealCurrencyPrices?: Record<string, number>;
|
2380
|
-
/** Override prices for this item in virtual currencies and
|
2710
|
+
/** Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
|
2381
2711
|
VirtualCurrencyPrices?: Record<string, number>;
|
2382
2712
|
}
|
2383
2713
|
interface StoreMarketingModel {
|
@@ -2393,7 +2723,7 @@ interface SubscriptionModel {
|
|
2393
2723
|
Expiration: string;
|
2394
2724
|
/** The time the subscription was orignially purchased */
|
2395
2725
|
InitialSubscriptionTime: string;
|
2396
|
-
/** Whether this subscription is currently active. That is, if Expiration
|
2726
|
+
/** Whether this subscription is currently active. That is, if Expiration > now. */
|
2397
2727
|
IsActive: boolean;
|
2398
2728
|
/** The status of this subscription, according to the subscription provider. */
|
2399
2729
|
Status?: string;
|
@@ -2505,6 +2835,11 @@ interface UnlinkXboxAccountRequest extends IPlayFabRequestCommon {
|
|
2505
2835
|
CustomTags?: Record<string, string | null>;
|
2506
2836
|
/** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
|
2507
2837
|
PlayFabId: string;
|
2838
|
+
/**
|
2839
|
+
* Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").
|
2840
|
+
* @deprecated Do not use
|
2841
|
+
*/
|
2842
|
+
XboxToken?: string;
|
2508
2843
|
}
|
2509
2844
|
interface UnlinkXboxAccountResult extends IPlayFabResultCommon {
|
2510
2845
|
}
|
@@ -2566,8 +2901,19 @@ interface UpdateBanRequest {
|
|
2566
2901
|
BanId: string;
|
2567
2902
|
/** The updated expiration date for the ban. Null for no change. */
|
2568
2903
|
Expires?: string;
|
2904
|
+
/**
|
2905
|
+
* The updated decision to ban the Microsoft family members to be updated. Null for no change. This property is deprecated
|
2906
|
+
* and does not work anymore.
|
2907
|
+
* @deprecated Please use UserFamilyType instead.
|
2908
|
+
*/
|
2909
|
+
IncludeMicrosoftFamily?: boolean;
|
2569
2910
|
/** The updated IP address for the ban. Null for no change. */
|
2570
2911
|
IPAddress?: string;
|
2912
|
+
/**
|
2913
|
+
* The updated MAC address for the ban. Null for no change. This property is deprecated and does not work anymore.
|
2914
|
+
* @deprecated Do not use
|
2915
|
+
*/
|
2916
|
+
MACAddress?: string;
|
2571
2917
|
/** Whether to make this ban permanent. Set to true to make this ban permanent. This will not modify Active state. */
|
2572
2918
|
Permanent?: boolean;
|
2573
2919
|
/** The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. */
|
@@ -2590,7 +2936,7 @@ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
|
|
2590
2936
|
CustomTags?: Record<string, string | null>;
|
2591
2937
|
/**
|
2592
2938
|
* Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
|
2593
|
-
* not begin with a
|
2939
|
+
* not begin with a '!' character or be null.
|
2594
2940
|
*/
|
2595
2941
|
Data?: Record<string, string | null>;
|
2596
2942
|
/**
|
@@ -2598,7 +2944,7 @@ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
|
|
2598
2944
|
* constraints. Use this to delete the keys directly.
|
2599
2945
|
*/
|
2600
2946
|
KeysToRemove?: string[];
|
2601
|
-
/** Permission to be applied to all user data keys written in this request. Defaults to
|
2947
|
+
/** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
|
2602
2948
|
Permission?: string;
|
2603
2949
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
2604
2950
|
PlayFabId: string;
|
@@ -2627,7 +2973,7 @@ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
|
|
2627
2973
|
CustomTags?: Record<string, string | null>;
|
2628
2974
|
/**
|
2629
2975
|
* Optional field used for concurrency control. One can ensure that the update operation will only be performed if the
|
2630
|
-
* player
|
2976
|
+
* player's properties have not been updated by any other clients since last the version.
|
2631
2977
|
*/
|
2632
2978
|
ExpectedPropertiesVersion?: number;
|
2633
2979
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
@@ -2639,7 +2985,7 @@ interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
|
|
2639
2985
|
/** PlayFab unique identifier of the user whose properties were updated. */
|
2640
2986
|
PlayFabId?: string;
|
2641
2987
|
/**
|
2642
|
-
* Indicates the current version of a player
|
2988
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
2643
2989
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
2644
2990
|
*/
|
2645
2991
|
PropertiesVersion: number;
|
@@ -2670,7 +3016,7 @@ interface UpdateSharedGroupDataRequest extends IPlayFabRequestCommon {
|
|
2670
3016
|
CustomTags?: Record<string, string | null>;
|
2671
3017
|
/**
|
2672
3018
|
* Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
|
2673
|
-
* not begin with a
|
3019
|
+
* not begin with a '!' character or be null.
|
2674
3020
|
*/
|
2675
3021
|
Data?: Record<string, string | null>;
|
2676
3022
|
/**
|
@@ -2690,7 +3036,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
|
|
2690
3036
|
CustomTags?: Record<string, string | null>;
|
2691
3037
|
/**
|
2692
3038
|
* Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
|
2693
|
-
* not begin with a
|
3039
|
+
* not begin with a '!' character or be null.
|
2694
3040
|
*/
|
2695
3041
|
Data?: Record<string, string | null>;
|
2696
3042
|
/**
|
@@ -2698,7 +3044,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
|
|
2698
3044
|
* constraints. Use this to delete the keys directly.
|
2699
3045
|
*/
|
2700
3046
|
KeysToRemove?: string[];
|
2701
|
-
/** Permission to be applied to all user data keys written in this request. Defaults to
|
3047
|
+
/** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
|
2702
3048
|
Permission?: string;
|
2703
3049
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
2704
3050
|
PlayFabId: string;
|
@@ -2715,7 +3061,7 @@ interface UpdateUserInternalDataRequest extends IPlayFabRequestCommon {
|
|
2715
3061
|
CustomTags?: Record<string, string | null>;
|
2716
3062
|
/**
|
2717
3063
|
* Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
|
2718
|
-
* not begin with a
|
3064
|
+
* not begin with a '!' character or be null.
|
2719
3065
|
*/
|
2720
3066
|
Data?: Record<string, string | null>;
|
2721
3067
|
/**
|
@@ -2733,7 +3079,7 @@ interface UpdateUserInventoryItemDataRequest extends IPlayFabRequestCommon {
|
|
2733
3079
|
CustomTags?: Record<string, string | null>;
|
2734
3080
|
/**
|
2735
3081
|
* Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
|
2736
|
-
* not begin with a
|
3082
|
+
* not begin with a '!' character or be null.
|
2737
3083
|
*/
|
2738
3084
|
Data?: Record<string, string | null>;
|
2739
3085
|
/** Unique PlayFab assigned instance identifier of the item */
|
@@ -2746,6 +3092,18 @@ interface UpdateUserInventoryItemDataRequest extends IPlayFabRequestCommon {
|
|
2746
3092
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
2747
3093
|
PlayFabId: string;
|
2748
3094
|
}
|
3095
|
+
/** @deprecated Do not use */
|
3096
|
+
interface UpdateUserStatisticsRequest extends IPlayFabRequestCommon {
|
3097
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
3098
|
+
CustomTags?: Record<string, string | null>;
|
3099
|
+
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
3100
|
+
PlayFabId: string;
|
3101
|
+
/** Statistics to be updated with the provided values. */
|
3102
|
+
UserStatistics?: Record<string, number>;
|
3103
|
+
}
|
3104
|
+
/** @deprecated Do not use */
|
3105
|
+
interface UpdateUserStatisticsResult extends IPlayFabResultCommon {
|
3106
|
+
}
|
2749
3107
|
interface UserAccountInfo {
|
2750
3108
|
/** User Android device information, if an Android device has been linked */
|
2751
3109
|
AndroidDeviceInfo?: UserAndroidDeviceInfo;
|
@@ -2920,7 +3278,7 @@ interface UserSteamInfo {
|
|
2920
3278
|
SteamName?: string;
|
2921
3279
|
}
|
2922
3280
|
interface UserTitleInfo {
|
2923
|
-
/** URL to the player
|
3281
|
+
/** URL to the player's avatar. */
|
2924
3282
|
AvatarUrl?: string;
|
2925
3283
|
/**
|
2926
3284
|
* timestamp indicating when the user was first associated with this game (this can differ significantly from when the user
|
@@ -2960,12 +3318,12 @@ interface ValueToDateModel {
|
|
2960
3318
|
Currency?: string;
|
2961
3319
|
/**
|
2962
3320
|
* Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and
|
2963
|
-
* ninety-nine cents when Currency is
|
3321
|
+
* ninety-nine cents when Currency is 'USD')
|
2964
3322
|
*/
|
2965
3323
|
TotalValue: number;
|
2966
3324
|
/**
|
2967
|
-
* Total value of the purchases in a string representation of decimal monetary units. For example,
|
2968
|
-
* dollars and ninety-nine cents when Currency is
|
3325
|
+
* Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
|
3326
|
+
* dollars and ninety-nine cents when Currency is 'USD'.
|
2969
3327
|
*/
|
2970
3328
|
TotalValueAsDecimal?: string;
|
2971
3329
|
}
|
@@ -3050,25 +3408,53 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3050
3408
|
/**
|
3051
3409
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3052
3410
|
* version 2._ Increments the character's balance of the specified virtual currency by the stated amount
|
3053
|
-
*
|
3411
|
+
*
|
3412
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency Microsoft Documentation}
|
3413
|
+
* @example
|
3414
|
+
* await serverClient.AddCharacterVirtualCurrency({
|
3415
|
+
* "PlayFabId": "20394883",
|
3416
|
+
* "CharacterId": "23424524523",
|
3417
|
+
* "VirtualCurrency": "GC",
|
3418
|
+
* "Amount": 100
|
3419
|
+
* });
|
3054
3420
|
*/
|
3055
3421
|
AddCharacterVirtualCurrency(request: AddCharacterVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
|
3056
3422
|
/**
|
3057
3423
|
* Adds the Friend user to the friendlist of the user with PlayFabId. At least one of
|
3058
3424
|
* FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
|
3059
|
-
*
|
3425
|
+
*
|
3426
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend Microsoft Documentation}
|
3427
|
+
* @example
|
3428
|
+
* await serverClient.AddFriend({
|
3429
|
+
* "PlayFabId": "10931252888739651331",
|
3430
|
+
* "FriendPlayFabId": "20394883"
|
3431
|
+
* });
|
3060
3432
|
*/
|
3061
3433
|
AddFriend(request: AddFriendRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3062
3434
|
/**
|
3063
3435
|
* Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
|
3064
3436
|
* ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
|
3065
3437
|
* authentication credentials, as the intent is that it is easily accessible by other players.
|
3066
|
-
*
|
3438
|
+
*
|
3439
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid Microsoft Documentation}
|
3440
|
+
* @example
|
3441
|
+
* await serverClient.AddGenericID({
|
3442
|
+
* "GenericId": {
|
3443
|
+
* "ServiceName": "BigBizSocial",
|
3444
|
+
* "UserId": "1234567890"
|
3445
|
+
* }
|
3446
|
+
* });
|
3067
3447
|
*/
|
3068
3448
|
AddGenericID(request: AddGenericIDRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3069
3449
|
/**
|
3070
3450
|
* Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
3071
|
-
*
|
3451
|
+
*
|
3452
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag Microsoft Documentation}
|
3453
|
+
* @example
|
3454
|
+
* await serverClient.AddPlayerTag({
|
3455
|
+
* "PlayFabId": "10931252888739651331",
|
3456
|
+
* "TagName": "MostKilled"
|
3457
|
+
* });
|
3072
3458
|
*/
|
3073
3459
|
AddPlayerTag(request: AddPlayerTagRequest, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
|
3074
3460
|
/**
|
@@ -3076,35 +3462,94 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3076
3462
|
* in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small
|
3077
3463
|
* number of players, please see our guide:
|
3078
3464
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3079
|
-
*
|
3465
|
+
*
|
3466
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/addsharedgroupmembers Microsoft Documentation}
|
3467
|
+
* @example
|
3468
|
+
* await serverClient.AddSharedGroupMembers({
|
3469
|
+
* "SharedGroupId": "Clan Data",
|
3470
|
+
* "PlayFabIds": [
|
3471
|
+
* "D984A64B832",
|
3472
|
+
* "F74A523E1562"
|
3473
|
+
* ]
|
3474
|
+
* });
|
3080
3475
|
*/
|
3081
3476
|
AddSharedGroupMembers(request: AddSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
|
3082
3477
|
/**
|
3083
3478
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3084
3479
|
* version 2._ Increments the user's balance of the specified virtual currency by the stated amount
|
3085
|
-
*
|
3480
|
+
*
|
3481
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/adduservirtualcurrency Microsoft Documentation}
|
3482
|
+
* @example
|
3483
|
+
* await serverClient.AddUserVirtualCurrency({
|
3484
|
+
* "PlayFabId": "20394883",
|
3485
|
+
* "VirtualCurrency": "GC",
|
3486
|
+
* "Amount": 100
|
3487
|
+
* });
|
3086
3488
|
*/
|
3087
3489
|
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
3088
3490
|
/**
|
3089
3491
|
* Validated a client's session ticket, and if successful, returns details for that user
|
3090
|
-
*
|
3492
|
+
*
|
3493
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket Microsoft Documentation}
|
3494
|
+
* @example
|
3495
|
+
* await serverClient.AuthenticateSessionTicket({
|
3496
|
+
* "SessionTicket": "4D2----8D11F4249A80000-7C64AB0A9F1D8D1A.CD803BF233CE76CC"
|
3497
|
+
* });
|
3091
3498
|
*/
|
3092
3499
|
AuthenticateSessionTicket(request: AuthenticateSessionTicketRequest, extraHeaders?: Record<string, string>): Promise<AuthenticateSessionTicketResult>;
|
3093
3500
|
/**
|
3094
3501
|
* Awards the specified users the specified Steam achievements
|
3095
|
-
*
|
3502
|
+
*
|
3503
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement Microsoft Documentation}
|
3504
|
+
* @example
|
3505
|
+
* await serverClient.AwardSteamAchievement({
|
3506
|
+
* "Achievements": [
|
3507
|
+
* {
|
3508
|
+
* "PlayFabId": "234974573892",
|
3509
|
+
* "AchievementName": "FinishLevel1",
|
3510
|
+
* "Result": false
|
3511
|
+
* },
|
3512
|
+
* {
|
3513
|
+
* "PlayFabId": "334353433",
|
3514
|
+
* "AchievementName": "FinishLevel1",
|
3515
|
+
* "Result": false
|
3516
|
+
* }
|
3517
|
+
* ]
|
3518
|
+
* });
|
3096
3519
|
*/
|
3097
3520
|
AwardSteamAchievement(request: AwardSteamAchievementRequest, extraHeaders?: Record<string, string>): Promise<AwardSteamAchievementResult>;
|
3098
3521
|
/**
|
3099
3522
|
* Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
|
3100
|
-
*
|
3523
|
+
*
|
3524
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers Microsoft Documentation}
|
3525
|
+
* @example
|
3526
|
+
* await serverClient.BanUsers({
|
3527
|
+
* "Bans": [
|
3528
|
+
* {
|
3529
|
+
* "PlayFabId": "1679AF5CD04BD838",
|
3530
|
+
* "IPAddress": "192.168.1.1",
|
3531
|
+
* "Reason": "You cheated!",
|
3532
|
+
* "DurationInHours": 7
|
3533
|
+
* },
|
3534
|
+
* {
|
3535
|
+
* "PlayFabId": "2329AF5CD04BF513",
|
3536
|
+
* "Reason": "Caught you using speed hack!"
|
3537
|
+
* }
|
3538
|
+
* ]
|
3539
|
+
* });
|
3101
3540
|
*/
|
3102
3541
|
BanUsers(request: BanUsersRequest, extraHeaders?: Record<string, string>): Promise<BanUsersResult>;
|
3103
3542
|
/**
|
3104
3543
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3105
3544
|
* version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
|
3106
3545
|
* inventory.
|
3107
|
-
*
|
3546
|
+
*
|
3547
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/consumeitem Microsoft Documentation}
|
3548
|
+
* @example
|
3549
|
+
* await serverClient.ConsumeItem({
|
3550
|
+
* "ItemInstanceId": "94585729",
|
3551
|
+
* "ConsumeCount": 1
|
3552
|
+
* });
|
3108
3553
|
*/
|
3109
3554
|
ConsumeItem(request: ConsumeItemRequest, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
|
3110
3555
|
/**
|
@@ -3112,97 +3557,239 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3112
3557
|
* group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data
|
3113
3558
|
* between a very small number of players, please see our guide:
|
3114
3559
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3115
|
-
*
|
3560
|
+
*
|
3561
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/createsharedgroup Microsoft Documentation}
|
3562
|
+
* @example
|
3563
|
+
* await serverClient.CreateSharedGroup({
|
3564
|
+
* "SharedGroupId": "Clan Data"
|
3565
|
+
* });
|
3116
3566
|
*/
|
3117
3567
|
CreateSharedGroup(request: CreateSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
|
3118
3568
|
/**
|
3119
3569
|
* Deletes the specific character ID from the specified user.
|
3120
|
-
*
|
3570
|
+
*
|
3571
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser Microsoft Documentation}
|
3572
|
+
* @example
|
3573
|
+
* await serverClient.DeleteCharacterFromUser({
|
3574
|
+
* "PlayFabId": "12345",
|
3575
|
+
* "CharacterId": "98765432",
|
3576
|
+
* "SaveCharacterInventory": false
|
3577
|
+
* });
|
3121
3578
|
*/
|
3122
3579
|
DeleteCharacterFromUser(request: DeleteCharacterFromUserRequest, extraHeaders?: Record<string, string>): Promise<DeleteCharacterFromUserResult>;
|
3123
3580
|
/**
|
3124
3581
|
* Removes a user's player account from a title and deletes all associated data
|
3125
|
-
*
|
3582
|
+
*
|
3583
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer Microsoft Documentation}
|
3584
|
+
* @example
|
3585
|
+
* await serverClient.DeletePlayer({
|
3586
|
+
* "PlayFabId": "A68C908B66C23C5"
|
3587
|
+
* });
|
3126
3588
|
*/
|
3127
3589
|
DeletePlayer(request: DeletePlayerRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerResult>;
|
3128
3590
|
/**
|
3129
3591
|
* Deletes title-specific custom properties for a player
|
3130
|
-
*
|
3592
|
+
*
|
3593
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties Microsoft Documentation}
|
3594
|
+
* @example
|
3595
|
+
* await serverClient.DeletePlayerCustomProperties({
|
3596
|
+
* "PlayFabId": "2039475",
|
3597
|
+
* "PropertyNames": [
|
3598
|
+
* "level",
|
3599
|
+
* "created"
|
3600
|
+
* ],
|
3601
|
+
* "ExpectedPropertiesVersion": 12
|
3602
|
+
* });
|
3131
3603
|
*/
|
3132
3604
|
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
|
3133
3605
|
/**
|
3134
3606
|
* Deletes push notification template for title
|
3135
|
-
*
|
3607
|
+
*
|
3608
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate Microsoft Documentation}
|
3609
|
+
* @example
|
3610
|
+
* await serverClient.DeletePushNotificationTemplate({
|
3611
|
+
* "PushNotificationTemplateId": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4"
|
3612
|
+
* });
|
3136
3613
|
*/
|
3137
3614
|
DeletePushNotificationTemplate(request: DeletePushNotificationTemplateRequest, extraHeaders?: Record<string, string>): Promise<DeletePushNotificationTemplateResult>;
|
3138
3615
|
/**
|
3139
3616
|
* Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for
|
3140
3617
|
* sharing data between a very small number of players, please see our guide:
|
3141
3618
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3142
|
-
*
|
3619
|
+
*
|
3620
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/deletesharedgroup Microsoft Documentation}
|
3621
|
+
* @example
|
3622
|
+
* await serverClient.DeleteSharedGroup({
|
3623
|
+
* "SharedGroupId": "Clan Data"
|
3624
|
+
* });
|
3143
3625
|
*/
|
3144
3626
|
DeleteSharedGroup(request: DeleteSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3627
|
+
/**
|
3628
|
+
* Deletes custom data, all account linkages, and statistics.
|
3629
|
+
*
|
3630
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteusers Microsoft Documentation}
|
3631
|
+
* @deprecated Please use DeletePlayer instead.
|
3632
|
+
*/
|
3633
|
+
DeleteUsers(request: DeleteUsersRequest, extraHeaders?: Record<string, string>): Promise<DeleteUsersResult>;
|
3634
|
+
/**
|
3635
|
+
* Inform the matchmaker that a Game Server Instance is removed.
|
3636
|
+
*
|
3637
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/deregistergame Microsoft Documentation}
|
3638
|
+
* @deprecated Do not use
|
3639
|
+
*/
|
3640
|
+
DeregisterGame(request: DeregisterGameRequest, extraHeaders?: Record<string, string>): Promise<DeregisterGameResponse>;
|
3145
3641
|
/**
|
3146
3642
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3147
3643
|
* version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would
|
3148
3644
|
* have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to
|
3149
3645
|
* UnlockContainer.
|
3150
|
-
*
|
3646
|
+
*
|
3647
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable Microsoft Documentation}
|
3648
|
+
* @example
|
3649
|
+
* await serverClient.EvaluateRandomResultTable({
|
3650
|
+
* "TableId": "RareElementCard",
|
3651
|
+
* "CatalogVersion": "1"
|
3652
|
+
* });
|
3151
3653
|
*/
|
3152
3654
|
EvaluateRandomResultTable(request: EvaluateRandomResultTableRequest, extraHeaders?: Record<string, string>): Promise<EvaluateRandomResultTableResult>;
|
3153
3655
|
/**
|
3154
3656
|
* Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
|
3155
3657
|
* PlayFab ID is the entity ID of the player's master_player_account entity.
|
3156
|
-
*
|
3658
|
+
*
|
3659
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript Microsoft Documentation}
|
3660
|
+
* @example
|
3661
|
+
* await serverClient.ExecuteCloudScript({
|
3662
|
+
* "PlayFabId": "1337D00D",
|
3663
|
+
* "FunctionName": "levelCompleted",
|
3664
|
+
* "FunctionParameter": {
|
3665
|
+
* "level": 3,
|
3666
|
+
* "points": 400
|
3667
|
+
* },
|
3668
|
+
* "RevisionSelection": "Live",
|
3669
|
+
* "GeneratePlayStreamEvent": true
|
3670
|
+
* });
|
3157
3671
|
*/
|
3158
3672
|
ExecuteCloudScript(request: ExecuteCloudScriptServerRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
|
3673
|
+
/**
|
3674
|
+
* Retrieve a list of all PlayStream actions groups.
|
3675
|
+
*
|
3676
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getallactiongroups Microsoft Documentation}
|
3677
|
+
* @deprecated Please use GetAllSegments instead.
|
3678
|
+
*/
|
3679
|
+
GetAllActionGroups(request: GetAllActionGroupsRequest, extraHeaders?: Record<string, string>): Promise<GetAllActionGroupsResult>;
|
3159
3680
|
/**
|
3160
3681
|
* Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
|
3161
3682
|
* GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
|
3162
|
-
*
|
3683
|
+
*
|
3684
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments Microsoft Documentation}
|
3685
|
+
* @example
|
3686
|
+
* await serverClient.GetAllSegments({});
|
3163
3687
|
*/
|
3164
3688
|
GetAllSegments(request: GetAllSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
|
3165
3689
|
/**
|
3166
3690
|
* Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
|
3167
3691
|
* evaluated with the parent PlayFabId to guarantee uniqueness.
|
3168
|
-
*
|
3692
|
+
*
|
3693
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getalluserscharacters Microsoft Documentation}
|
3694
|
+
* @example
|
3695
|
+
* await serverClient.GetAllUsersCharacters({
|
3696
|
+
* "PlayFabId": "98333765432"
|
3697
|
+
* });
|
3169
3698
|
*/
|
3170
3699
|
GetAllUsersCharacters(request: ListUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
|
3171
3700
|
/**
|
3172
3701
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3173
3702
|
* version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
|
3174
|
-
*
|
3703
|
+
*
|
3704
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getcatalogitems Microsoft Documentation}
|
3705
|
+
* @example
|
3706
|
+
* await serverClient.GetCatalogItems({
|
3707
|
+
* "CatalogVersion": "1"
|
3708
|
+
* });
|
3175
3709
|
*/
|
3176
3710
|
GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
|
3177
3711
|
/**
|
3178
3712
|
* Retrieves the title-specific custom data for the user which is readable and writable by the client
|
3179
|
-
*
|
3713
|
+
*
|
3714
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata Microsoft Documentation}
|
3715
|
+
* @example
|
3716
|
+
* await serverClient.GetCharacterData({
|
3717
|
+
* "PlayFabId": "2039475",
|
3718
|
+
* "CharacterId": "98342357",
|
3719
|
+
* "Keys": [
|
3720
|
+
* "preferences",
|
3721
|
+
* "progress"
|
3722
|
+
* ],
|
3723
|
+
* "IfChangedFromDataVersion": 1
|
3724
|
+
* });
|
3180
3725
|
*/
|
3181
3726
|
GetCharacterData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3182
3727
|
/**
|
3183
3728
|
* Retrieves the title-specific custom data for the user's character which cannot be accessed by the client
|
3184
|
-
*
|
3729
|
+
*
|
3730
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata Microsoft Documentation}
|
3731
|
+
* @example
|
3732
|
+
* await serverClient.GetCharacterInternalData({
|
3733
|
+
* "PlayFabId": "2039475",
|
3734
|
+
* "CharacterId": "98342357",
|
3735
|
+
* "Keys": [
|
3736
|
+
* "preferences",
|
3737
|
+
* "progress"
|
3738
|
+
* ],
|
3739
|
+
* "IfChangedFromDataVersion": 1
|
3740
|
+
* });
|
3185
3741
|
*/
|
3186
3742
|
GetCharacterInternalData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3187
3743
|
/**
|
3188
3744
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3189
3745
|
* version 2._ Retrieves the specified character's current inventory of virtual goods
|
3190
|
-
*
|
3746
|
+
*
|
3747
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getcharacterinventory Microsoft Documentation}
|
3748
|
+
* @example
|
3749
|
+
* await serverClient.GetCharacterInventory({
|
3750
|
+
* "PlayFabId": "204883457",
|
3751
|
+
* "CharacterId": "9890723423",
|
3752
|
+
* "CatalogVersion": "5"
|
3753
|
+
* });
|
3191
3754
|
*/
|
3192
3755
|
GetCharacterInventory(request: GetCharacterInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
|
3193
3756
|
/**
|
3194
3757
|
* Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
|
3195
|
-
*
|
3758
|
+
*
|
3759
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterleaderboard Microsoft Documentation}
|
3760
|
+
* @example
|
3761
|
+
* await serverClient.GetCharacterLeaderboard({
|
3762
|
+
* "StatisticName": "Kills",
|
3763
|
+
* "StartPosition": 0,
|
3764
|
+
* "MaxResultsCount": 20
|
3765
|
+
* });
|
3196
3766
|
*/
|
3197
3767
|
GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
|
3198
3768
|
/**
|
3199
3769
|
* Retrieves the title-specific custom data for the user's character which can only be read by the client
|
3200
|
-
*
|
3770
|
+
*
|
3771
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata Microsoft Documentation}
|
3772
|
+
* @example
|
3773
|
+
* await serverClient.GetCharacterReadOnlyData({
|
3774
|
+
* "PlayFabId": "2039475",
|
3775
|
+
* "CharacterId": "98342357",
|
3776
|
+
* "Keys": [
|
3777
|
+
* "preferences",
|
3778
|
+
* "progress"
|
3779
|
+
* ],
|
3780
|
+
* "IfChangedFromDataVersion": 1
|
3781
|
+
* });
|
3201
3782
|
*/
|
3202
3783
|
GetCharacterReadOnlyData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3203
3784
|
/**
|
3204
3785
|
* Retrieves the details of all title-specific statistics for the specific character
|
3205
|
-
*
|
3786
|
+
*
|
3787
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics Microsoft Documentation}
|
3788
|
+
* @example
|
3789
|
+
* await serverClient.GetCharacterStatistics({
|
3790
|
+
* "PlayFabId": "10931252888739651331",
|
3791
|
+
* "CharacterId": "98765432"
|
3792
|
+
* });
|
3206
3793
|
*/
|
3207
3794
|
GetCharacterStatistics(request: GetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
|
3208
3795
|
/**
|
@@ -3212,60 +3799,146 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3212
3799
|
* the query to retrieve the data will fail. See this post for more information:
|
3213
3800
|
* https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
|
3214
3801
|
* please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
|
3215
|
-
*
|
3802
|
+
*
|
3803
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/content/getcontentdownloadurl Microsoft Documentation}
|
3804
|
+
* @example
|
3805
|
+
* await serverClient.GetContentDownloadUrl({
|
3806
|
+
* "Key": "images/sword_icon.png"
|
3807
|
+
* });
|
3216
3808
|
*/
|
3217
3809
|
GetContentDownloadUrl(request: GetContentDownloadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
|
3218
3810
|
/**
|
3219
3811
|
* Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the
|
3220
3812
|
* leaderboard
|
3221
|
-
*
|
3813
|
+
*
|
3814
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard Microsoft Documentation}
|
3815
|
+
* @example
|
3816
|
+
* await serverClient.GetFriendLeaderboard({
|
3817
|
+
* "PlayFabId": "98092347523",
|
3818
|
+
* "StatisticName": "Kills",
|
3819
|
+
* "StartPosition": 1258,
|
3820
|
+
* "MaxResultsCount": 20,
|
3821
|
+
* "ExternalPlatformFriends": "None"
|
3822
|
+
* });
|
3222
3823
|
*/
|
3223
3824
|
GetFriendLeaderboard(request: GetFriendLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
|
3224
3825
|
/**
|
3225
3826
|
* Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from
|
3226
3827
|
* linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
|
3227
|
-
*
|
3828
|
+
*
|
3829
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/getfriendslist Microsoft Documentation}
|
3830
|
+
* @example
|
3831
|
+
* await serverClient.GetFriendsList({
|
3832
|
+
* "PlayFabId": "93798903892789754",
|
3833
|
+
* "ExternalPlatformFriends": "All"
|
3834
|
+
* });
|
3228
3835
|
*/
|
3229
3836
|
GetFriendsList(request: GetFriendsListRequest, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
|
3230
3837
|
/**
|
3231
3838
|
* Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
|
3232
|
-
*
|
3839
|
+
*
|
3840
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboard Microsoft Documentation}
|
3841
|
+
* @example
|
3842
|
+
* await serverClient.GetLeaderboard({
|
3843
|
+
* "StatisticName": "Kills",
|
3844
|
+
* "StartPosition": 0,
|
3845
|
+
* "MaxResultsCount": 20
|
3846
|
+
* });
|
3233
3847
|
*/
|
3234
3848
|
GetLeaderboard(request: GetLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
|
3235
3849
|
/**
|
3236
3850
|
* Retrieves a list of ranked characters for the given statistic, centered on the requested user
|
3237
|
-
*
|
3851
|
+
*
|
3852
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter Microsoft Documentation}
|
3853
|
+
* @example
|
3854
|
+
* await serverClient.GetLeaderboardAroundCharacter({
|
3855
|
+
* "StatisticName": "Kills",
|
3856
|
+
* "PlayFabId": "10931252888739651331",
|
3857
|
+
* "CharacterId": "987343220",
|
3858
|
+
* "MaxResultsCount": 20
|
3859
|
+
* });
|
3238
3860
|
*/
|
3239
3861
|
GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
|
3240
3862
|
/**
|
3241
3863
|
* Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
|
3242
|
-
*
|
3864
|
+
*
|
3865
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser Microsoft Documentation}
|
3866
|
+
* @example
|
3867
|
+
* await serverClient.GetLeaderboardAroundUser({
|
3868
|
+
* "StatisticName": "Kills",
|
3869
|
+
* "PlayFabId": "10931252888739651331",
|
3870
|
+
* "MaxResultsCount": 20
|
3871
|
+
* });
|
3243
3872
|
*/
|
3244
3873
|
GetLeaderboardAroundUser(request: GetLeaderboardAroundUserRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundUserResult>;
|
3245
3874
|
/**
|
3246
3875
|
* Retrieves a list of all of the user's characters for the given statistic.
|
3247
|
-
*
|
3876
|
+
*
|
3877
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters Microsoft Documentation}
|
3878
|
+
* @example
|
3879
|
+
* await serverClient.GetLeaderboardForUserCharacters({
|
3880
|
+
* "StatisticName": "Kills",
|
3881
|
+
* "PlayFabId": "10931252888739651331"
|
3882
|
+
* });
|
3248
3883
|
*/
|
3249
3884
|
GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
|
3250
3885
|
/**
|
3251
3886
|
* Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be
|
3252
3887
|
* returned. All parameters default to false.
|
3253
|
-
*
|
3888
|
+
*
|
3889
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo Microsoft Documentation}
|
3890
|
+
* @example
|
3891
|
+
* await serverClient.GetPlayerCombinedInfo({
|
3892
|
+
* "PlayFabId": "4027527BF22653D1",
|
3893
|
+
* "InfoRequestParameters": {
|
3894
|
+
* "GetUserAccountInfo": true,
|
3895
|
+
* "GetUserInventory": false,
|
3896
|
+
* "GetUserVirtualCurrency": true,
|
3897
|
+
* "GetUserData": true,
|
3898
|
+
* "UserDataKeys": [
|
3899
|
+
* "preferences",
|
3900
|
+
* "progress"
|
3901
|
+
* ],
|
3902
|
+
* "GetUserReadOnlyData": false,
|
3903
|
+
* "GetCharacterInventories": false,
|
3904
|
+
* "GetCharacterList": false,
|
3905
|
+
* "GetTitleData": false,
|
3906
|
+
* "GetPlayerStatistics": false,
|
3907
|
+
* "GetPlayerProfile": false,
|
3908
|
+
* "GetEntityLineage": false
|
3909
|
+
* }
|
3910
|
+
* });
|
3254
3911
|
*/
|
3255
3912
|
GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCombinedInfoResult>;
|
3256
3913
|
/**
|
3257
3914
|
* Retrieves a title-specific custom property value for a player.
|
3258
|
-
*
|
3915
|
+
*
|
3916
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty Microsoft Documentation}
|
3917
|
+
* @example
|
3918
|
+
* await serverClient.GetPlayerCustomProperty({
|
3919
|
+
* "PlayFabId": "2039475",
|
3920
|
+
* "PropertyName": "level"
|
3921
|
+
* });
|
3259
3922
|
*/
|
3260
3923
|
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
|
3261
3924
|
/**
|
3262
3925
|
* Retrieves the player's profile
|
3263
|
-
*
|
3926
|
+
*
|
3927
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile Microsoft Documentation}
|
3928
|
+
* @example
|
3929
|
+
* await serverClient.GetPlayerProfile({
|
3930
|
+
* "PlayFabId": "621EF20237534A44"
|
3931
|
+
* });
|
3264
3932
|
*/
|
3265
3933
|
GetPlayerProfile(request: GetPlayerProfileRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
|
3266
3934
|
/**
|
3267
3935
|
* List all segments that a player currently belongs to at this moment in time.
|
3268
|
-
*
|
3936
|
+
*
|
3937
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments Microsoft Documentation}
|
3938
|
+
* @example
|
3939
|
+
* await serverClient.GetPlayerSegments({
|
3940
|
+
* "PlayFabId": "1337AA00"
|
3941
|
+
* });
|
3269
3942
|
*/
|
3270
3943
|
GetPlayerSegments(request: GetPlayersSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
|
3271
3944
|
/**
|
@@ -3274,358 +3947,893 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3274
3947
|
* on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
|
3275
3948
|
* in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
|
3276
3949
|
* called 30 times in one minute. You will be returned an error if you exceed this threshold.
|
3277
|
-
*
|
3950
|
+
*
|
3951
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment Microsoft Documentation}
|
3952
|
+
* @example
|
3953
|
+
* await serverClient.GetPlayersInSegment({
|
3954
|
+
* "SegmentId": "1337AA00",
|
3955
|
+
* "SecondsToLive": 5,
|
3956
|
+
* "MaxBatchSize": 500
|
3957
|
+
* });
|
3278
3958
|
*/
|
3279
3959
|
GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
|
3280
3960
|
/**
|
3281
3961
|
* Retrieves the current version and values for the indicated statistics, for the local player.
|
3282
|
-
*
|
3962
|
+
*
|
3963
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics Microsoft Documentation}
|
3964
|
+
* @example
|
3965
|
+
* await serverClient.GetPlayerStatistics({
|
3966
|
+
* "PlayFabId": "621EF2023753444",
|
3967
|
+
* "StatisticNames": [
|
3968
|
+
* "Points",
|
3969
|
+
* "Wins"
|
3970
|
+
* ]
|
3971
|
+
* });
|
3283
3972
|
*/
|
3284
3973
|
GetPlayerStatistics(request: GetPlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticsResult>;
|
3285
3974
|
/**
|
3286
3975
|
* Retrieves the information on the available versions of the specified statistic.
|
3287
|
-
*
|
3976
|
+
*
|
3977
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions Microsoft Documentation}
|
3978
|
+
* @example
|
3979
|
+
* await serverClient.GetPlayerStatisticVersions({
|
3980
|
+
* "StatisticName": "headshots"
|
3981
|
+
* });
|
3288
3982
|
*/
|
3289
3983
|
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
|
3290
3984
|
/**
|
3291
3985
|
* Get all tags with a given Namespace (optional) from a player profile.
|
3292
|
-
*
|
3986
|
+
*
|
3987
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags Microsoft Documentation}
|
3988
|
+
* @example
|
3989
|
+
* await serverClient.GetPlayerTags({
|
3990
|
+
* "PlayFabId": "10931252888739651331",
|
3991
|
+
* "Namespace": "title.AAA"
|
3992
|
+
* });
|
3293
3993
|
*/
|
3294
3994
|
GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
|
3295
3995
|
/**
|
3296
3996
|
* Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
|
3297
|
-
*
|
3997
|
+
*
|
3998
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids Microsoft Documentation}
|
3999
|
+
* @example
|
4000
|
+
* await serverClient.GetPlayFabIDsFromBattleNetAccountIds({
|
4001
|
+
* "BattleNetAccountIds": [
|
4002
|
+
* "526f79204261747478",
|
4003
|
+
* "526f79204261747479"
|
4004
|
+
* ]
|
4005
|
+
* });
|
3298
4006
|
*/
|
3299
4007
|
GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromBattleNetAccountIdsResult>;
|
3300
4008
|
/**
|
3301
4009
|
* Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
|
3302
|
-
*
|
4010
|
+
*
|
4011
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids Microsoft Documentation}
|
4012
|
+
* @example
|
4013
|
+
* await serverClient.GetPlayFabIDsFromFacebookIDs({
|
4014
|
+
* "FacebookIDs": [
|
4015
|
+
* "857498576495",
|
4016
|
+
* "759374651209"
|
4017
|
+
* ]
|
4018
|
+
* });
|
3303
4019
|
*/
|
3304
4020
|
GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookIDsResult>;
|
3305
4021
|
/**
|
3306
4022
|
* Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.
|
3307
|
-
*
|
4023
|
+
*
|
4024
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids Microsoft Documentation}
|
4025
|
+
* @example
|
4026
|
+
* await serverClient.GetPlayFabIDsFromFacebookInstantGamesIds({
|
4027
|
+
* "FacebookInstantGamesIds": [
|
4028
|
+
* "1114685845316172",
|
4029
|
+
* "1114685845316173"
|
4030
|
+
* ]
|
4031
|
+
* });
|
3308
4032
|
*/
|
3309
4033
|
GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
|
3310
4034
|
/**
|
3311
4035
|
* Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
|
3312
4036
|
* service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
|
3313
4037
|
* added to the player account.
|
3314
|
-
*
|
4038
|
+
*
|
4039
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromgenericids Microsoft Documentation}
|
4040
|
+
* @example
|
4041
|
+
* await serverClient.GetPlayFabIDsFromGenericIDs({
|
4042
|
+
* "GenericIDs": [
|
4043
|
+
* {
|
4044
|
+
* "ServiceName": "BigBizSocial",
|
4045
|
+
* "UserId": "1234567890"
|
4046
|
+
* },
|
4047
|
+
* {
|
4048
|
+
* "ServiceName": "VeeCeeMe",
|
4049
|
+
* "UserId": "og5igh85gf43gf"
|
4050
|
+
* }
|
4051
|
+
* ]
|
4052
|
+
* });
|
3315
4053
|
*/
|
3316
4054
|
GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGenericIDsResult>;
|
3317
4055
|
/**
|
3318
4056
|
* Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
|
3319
|
-
*
|
4057
|
+
*
|
4058
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids Microsoft Documentation}
|
4059
|
+
* @example
|
4060
|
+
* await serverClient.GetPlayFabIDsFromNintendoServiceAccountIds({
|
4061
|
+
* "NintendoAccountIds": [
|
4062
|
+
* "526f79204261747478",
|
4063
|
+
* "526f79204261747479"
|
4064
|
+
* ]
|
4065
|
+
* });
|
3320
4066
|
*/
|
3321
4067
|
GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoServiceAccountIdsResult>;
|
3322
4068
|
/**
|
3323
4069
|
* Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
|
3324
|
-
*
|
4070
|
+
*
|
4071
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids Microsoft Documentation}
|
4072
|
+
* @example
|
4073
|
+
* await serverClient.GetPlayFabIDsFromNintendoSwitchDeviceIds({
|
4074
|
+
* "NintendoSwitchDeviceIds": [
|
4075
|
+
* "526f79204261747478",
|
4076
|
+
* "526f79204261747479"
|
4077
|
+
* ]
|
4078
|
+
* });
|
3325
4079
|
*/
|
3326
4080
|
GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoSwitchDeviceIdsResult>;
|
3327
4081
|
/**
|
3328
4082
|
* Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
|
3329
|
-
*
|
4083
|
+
*
|
4084
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids Microsoft Documentation}
|
4085
|
+
* @example
|
4086
|
+
* await serverClient.GetPlayFabIDsFromPSNAccountIDs({
|
4087
|
+
* "PSNAccountIDs": [
|
4088
|
+
* "857498576495",
|
4089
|
+
* "759374651209"
|
4090
|
+
* ]
|
4091
|
+
* });
|
3330
4092
|
*/
|
3331
4093
|
GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNAccountIDsResult>;
|
3332
4094
|
/**
|
3333
4095
|
* Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
|
3334
|
-
*
|
4096
|
+
*
|
4097
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids Microsoft Documentation}
|
4098
|
+
* @example
|
4099
|
+
* await serverClient.GetPlayFabIDsFromPSNOnlineIDs({
|
4100
|
+
* "PSNOnlineIDs": [
|
4101
|
+
* "857555576495",
|
4102
|
+
* "759345551209"
|
4103
|
+
* ]
|
4104
|
+
* });
|
3335
4105
|
*/
|
3336
4106
|
GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNOnlineIDsResult>;
|
3337
4107
|
/**
|
3338
4108
|
* Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
|
3339
4109
|
* IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
|
3340
|
-
*
|
4110
|
+
*
|
4111
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids Microsoft Documentation}
|
4112
|
+
* @example
|
4113
|
+
* await serverClient.GetPlayFabIDsFromSteamIDs({
|
4114
|
+
* "SteamStringIDs": [
|
4115
|
+
* "857498576495",
|
4116
|
+
* "759374651209"
|
4117
|
+
* ]
|
4118
|
+
* });
|
3341
4119
|
*/
|
3342
4120
|
GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamIDsResult>;
|
3343
4121
|
/**
|
3344
4122
|
* Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
|
3345
4123
|
* names.
|
3346
|
-
*
|
4124
|
+
*
|
4125
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames Microsoft Documentation}
|
4126
|
+
* @example
|
4127
|
+
* await serverClient.GetPlayFabIDsFromSteamNames({
|
4128
|
+
* "SteamNames": [
|
4129
|
+
* "steamPersonaName1",
|
4130
|
+
* "steamPersonaName2"
|
4131
|
+
* ]
|
4132
|
+
* });
|
3347
4133
|
*/
|
3348
4134
|
GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamNamesResult>;
|
3349
4135
|
/**
|
3350
4136
|
* Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
|
3351
4137
|
* the user accounts, available as "_id" from the Twitch API methods (ex:
|
3352
4138
|
* https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
|
3353
|
-
*
|
4139
|
+
*
|
4140
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromtwitchids Microsoft Documentation}
|
4141
|
+
* @example
|
4142
|
+
* await serverClient.GetPlayFabIDsFromTwitchIDs({
|
4143
|
+
* "TwitchIds": [
|
4144
|
+
* "127168541",
|
4145
|
+
* "88315720"
|
4146
|
+
* ]
|
4147
|
+
* });
|
3354
4148
|
*/
|
3355
4149
|
GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromTwitchIDsResult>;
|
3356
4150
|
/**
|
3357
4151
|
* Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
|
3358
|
-
*
|
4152
|
+
*
|
4153
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids Microsoft Documentation}
|
4154
|
+
* @example
|
4155
|
+
* await serverClient.GetPlayFabIDsFromXboxLiveIDs({
|
4156
|
+
* "XboxLiveAccountIDs": [
|
4157
|
+
* "857498576495",
|
4158
|
+
* "759374651209"
|
4159
|
+
* ],
|
4160
|
+
* "Sandbox": "RETAIL"
|
4161
|
+
* });
|
3359
4162
|
*/
|
3360
4163
|
GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromXboxLiveIDsResult>;
|
3361
4164
|
/**
|
3362
4165
|
* Retrieves the key-value store of custom publisher settings
|
3363
|
-
*
|
4166
|
+
*
|
4167
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata Microsoft Documentation}
|
4168
|
+
* @example
|
4169
|
+
* await serverClient.GetPublisherData({
|
4170
|
+
* "Keys": [
|
4171
|
+
* "color",
|
4172
|
+
* "propertyA"
|
4173
|
+
* ]
|
4174
|
+
* });
|
3364
4175
|
*/
|
3365
4176
|
GetPublisherData(request: GetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
|
3366
4177
|
/**
|
3367
4178
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3368
4179
|
* version 2._ Retrieves the configuration information for the specified random results tables for the title, including all
|
3369
4180
|
* ItemId values and weights
|
3370
|
-
*
|
4181
|
+
*
|
4182
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables Microsoft Documentation}
|
4183
|
+
* @example
|
4184
|
+
* await serverClient.GetRandomResultTables({
|
4185
|
+
* "CatalogVersion": "1",
|
4186
|
+
* "TableIDs": [
|
4187
|
+
* "CommonElementCard",
|
4188
|
+
* "UncommonElementCard",
|
4189
|
+
* "RareElementCard"
|
4190
|
+
* ]
|
4191
|
+
* });
|
3371
4192
|
*/
|
3372
4193
|
GetRandomResultTables(request: GetRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
|
3373
4194
|
/**
|
3374
4195
|
* Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
|
3375
|
-
*
|
4196
|
+
*
|
4197
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids Microsoft Documentation}
|
4198
|
+
* @example
|
4199
|
+
* await serverClient.GetServerCustomIDsFromPlayFabIDs({
|
4200
|
+
* "PlayFabIDs": [
|
4201
|
+
* "1232421311"
|
4202
|
+
* ]
|
4203
|
+
* });
|
3376
4204
|
*/
|
3377
4205
|
GetServerCustomIDsFromPlayFabIDs(request: GetServerCustomIDsFromPlayFabIDsRequest, extraHeaders?: Record<string, string>): Promise<GetServerCustomIDsFromPlayFabIDsResult>;
|
3378
4206
|
/**
|
3379
4207
|
* Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all
|
3380
4208
|
* public and private group data. Shared Groups are designed for sharing data between a very small number of players,
|
3381
4209
|
* please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3382
|
-
*
|
4210
|
+
*
|
4211
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/getsharedgroupdata Microsoft Documentation}
|
4212
|
+
* @example
|
4213
|
+
* await serverClient.GetSharedGroupData({
|
4214
|
+
* "SharedGroupId": "Clan Data",
|
4215
|
+
* "Keys": [
|
4216
|
+
* "ClanKills",
|
4217
|
+
* "LastClanUpdate"
|
4218
|
+
* ],
|
4219
|
+
* "GetMembers": true
|
4220
|
+
* });
|
3383
4221
|
*/
|
3384
4222
|
GetSharedGroupData(request: GetSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<GetSharedGroupDataResult>;
|
3385
4223
|
/**
|
3386
4224
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3387
4225
|
* version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified
|
3388
4226
|
* player
|
3389
|
-
*
|
4227
|
+
*
|
4228
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems Microsoft Documentation}
|
4229
|
+
* @example
|
4230
|
+
* await serverClient.GetStoreItems({
|
4231
|
+
* "StoreId": "BonusStore",
|
4232
|
+
* "PlayFabId": "20394883"
|
4233
|
+
* });
|
3390
4234
|
*/
|
3391
4235
|
GetStoreItems(request: GetStoreItemsServerRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
|
3392
4236
|
/**
|
3393
4237
|
* Retrieves the current server time
|
3394
|
-
*
|
4238
|
+
*
|
4239
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime Microsoft Documentation}
|
4240
|
+
* @example
|
4241
|
+
* await serverClient.GetTime({});
|
3395
4242
|
*/
|
3396
4243
|
GetTime(request: GetTimeRequest, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
|
3397
4244
|
/**
|
3398
4245
|
* Retrieves the key-value store of custom title settings
|
3399
|
-
*
|
4246
|
+
*
|
4247
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata Microsoft Documentation}
|
4248
|
+
* @example
|
4249
|
+
* await serverClient.GetTitleData({
|
4250
|
+
* "Keys": [
|
4251
|
+
* "color",
|
4252
|
+
* "propertyA"
|
4253
|
+
* ]
|
4254
|
+
* });
|
3400
4255
|
*/
|
3401
4256
|
GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3402
4257
|
/**
|
3403
4258
|
* Retrieves the key-value store of custom internal title settings
|
3404
|
-
*
|
4259
|
+
*
|
4260
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata Microsoft Documentation}
|
4261
|
+
* @example
|
4262
|
+
* await serverClient.GetTitleInternalData({
|
4263
|
+
* "Keys": [
|
4264
|
+
* "color",
|
4265
|
+
* "propertyA"
|
4266
|
+
* ]
|
4267
|
+
* });
|
3405
4268
|
*/
|
3406
4269
|
GetTitleInternalData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3407
4270
|
/**
|
3408
4271
|
* Retrieves the title news feed, as configured in the developer portal
|
3409
|
-
*
|
4272
|
+
*
|
4273
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews Microsoft Documentation}
|
4274
|
+
* @example
|
4275
|
+
* await serverClient.GetTitleNews({
|
4276
|
+
* "Count": 25
|
4277
|
+
* });
|
3410
4278
|
*/
|
3411
4279
|
GetTitleNews(request: GetTitleNewsRequest, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
|
3412
4280
|
/**
|
3413
4281
|
* Retrieves the relevant details for a specified user
|
3414
|
-
*
|
4282
|
+
*
|
4283
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo Microsoft Documentation}
|
4284
|
+
* @example
|
4285
|
+
* await serverClient.GetUserAccountInfo({
|
4286
|
+
* "PlayFabId": "10931252888739651331"
|
4287
|
+
* });
|
3415
4288
|
*/
|
3416
4289
|
GetUserAccountInfo(request: GetUserAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<GetUserAccountInfoResult>;
|
3417
4290
|
/**
|
3418
4291
|
* Gets all bans for a user.
|
3419
|
-
*
|
4292
|
+
*
|
4293
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans Microsoft Documentation}
|
4294
|
+
* @example
|
4295
|
+
* await serverClient.GetUserBans({
|
4296
|
+
* "PlayFabId": "1679AF5CD04BD838"
|
4297
|
+
* });
|
3420
4298
|
*/
|
3421
4299
|
GetUserBans(request: GetUserBansRequest, extraHeaders?: Record<string, string>): Promise<GetUserBansResult>;
|
3422
4300
|
/**
|
3423
4301
|
* Retrieves the title-specific custom data for the user which is readable and writable by the client
|
3424
|
-
*
|
4302
|
+
*
|
4303
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata Microsoft Documentation}
|
4304
|
+
* @example
|
4305
|
+
* await serverClient.GetUserData({
|
4306
|
+
* "PlayFabId": "2039475",
|
4307
|
+
* "Keys": [
|
4308
|
+
* "preferences",
|
4309
|
+
* "progress"
|
4310
|
+
* ],
|
4311
|
+
* "IfChangedFromDataVersion": 13
|
4312
|
+
* });
|
3425
4313
|
*/
|
3426
4314
|
GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3427
4315
|
/**
|
3428
4316
|
* Retrieves the title-specific custom data for the user which cannot be accessed by the client
|
3429
|
-
*
|
4317
|
+
*
|
4318
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata Microsoft Documentation}
|
4319
|
+
* @example
|
4320
|
+
* await serverClient.GetUserInternalData({
|
4321
|
+
* "PlayFabId": "2039475",
|
4322
|
+
* "Keys": [
|
4323
|
+
* "preferences",
|
4324
|
+
* "progress"
|
4325
|
+
* ],
|
4326
|
+
* "IfChangedFromDataVersion": 13
|
4327
|
+
* });
|
3430
4328
|
*/
|
3431
4329
|
GetUserInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3432
4330
|
/**
|
3433
4331
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3434
4332
|
* version 2._ Retrieves the specified user's current inventory of virtual goods
|
3435
|
-
*
|
4333
|
+
*
|
4334
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory Microsoft Documentation}
|
4335
|
+
* @example
|
4336
|
+
* await serverClient.GetUserInventory({
|
4337
|
+
* "PlayFabId": "204883457"
|
4338
|
+
* });
|
3436
4339
|
*/
|
3437
4340
|
GetUserInventory(request: GetUserInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
|
3438
4341
|
/**
|
3439
4342
|
* Retrieves the publisher-specific custom data for the user which is readable and writable by the client
|
3440
|
-
*
|
4343
|
+
*
|
4344
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherdata Microsoft Documentation}
|
4345
|
+
* @example
|
4346
|
+
* await serverClient.GetUserPublisherData({
|
4347
|
+
* "PlayFabId": "2039475",
|
4348
|
+
* "Keys": [
|
4349
|
+
* "preferences",
|
4350
|
+
* "progress"
|
4351
|
+
* ],
|
4352
|
+
* "IfChangedFromDataVersion": 13
|
4353
|
+
* });
|
3441
4354
|
*/
|
3442
4355
|
GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3443
4356
|
/**
|
3444
4357
|
* Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
|
3445
|
-
*
|
4358
|
+
*
|
4359
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata Microsoft Documentation}
|
4360
|
+
* @example
|
4361
|
+
* await serverClient.GetUserPublisherInternalData({
|
4362
|
+
* "PlayFabId": "2039475",
|
4363
|
+
* "Keys": [
|
4364
|
+
* "preferences",
|
4365
|
+
* "progress"
|
4366
|
+
* ],
|
4367
|
+
* "IfChangedFromDataVersion": 13
|
4368
|
+
* });
|
3446
4369
|
*/
|
3447
4370
|
GetUserPublisherInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3448
4371
|
/**
|
3449
4372
|
* Retrieves the publisher-specific custom data for the user which can only be read by the client
|
3450
|
-
*
|
4373
|
+
*
|
4374
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
|
4375
|
+
* @example
|
4376
|
+
* await serverClient.GetUserPublisherReadOnlyData({
|
4377
|
+
* "PlayFabId": "2039475",
|
4378
|
+
* "Keys": [
|
4379
|
+
* "preferences",
|
4380
|
+
* "progress"
|
4381
|
+
* ],
|
4382
|
+
* "IfChangedFromDataVersion": 13
|
4383
|
+
* });
|
3451
4384
|
*/
|
3452
4385
|
GetUserPublisherReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3453
4386
|
/**
|
3454
4387
|
* Retrieves the title-specific custom data for the user which can only be read by the client
|
3455
|
-
*
|
4388
|
+
*
|
4389
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserreadonlydata Microsoft Documentation}
|
4390
|
+
* @example
|
4391
|
+
* await serverClient.GetUserReadOnlyData({
|
4392
|
+
* "PlayFabId": "2039475",
|
4393
|
+
* "Keys": [
|
4394
|
+
* "preferences",
|
4395
|
+
* "progress"
|
4396
|
+
* ],
|
4397
|
+
* "IfChangedFromDataVersion": 13
|
4398
|
+
* });
|
3456
4399
|
*/
|
3457
4400
|
GetUserReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
4401
|
+
/**
|
4402
|
+
* Retrieves the details of all title-specific statistics for the user
|
4403
|
+
*
|
4404
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserstatistics Microsoft Documentation}
|
4405
|
+
* @deprecated Please use GetPlayerStatistics instead.
|
4406
|
+
*/
|
4407
|
+
GetUserStatistics(request: GetUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetUserStatisticsResult>;
|
3458
4408
|
/**
|
3459
4409
|
* Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
|
3460
4410
|
* with the parent PlayFabId to guarantee uniqueness.
|
3461
|
-
*
|
4411
|
+
*
|
4412
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/grantcharactertouser Microsoft Documentation}
|
4413
|
+
* @example
|
4414
|
+
* await serverClient.GrantCharacterToUser({
|
4415
|
+
* "PlayFabId": "20394883567",
|
4416
|
+
* "CharacterName": "FighterDude",
|
4417
|
+
* "CharacterType": "Blue Warrior"
|
4418
|
+
* });
|
3462
4419
|
*/
|
3463
4420
|
GrantCharacterToUser(request: GrantCharacterToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
|
3464
4421
|
/**
|
3465
4422
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3466
4423
|
* version 2._ Adds the specified items to the specified character's inventory
|
3467
|
-
*
|
4424
|
+
*
|
4425
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter Microsoft Documentation}
|
4426
|
+
* @example
|
4427
|
+
* await serverClient.GrantItemsToCharacter({
|
4428
|
+
* "CharacterId": "9876543268",
|
4429
|
+
* "PlayFabId": "20394883",
|
4430
|
+
* "Annotation": "Entered Level 2",
|
4431
|
+
* "ItemIds": [
|
4432
|
+
* "shield_level_5",
|
4433
|
+
* "shield_level_6"
|
4434
|
+
* ]
|
4435
|
+
* });
|
3468
4436
|
*/
|
3469
4437
|
GrantItemsToCharacter(request: GrantItemsToCharacterRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToCharacterResult>;
|
3470
4438
|
/**
|
3471
4439
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3472
4440
|
* version 2._ Adds the specified items to the specified user's inventory
|
3473
|
-
*
|
4441
|
+
*
|
4442
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser Microsoft Documentation}
|
4443
|
+
* @example
|
4444
|
+
* await serverClient.GrantItemsToUser({
|
4445
|
+
* "PlayFabId": "20394883",
|
4446
|
+
* "Annotation": "Entered Level 2",
|
4447
|
+
* "ItemIds": [
|
4448
|
+
* "shield_level_3",
|
4449
|
+
* "shield_level_4"
|
4450
|
+
* ]
|
4451
|
+
* });
|
3474
4452
|
*/
|
3475
4453
|
GrantItemsToUser(request: GrantItemsToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUserResult>;
|
3476
4454
|
/**
|
3477
4455
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3478
4456
|
* version 2._ Adds the specified items to the specified user inventories
|
3479
|
-
*
|
4457
|
+
*
|
4458
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers Microsoft Documentation}
|
4459
|
+
* @example
|
4460
|
+
* await serverClient.GrantItemsToUsers({
|
4461
|
+
* "CatalogVersion": "5",
|
4462
|
+
* "ItemGrants": [
|
4463
|
+
* {
|
4464
|
+
* "PlayFabId": "20394883",
|
4465
|
+
* "ItemId": "shield_level_1",
|
4466
|
+
* "Annotation": "Entered Level 2"
|
4467
|
+
* },
|
4468
|
+
* {
|
4469
|
+
* "PlayFabId": "20394883",
|
4470
|
+
* "ItemId": "shield_level_2",
|
4471
|
+
* "Annotation": "Entered Level 2",
|
4472
|
+
* "Data": {
|
4473
|
+
* "Equipped": "True",
|
4474
|
+
* "Slot": "Head"
|
4475
|
+
* }
|
4476
|
+
* }
|
4477
|
+
* ]
|
4478
|
+
* });
|
3480
4479
|
*/
|
3481
4480
|
GrantItemsToUsers(request: GrantItemsToUsersRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUsersResult>;
|
3482
4481
|
/**
|
3483
4482
|
* Links the Battle.net account associated with the token to the user's PlayFab account.
|
3484
|
-
*
|
4483
|
+
*
|
4484
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount Microsoft Documentation}
|
4485
|
+
* @example
|
4486
|
+
* await serverClient.LinkBattleNetAccount({
|
4487
|
+
* "PlayFabId": "1234FA342",
|
4488
|
+
* "IdentityToken": "eyJraWQi..."
|
4489
|
+
* });
|
3485
4490
|
*/
|
3486
4491
|
LinkBattleNetAccount(request: LinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3487
4492
|
/**
|
3488
4493
|
* Links the Nintendo account associated with the token to the user's PlayFab account
|
3489
|
-
*
|
4494
|
+
*
|
4495
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount Microsoft Documentation}
|
4496
|
+
* @example
|
4497
|
+
* await serverClient.LinkNintendoServiceAccount({
|
4498
|
+
* "PlayFabId": "1234FA342",
|
4499
|
+
* "IdentityToken": "eyJraWQi..."
|
4500
|
+
* });
|
3490
4501
|
*/
|
3491
4502
|
LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3492
4503
|
/**
|
3493
4504
|
* Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account
|
3494
|
-
*
|
4505
|
+
*
|
4506
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject Microsoft Documentation}
|
4507
|
+
* @example
|
4508
|
+
* await serverClient.LinkNintendoServiceAccountSubject({
|
4509
|
+
* "PlayFabId": "1234FA342",
|
4510
|
+
* "Subject": "8e7Eju4j9"
|
4511
|
+
* });
|
3495
4512
|
*/
|
3496
4513
|
LinkNintendoServiceAccountSubject(request: LinkNintendoServiceAccountSubjectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3497
4514
|
/**
|
3498
4515
|
* Links the NintendoSwitchDeviceId to the user's PlayFab account
|
3499
|
-
*
|
4516
|
+
*
|
4517
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid Microsoft Documentation}
|
4518
|
+
* @example
|
4519
|
+
* await serverClient.LinkNintendoSwitchDeviceId({
|
4520
|
+
* "PlayFabId": "1234FA342",
|
4521
|
+
* "NintendoSwitchDeviceId": "526f79204261747479"
|
4522
|
+
* });
|
3500
4523
|
*/
|
3501
4524
|
LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
|
3502
4525
|
/**
|
3503
4526
|
* Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
|
3504
|
-
*
|
4527
|
+
*
|
4528
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnaccount Microsoft Documentation}
|
4529
|
+
* @example
|
4530
|
+
* await serverClient.LinkPSNAccount({
|
4531
|
+
* "PlayFabId": "1234FA342",
|
4532
|
+
* "AuthCode": "LKJDG7DDE",
|
4533
|
+
* "RedirectUri": "orbis://games"
|
4534
|
+
* });
|
3505
4535
|
*/
|
3506
4536
|
LinkPSNAccount(request: LinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
|
3507
4537
|
/**
|
3508
4538
|
* Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account
|
3509
|
-
*
|
4539
|
+
*
|
4540
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid Microsoft Documentation}
|
4541
|
+
* @example
|
4542
|
+
* await serverClient.LinkPSNId({
|
4543
|
+
* "PlayFabId": "1234FA342",
|
4544
|
+
* "PSNUserId": "LKJDG7DDE"
|
4545
|
+
* });
|
3510
4546
|
*/
|
3511
4547
|
LinkPSNId(request: LinkPSNIdRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNIdResponse>;
|
3512
4548
|
/**
|
3513
4549
|
* Links the custom server identifier, generated by the title, to the user's PlayFab account.
|
3514
|
-
*
|
4550
|
+
*
|
4551
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid Microsoft Documentation}
|
4552
|
+
* @example
|
4553
|
+
* await serverClient.LinkServerCustomId({
|
4554
|
+
* "PlayFabId": "123412341234",
|
4555
|
+
* "ServerCustomId": "67AB-5397-CC54-EA31"
|
4556
|
+
* });
|
3515
4557
|
*/
|
3516
4558
|
LinkServerCustomId(request: LinkServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<LinkServerCustomIdResult>;
|
3517
4559
|
/**
|
3518
4560
|
* Links the Steam account associated with the provided Steam ID to the user's PlayFab account
|
3519
|
-
*
|
4561
|
+
*
|
4562
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid Microsoft Documentation}
|
4563
|
+
* @example
|
4564
|
+
* await serverClient.LinkSteamId({
|
4565
|
+
* "SteamId": "22223333",
|
4566
|
+
* "PlayFabId": "5a446c83645201"
|
4567
|
+
* });
|
3520
4568
|
*/
|
3521
4569
|
LinkSteamId(request: LinkSteamIdRequest, extraHeaders?: Record<string, string>): Promise<LinkSteamIdResult>;
|
3522
4570
|
/**
|
3523
4571
|
* Links the Xbox Live account associated with the provided access code to the user's PlayFab account
|
3524
|
-
*
|
4572
|
+
*
|
4573
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount Microsoft Documentation}
|
4574
|
+
* @example
|
4575
|
+
* await serverClient.LinkXboxAccount({
|
4576
|
+
* "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
|
4577
|
+
* "PlayFabId": "5a446c83645201"
|
4578
|
+
* });
|
3525
4579
|
*/
|
3526
4580
|
LinkXboxAccount(request: LinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
|
3527
4581
|
/**
|
3528
4582
|
* Retrieves title-specific custom property values for a player.
|
3529
|
-
*
|
4583
|
+
*
|
4584
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties Microsoft Documentation}
|
4585
|
+
* @example
|
4586
|
+
* await serverClient.ListPlayerCustomProperties({
|
4587
|
+
* "PlayFabId": "2039475"
|
4588
|
+
* });
|
3530
4589
|
*/
|
3531
4590
|
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
|
4591
|
+
/**
|
4592
|
+
* Logs a custom analytics event
|
4593
|
+
*
|
4594
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/logevent Microsoft Documentation}
|
4595
|
+
* @deprecated Please use WritePlayerEvent instead.
|
4596
|
+
*/
|
4597
|
+
LogEvent(request: LogEventRequest, extraHeaders?: Record<string, string>): Promise<LogEventResult>;
|
3532
4598
|
/**
|
3533
4599
|
* Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
|
3534
4600
|
* API calls which require an authenticated user
|
3535
|
-
*
|
4601
|
+
*
|
4602
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid Microsoft Documentation}
|
4603
|
+
* @example
|
4604
|
+
* await serverClient.LoginWithAndroidDeviceID({
|
4605
|
+
* "AndroidDeviceId": "526f79204261747479",
|
4606
|
+
* "OS": "5.0",
|
4607
|
+
* "AndroidDevice": "Nexus 6",
|
4608
|
+
* "CreateAccount": false
|
4609
|
+
* });
|
3536
4610
|
*/
|
3537
4611
|
LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3538
4612
|
/**
|
3539
4613
|
* Sign in the user with a Battle.net identity token
|
3540
|
-
*
|
4614
|
+
*
|
4615
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet Microsoft Documentation}
|
4616
|
+
* @example
|
4617
|
+
* await serverClient.LoginWithBattleNet({
|
4618
|
+
* "IdentityToken": "eyJraWQi..."
|
4619
|
+
* });
|
3541
4620
|
*/
|
3542
4621
|
LoginWithBattleNet(request: LoginWithBattleNetRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3543
4622
|
/**
|
3544
4623
|
* Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
|
3545
4624
|
* subsequently be used for API calls which require an authenticated user
|
3546
|
-
*
|
4625
|
+
*
|
4626
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid Microsoft Documentation}
|
4627
|
+
* @example
|
4628
|
+
* await serverClient.LoginWithCustomID({
|
4629
|
+
* "CustomId": "67AB-5397-CC54-EA31",
|
4630
|
+
* "CreateAccount": false
|
4631
|
+
* });
|
3547
4632
|
*/
|
3548
4633
|
LoginWithCustomID(request: LoginWithCustomIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3549
4634
|
/**
|
3550
4635
|
* Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API
|
3551
4636
|
* calls which require an authenticated user
|
3552
|
-
*
|
4637
|
+
*
|
4638
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid Microsoft Documentation}
|
4639
|
+
* @example
|
4640
|
+
* await serverClient.LoginWithIOSDeviceID({
|
4641
|
+
* "DeviceId": "29848d9bh8900a0b003",
|
4642
|
+
* "OS": "7.11",
|
4643
|
+
* "DeviceModel": "Iphone 5s",
|
4644
|
+
* "CreateAccount": false
|
4645
|
+
* });
|
3553
4646
|
*/
|
3554
4647
|
LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3555
4648
|
/**
|
3556
4649
|
* Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
|
3557
4650
|
* subsequently be used for API calls which require an authenticated user
|
3558
|
-
*
|
4651
|
+
*
|
4652
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithpsn Microsoft Documentation}
|
4653
|
+
* @example
|
4654
|
+
* await serverClient.LoginWithPSN({
|
4655
|
+
* "AuthCode": "LKJ6D896D",
|
4656
|
+
* "RedirectUri": "orbis://games",
|
4657
|
+
* "CreateAccount": false
|
4658
|
+
* });
|
3559
4659
|
*/
|
3560
4660
|
LoginWithPSN(request: LoginWithPSNRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3561
4661
|
/**
|
3562
4662
|
* Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID
|
3563
4663
|
* and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
|
3564
|
-
*
|
4664
|
+
*
|
4665
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid Microsoft Documentation}
|
4666
|
+
* @example
|
4667
|
+
* await serverClient.LoginWithServerCustomId({
|
4668
|
+
* "ServerCustomId": "asdalsdkjar09u23ijf",
|
4669
|
+
* "CreateAccount": true
|
4670
|
+
* });
|
3565
4671
|
*/
|
3566
4672
|
LoginWithServerCustomId(request: LoginWithServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3567
4673
|
/**
|
3568
4674
|
* Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which
|
3569
4675
|
* require an authenticated user
|
3570
|
-
*
|
4676
|
+
*
|
4677
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid Microsoft Documentation}
|
4678
|
+
* @example
|
4679
|
+
* await serverClient.LoginWithSteamId({
|
4680
|
+
* "SteamId": "12344553",
|
4681
|
+
* "CreateAccount": false
|
4682
|
+
* });
|
3571
4683
|
*/
|
3572
4684
|
LoginWithSteamId(request: LoginWithSteamIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3573
4685
|
/**
|
3574
4686
|
* Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can
|
3575
4687
|
* subsequently be used for API calls which require an authenticated user
|
3576
|
-
*
|
4688
|
+
*
|
4689
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox Microsoft Documentation}
|
4690
|
+
* @example
|
4691
|
+
* await serverClient.LoginWithXbox({
|
4692
|
+
* "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
|
4693
|
+
* "CreateAccount": false
|
4694
|
+
* });
|
3577
4695
|
*/
|
3578
4696
|
LoginWithXbox(request: LoginWithXboxRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3579
4697
|
/**
|
3580
4698
|
* Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API
|
3581
4699
|
* calls which require an authenticated user
|
3582
|
-
*
|
4700
|
+
*
|
4701
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid Microsoft Documentation}
|
4702
|
+
* @example
|
4703
|
+
* await serverClient.LoginWithXboxId({
|
4704
|
+
* "XboxId": "12344553",
|
4705
|
+
* "Sandbox": "RETAIL",
|
4706
|
+
* "CreateAccount": false
|
4707
|
+
* });
|
3583
4708
|
*/
|
3584
4709
|
LoginWithXboxId(request: LoginWithXboxIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3585
4710
|
/**
|
3586
4711
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3587
4712
|
* version 2._ Modifies the number of remaining uses of a player's inventory item
|
3588
|
-
*
|
4713
|
+
*
|
4714
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses Microsoft Documentation}
|
4715
|
+
* @example
|
4716
|
+
* await serverClient.ModifyItemUses({
|
4717
|
+
* "PlayFabId": "20394883",
|
4718
|
+
* "ItemInstanceId": "94585729",
|
4719
|
+
* "UsesToAdd": 1
|
4720
|
+
* });
|
3589
4721
|
*/
|
3590
4722
|
ModifyItemUses(request: ModifyItemUsesRequest, extraHeaders?: Record<string, string>): Promise<ModifyItemUsesResult>;
|
3591
4723
|
/**
|
3592
4724
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3593
4725
|
* version 2._ Moves an item from a character's inventory into another of the users's character's inventory.
|
3594
|
-
*
|
4726
|
+
*
|
4727
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter Microsoft Documentation}
|
4728
|
+
* @example
|
4729
|
+
* await serverClient.MoveItemToCharacterFromCharacter({
|
4730
|
+
* "PlayFabId": "234234897234",
|
4731
|
+
* "GivingCharacterId": "98092347523",
|
4732
|
+
* "ReceivingCharacterId": "6323489712",
|
4733
|
+
* "ItemInstanceId": "701231299999"
|
4734
|
+
* });
|
3595
4735
|
*/
|
3596
4736
|
MoveItemToCharacterFromCharacter(request: MoveItemToCharacterFromCharacterRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromCharacterResult>;
|
3597
4737
|
/**
|
3598
4738
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3599
4739
|
* version 2._ Moves an item from a user's inventory into their character's inventory.
|
3600
|
-
*
|
4740
|
+
*
|
4741
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser Microsoft Documentation}
|
4742
|
+
* @example
|
4743
|
+
* await serverClient.MoveItemToCharacterFromUser({
|
4744
|
+
* "PlayFabId": "234234897234",
|
4745
|
+
* "CharacterId": "98092347523",
|
4746
|
+
* "ItemInstanceId": "701231299999"
|
4747
|
+
* });
|
3601
4748
|
*/
|
3602
4749
|
MoveItemToCharacterFromUser(request: MoveItemToCharacterFromUserRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromUserResult>;
|
3603
4750
|
/**
|
3604
4751
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3605
4752
|
* version 2._ Moves an item from a character's inventory into the owning user's inventory.
|
3606
|
-
*
|
4753
|
+
*
|
4754
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter Microsoft Documentation}
|
4755
|
+
* @example
|
4756
|
+
* await serverClient.MoveItemToUserFromCharacter({
|
4757
|
+
* "PlayFabId": "234234897234",
|
4758
|
+
* "CharacterId": "98092347523",
|
4759
|
+
* "ItemInstanceId": "701231299999"
|
4760
|
+
* });
|
3607
4761
|
*/
|
3608
4762
|
MoveItemToUserFromCharacter(request: MoveItemToUserFromCharacterRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToUserFromCharacterResult>;
|
4763
|
+
/**
|
4764
|
+
* Informs the PlayFab match-making service that the user specified has left the Game Server Instance
|
4765
|
+
*
|
4766
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/notifymatchmakerplayerleft Microsoft Documentation}
|
4767
|
+
* @deprecated Do not use
|
4768
|
+
*/
|
4769
|
+
NotifyMatchmakerPlayerLeft(request: NotifyMatchmakerPlayerLeftRequest, extraHeaders?: Record<string, string>): Promise<NotifyMatchmakerPlayerLeftResult>;
|
3609
4770
|
/**
|
3610
4771
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3611
4772
|
* version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
|
3612
4773
|
* Economy->Catalogs tab in the PlayFab Game Manager.
|
3613
|
-
*
|
4774
|
+
*
|
4775
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/redeemcoupon Microsoft Documentation}
|
4776
|
+
* @example
|
4777
|
+
* await serverClient.RedeemCoupon({
|
4778
|
+
* "CouponCode": "123-1234-123",
|
4779
|
+
* "CatalogVersion": "5"
|
4780
|
+
* });
|
3614
4781
|
*/
|
3615
4782
|
RedeemCoupon(request: RedeemCouponRequest, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
|
4783
|
+
/**
|
4784
|
+
* Validates a Game Server session ticket and returns details about the user
|
4785
|
+
*
|
4786
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/redeemmatchmakerticket Microsoft Documentation}
|
4787
|
+
* @deprecated Do not use
|
4788
|
+
*/
|
4789
|
+
RedeemMatchmakerTicket(request: RedeemMatchmakerTicketRequest, extraHeaders?: Record<string, string>): Promise<RedeemMatchmakerTicketResult>;
|
4790
|
+
/**
|
4791
|
+
* Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance.
|
4792
|
+
*
|
4793
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/refreshgameserverinstanceheartbeat Microsoft Documentation}
|
4794
|
+
* @deprecated Do not use
|
4795
|
+
*/
|
4796
|
+
RefreshGameServerInstanceHeartbeat(request: RefreshGameServerInstanceHeartbeatRequest, extraHeaders?: Record<string, string>): Promise<RefreshGameServerInstanceHeartbeatResult>;
|
4797
|
+
/**
|
4798
|
+
* Inform the matchmaker that a new Game Server Instance is added.
|
4799
|
+
*
|
4800
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/registergame Microsoft Documentation}
|
4801
|
+
* @deprecated Do not use
|
4802
|
+
*/
|
4803
|
+
RegisterGame(request: RegisterGameRequest, extraHeaders?: Record<string, string>): Promise<RegisterGameResponse>;
|
3616
4804
|
/**
|
3617
4805
|
* Removes the specified friend from the the user's friend list
|
3618
|
-
*
|
4806
|
+
*
|
4807
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend Microsoft Documentation}
|
4808
|
+
* @example
|
4809
|
+
* await serverClient.RemoveFriend({
|
4810
|
+
* "FriendPlayFabId": "29837799",
|
4811
|
+
* "PlayFabId": "1a46086aed40f142"
|
4812
|
+
* });
|
3619
4813
|
*/
|
3620
4814
|
RemoveFriend(request: RemoveFriendRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3621
4815
|
/**
|
3622
4816
|
* Removes the specified generic service identifier from the player's PlayFab account.
|
3623
|
-
*
|
4817
|
+
*
|
4818
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid Microsoft Documentation}
|
4819
|
+
* @example
|
4820
|
+
* await serverClient.RemoveGenericID({
|
4821
|
+
* "GenericId": {
|
4822
|
+
* "ServiceName": "BigBizSocial",
|
4823
|
+
* "UserId": "1234567890"
|
4824
|
+
* }
|
4825
|
+
* });
|
3624
4826
|
*/
|
3625
4827
|
RemoveGenericID(request: RemoveGenericIDRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3626
4828
|
/**
|
3627
4829
|
* Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
3628
|
-
*
|
4830
|
+
*
|
4831
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag Microsoft Documentation}
|
4832
|
+
* @example
|
4833
|
+
* await serverClient.RemovePlayerTag({
|
4834
|
+
* "PlayFabId": "10931252888739651331",
|
4835
|
+
* "TagName": "MostKilled"
|
4836
|
+
* });
|
3629
4837
|
*/
|
3630
4838
|
RemovePlayerTag(request: RemovePlayerTagRequest, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
|
3631
4839
|
/**
|
@@ -3633,138 +4841,332 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3633
4841
|
* group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
|
3634
4842
|
* will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
|
3635
4843
|
* guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3636
|
-
*
|
4844
|
+
*
|
4845
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/removesharedgroupmembers Microsoft Documentation}
|
4846
|
+
* @example
|
4847
|
+
* await serverClient.RemoveSharedGroupMembers({
|
4848
|
+
* "SharedGroupId": "Clan Data",
|
4849
|
+
* "PlayFabIds": [
|
4850
|
+
* "D984A64B832",
|
4851
|
+
* "F74A523E1562"
|
4852
|
+
* ]
|
4853
|
+
* });
|
3637
4854
|
*/
|
3638
4855
|
RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
|
3639
4856
|
/**
|
3640
4857
|
* Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service
|
3641
4858
|
* representatives for the title can take action concerning potentially toxic players.
|
3642
|
-
*
|
4859
|
+
*
|
4860
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer Microsoft Documentation}
|
4861
|
+
* @example
|
4862
|
+
* await serverClient.ReportPlayer({
|
4863
|
+
* "ReporterId": "9ddafe27d6d445da",
|
4864
|
+
* "ReporteeId": "1a46086aed40f142",
|
4865
|
+
* "Comment": "cheating"
|
4866
|
+
* });
|
3643
4867
|
*/
|
3644
4868
|
ReportPlayer(request: ReportPlayerServerRequest, extraHeaders?: Record<string, string>): Promise<ReportPlayerServerResult>;
|
3645
4869
|
/**
|
3646
4870
|
* Revoke all active bans for a user.
|
3647
|
-
*
|
4871
|
+
*
|
4872
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser Microsoft Documentation}
|
4873
|
+
* @example
|
4874
|
+
* await serverClient.RevokeAllBansForUser({
|
4875
|
+
* "PlayFabId": "1679AF5CD04BD838"
|
4876
|
+
* });
|
3648
4877
|
*/
|
3649
4878
|
RevokeAllBansForUser(request: RevokeAllBansForUserRequest, extraHeaders?: Record<string, string>): Promise<RevokeAllBansForUserResult>;
|
3650
4879
|
/**
|
3651
4880
|
* Revoke all active bans specified with BanId.
|
3652
|
-
*
|
4881
|
+
*
|
4882
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans Microsoft Documentation}
|
4883
|
+
* @example
|
4884
|
+
* await serverClient.RevokeBans({
|
4885
|
+
* "BanIds": [
|
4886
|
+
* "E0B5FF89542D413C",
|
4887
|
+
* "EF43FF89542G1546"
|
4888
|
+
* ]
|
4889
|
+
* });
|
3653
4890
|
*/
|
3654
4891
|
RevokeBans(request: RevokeBansRequest, extraHeaders?: Record<string, string>): Promise<RevokeBansResult>;
|
3655
4892
|
/**
|
3656
4893
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3657
4894
|
* version 2._ Revokes access to an item in a user's inventory
|
3658
|
-
*
|
4895
|
+
*
|
4896
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem Microsoft Documentation}
|
4897
|
+
* @example
|
4898
|
+
* await serverClient.RevokeInventoryItem({
|
4899
|
+
* "PlayFabId": "203945882",
|
4900
|
+
* "ItemInstanceId": "2048583045"
|
4901
|
+
* });
|
3659
4902
|
*/
|
3660
4903
|
RevokeInventoryItem(request: RevokeInventoryItemRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryResult>;
|
3661
4904
|
/**
|
3662
4905
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3663
4906
|
* version 2._ Revokes access for up to 25 items across multiple users and characters.
|
3664
|
-
*
|
4907
|
+
*
|
4908
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems Microsoft Documentation}
|
4909
|
+
* @example
|
4910
|
+
* await serverClient.RevokeInventoryItems({
|
4911
|
+
* "Items": [
|
4912
|
+
* {
|
4913
|
+
* "PlayFabId": "203945882",
|
4914
|
+
* "ItemInstanceId": "2048583045"
|
4915
|
+
* }
|
4916
|
+
* ]
|
4917
|
+
* });
|
3665
4918
|
*/
|
3666
4919
|
RevokeInventoryItems(request: RevokeInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
|
3667
4920
|
/**
|
3668
4921
|
* Saves push notification template for title
|
3669
|
-
*
|
4922
|
+
*
|
4923
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate Microsoft Documentation}
|
4924
|
+
* @example
|
4925
|
+
* await serverClient.SavePushNotificationTemplate({
|
4926
|
+
* "Id": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4",
|
4927
|
+
* "Name": "F8763A987E",
|
4928
|
+
* "AndroidPayload": "{ notification: { body: \"Some Message\", title: \"Subject\", body_loc_key: \"someLocKey\" } }",
|
4929
|
+
* "IOSPayload": "{ aps: { alert: { body: \"Some Message\", title: \"Subject\", \"loc-key\": \"someLocKey\" } } }",
|
4930
|
+
* "LocalizedPushNotificationTemplates": {
|
4931
|
+
* "en": {
|
4932
|
+
* "Subject": "Recent Attack",
|
4933
|
+
* "Message": "You have been attacked! Go defend your base!"
|
4934
|
+
* },
|
4935
|
+
* "fr": {
|
4936
|
+
* "Subject": "Attaque récente",
|
4937
|
+
* "Message": "Vous avez été attaqué! Va défendre ta base!"
|
4938
|
+
* }
|
4939
|
+
* }
|
4940
|
+
* });
|
3670
4941
|
*/
|
3671
4942
|
SavePushNotificationTemplate(request: SavePushNotificationTemplateRequest, extraHeaders?: Record<string, string>): Promise<SavePushNotificationTemplateResult>;
|
3672
4943
|
/**
|
3673
4944
|
* Forces an email to be sent to the registered contact email address for the user's account based on an account recovery
|
3674
4945
|
* email template
|
3675
|
-
*
|
4946
|
+
*
|
4947
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail Microsoft Documentation}
|
4948
|
+
* @example
|
4949
|
+
* await serverClient.SendCustomAccountRecoveryEmail({
|
4950
|
+
* "EmailTemplateId": "D53AB15D8F12E330",
|
4951
|
+
* "Email": "Me@here.com"
|
4952
|
+
* });
|
3676
4953
|
*/
|
3677
4954
|
SendCustomAccountRecoveryEmail(request: SendCustomAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendCustomAccountRecoveryEmailResult>;
|
3678
4955
|
/**
|
3679
4956
|
* Sends an email based on an email template to a player's contact email
|
3680
|
-
*
|
4957
|
+
*
|
4958
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate Microsoft Documentation}
|
4959
|
+
* @example
|
4960
|
+
* await serverClient.SendEmailFromTemplate({
|
4961
|
+
* "EmailTemplateId": "B53CA15D92D2E331",
|
4962
|
+
* "PlayFabId": "A01DC15D8E12E230"
|
4963
|
+
* });
|
3681
4964
|
*/
|
3682
4965
|
SendEmailFromTemplate(request: SendEmailFromTemplateRequest, extraHeaders?: Record<string, string>): Promise<SendEmailFromTemplateResult>;
|
3683
4966
|
/**
|
3684
4967
|
* Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push
|
3685
4968
|
* Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
|
3686
|
-
*
|
4969
|
+
*
|
4970
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification Microsoft Documentation}
|
4971
|
+
* @example
|
4972
|
+
* await serverClient.SendPushNotification({
|
4973
|
+
* "Recipient": "F8763A987E",
|
4974
|
+
* "Message": "You have been attacked! Go defend your base!"
|
4975
|
+
* });
|
3687
4976
|
*/
|
3688
4977
|
SendPushNotification(request: SendPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
|
3689
4978
|
/**
|
3690
4979
|
* Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push
|
3691
4980
|
* Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
|
3692
|
-
*
|
4981
|
+
*
|
4982
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate Microsoft Documentation}
|
4983
|
+
* @example
|
4984
|
+
* await serverClient.SendPushNotificationFromTemplate({
|
4985
|
+
* "Recipient": "F8763A987E",
|
4986
|
+
* "PushNotificationTemplateId": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4"
|
4987
|
+
* });
|
3693
4988
|
*/
|
3694
4989
|
SendPushNotificationFromTemplate(request: SendPushNotificationFromTemplateRequest, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
|
3695
4990
|
/**
|
3696
4991
|
* Updates the tag list for a specified user in the friend list of another user
|
3697
|
-
*
|
4992
|
+
*
|
4993
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags Microsoft Documentation}
|
4994
|
+
* @example
|
4995
|
+
* await serverClient.SetFriendTags({
|
4996
|
+
* "PlayFabId": "ABCDEF123456",
|
4997
|
+
* "FriendPlayFabId": "298ABC37799",
|
4998
|
+
* "Tags": [
|
4999
|
+
* "sniper",
|
5000
|
+
* "melee"
|
5001
|
+
* ]
|
5002
|
+
* });
|
3698
5003
|
*/
|
3699
5004
|
SetFriendTags(request: SetFriendTagsRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
5005
|
+
/**
|
5006
|
+
* Sets the custom data of the indicated Game Server Instance
|
5007
|
+
*
|
5008
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancedata Microsoft Documentation}
|
5009
|
+
* @deprecated Do not use
|
5010
|
+
*/
|
5011
|
+
SetGameServerInstanceData(request: SetGameServerInstanceDataRequest, extraHeaders?: Record<string, string>): Promise<SetGameServerInstanceDataResult>;
|
5012
|
+
/**
|
5013
|
+
* Set the state of the indicated Game Server Instance.
|
5014
|
+
*
|
5015
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancestate Microsoft Documentation}
|
5016
|
+
* @deprecated Do not use
|
5017
|
+
*/
|
5018
|
+
SetGameServerInstanceState(request: SetGameServerInstanceStateRequest, extraHeaders?: Record<string, string>): Promise<SetGameServerInstanceStateResult>;
|
5019
|
+
/**
|
5020
|
+
* Set custom tags for the specified Game Server Instance
|
5021
|
+
*
|
5022
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancetags Microsoft Documentation}
|
5023
|
+
* @deprecated Do not use
|
5024
|
+
*/
|
5025
|
+
SetGameServerInstanceTags(request: SetGameServerInstanceTagsRequest, extraHeaders?: Record<string, string>): Promise<SetGameServerInstanceTagsResult>;
|
3700
5026
|
/**
|
3701
5027
|
* Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
|
3702
5028
|
* secret use the Admin or Server API method SetPlayerSecret.
|
3703
|
-
*
|
5029
|
+
*
|
5030
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/setplayersecret Microsoft Documentation}
|
5031
|
+
* @example
|
5032
|
+
* await serverClient.SetPlayerSecret({
|
5033
|
+
* "PlayerSecret": "ExampleSecret",
|
5034
|
+
* "PlayFabId": "ABCD1234"
|
5035
|
+
* });
|
3704
5036
|
*/
|
3705
5037
|
SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
|
3706
5038
|
/**
|
3707
5039
|
* Updates the key-value store of custom publisher settings
|
3708
|
-
*
|
5040
|
+
*
|
5041
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata Microsoft Documentation}
|
5042
|
+
* @example
|
5043
|
+
* await serverClient.SetPublisherData({
|
5044
|
+
* "Key": "Running Speed",
|
5045
|
+
* "Value": "1.03"
|
5046
|
+
* });
|
3709
5047
|
*/
|
3710
5048
|
SetPublisherData(request: SetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
|
3711
5049
|
/**
|
3712
5050
|
* Updates the key-value store of custom title settings
|
3713
|
-
*
|
5051
|
+
*
|
5052
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata Microsoft Documentation}
|
5053
|
+
* @example
|
5054
|
+
* await serverClient.SetTitleData({
|
5055
|
+
* "Key": "Running Speed",
|
5056
|
+
* "Value": "1.03"
|
5057
|
+
* });
|
3714
5058
|
*/
|
3715
5059
|
SetTitleData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3716
5060
|
/**
|
3717
5061
|
* Updates the key-value store of custom title settings
|
3718
|
-
*
|
5062
|
+
*
|
5063
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata Microsoft Documentation}
|
5064
|
+
* @example
|
5065
|
+
* await serverClient.SetTitleInternalData({
|
5066
|
+
* "Key": "Running Speed",
|
5067
|
+
* "Value": "1.03"
|
5068
|
+
* });
|
3719
5069
|
*/
|
3720
5070
|
SetTitleInternalData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3721
5071
|
/**
|
3722
5072
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3723
5073
|
* version 2._ Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to
|
3724
5074
|
* make a VC balance negative with this API.
|
3725
|
-
*
|
5075
|
+
*
|
5076
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractcharactervirtualcurrency Microsoft Documentation}
|
5077
|
+
* @example
|
5078
|
+
* await serverClient.SubtractCharacterVirtualCurrency({
|
5079
|
+
* "PlayFabId": "20394883",
|
5080
|
+
* "CharacterId": "23424524523",
|
5081
|
+
* "VirtualCurrency": "GC",
|
5082
|
+
* "Amount": 100
|
5083
|
+
* });
|
3726
5084
|
*/
|
3727
5085
|
SubtractCharacterVirtualCurrency(request: SubtractCharacterVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
|
3728
5086
|
/**
|
3729
5087
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3730
5088
|
* version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
|
3731
5089
|
* a VC balance negative with this API.
|
3732
|
-
*
|
5090
|
+
*
|
5091
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
|
5092
|
+
* @example
|
5093
|
+
* await serverClient.SubtractUserVirtualCurrency({
|
5094
|
+
* "PlayFabId": "20394883",
|
5095
|
+
* "VirtualCurrency": "GC",
|
5096
|
+
* "Amount": 100
|
5097
|
+
* });
|
3733
5098
|
*/
|
3734
5099
|
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
3735
5100
|
/**
|
3736
5101
|
* Unlinks the related Battle.net account from the user's PlayFab account.
|
3737
|
-
*
|
5102
|
+
*
|
5103
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount Microsoft Documentation}
|
5104
|
+
* @example
|
5105
|
+
* await serverClient.UnlinkBattleNetAccount({
|
5106
|
+
* "PlayFabId": "1234FA342"
|
5107
|
+
* });
|
3738
5108
|
*/
|
3739
5109
|
UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3740
5110
|
/**
|
3741
5111
|
* Unlinks the related Nintendo account from the user's PlayFab account
|
3742
|
-
*
|
5112
|
+
*
|
5113
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount Microsoft Documentation}
|
5114
|
+
* @example
|
5115
|
+
* await serverClient.UnlinkNintendoServiceAccount({
|
5116
|
+
* "PlayFabId": "1234FA342"
|
5117
|
+
* });
|
3743
5118
|
*/
|
3744
5119
|
UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3745
5120
|
/**
|
3746
5121
|
* Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
|
3747
|
-
*
|
5122
|
+
*
|
5123
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoswitchdeviceid Microsoft Documentation}
|
5124
|
+
* @example
|
5125
|
+
* await serverClient.UnlinkNintendoSwitchDeviceId({
|
5126
|
+
* "PlayFabId": "1234FA342",
|
5127
|
+
* "NintendoSwitchDeviceId": "526f79204261747479"
|
5128
|
+
* });
|
3748
5129
|
*/
|
3749
5130
|
UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
|
3750
5131
|
/**
|
3751
5132
|
* Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
|
3752
|
-
*
|
5133
|
+
*
|
5134
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount Microsoft Documentation}
|
5135
|
+
* @example
|
5136
|
+
* await serverClient.UnlinkPSNAccount({
|
5137
|
+
* "PlayFabId": "1234FA342"
|
5138
|
+
* });
|
3753
5139
|
*/
|
3754
5140
|
UnlinkPSNAccount(request: UnlinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
|
3755
5141
|
/**
|
3756
5142
|
* Unlinks the custom server identifier from the user's PlayFab account.
|
3757
|
-
*
|
5143
|
+
*
|
5144
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid Microsoft Documentation}
|
5145
|
+
* @example
|
5146
|
+
* await serverClient.UnlinkServerCustomId({
|
5147
|
+
* "PlayFabId": "123412341234",
|
5148
|
+
* "ServerCustomId": "67AB-5397-CC54-EA31"
|
5149
|
+
* });
|
3758
5150
|
*/
|
3759
5151
|
UnlinkServerCustomId(request: UnlinkServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkServerCustomIdResult>;
|
3760
5152
|
/**
|
3761
5153
|
* Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account
|
3762
|
-
*
|
5154
|
+
*
|
5155
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid Microsoft Documentation}
|
5156
|
+
* @example
|
5157
|
+
* await serverClient.UnlinkSteamId({
|
5158
|
+
* "PlayFabId": "5a446c83645201"
|
5159
|
+
* });
|
3763
5160
|
*/
|
3764
5161
|
UnlinkSteamId(request: UnlinkSteamIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkSteamIdResult>;
|
3765
5162
|
/**
|
3766
5163
|
* Unlinks the related Xbox Live account from the user's PlayFab account
|
3767
|
-
*
|
5164
|
+
*
|
5165
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount Microsoft Documentation}
|
5166
|
+
* @example
|
5167
|
+
* await serverClient.UnlinkXboxAccount({
|
5168
|
+
* "PlayFabId": "5a446c83645201"
|
5169
|
+
* });
|
3768
5170
|
*/
|
3769
5171
|
UnlinkXboxAccount(request: UnlinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
|
3770
5172
|
/**
|
@@ -3772,7 +5174,14 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3772
5174
|
* version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when
|
3773
5175
|
* required), and returns the contents of the opened container. If the container (and key when relevant) are consumable
|
3774
5176
|
* (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
|
3775
|
-
*
|
5177
|
+
*
|
5178
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontainerinstance Microsoft Documentation}
|
5179
|
+
* @example
|
5180
|
+
* await serverClient.UnlockContainerInstance({
|
5181
|
+
* "PlayFabId": "20394883",
|
5182
|
+
* "ContainerItemInstanceId": "123456788",
|
5183
|
+
* "KeyItemInstanceId": "123456789"
|
5184
|
+
* });
|
3776
5185
|
*/
|
3777
5186
|
UnlockContainerInstance(request: UnlockContainerInstanceRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
|
3778
5187
|
/**
|
@@ -3781,47 +5190,161 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3781
5190
|
* unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when
|
3782
5191
|
* relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of
|
3783
5192
|
* ConsumeItem.
|
3784
|
-
*
|
5193
|
+
*
|
5194
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontaineritem Microsoft Documentation}
|
5195
|
+
* @example
|
5196
|
+
* await serverClient.UnlockContainerItem({
|
5197
|
+
* "PlayFabId": "20394883",
|
5198
|
+
* "ContainerItemId": "crate block 1"
|
5199
|
+
* });
|
3785
5200
|
*/
|
3786
5201
|
UnlockContainerItem(request: UnlockContainerItemRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
|
3787
5202
|
/**
|
3788
5203
|
* Update the avatar URL of the specified player
|
3789
|
-
*
|
5204
|
+
*
|
5205
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl Microsoft Documentation}
|
5206
|
+
* @example
|
5207
|
+
* await serverClient.UpdateAvatarUrl({
|
5208
|
+
* "PlayFabId": "22ca65837b158fab",
|
5209
|
+
* "ImageUrl": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50"
|
5210
|
+
* });
|
3790
5211
|
*/
|
3791
5212
|
UpdateAvatarUrl(request: UpdateAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3792
5213
|
/**
|
3793
5214
|
* Updates information of a list of existing bans specified with Ban Ids.
|
3794
|
-
*
|
5215
|
+
*
|
5216
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans Microsoft Documentation}
|
5217
|
+
* @example
|
5218
|
+
* await serverClient.UpdateBans({
|
5219
|
+
* "Bans": [
|
5220
|
+
* {
|
5221
|
+
* "BanId": "E0B5FF89542D413C",
|
5222
|
+
* "Permanent": true,
|
5223
|
+
* "Active": true
|
5224
|
+
* },
|
5225
|
+
* {
|
5226
|
+
* "BanId": "EF43FF89542G1546",
|
5227
|
+
* "Reason": "Royal pardon",
|
5228
|
+
* "Expires": "2016-07-04T00:00:00Z"
|
5229
|
+
* }
|
5230
|
+
* ]
|
5231
|
+
* });
|
3795
5232
|
*/
|
3796
5233
|
UpdateBans(request: UpdateBansRequest, extraHeaders?: Record<string, string>): Promise<UpdateBansResult>;
|
3797
5234
|
/**
|
3798
5235
|
* Updates the title-specific custom data for the user's character which is readable and writable by the client
|
3799
|
-
*
|
5236
|
+
*
|
5237
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterdata Microsoft Documentation}
|
5238
|
+
* @example
|
5239
|
+
* await serverClient.UpdateCharacterData({
|
5240
|
+
* "PlayFabId": "2039475",
|
5241
|
+
* "CharacterId": "98342357",
|
5242
|
+
* "Data": {
|
5243
|
+
* "Class": "Fighter",
|
5244
|
+
* "Gender": "Female",
|
5245
|
+
* "Icon": "Guard 3",
|
5246
|
+
* "Theme": "Colorful"
|
5247
|
+
* },
|
5248
|
+
* "Permission": "Public"
|
5249
|
+
* });
|
3800
5250
|
*/
|
3801
5251
|
UpdateCharacterData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
|
3802
5252
|
/**
|
3803
5253
|
* Updates the title-specific custom data for the user's character which cannot be accessed by the client
|
3804
|
-
*
|
5254
|
+
*
|
5255
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata Microsoft Documentation}
|
5256
|
+
* @example
|
5257
|
+
* await serverClient.UpdateCharacterInternalData({
|
5258
|
+
* "PlayFabId": "2039475",
|
5259
|
+
* "CharacterId": "98342357",
|
5260
|
+
* "Data": {
|
5261
|
+
* "Class": "Fighter",
|
5262
|
+
* "Gender": "Female",
|
5263
|
+
* "Icon": "Guard 3",
|
5264
|
+
* "Theme": "Colorful"
|
5265
|
+
* },
|
5266
|
+
* "Permission": "Public"
|
5267
|
+
* });
|
3805
5268
|
*/
|
3806
5269
|
UpdateCharacterInternalData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
|
3807
5270
|
/**
|
3808
5271
|
* Updates the title-specific custom data for the user's character which can only be read by the client
|
3809
|
-
*
|
5272
|
+
*
|
5273
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata Microsoft Documentation}
|
5274
|
+
* @example
|
5275
|
+
* await serverClient.UpdateCharacterReadOnlyData({
|
5276
|
+
* "PlayFabId": "2039475",
|
5277
|
+
* "CharacterId": "98342357",
|
5278
|
+
* "Data": {
|
5279
|
+
* "Class": "Fighter",
|
5280
|
+
* "Gender": "Female",
|
5281
|
+
* "Icon": "Guard 3",
|
5282
|
+
* "Theme": "Colorful"
|
5283
|
+
* },
|
5284
|
+
* "Permission": "Public"
|
5285
|
+
* });
|
3810
5286
|
*/
|
3811
5287
|
UpdateCharacterReadOnlyData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
|
3812
5288
|
/**
|
3813
5289
|
* Updates the values of the specified title-specific statistics for the specific character
|
3814
|
-
*
|
5290
|
+
*
|
5291
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics Microsoft Documentation}
|
5292
|
+
* @example
|
5293
|
+
* await serverClient.UpdateCharacterStatistics({
|
5294
|
+
* "PlayFabId": "10931252888739651331",
|
5295
|
+
* "CharacterId": "98765432",
|
5296
|
+
* "CharacterStatistics": {
|
5297
|
+
* "Headshots": 18,
|
5298
|
+
* "Kills": 47
|
5299
|
+
* }
|
5300
|
+
* });
|
3815
5301
|
*/
|
3816
5302
|
UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterStatisticsResult>;
|
3817
5303
|
/**
|
3818
5304
|
* Updates the title-specific custom property values for a player
|
3819
|
-
*
|
5305
|
+
*
|
5306
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties Microsoft Documentation}
|
5307
|
+
* @example
|
5308
|
+
* await serverClient.UpdatePlayerCustomProperties({
|
5309
|
+
* "PlayFabId": "2039475",
|
5310
|
+
* "Properties": [
|
5311
|
+
* {
|
5312
|
+
* "Name": "level",
|
5313
|
+
* "Value": 5
|
5314
|
+
* },
|
5315
|
+
* {
|
5316
|
+
* "Name": "created",
|
5317
|
+
* "Value": false
|
5318
|
+
* }
|
5319
|
+
* ],
|
5320
|
+
* "ExpectedPropertiesVersion": 12
|
5321
|
+
* });
|
3820
5322
|
*/
|
3821
5323
|
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
|
3822
5324
|
/**
|
3823
5325
|
* Updates the values of the specified title-specific statistics for the user
|
3824
|
-
*
|
5326
|
+
*
|
5327
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics Microsoft Documentation}
|
5328
|
+
* @example
|
5329
|
+
* await serverClient.UpdatePlayerStatistics({
|
5330
|
+
* "PlayFabId": "10931252888739651331",
|
5331
|
+
* "Statistics": [
|
5332
|
+
* {
|
5333
|
+
* "StatisticName": "Points",
|
5334
|
+
* "Version": 1,
|
5335
|
+
* "Value": 600
|
5336
|
+
* },
|
5337
|
+
* {
|
5338
|
+
* "StatisticName": "Wins",
|
5339
|
+
* "Version": 2,
|
5340
|
+
* "Value": 16
|
5341
|
+
* },
|
5342
|
+
* {
|
5343
|
+
* "StatisticName": "Stars",
|
5344
|
+
* "Value": 7
|
5345
|
+
* }
|
5346
|
+
* ]
|
5347
|
+
* });
|
3825
5348
|
*/
|
3826
5349
|
UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
|
3827
5350
|
/**
|
@@ -3830,58 +5353,197 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3830
5353
|
* Regardless of the permission setting, only members of the group (and the server) can update the data. Shared Groups are
|
3831
5354
|
* designed for sharing data between a very small number of players, please see our guide:
|
3832
5355
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3833
|
-
*
|
5356
|
+
*
|
5357
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/updatesharedgroupdata Microsoft Documentation}
|
5358
|
+
* @example
|
5359
|
+
* await serverClient.UpdateSharedGroupData({
|
5360
|
+
* "SharedGroupId": "Clan Data",
|
5361
|
+
* "Data": {
|
5362
|
+
* "ClanKills": "34",
|
5363
|
+
* "LastClanUpdate": "2014-10-03T09:21:14Z"
|
5364
|
+
* },
|
5365
|
+
* "Permission": "Public"
|
5366
|
+
* });
|
3834
5367
|
*/
|
3835
5368
|
UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
|
3836
5369
|
/**
|
3837
5370
|
* Updates the title-specific custom data for the user which is readable and writable by the client
|
3838
|
-
*
|
5371
|
+
*
|
5372
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata Microsoft Documentation}
|
5373
|
+
* @example
|
5374
|
+
* await serverClient.UpdateUserData({
|
5375
|
+
* "PlayFabId": "2039475",
|
5376
|
+
* "Data": {
|
5377
|
+
* "Class": "Fighter",
|
5378
|
+
* "Gender": "Female",
|
5379
|
+
* "Icon": "Guard 3",
|
5380
|
+
* "Theme": "Colorful"
|
5381
|
+
* },
|
5382
|
+
* "Permission": "Public"
|
5383
|
+
* });
|
3839
5384
|
*/
|
3840
5385
|
UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3841
5386
|
/**
|
3842
5387
|
* Updates the title-specific custom data for the user which cannot be accessed by the client
|
3843
|
-
*
|
5388
|
+
*
|
5389
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata Microsoft Documentation}
|
5390
|
+
* @example
|
5391
|
+
* await serverClient.UpdateUserInternalData({
|
5392
|
+
* "PlayFabId": "2039475",
|
5393
|
+
* "Data": {
|
5394
|
+
* "Class": "Fighter",
|
5395
|
+
* "Gender": "Female",
|
5396
|
+
* "Icon": "Guard 3",
|
5397
|
+
* "Theme": "Colorful"
|
5398
|
+
* }
|
5399
|
+
* });
|
3844
5400
|
*/
|
3845
5401
|
UpdateUserInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3846
5402
|
/**
|
3847
5403
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3848
5404
|
* version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.
|
3849
|
-
*
|
5405
|
+
*
|
5406
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata Microsoft Documentation}
|
5407
|
+
* @example
|
5408
|
+
* await serverClient.UpdateUserInventoryItemCustomData({
|
5409
|
+
* "PlayFabId": "204883457",
|
5410
|
+
* "CharacterId": "9890723423",
|
5411
|
+
* "ItemInstanceId": "88331144",
|
5412
|
+
* "Data": {
|
5413
|
+
* "Equipped": "True",
|
5414
|
+
* "Slot": "Head"
|
5415
|
+
* }
|
5416
|
+
* });
|
3850
5417
|
*/
|
3851
5418
|
UpdateUserInventoryItemCustomData(request: UpdateUserInventoryItemDataRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3852
5419
|
/**
|
3853
5420
|
* Updates the publisher-specific custom data for the user which is readable and writable by the client
|
3854
|
-
*
|
5421
|
+
*
|
5422
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata Microsoft Documentation}
|
5423
|
+
* @example
|
5424
|
+
* await serverClient.UpdateUserPublisherData({
|
5425
|
+
* "PlayFabId": "2039475",
|
5426
|
+
* "Data": {
|
5427
|
+
* "Class": "Fighter",
|
5428
|
+
* "Gender": "Female",
|
5429
|
+
* "Icon": "Guard 3",
|
5430
|
+
* "Theme": "Colorful"
|
5431
|
+
* },
|
5432
|
+
* "Permission": "Public"
|
5433
|
+
* });
|
3855
5434
|
*/
|
3856
5435
|
UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3857
5436
|
/**
|
3858
5437
|
* Updates the publisher-specific custom data for the user which cannot be accessed by the client
|
3859
|
-
*
|
5438
|
+
*
|
5439
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata Microsoft Documentation}
|
5440
|
+
* @example
|
5441
|
+
* await serverClient.UpdateUserPublisherInternalData({
|
5442
|
+
* "PlayFabId": "2039475",
|
5443
|
+
* "Data": {
|
5444
|
+
* "Class": "Fighter",
|
5445
|
+
* "Gender": "Female",
|
5446
|
+
* "Icon": "Guard 3",
|
5447
|
+
* "Theme": "Colorful"
|
5448
|
+
* }
|
5449
|
+
* });
|
3860
5450
|
*/
|
3861
5451
|
UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3862
5452
|
/**
|
3863
5453
|
* Updates the publisher-specific custom data for the user which can only be read by the client
|
3864
|
-
*
|
5454
|
+
*
|
5455
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata Microsoft Documentation}
|
5456
|
+
* @example
|
5457
|
+
* await serverClient.UpdateUserPublisherReadOnlyData({
|
5458
|
+
* "PlayFabId": "2039475",
|
5459
|
+
* "Data": {
|
5460
|
+
* "Class": "Fighter",
|
5461
|
+
* "Gender": "Female",
|
5462
|
+
* "Icon": "Guard 3",
|
5463
|
+
* "Theme": "Colorful"
|
5464
|
+
* },
|
5465
|
+
* "Permission": "Public"
|
5466
|
+
* });
|
3865
5467
|
*/
|
3866
5468
|
UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3867
5469
|
/**
|
3868
5470
|
* Updates the title-specific custom data for the user which can only be read by the client
|
3869
|
-
*
|
5471
|
+
*
|
5472
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata Microsoft Documentation}
|
5473
|
+
* @example
|
5474
|
+
* await serverClient.UpdateUserReadOnlyData({
|
5475
|
+
* "PlayFabId": "2039475",
|
5476
|
+
* "Data": {
|
5477
|
+
* "Class": "Fighter",
|
5478
|
+
* "Gender": "Female",
|
5479
|
+
* "Icon": "Guard 3",
|
5480
|
+
* "Theme": "Colorful"
|
5481
|
+
* },
|
5482
|
+
* "Permission": "Public"
|
5483
|
+
* });
|
3870
5484
|
*/
|
3871
5485
|
UpdateUserReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
5486
|
+
/**
|
5487
|
+
* Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
|
5488
|
+
* update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
|
5489
|
+
*
|
5490
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserstatistics Microsoft Documentation}
|
5491
|
+
* @deprecated Please use UpdatePlayerStatistics instead.
|
5492
|
+
*/
|
5493
|
+
UpdateUserStatistics(request: UpdateUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserStatisticsResult>;
|
3872
5494
|
/**
|
3873
5495
|
* Writes a character-based event into PlayStream.
|
3874
|
-
*
|
5496
|
+
*
|
5497
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent Microsoft Documentation}
|
5498
|
+
* @example
|
5499
|
+
* await serverClient.WriteCharacterEvent({
|
5500
|
+
* "PlayFabId": "3947655299CB786",
|
5501
|
+
* "CharacterId": "E161CB4B7F6C34B",
|
5502
|
+
* "EventName": "character_defeated_enemy",
|
5503
|
+
* "Timestamp": "2016-03-07T00:00:00Z",
|
5504
|
+
* "Body": {
|
5505
|
+
* "Enemy": "guardian",
|
5506
|
+
* "Damage": 5,
|
5507
|
+
* "Coordinates": {
|
5508
|
+
* "X": 123.4,
|
5509
|
+
* "Y": 543.2
|
5510
|
+
* }
|
5511
|
+
* }
|
5512
|
+
* });
|
3875
5513
|
*/
|
3876
5514
|
WriteCharacterEvent(request: WriteServerCharacterEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
3877
5515
|
/**
|
3878
5516
|
* Writes a player-based event into PlayStream.
|
3879
|
-
*
|
5517
|
+
*
|
5518
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent Microsoft Documentation}
|
5519
|
+
* @example
|
5520
|
+
* await serverClient.WritePlayerEvent({
|
5521
|
+
* "PlayFabId": "3947655299CB786",
|
5522
|
+
* "EventName": "player_defeated_enemy",
|
5523
|
+
* "Timestamp": "2016-03-07T00:00:00Z",
|
5524
|
+
* "Body": {
|
5525
|
+
* "Enemy": "guardian",
|
5526
|
+
* "Damage": 5,
|
5527
|
+
* "Coordinates": {
|
5528
|
+
* "X": 123.4,
|
5529
|
+
* "Y": 543.2
|
5530
|
+
* }
|
5531
|
+
* }
|
5532
|
+
* });
|
3880
5533
|
*/
|
3881
5534
|
WritePlayerEvent(request: WriteServerPlayerEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
3882
5535
|
/**
|
3883
5536
|
* Writes a title-based event into PlayStream.
|
3884
|
-
*
|
5537
|
+
*
|
5538
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent Microsoft Documentation}
|
5539
|
+
* @example
|
5540
|
+
* await serverClient.WriteTitleEvent({
|
5541
|
+
* "EventName": "client_update_submitted",
|
5542
|
+
* "Timestamp": "2016-03-07T00:00:00Z",
|
5543
|
+
* "Body": {
|
5544
|
+
* "Version": "1.4.50"
|
5545
|
+
* }
|
5546
|
+
* });
|
3885
5547
|
*/
|
3886
5548
|
WriteTitleEvent(request: WriteTitleEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
3887
5549
|
}
|