async-playfab-web-sdk 1.192.250526-2 → 1.192.250526-4
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 +31 -31
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +118 -118
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +5 -5
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +174 -174
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +16 -16
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +8 -8
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +47 -47
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +13 -13
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +14 -14
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +26 -26
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +7 -7
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +2 -2
- package/dist/Localization.js +2 -2
- package/dist/Multiplayer.d.ts +88 -88
- package/dist/Multiplayer.js +2 -2
- package/dist/{PlayFabCommon-BUv4zqXf.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +6 -10
- package/dist/Profiles.d.ts +10 -10
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +24 -24
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +150 -150
- package/dist/Server.js +2 -2
- package/dist/{chunk-FPCXHDA7.js → chunk-2IBLMNAQ.js} +236 -236
- package/dist/chunk-2IBLMNAQ.js.map +1 -0
- package/dist/{chunk-5AAYYQU7.js → chunk-3TRLETD6.js} +32 -32
- package/dist/chunk-3TRLETD6.js.map +1 -0
- package/dist/{chunk-2NRPVFSH.js → chunk-4LT3OUQD.js} +176 -176
- package/dist/chunk-4LT3OUQD.js.map +1 -0
- package/dist/{chunk-CY3H2GBI.js → chunk-6TH6EJYH.js} +37 -78
- package/dist/chunk-6TH6EJYH.js.map +1 -0
- package/dist/{chunk-ZY56RXKC.js → chunk-7UQYMDJQ.js} +62 -62
- package/dist/chunk-7UQYMDJQ.js.map +1 -0
- package/dist/{chunk-D53KEX67.js → chunk-CLMINF57.js} +4 -4
- package/dist/chunk-CLMINF57.js.map +1 -0
- package/dist/{chunk-EY77H23H.js → chunk-F5NRBD4O.js} +48 -48
- package/dist/chunk-F5NRBD4O.js.map +1 -0
- package/dist/{chunk-QCCQJDCR.js → chunk-FEEE3PRD.js} +348 -348
- package/dist/chunk-FEEE3PRD.js.map +1 -0
- package/dist/{chunk-JRE75IDS.js → chunk-HKZJ4H4O.js} +26 -26
- package/dist/chunk-HKZJ4H4O.js.map +1 -0
- package/dist/{chunk-VTCQRNBL.js → chunk-NJQCK4TL.js} +16 -16
- package/dist/chunk-NJQCK4TL.js.map +1 -0
- package/dist/{chunk-BZECCU2H.js → chunk-ONCBQLGS.js} +300 -300
- package/dist/chunk-ONCBQLGS.js.map +1 -0
- package/dist/{chunk-RODJAJP2.js → chunk-PXPOK2QU.js} +14 -14
- package/dist/chunk-PXPOK2QU.js.map +1 -0
- package/dist/{chunk-7VP4SIOQ.js → chunk-Q22JHX4G.js} +20 -20
- package/dist/chunk-Q22JHX4G.js.map +1 -0
- package/dist/{chunk-V56QSAWL.js → chunk-RJPMKD7P.js} +10 -10
- package/dist/chunk-RJPMKD7P.js.map +1 -0
- package/dist/{chunk-42AWSTMK.js → chunk-WROXLFDZ.js} +28 -28
- package/dist/chunk-WROXLFDZ.js.map +1 -0
- package/dist/{chunk-CDBIRT6V.js → chunk-XAI5IWL4.js} +52 -52
- package/dist/chunk-XAI5IWL4.js.map +1 -0
- package/dist/{chunk-RHQFG2EP.js → chunk-XM26BUTO.js} +94 -94
- package/dist/chunk-XM26BUTO.js.map +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +17 -17
- package/package.json +1 -1
- package/dist/chunk-2NRPVFSH.js.map +0 -1
- package/dist/chunk-42AWSTMK.js.map +0 -1
- package/dist/chunk-5AAYYQU7.js.map +0 -1
- package/dist/chunk-7VP4SIOQ.js.map +0 -1
- package/dist/chunk-BZECCU2H.js.map +0 -1
- package/dist/chunk-CDBIRT6V.js.map +0 -1
- package/dist/chunk-CY3H2GBI.js.map +0 -1
- package/dist/chunk-D53KEX67.js.map +0 -1
- package/dist/chunk-EY77H23H.js.map +0 -1
- package/dist/chunk-FPCXHDA7.js.map +0 -1
- package/dist/chunk-JRE75IDS.js.map +0 -1
- package/dist/chunk-QCCQJDCR.js.map +0 -1
- package/dist/chunk-RHQFG2EP.js.map +0 -1
- package/dist/chunk-RODJAJP2.js.map +0 -1
- package/dist/chunk-V56QSAWL.js.map +0 -1
- package/dist/chunk-VTCQRNBL.js.map +0 -1
- package/dist/chunk-ZY56RXKC.js.map +0 -1
package/dist/Client.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 AcceptTradeRequest extends IPlayFabRequestCommon {
|
4
4
|
/**
|
@@ -3496,97 +3496,97 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
3496
3496
|
* items will be swapped between the two players' inventories.
|
3497
3497
|
* https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade
|
3498
3498
|
*/
|
3499
|
-
AcceptTrade(request: AcceptTradeRequest,
|
3499
|
+
AcceptTrade(request: AcceptTradeRequest, extraHeaders?: Record<string, string>): Promise<AcceptTradeResponse>;
|
3500
3500
|
/**
|
3501
3501
|
* Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
|
3502
3502
|
* least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
|
3503
3503
|
* https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend
|
3504
3504
|
*/
|
3505
|
-
AddFriend(request: AddFriendRequest,
|
3505
|
+
AddFriend(request: AddFriendRequest, extraHeaders?: Record<string, string>): Promise<AddFriendResult>;
|
3506
3506
|
/**
|
3507
3507
|
* Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
|
3508
3508
|
* ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
|
3509
3509
|
* authentication credentials, as the intent is that it is easily accessible by other players.
|
3510
3510
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid
|
3511
3511
|
*/
|
3512
|
-
AddGenericID(request: AddGenericIDRequest,
|
3512
|
+
AddGenericID(request: AddGenericIDRequest, extraHeaders?: Record<string, string>): Promise<AddGenericIDResult>;
|
3513
3513
|
/**
|
3514
3514
|
* Adds or updates a contact email to the player's profile.
|
3515
3515
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail
|
3516
3516
|
*/
|
3517
|
-
AddOrUpdateContactEmail(request: AddOrUpdateContactEmailRequest,
|
3517
|
+
AddOrUpdateContactEmail(request: AddOrUpdateContactEmailRequest, extraHeaders?: Record<string, string>): Promise<AddOrUpdateContactEmailResult>;
|
3518
3518
|
/**
|
3519
3519
|
* Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users
|
3520
3520
|
* in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
|
3521
3521
|
* please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3522
3522
|
* https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers
|
3523
3523
|
*/
|
3524
|
-
AddSharedGroupMembers(request: AddSharedGroupMembersRequest,
|
3524
|
+
AddSharedGroupMembers(request: AddSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
|
3525
3525
|
/**
|
3526
3526
|
* Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
|
3527
3527
|
* ID login.
|
3528
3528
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword
|
3529
3529
|
*/
|
3530
|
-
AddUsernamePassword(request: AddUsernamePasswordRequest,
|
3530
|
+
AddUsernamePassword(request: AddUsernamePasswordRequest, extraHeaders?: Record<string, string>): Promise<AddUsernamePasswordResult>;
|
3531
3531
|
/**
|
3532
3532
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3533
3533
|
* version 2._ Increments the user's balance of the specified virtual currency by the stated amount
|
3534
3534
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency
|
3535
3535
|
*/
|
3536
|
-
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest,
|
3536
|
+
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
3537
3537
|
/**
|
3538
3538
|
* Registers the Android device to receive push notifications
|
3539
3539
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration
|
3540
3540
|
*/
|
3541
|
-
AndroidDevicePushNotificationRegistration(request: AndroidDevicePushNotificationRegistrationRequest,
|
3541
|
+
AndroidDevicePushNotificationRegistration(request: AndroidDevicePushNotificationRegistrationRequest, extraHeaders?: Record<string, string>): Promise<AndroidDevicePushNotificationRegistrationResult>;
|
3542
3542
|
/**
|
3543
3543
|
* Attributes an install for advertisment.
|
3544
3544
|
* https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall
|
3545
3545
|
*/
|
3546
|
-
AttributeInstall(request: AttributeInstallRequest,
|
3546
|
+
AttributeInstall(request: AttributeInstallRequest, extraHeaders?: Record<string, string>): Promise<AttributeInstallResult>;
|
3547
3547
|
/**
|
3548
3548
|
* Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
|
3549
3549
|
* can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
|
3550
3550
|
* players from accepting them, for trades that can be claimed by more than one player).
|
3551
3551
|
* https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade
|
3552
3552
|
*/
|
3553
|
-
CancelTrade(request: CancelTradeRequest,
|
3553
|
+
CancelTrade(request: CancelTradeRequest, extraHeaders?: Record<string, string>): Promise<CancelTradeResponse>;
|
3554
3554
|
/**
|
3555
3555
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3556
3556
|
* version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
|
3557
3557
|
* virtual currency balances as appropriate
|
3558
3558
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase
|
3559
3559
|
*/
|
3560
|
-
ConfirmPurchase(request: ConfirmPurchaseRequest,
|
3560
|
+
ConfirmPurchase(request: ConfirmPurchaseRequest, extraHeaders?: Record<string, string>): Promise<ConfirmPurchaseResult>;
|
3561
3561
|
/**
|
3562
3562
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3563
3563
|
* version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
|
3564
3564
|
* inventory.
|
3565
3565
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem
|
3566
3566
|
*/
|
3567
|
-
ConsumeItem(request: ConsumeItemRequest,
|
3567
|
+
ConsumeItem(request: ConsumeItemRequest, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
|
3568
3568
|
/**
|
3569
3569
|
* Grants the player's current entitlements from Microsoft Store's Collection API
|
3570
3570
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements
|
3571
3571
|
*/
|
3572
|
-
ConsumeMicrosoftStoreEntitlements(request: ConsumeMicrosoftStoreEntitlementsRequest,
|
3572
|
+
ConsumeMicrosoftStoreEntitlements(request: ConsumeMicrosoftStoreEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumeMicrosoftStoreEntitlementsResponse>;
|
3573
3573
|
/**
|
3574
3574
|
* Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
|
3575
3575
|
* PlayFab items
|
3576
3576
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements
|
3577
3577
|
*/
|
3578
|
-
ConsumePS5Entitlements(request: ConsumePS5EntitlementsRequest,
|
3578
|
+
ConsumePS5Entitlements(request: ConsumePS5EntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumePS5EntitlementsResult>;
|
3579
3579
|
/**
|
3580
3580
|
* Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
|
3581
3581
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements
|
3582
3582
|
*/
|
3583
|
-
ConsumePSNEntitlements(request: ConsumePSNEntitlementsRequest,
|
3583
|
+
ConsumePSNEntitlements(request: ConsumePSNEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumePSNEntitlementsResult>;
|
3584
3584
|
/**
|
3585
3585
|
* Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
|
3586
3586
|
* player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
|
3587
3587
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements
|
3588
3588
|
*/
|
3589
|
-
ConsumeXboxEntitlements(request: ConsumeXboxEntitlementsRequest,
|
3589
|
+
ConsumeXboxEntitlements(request: ConsumeXboxEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumeXboxEntitlementsResult>;
|
3590
3590
|
/**
|
3591
3591
|
* Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
|
3592
3592
|
* group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
|
@@ -3594,66 +3594,66 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
3594
3594
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3595
3595
|
* https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup
|
3596
3596
|
*/
|
3597
|
-
CreateSharedGroup(request: CreateSharedGroupRequest,
|
3597
|
+
CreateSharedGroup(request: CreateSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
|
3598
3598
|
/**
|
3599
3599
|
* Deletes title-specific custom properties for a player
|
3600
3600
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties
|
3601
3601
|
*/
|
3602
|
-
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest,
|
3602
|
+
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
|
3603
3603
|
/**
|
3604
3604
|
* Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
|
3605
3605
|
* PlayFab ID is the entity ID of the player's master_player_account entity.
|
3606
3606
|
* https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript
|
3607
3607
|
*/
|
3608
|
-
ExecuteCloudScript(request: ExecuteCloudScriptRequest,
|
3608
|
+
ExecuteCloudScript(request: ExecuteCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
|
3609
3609
|
/**
|
3610
3610
|
* Retrieves the user's PlayFab account details
|
3611
3611
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo
|
3612
3612
|
*/
|
3613
|
-
GetAccountInfo(request: GetAccountInfoRequest,
|
3613
|
+
GetAccountInfo(request: GetAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<GetAccountInfoResult>;
|
3614
3614
|
/**
|
3615
3615
|
* Returns a list of ad placements and a reward for each
|
3616
3616
|
* https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements
|
3617
3617
|
*/
|
3618
|
-
GetAdPlacements(request: GetAdPlacementsRequest,
|
3618
|
+
GetAdPlacements(request: GetAdPlacementsRequest, extraHeaders?: Record<string, string>): Promise<GetAdPlacementsResult>;
|
3619
3619
|
/**
|
3620
3620
|
* Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
|
3621
3621
|
* evaluated with the parent PlayFabId to guarantee uniqueness.
|
3622
3622
|
* https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters
|
3623
3623
|
*/
|
3624
|
-
GetAllUsersCharacters(request: ListUsersCharactersRequest,
|
3624
|
+
GetAllUsersCharacters(request: ListUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
|
3625
3625
|
/**
|
3626
3626
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3627
3627
|
* version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
|
3628
3628
|
* https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems
|
3629
3629
|
*/
|
3630
|
-
GetCatalogItems(request: GetCatalogItemsRequest,
|
3630
|
+
GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
|
3631
3631
|
/**
|
3632
3632
|
* Retrieves the title-specific custom data for the character which is readable and writable by the client
|
3633
3633
|
* https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata
|
3634
3634
|
*/
|
3635
|
-
GetCharacterData(request: GetCharacterDataRequest,
|
3635
|
+
GetCharacterData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3636
3636
|
/**
|
3637
3637
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3638
3638
|
* version 2._ Retrieves the specified character's current inventory of virtual goods
|
3639
3639
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory
|
3640
3640
|
*/
|
3641
|
-
GetCharacterInventory(request: GetCharacterInventoryRequest,
|
3641
|
+
GetCharacterInventory(request: GetCharacterInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
|
3642
3642
|
/**
|
3643
3643
|
* Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
|
3644
3644
|
* https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard
|
3645
3645
|
*/
|
3646
|
-
GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest,
|
3646
|
+
GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
|
3647
3647
|
/**
|
3648
3648
|
* Retrieves the title-specific custom data for the character which can only be read by the client
|
3649
3649
|
* https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata
|
3650
3650
|
*/
|
3651
|
-
GetCharacterReadOnlyData(request: GetCharacterDataRequest,
|
3651
|
+
GetCharacterReadOnlyData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3652
3652
|
/**
|
3653
3653
|
* Retrieves the details of all title-specific statistics for the user
|
3654
3654
|
* https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics
|
3655
3655
|
*/
|
3656
|
-
GetCharacterStatistics(request: GetCharacterStatisticsRequest,
|
3656
|
+
GetCharacterStatistics(request: GetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
|
3657
3657
|
/**
|
3658
3658
|
* This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
|
3659
3659
|
* URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
|
@@ -3663,46 +3663,46 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
3663
3663
|
* please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
|
3664
3664
|
* https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl
|
3665
3665
|
*/
|
3666
|
-
GetContentDownloadUrl(request: GetContentDownloadUrlRequest,
|
3666
|
+
GetContentDownloadUrl(request: GetContentDownloadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
|
3667
3667
|
/**
|
3668
3668
|
* Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
|
3669
3669
|
* the leaderboard
|
3670
3670
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard
|
3671
3671
|
*/
|
3672
|
-
GetFriendLeaderboard(request: GetFriendLeaderboardRequest,
|
3672
|
+
GetFriendLeaderboard(request: GetFriendLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
|
3673
3673
|
/**
|
3674
3674
|
* Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
|
3675
3675
|
* user. If PlayFabId is empty or null will return currently logged in user.
|
3676
3676
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer
|
3677
3677
|
*/
|
3678
|
-
GetFriendLeaderboardAroundPlayer(request: GetFriendLeaderboardAroundPlayerRequest,
|
3678
|
+
GetFriendLeaderboardAroundPlayer(request: GetFriendLeaderboardAroundPlayerRequest, extraHeaders?: Record<string, string>): Promise<GetFriendLeaderboardAroundPlayerResult>;
|
3679
3679
|
/**
|
3680
3680
|
* Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
|
3681
3681
|
* linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
|
3682
3682
|
* https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist
|
3683
3683
|
*/
|
3684
|
-
GetFriendsList(request: GetFriendsListRequest,
|
3684
|
+
GetFriendsList(request: GetFriendsListRequest, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
|
3685
3685
|
/**
|
3686
3686
|
* Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
|
3687
3687
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard
|
3688
3688
|
*/
|
3689
|
-
GetLeaderboard(request: GetLeaderboardRequest,
|
3689
|
+
GetLeaderboard(request: GetLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
|
3690
3690
|
/**
|
3691
3691
|
* Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID
|
3692
3692
|
* https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter
|
3693
3693
|
*/
|
3694
|
-
GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest,
|
3694
|
+
GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
|
3695
3695
|
/**
|
3696
3696
|
* Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
|
3697
3697
|
* null will return currently logged in user.
|
3698
3698
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer
|
3699
3699
|
*/
|
3700
|
-
GetLeaderboardAroundPlayer(request: GetLeaderboardAroundPlayerRequest,
|
3700
|
+
GetLeaderboardAroundPlayer(request: GetLeaderboardAroundPlayerRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundPlayerResult>;
|
3701
3701
|
/**
|
3702
3702
|
* Retrieves a list of all of the user's characters for the given statistic.
|
3703
3703
|
* https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters
|
3704
3704
|
*/
|
3705
|
-
GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest,
|
3705
|
+
GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
|
3706
3706
|
/**
|
3707
3707
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3708
3708
|
* version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
|
@@ -3710,158 +3710,158 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
3710
3710
|
* client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
|
3711
3711
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken
|
3712
3712
|
*/
|
3713
|
-
GetPaymentToken(request: GetPaymentTokenRequest,
|
3713
|
+
GetPaymentToken(request: GetPaymentTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPaymentTokenResult>;
|
3714
3714
|
/**
|
3715
3715
|
* Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
|
3716
3716
|
* https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
|
3717
3717
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken
|
3718
3718
|
*/
|
3719
|
-
GetPhotonAuthenticationToken(request: GetPhotonAuthenticationTokenRequest,
|
3719
|
+
GetPhotonAuthenticationToken(request: GetPhotonAuthenticationTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPhotonAuthenticationTokenResult>;
|
3720
3720
|
/**
|
3721
3721
|
* Retrieves all of the user's different kinds of info.
|
3722
3722
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo
|
3723
3723
|
*/
|
3724
|
-
GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest,
|
3724
|
+
GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCombinedInfoResult>;
|
3725
3725
|
/**
|
3726
3726
|
* Retrieves a title-specific custom property value for a player.
|
3727
3727
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty
|
3728
3728
|
*/
|
3729
|
-
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest,
|
3729
|
+
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
|
3730
3730
|
/**
|
3731
3731
|
* Retrieves the player's profile
|
3732
3732
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile
|
3733
3733
|
*/
|
3734
|
-
GetPlayerProfile(request: GetPlayerProfileRequest,
|
3734
|
+
GetPlayerProfile(request: GetPlayerProfileRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
|
3735
3735
|
/**
|
3736
3736
|
* List all segments that a player currently belongs to at this moment in time.
|
3737
3737
|
* https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments
|
3738
3738
|
*/
|
3739
|
-
GetPlayerSegments(request: GetPlayerSegmentsRequest,
|
3739
|
+
GetPlayerSegments(request: GetPlayerSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
|
3740
3740
|
/**
|
3741
3741
|
* Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
|
3742
3742
|
* player.
|
3743
3743
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics
|
3744
3744
|
*/
|
3745
|
-
GetPlayerStatistics(request: GetPlayerStatisticsRequest,
|
3745
|
+
GetPlayerStatistics(request: GetPlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticsResult>;
|
3746
3746
|
/**
|
3747
3747
|
* Retrieves the information on the available versions of the specified statistic.
|
3748
3748
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions
|
3749
3749
|
*/
|
3750
|
-
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest,
|
3750
|
+
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
|
3751
3751
|
/**
|
3752
3752
|
* Get all tags with a given Namespace (optional) from a player profile.
|
3753
3753
|
* https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags
|
3754
3754
|
*/
|
3755
|
-
GetPlayerTags(request: GetPlayerTagsRequest,
|
3755
|
+
GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
|
3756
3756
|
/**
|
3757
3757
|
* Gets all trades the player has either opened or accepted, optionally filtered by trade status.
|
3758
3758
|
* https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades
|
3759
3759
|
*/
|
3760
|
-
GetPlayerTrades(request: GetPlayerTradesRequest,
|
3760
|
+
GetPlayerTrades(request: GetPlayerTradesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTradesResponse>;
|
3761
3761
|
/**
|
3762
3762
|
* Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
|
3763
3763
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids
|
3764
3764
|
*/
|
3765
|
-
GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest,
|
3765
|
+
GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromBattleNetAccountIdsResult>;
|
3766
3766
|
/**
|
3767
3767
|
* Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
|
3768
3768
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids
|
3769
3769
|
*/
|
3770
|
-
GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest,
|
3770
|
+
GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookIDsResult>;
|
3771
3771
|
/**
|
3772
3772
|
* Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
|
3773
3773
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids
|
3774
3774
|
*/
|
3775
|
-
GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest,
|
3775
|
+
GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
|
3776
3776
|
/**
|
3777
3777
|
* Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
|
3778
3778
|
* Programming Guide as the Player Identifier).
|
3779
3779
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids
|
3780
3780
|
*/
|
3781
|
-
GetPlayFabIDsFromGameCenterIDs(request: GetPlayFabIDsFromGameCenterIDsRequest,
|
3781
|
+
GetPlayFabIDsFromGameCenterIDs(request: GetPlayFabIDsFromGameCenterIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGameCenterIDsResult>;
|
3782
3782
|
/**
|
3783
3783
|
* Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
|
3784
3784
|
* service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
|
3785
3785
|
* added to the player account.
|
3786
3786
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids
|
3787
3787
|
*/
|
3788
|
-
GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest,
|
3788
|
+
GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGenericIDsResult>;
|
3789
3789
|
/**
|
3790
3790
|
* Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
|
3791
3791
|
* the user accounts, available as "id" in the Google+ People API calls.
|
3792
3792
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids
|
3793
3793
|
*/
|
3794
|
-
GetPlayFabIDsFromGoogleIDs(request: GetPlayFabIDsFromGoogleIDsRequest,
|
3794
|
+
GetPlayFabIDsFromGoogleIDs(request: GetPlayFabIDsFromGoogleIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGoogleIDsResult>;
|
3795
3795
|
/**
|
3796
3796
|
* Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
|
3797
3797
|
* identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
|
3798
3798
|
* calls.
|
3799
3799
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids
|
3800
3800
|
*/
|
3801
|
-
GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request: GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest,
|
3801
|
+
GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request: GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult>;
|
3802
3802
|
/**
|
3803
3803
|
* Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
|
3804
3804
|
* IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
|
3805
3805
|
* http://developers.kongregate.com/docs/client/getUserId).
|
3806
3806
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids
|
3807
3807
|
*/
|
3808
|
-
GetPlayFabIDsFromKongregateIDs(request: GetPlayFabIDsFromKongregateIDsRequest,
|
3808
|
+
GetPlayFabIDsFromKongregateIDs(request: GetPlayFabIDsFromKongregateIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromKongregateIDsResult>;
|
3809
3809
|
/**
|
3810
3810
|
* Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
|
3811
3811
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids
|
3812
3812
|
*/
|
3813
|
-
GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest,
|
3813
|
+
GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoServiceAccountIdsResult>;
|
3814
3814
|
/**
|
3815
3815
|
* Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
|
3816
3816
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids
|
3817
3817
|
*/
|
3818
|
-
GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest,
|
3818
|
+
GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoSwitchDeviceIdsResult>;
|
3819
3819
|
/**
|
3820
3820
|
* Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
|
3821
3821
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids
|
3822
3822
|
*/
|
3823
|
-
GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest,
|
3823
|
+
GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNAccountIDsResult>;
|
3824
3824
|
/**
|
3825
3825
|
* Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
|
3826
3826
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids
|
3827
3827
|
*/
|
3828
|
-
GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest,
|
3828
|
+
GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNOnlineIDsResult>;
|
3829
3829
|
/**
|
3830
3830
|
* Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
|
3831
3831
|
* IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
|
3832
3832
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids
|
3833
3833
|
*/
|
3834
|
-
GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest,
|
3834
|
+
GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamIDsResult>;
|
3835
3835
|
/**
|
3836
3836
|
* Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
|
3837
3837
|
* names.
|
3838
3838
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames
|
3839
3839
|
*/
|
3840
|
-
GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest,
|
3840
|
+
GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamNamesResult>;
|
3841
3841
|
/**
|
3842
3842
|
* Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
|
3843
3843
|
* the user accounts, available as "_id" from the Twitch API methods (ex:
|
3844
3844
|
* https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
|
3845
3845
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids
|
3846
3846
|
*/
|
3847
|
-
GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest,
|
3847
|
+
GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromTwitchIDsResult>;
|
3848
3848
|
/**
|
3849
3849
|
* Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
|
3850
3850
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids
|
3851
3851
|
*/
|
3852
|
-
GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest,
|
3852
|
+
GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromXboxLiveIDsResult>;
|
3853
3853
|
/**
|
3854
3854
|
* Retrieves the key-value store of custom publisher settings
|
3855
3855
|
* https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata
|
3856
3856
|
*/
|
3857
|
-
GetPublisherData(request: GetPublisherDataRequest,
|
3857
|
+
GetPublisherData(request: GetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
|
3858
3858
|
/**
|
3859
3859
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3860
3860
|
* version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
|
3861
3861
|
* are still active.
|
3862
3862
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase
|
3863
3863
|
*/
|
3864
|
-
GetPurchase(request: GetPurchaseRequest,
|
3864
|
+
GetPurchase(request: GetPurchaseRequest, extraHeaders?: Record<string, string>): Promise<GetPurchaseResult>;
|
3865
3865
|
/**
|
3866
3866
|
* Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group
|
3867
3867
|
* may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
|
@@ -3869,100 +3869,100 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
3869
3869
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3870
3870
|
* https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata
|
3871
3871
|
*/
|
3872
|
-
GetSharedGroupData(request: GetSharedGroupDataRequest,
|
3872
|
+
GetSharedGroupData(request: GetSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<GetSharedGroupDataResult>;
|
3873
3873
|
/**
|
3874
3874
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3875
3875
|
* version 2._ Retrieves the set of items defined for the specified store, including all prices defined
|
3876
3876
|
* https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems
|
3877
3877
|
*/
|
3878
|
-
GetStoreItems(request: GetStoreItemsRequest,
|
3878
|
+
GetStoreItems(request: GetStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
|
3879
3879
|
/**
|
3880
3880
|
* Retrieves the current server time
|
3881
3881
|
* https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime
|
3882
3882
|
*/
|
3883
|
-
GetTime(request: GetTimeRequest,
|
3883
|
+
GetTime(request: GetTimeRequest, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
|
3884
3884
|
/**
|
3885
3885
|
* Retrieves the key-value store of custom title settings
|
3886
3886
|
* https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata
|
3887
3887
|
*/
|
3888
|
-
GetTitleData(request: GetTitleDataRequest,
|
3888
|
+
GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3889
3889
|
/**
|
3890
3890
|
* Retrieves the title news feed, as configured in the developer portal
|
3891
3891
|
* https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews
|
3892
3892
|
*/
|
3893
|
-
GetTitleNews(request: GetTitleNewsRequest,
|
3893
|
+
GetTitleNews(request: GetTitleNewsRequest, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
|
3894
3894
|
/**
|
3895
3895
|
* Returns the title's base 64 encoded RSA CSP blob.
|
3896
3896
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey
|
3897
3897
|
*/
|
3898
|
-
GetTitlePublicKey(request: GetTitlePublicKeyRequest,
|
3898
|
+
GetTitlePublicKey(request: GetTitlePublicKeyRequest, extraHeaders?: Record<string, string>): Promise<GetTitlePublicKeyResult>;
|
3899
3899
|
/**
|
3900
3900
|
* Gets the current status of an existing trade.
|
3901
3901
|
* https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus
|
3902
3902
|
*/
|
3903
|
-
GetTradeStatus(request: GetTradeStatusRequest,
|
3903
|
+
GetTradeStatus(request: GetTradeStatusRequest, extraHeaders?: Record<string, string>): Promise<GetTradeStatusResponse>;
|
3904
3904
|
/**
|
3905
3905
|
* Retrieves the title-specific custom data for the user which is readable and writable by the client
|
3906
3906
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata
|
3907
3907
|
*/
|
3908
|
-
GetUserData(request: GetUserDataRequest,
|
3908
|
+
GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3909
3909
|
/**
|
3910
3910
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3911
3911
|
* version 2._ Retrieves the user's current inventory of virtual goods
|
3912
3912
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory
|
3913
3913
|
*/
|
3914
|
-
GetUserInventory(request: GetUserInventoryRequest,
|
3914
|
+
GetUserInventory(request: GetUserInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
|
3915
3915
|
/**
|
3916
3916
|
* Retrieves the publisher-specific custom data for the user which is readable and writable by the client
|
3917
3917
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata
|
3918
3918
|
*/
|
3919
|
-
GetUserPublisherData(request: GetUserDataRequest,
|
3919
|
+
GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3920
3920
|
/**
|
3921
3921
|
* Retrieves the publisher-specific custom data for the user which can only be read by the client
|
3922
3922
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata
|
3923
3923
|
*/
|
3924
|
-
GetUserPublisherReadOnlyData(request: GetUserDataRequest,
|
3924
|
+
GetUserPublisherReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3925
3925
|
/**
|
3926
3926
|
* Retrieves the title-specific custom data for the user which can only be read by the client
|
3927
3927
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata
|
3928
3928
|
*/
|
3929
|
-
GetUserReadOnlyData(request: GetUserDataRequest,
|
3929
|
+
GetUserReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3930
3930
|
/**
|
3931
3931
|
* Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
|
3932
3932
|
* with the parent PlayFabId to guarantee uniqueness.
|
3933
3933
|
* https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser
|
3934
3934
|
*/
|
3935
|
-
GrantCharacterToUser(request: GrantCharacterToUserRequest,
|
3935
|
+
GrantCharacterToUser(request: GrantCharacterToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
|
3936
3936
|
/**
|
3937
3937
|
* Links the Android device identifier to the user's PlayFab account
|
3938
3938
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid
|
3939
3939
|
*/
|
3940
|
-
LinkAndroidDeviceID(request: LinkAndroidDeviceIDRequest,
|
3940
|
+
LinkAndroidDeviceID(request: LinkAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LinkAndroidDeviceIDResult>;
|
3941
3941
|
/**
|
3942
3942
|
* Links the Apple account associated with the token to the user's PlayFab account.
|
3943
3943
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple
|
3944
3944
|
*/
|
3945
|
-
LinkApple(request: LinkAppleRequest,
|
3945
|
+
LinkApple(request: LinkAppleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3946
3946
|
/**
|
3947
3947
|
* Links the Battle.net account associated with the token to the user's PlayFab account.
|
3948
3948
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount
|
3949
3949
|
*/
|
3950
|
-
LinkBattleNetAccount(request: LinkBattleNetAccountRequest,
|
3950
|
+
LinkBattleNetAccount(request: LinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3951
3951
|
/**
|
3952
3952
|
* Links the custom identifier, generated by the title, to the user's PlayFab account
|
3953
3953
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid
|
3954
3954
|
*/
|
3955
|
-
LinkCustomID(request: LinkCustomIDRequest,
|
3955
|
+
LinkCustomID(request: LinkCustomIDRequest, extraHeaders?: Record<string, string>): Promise<LinkCustomIDResult>;
|
3956
3956
|
/**
|
3957
3957
|
* Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
|
3958
3958
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount
|
3959
3959
|
*/
|
3960
|
-
LinkFacebookAccount(request: LinkFacebookAccountRequest,
|
3960
|
+
LinkFacebookAccount(request: LinkFacebookAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkFacebookAccountResult>;
|
3961
3961
|
/**
|
3962
3962
|
* Links the Facebook Instant Games Id to the user's PlayFab account
|
3963
3963
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid
|
3964
3964
|
*/
|
3965
|
-
LinkFacebookInstantGamesId(request: LinkFacebookInstantGamesIdRequest,
|
3965
|
+
LinkFacebookInstantGamesId(request: LinkFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<LinkFacebookInstantGamesIdResult>;
|
3966
3966
|
/**
|
3967
3967
|
* Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with
|
3968
3968
|
* a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
|
@@ -3970,91 +3970,91 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
3970
3970
|
* page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
|
3971
3971
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount
|
3972
3972
|
*/
|
3973
|
-
LinkGameCenterAccount(request: LinkGameCenterAccountRequest,
|
3973
|
+
LinkGameCenterAccount(request: LinkGameCenterAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGameCenterAccountResult>;
|
3974
3974
|
/**
|
3975
3975
|
* Links the currently signed-in user account to their Google account, using their Google account credentials
|
3976
3976
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount
|
3977
3977
|
*/
|
3978
|
-
LinkGoogleAccount(request: LinkGoogleAccountRequest,
|
3978
|
+
LinkGoogleAccount(request: LinkGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGoogleAccountResult>;
|
3979
3979
|
/**
|
3980
3980
|
* Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
|
3981
3981
|
* credentials
|
3982
3982
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount
|
3983
3983
|
*/
|
3984
|
-
LinkGooglePlayGamesServicesAccount(request: LinkGooglePlayGamesServicesAccountRequest,
|
3984
|
+
LinkGooglePlayGamesServicesAccount(request: LinkGooglePlayGamesServicesAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGooglePlayGamesServicesAccountResult>;
|
3985
3985
|
/**
|
3986
3986
|
* Links the vendor-specific iOS device identifier to the user's PlayFab account
|
3987
3987
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid
|
3988
3988
|
*/
|
3989
|
-
LinkIOSDeviceID(request: LinkIOSDeviceIDRequest,
|
3989
|
+
LinkIOSDeviceID(request: LinkIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LinkIOSDeviceIDResult>;
|
3990
3990
|
/**
|
3991
3991
|
* Links the Kongregate identifier to the user's PlayFab account
|
3992
3992
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate
|
3993
3993
|
*/
|
3994
|
-
LinkKongregate(request: LinkKongregateAccountRequest,
|
3994
|
+
LinkKongregate(request: LinkKongregateAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkKongregateAccountResult>;
|
3995
3995
|
/**
|
3996
3996
|
* Links the Nintendo account associated with the token to the user's PlayFab account.
|
3997
3997
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount
|
3998
3998
|
*/
|
3999
|
-
LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest,
|
3999
|
+
LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
4000
4000
|
/**
|
4001
4001
|
* Links the NintendoSwitchDeviceId to the user's PlayFab account
|
4002
4002
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid
|
4003
4003
|
*/
|
4004
|
-
LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest,
|
4004
|
+
LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
|
4005
4005
|
/**
|
4006
4006
|
* Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
|
4007
4007
|
* Open ID Connect provider and the OpenId Connect JWT from that provider.
|
4008
4008
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect
|
4009
4009
|
*/
|
4010
|
-
LinkOpenIdConnect(request: LinkOpenIdConnectRequest,
|
4010
|
+
LinkOpenIdConnect(request: LinkOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
4011
4011
|
/**
|
4012
4012
|
* Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
|
4013
4013
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount
|
4014
4014
|
*/
|
4015
|
-
LinkPSNAccount(request: LinkPSNAccountRequest,
|
4015
|
+
LinkPSNAccount(request: LinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
|
4016
4016
|
/**
|
4017
4017
|
* Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
|
4018
4018
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount
|
4019
4019
|
*/
|
4020
|
-
LinkSteamAccount(request: LinkSteamAccountRequest,
|
4020
|
+
LinkSteamAccount(request: LinkSteamAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkSteamAccountResult>;
|
4021
4021
|
/**
|
4022
4022
|
* Links the Twitch account associated with the token to the user's PlayFab account.
|
4023
4023
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch
|
4024
4024
|
*/
|
4025
|
-
LinkTwitch(request: LinkTwitchAccountRequest,
|
4025
|
+
LinkTwitch(request: LinkTwitchAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkTwitchAccountResult>;
|
4026
4026
|
/**
|
4027
4027
|
* Links the Xbox Live account associated with the provided access code to the user's PlayFab account
|
4028
4028
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount
|
4029
4029
|
*/
|
4030
|
-
LinkXboxAccount(request: LinkXboxAccountRequest,
|
4030
|
+
LinkXboxAccount(request: LinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
|
4031
4031
|
/**
|
4032
4032
|
* Retrieves title-specific custom property values for a player.
|
4033
4033
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties
|
4034
4034
|
*/
|
4035
|
-
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest,
|
4035
|
+
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
|
4036
4036
|
/**
|
4037
4037
|
* Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
|
4038
4038
|
* API calls which require an authenticated user
|
4039
4039
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid
|
4040
4040
|
*/
|
4041
|
-
LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest,
|
4041
|
+
LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4042
4042
|
/**
|
4043
4043
|
* Signs in the user with a Sign in with Apple identity token.
|
4044
4044
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple
|
4045
4045
|
*/
|
4046
|
-
LoginWithApple(request: LoginWithAppleRequest,
|
4046
|
+
LoginWithApple(request: LoginWithAppleRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4047
4047
|
/**
|
4048
4048
|
* Sign in the user with a Battle.net identity token
|
4049
4049
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet
|
4050
4050
|
*/
|
4051
|
-
LoginWithBattleNet(request: LoginWithBattleNetRequest,
|
4051
|
+
LoginWithBattleNet(request: LoginWithBattleNetRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4052
4052
|
/**
|
4053
4053
|
* Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
|
4054
4054
|
* subsequently be used for API calls which require an authenticated user
|
4055
4055
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid
|
4056
4056
|
*/
|
4057
|
-
LoginWithCustomID(request: LoginWithCustomIDRequest,
|
4057
|
+
LoginWithCustomID(request: LoginWithCustomIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4058
4058
|
/**
|
4059
4059
|
* Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
|
4060
4060
|
* which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
|
@@ -4062,19 +4062,19 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
4062
4062
|
* RegisterPlayFabUser.
|
4063
4063
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress
|
4064
4064
|
*/
|
4065
|
-
LoginWithEmailAddress(request: LoginWithEmailAddressRequest,
|
4065
|
+
LoginWithEmailAddress(request: LoginWithEmailAddressRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4066
4066
|
/**
|
4067
4067
|
* Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
|
4068
4068
|
* calls which require an authenticated user
|
4069
4069
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook
|
4070
4070
|
*/
|
4071
|
-
LoginWithFacebook(request: LoginWithFacebookRequest,
|
4071
|
+
LoginWithFacebook(request: LoginWithFacebookRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4072
4072
|
/**
|
4073
4073
|
* Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for
|
4074
4074
|
* API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
|
4075
4075
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid
|
4076
4076
|
*/
|
4077
|
-
LoginWithFacebookInstantGamesId(request: LoginWithFacebookInstantGamesIdRequest,
|
4077
|
+
LoginWithFacebookInstantGamesId(request: LoginWithFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4078
4078
|
/**
|
4079
4079
|
* Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be
|
4080
4080
|
* used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not
|
@@ -4083,45 +4083,45 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
4083
4083
|
* enabling the 'Require secure authentication only for this app' option.
|
4084
4084
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter
|
4085
4085
|
*/
|
4086
|
-
LoginWithGameCenter(request: LoginWithGameCenterRequest,
|
4086
|
+
LoginWithGameCenter(request: LoginWithGameCenterRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4087
4087
|
/**
|
4088
4088
|
* Signs the user in using their Google account credentials
|
4089
4089
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount
|
4090
4090
|
*/
|
4091
|
-
LoginWithGoogleAccount(request: LoginWithGoogleAccountRequest,
|
4091
|
+
LoginWithGoogleAccount(request: LoginWithGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4092
4092
|
/**
|
4093
4093
|
* Signs the user in using their Google Play Games account credentials
|
4094
4094
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices
|
4095
4095
|
*/
|
4096
|
-
LoginWithGooglePlayGamesServices(request: LoginWithGooglePlayGamesServicesRequest,
|
4096
|
+
LoginWithGooglePlayGamesServices(request: LoginWithGooglePlayGamesServicesRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4097
4097
|
/**
|
4098
4098
|
* Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently
|
4099
4099
|
* be used for API calls which require an authenticated user
|
4100
4100
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid
|
4101
4101
|
*/
|
4102
|
-
LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest,
|
4102
|
+
LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4103
4103
|
/**
|
4104
4104
|
* Signs the user in using a Kongregate player account.
|
4105
4105
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate
|
4106
4106
|
*/
|
4107
|
-
LoginWithKongregate(request: LoginWithKongregateRequest,
|
4107
|
+
LoginWithKongregate(request: LoginWithKongregateRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4108
4108
|
/**
|
4109
4109
|
* Signs in the user with a Nintendo service account token.
|
4110
4110
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount
|
4111
4111
|
*/
|
4112
|
-
LoginWithNintendoServiceAccount(request: LoginWithNintendoServiceAccountRequest,
|
4112
|
+
LoginWithNintendoServiceAccount(request: LoginWithNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4113
4113
|
/**
|
4114
4114
|
* Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for
|
4115
4115
|
* API calls which require an authenticated user
|
4116
4116
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid
|
4117
4117
|
*/
|
4118
|
-
LoginWithNintendoSwitchDeviceId(request: LoginWithNintendoSwitchDeviceIdRequest,
|
4118
|
+
LoginWithNintendoSwitchDeviceId(request: LoginWithNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4119
4119
|
/**
|
4120
4120
|
* Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect
|
4121
4121
|
* provider.
|
4122
4122
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect
|
4123
4123
|
*/
|
4124
|
-
LoginWithOpenIdConnect(request: LoginWithOpenIdConnectRequest,
|
4124
|
+
LoginWithOpenIdConnect(request: LoginWithOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4125
4125
|
/**
|
4126
4126
|
* Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
|
4127
4127
|
* which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of
|
@@ -4129,86 +4129,86 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
4129
4129
|
* RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
|
4130
4130
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab
|
4131
4131
|
*/
|
4132
|
-
LoginWithPlayFab(request: LoginWithPlayFabRequest,
|
4132
|
+
LoginWithPlayFab(request: LoginWithPlayFabRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4133
4133
|
/**
|
4134
4134
|
* Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
|
4135
4135
|
* subsequently be used for API calls which require an authenticated user
|
4136
4136
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn
|
4137
4137
|
*/
|
4138
|
-
LoginWithPSN(request: LoginWithPSNRequest,
|
4138
|
+
LoginWithPSN(request: LoginWithPSNRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4139
4139
|
/**
|
4140
4140
|
* Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for
|
4141
4141
|
* API calls which require an authenticated user
|
4142
4142
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam
|
4143
4143
|
*/
|
4144
|
-
LoginWithSteam(request: LoginWithSteamRequest,
|
4144
|
+
LoginWithSteam(request: LoginWithSteamRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4145
4145
|
/**
|
4146
4146
|
* Signs the user in using a Twitch access token.
|
4147
4147
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch
|
4148
4148
|
*/
|
4149
|
-
LoginWithTwitch(request: LoginWithTwitchRequest,
|
4149
|
+
LoginWithTwitch(request: LoginWithTwitchRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4150
4150
|
/**
|
4151
4151
|
* Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls
|
4152
4152
|
* which require an authenticated user
|
4153
4153
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox
|
4154
4154
|
*/
|
4155
|
-
LoginWithXbox(request: LoginWithXboxRequest,
|
4155
|
+
LoginWithXbox(request: LoginWithXboxRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
|
4156
4156
|
/**
|
4157
4157
|
* Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
|
4158
4158
|
* https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade
|
4159
4159
|
*/
|
4160
|
-
OpenTrade(request: OpenTradeRequest,
|
4160
|
+
OpenTrade(request: OpenTradeRequest, extraHeaders?: Record<string, string>): Promise<OpenTradeResponse>;
|
4161
4161
|
/**
|
4162
4162
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4163
4163
|
* version 2._ Selects a payment option for purchase order created via StartPurchase
|
4164
4164
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase
|
4165
4165
|
*/
|
4166
|
-
PayForPurchase(request: PayForPurchaseRequest,
|
4166
|
+
PayForPurchase(request: PayForPurchaseRequest, extraHeaders?: Record<string, string>): Promise<PayForPurchaseResult>;
|
4167
4167
|
/**
|
4168
4168
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4169
4169
|
* version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as
|
4170
4170
|
* well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
|
4171
4171
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem
|
4172
4172
|
*/
|
4173
|
-
PurchaseItem(request: PurchaseItemRequest,
|
4173
|
+
PurchaseItem(request: PurchaseItemRequest, extraHeaders?: Record<string, string>): Promise<PurchaseItemResult>;
|
4174
4174
|
/**
|
4175
4175
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4176
4176
|
* version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
|
4177
4177
|
* Economy->Catalogs tab in the PlayFab Game Manager.
|
4178
4178
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon
|
4179
4179
|
*/
|
4180
|
-
RedeemCoupon(request: RedeemCouponRequest,
|
4180
|
+
RedeemCoupon(request: RedeemCouponRequest, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
|
4181
4181
|
/**
|
4182
4182
|
* Uses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token
|
4183
4183
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken
|
4184
4184
|
*/
|
4185
|
-
RefreshPSNAuthToken(request: RefreshPSNAuthTokenRequest,
|
4185
|
+
RefreshPSNAuthToken(request: RefreshPSNAuthTokenRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
4186
4186
|
/**
|
4187
4187
|
* Registers the iOS device to receive push notifications
|
4188
4188
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification
|
4189
4189
|
*/
|
4190
|
-
RegisterForIOSPushNotification(request: RegisterForIOSPushNotificationRequest,
|
4190
|
+
RegisterForIOSPushNotification(request: RegisterForIOSPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<RegisterForIOSPushNotificationResult>;
|
4191
4191
|
/**
|
4192
4192
|
* Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which
|
4193
4193
|
* require an authenticated user. You must supply a username and an email address.
|
4194
4194
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser
|
4195
4195
|
*/
|
4196
|
-
RegisterPlayFabUser(request: RegisterPlayFabUserRequest,
|
4196
|
+
RegisterPlayFabUser(request: RegisterPlayFabUserRequest, extraHeaders?: Record<string, string>): Promise<RegisterPlayFabUserResult>;
|
4197
4197
|
/**
|
4198
4198
|
* Removes a contact email from the player's profile.
|
4199
4199
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail
|
4200
4200
|
*/
|
4201
|
-
RemoveContactEmail(request: RemoveContactEmailRequest,
|
4201
|
+
RemoveContactEmail(request: RemoveContactEmailRequest, extraHeaders?: Record<string, string>): Promise<RemoveContactEmailResult>;
|
4202
4202
|
/**
|
4203
4203
|
* Removes a specified user from the friend list of the local user
|
4204
4204
|
* https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend
|
4205
4205
|
*/
|
4206
|
-
RemoveFriend(request: RemoveFriendRequest,
|
4206
|
+
RemoveFriend(request: RemoveFriendRequest, extraHeaders?: Record<string, string>): Promise<RemoveFriendResult>;
|
4207
4207
|
/**
|
4208
4208
|
* Removes the specified generic service identifier from the player's PlayFab account.
|
4209
4209
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid
|
4210
4210
|
*/
|
4211
|
-
RemoveGenericID(request: RemoveGenericIDRequest,
|
4211
|
+
RemoveGenericID(request: RemoveGenericIDRequest, extraHeaders?: Record<string, string>): Promise<RemoveGenericIDResult>;
|
4212
4212
|
/**
|
4213
4213
|
* Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the
|
4214
4214
|
* group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
|
@@ -4216,158 +4216,158 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
4216
4216
|
* guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
4217
4217
|
* https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers
|
4218
4218
|
*/
|
4219
|
-
RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest,
|
4219
|
+
RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
|
4220
4220
|
/**
|
4221
4221
|
* Report player's ad activity
|
4222
4222
|
* https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity
|
4223
4223
|
*/
|
4224
|
-
ReportAdActivity(request: ReportAdActivityRequest,
|
4224
|
+
ReportAdActivity(request: ReportAdActivityRequest, extraHeaders?: Record<string, string>): Promise<ReportAdActivityResult>;
|
4225
4225
|
/**
|
4226
4226
|
* Write a PlayStream event to describe the provided player device information. This API method is not designed to be
|
4227
4227
|
* called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
|
4228
4228
|
* https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo
|
4229
4229
|
*/
|
4230
|
-
ReportDeviceInfo(request: DeviceInfoRequest,
|
4230
|
+
ReportDeviceInfo(request: DeviceInfoRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
4231
4231
|
/**
|
4232
4232
|
* Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title
|
4233
4233
|
* can take action concerning potentially toxic players.
|
4234
4234
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer
|
4235
4235
|
*/
|
4236
|
-
ReportPlayer(request: ReportPlayerClientRequest,
|
4236
|
+
ReportPlayer(request: ReportPlayerClientRequest, extraHeaders?: Record<string, string>): Promise<ReportPlayerClientResult>;
|
4237
4237
|
/**
|
4238
4238
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4239
4239
|
* version 2._ Restores all in-app purchases based on the given restore receipt
|
4240
4240
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases
|
4241
4241
|
*/
|
4242
|
-
RestoreIOSPurchases(request: RestoreIOSPurchasesRequest,
|
4242
|
+
RestoreIOSPurchases(request: RestoreIOSPurchasesRequest, extraHeaders?: Record<string, string>): Promise<RestoreIOSPurchasesResult>;
|
4243
4243
|
/**
|
4244
4244
|
* Reward player's ad activity
|
4245
4245
|
* https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity
|
4246
4246
|
*/
|
4247
|
-
RewardAdActivity(request: RewardAdActivityRequest,
|
4247
|
+
RewardAdActivity(request: RewardAdActivityRequest, extraHeaders?: Record<string, string>): Promise<RewardAdActivityResult>;
|
4248
4248
|
/**
|
4249
4249
|
* Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
|
4250
4250
|
* change the password.If an account recovery email template ID is provided, an email using the custom email template will
|
4251
4251
|
* be used.
|
4252
4252
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail
|
4253
4253
|
*/
|
4254
|
-
SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest,
|
4254
|
+
SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
|
4255
4255
|
/**
|
4256
4256
|
* Updates the tag list for a specified user in the friend list of the local user
|
4257
4257
|
* https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags
|
4258
4258
|
*/
|
4259
|
-
SetFriendTags(request: SetFriendTagsRequest,
|
4259
|
+
SetFriendTags(request: SetFriendTagsRequest, extraHeaders?: Record<string, string>): Promise<SetFriendTagsResult>;
|
4260
4260
|
/**
|
4261
4261
|
* Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
|
4262
4262
|
* secret use the Admin or Server API method SetPlayerSecret.
|
4263
4263
|
* https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret
|
4264
4264
|
*/
|
4265
|
-
SetPlayerSecret(request: SetPlayerSecretRequest,
|
4265
|
+
SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
|
4266
4266
|
/**
|
4267
4267
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4268
4268
|
* version 2._ Creates an order for a list of items from the title catalog
|
4269
4269
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase
|
4270
4270
|
*/
|
4271
|
-
StartPurchase(request: StartPurchaseRequest,
|
4271
|
+
StartPurchase(request: StartPurchaseRequest, extraHeaders?: Record<string, string>): Promise<StartPurchaseResult>;
|
4272
4272
|
/**
|
4273
4273
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4274
4274
|
* version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
|
4275
4275
|
* a VC balance negative with this API.
|
4276
4276
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency
|
4277
4277
|
*/
|
4278
|
-
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest,
|
4278
|
+
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
4279
4279
|
/**
|
4280
4280
|
* Unlinks the related Android device identifier from the user's PlayFab account
|
4281
4281
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid
|
4282
4282
|
*/
|
4283
|
-
UnlinkAndroidDeviceID(request: UnlinkAndroidDeviceIDRequest,
|
4283
|
+
UnlinkAndroidDeviceID(request: UnlinkAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkAndroidDeviceIDResult>;
|
4284
4284
|
/**
|
4285
4285
|
* Unlinks the related Apple account from the user's PlayFab account.
|
4286
4286
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple
|
4287
4287
|
*/
|
4288
|
-
UnlinkApple(request: UnlinkAppleRequest,
|
4288
|
+
UnlinkApple(request: UnlinkAppleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
4289
4289
|
/**
|
4290
4290
|
* Unlinks the related Battle.net account from the user's PlayFab account.
|
4291
4291
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount
|
4292
4292
|
*/
|
4293
|
-
UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest,
|
4293
|
+
UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
4294
4294
|
/**
|
4295
4295
|
* Unlinks the related custom identifier from the user's PlayFab account
|
4296
4296
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid
|
4297
4297
|
*/
|
4298
|
-
UnlinkCustomID(request: UnlinkCustomIDRequest,
|
4298
|
+
UnlinkCustomID(request: UnlinkCustomIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkCustomIDResult>;
|
4299
4299
|
/**
|
4300
4300
|
* Unlinks the related Facebook account from the user's PlayFab account
|
4301
4301
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount
|
4302
4302
|
*/
|
4303
|
-
UnlinkFacebookAccount(request: UnlinkFacebookAccountRequest,
|
4303
|
+
UnlinkFacebookAccount(request: UnlinkFacebookAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookAccountResult>;
|
4304
4304
|
/**
|
4305
4305
|
* Unlinks the related Facebook Instant Game Ids from the user's PlayFab account
|
4306
4306
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid
|
4307
4307
|
*/
|
4308
|
-
UnlinkFacebookInstantGamesId(request: UnlinkFacebookInstantGamesIdRequest,
|
4308
|
+
UnlinkFacebookInstantGamesId(request: UnlinkFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookInstantGamesIdResult>;
|
4309
4309
|
/**
|
4310
4310
|
* Unlinks the related Game Center account from the user's PlayFab account
|
4311
4311
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount
|
4312
4312
|
*/
|
4313
|
-
UnlinkGameCenterAccount(request: UnlinkGameCenterAccountRequest,
|
4313
|
+
UnlinkGameCenterAccount(request: UnlinkGameCenterAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGameCenterAccountResult>;
|
4314
4314
|
/**
|
4315
4315
|
* Unlinks the related Google account from the user's PlayFab account
|
4316
4316
|
* (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).
|
4317
4317
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount
|
4318
4318
|
*/
|
4319
|
-
UnlinkGoogleAccount(request: UnlinkGoogleAccountRequest,
|
4319
|
+
UnlinkGoogleAccount(request: UnlinkGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGoogleAccountResult>;
|
4320
4320
|
/**
|
4321
4321
|
* Unlinks the related Google Play Games account from the user's PlayFab account.
|
4322
4322
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount
|
4323
4323
|
*/
|
4324
|
-
UnlinkGooglePlayGamesServicesAccount(request: UnlinkGooglePlayGamesServicesAccountRequest,
|
4324
|
+
UnlinkGooglePlayGamesServicesAccount(request: UnlinkGooglePlayGamesServicesAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGooglePlayGamesServicesAccountResult>;
|
4325
4325
|
/**
|
4326
4326
|
* Unlinks the related iOS device identifier from the user's PlayFab account
|
4327
4327
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid
|
4328
4328
|
*/
|
4329
|
-
UnlinkIOSDeviceID(request: UnlinkIOSDeviceIDRequest,
|
4329
|
+
UnlinkIOSDeviceID(request: UnlinkIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkIOSDeviceIDResult>;
|
4330
4330
|
/**
|
4331
4331
|
* Unlinks the related Kongregate identifier from the user's PlayFab account
|
4332
4332
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate
|
4333
4333
|
*/
|
4334
|
-
UnlinkKongregate(request: UnlinkKongregateAccountRequest,
|
4334
|
+
UnlinkKongregate(request: UnlinkKongregateAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkKongregateAccountResult>;
|
4335
4335
|
/**
|
4336
4336
|
* Unlinks the related Nintendo account from the user's PlayFab account.
|
4337
4337
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount
|
4338
4338
|
*/
|
4339
|
-
UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest,
|
4339
|
+
UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
4340
4340
|
/**
|
4341
4341
|
* Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
|
4342
4342
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid
|
4343
4343
|
*/
|
4344
|
-
UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest,
|
4344
|
+
UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
|
4345
4345
|
/**
|
4346
4346
|
* Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship
|
4347
4347
|
* between a title and an Open ID Connect provider.
|
4348
4348
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect
|
4349
4349
|
*/
|
4350
|
-
UnlinkOpenIdConnect(request: UnlinkOpenIdConnectRequest,
|
4350
|
+
UnlinkOpenIdConnect(request: UnlinkOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
4351
4351
|
/**
|
4352
4352
|
* Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
|
4353
4353
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount
|
4354
4354
|
*/
|
4355
|
-
UnlinkPSNAccount(request: UnlinkPSNAccountRequest,
|
4355
|
+
UnlinkPSNAccount(request: UnlinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
|
4356
4356
|
/**
|
4357
4357
|
* Unlinks the related Steam account from the user's PlayFab account
|
4358
4358
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount
|
4359
4359
|
*/
|
4360
|
-
UnlinkSteamAccount(request: UnlinkSteamAccountRequest,
|
4360
|
+
UnlinkSteamAccount(request: UnlinkSteamAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkSteamAccountResult>;
|
4361
4361
|
/**
|
4362
4362
|
* Unlinks the related Twitch account from the user's PlayFab account.
|
4363
4363
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch
|
4364
4364
|
*/
|
4365
|
-
UnlinkTwitch(request: UnlinkTwitchAccountRequest,
|
4365
|
+
UnlinkTwitch(request: UnlinkTwitchAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkTwitchAccountResult>;
|
4366
4366
|
/**
|
4367
4367
|
* Unlinks the related Xbox Live account from the user's PlayFab account
|
4368
4368
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount
|
4369
4369
|
*/
|
4370
|
-
UnlinkXboxAccount(request: UnlinkXboxAccountRequest,
|
4370
|
+
UnlinkXboxAccount(request: UnlinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
|
4371
4371
|
/**
|
4372
4372
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4373
4373
|
* version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the
|
@@ -4375,7 +4375,7 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
4375
4375
|
* be decremented, consistent with the operation of ConsumeItem.
|
4376
4376
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance
|
4377
4377
|
*/
|
4378
|
-
UnlockContainerInstance(request: UnlockContainerInstanceRequest,
|
4378
|
+
UnlockContainerInstance(request: UnlockContainerInstanceRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
|
4379
4379
|
/**
|
4380
4380
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4381
4381
|
* version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it
|
@@ -4383,34 +4383,34 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
4383
4383
|
* consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
|
4384
4384
|
* https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem
|
4385
4385
|
*/
|
4386
|
-
UnlockContainerItem(request: UnlockContainerItemRequest,
|
4386
|
+
UnlockContainerItem(request: UnlockContainerItemRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
|
4387
4387
|
/**
|
4388
4388
|
* Update the avatar URL of the player
|
4389
4389
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl
|
4390
4390
|
*/
|
4391
|
-
UpdateAvatarUrl(request: UpdateAvatarUrlRequest,
|
4391
|
+
UpdateAvatarUrl(request: UpdateAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
4392
4392
|
/**
|
4393
4393
|
* Creates and updates the title-specific custom data for the user's character which is readable and writable by the client
|
4394
4394
|
* https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata
|
4395
4395
|
*/
|
4396
|
-
UpdateCharacterData(request: UpdateCharacterDataRequest,
|
4396
|
+
UpdateCharacterData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
|
4397
4397
|
/**
|
4398
4398
|
* Updates the values of the specified title-specific statistics for the specific character. By default, clients are not
|
4399
4399
|
* permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
|
4400
4400
|
* https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics
|
4401
4401
|
*/
|
4402
|
-
UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest,
|
4402
|
+
UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterStatisticsResult>;
|
4403
4403
|
/**
|
4404
4404
|
* Updates the title-specific custom property values for a player
|
4405
4405
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties
|
4406
4406
|
*/
|
4407
|
-
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest,
|
4407
|
+
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
|
4408
4408
|
/**
|
4409
4409
|
* Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
|
4410
4410
|
* update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
|
4411
4411
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics
|
4412
4412
|
*/
|
4413
|
-
UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest,
|
4413
|
+
UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
|
4414
4414
|
/**
|
4415
4415
|
* Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
|
4416
4416
|
* or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
|
@@ -4419,64 +4419,64 @@ declare class PlayFabClientApi extends PlayFabCommon {
|
|
4419
4419
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
4420
4420
|
* https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata
|
4421
4421
|
*/
|
4422
|
-
UpdateSharedGroupData(request: UpdateSharedGroupDataRequest,
|
4422
|
+
UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
|
4423
4423
|
/**
|
4424
4424
|
* Creates and updates the title-specific custom data for the user which is readable and writable by the client
|
4425
4425
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata
|
4426
4426
|
*/
|
4427
|
-
UpdateUserData(request: UpdateUserDataRequest,
|
4427
|
+
UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
4428
4428
|
/**
|
4429
4429
|
* Creates and updates the publisher-specific custom data for the user which is readable and writable by the client
|
4430
4430
|
* https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata
|
4431
4431
|
*/
|
4432
|
-
UpdateUserPublisherData(request: UpdateUserDataRequest,
|
4432
|
+
UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
4433
4433
|
/**
|
4434
4434
|
* Updates the title specific display name for the user
|
4435
4435
|
* https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname
|
4436
4436
|
*/
|
4437
|
-
UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest,
|
4437
|
+
UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
|
4438
4438
|
/**
|
4439
4439
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4440
4440
|
* version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches
|
4441
4441
|
* the purchased catalog item
|
4442
4442
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt
|
4443
4443
|
*/
|
4444
|
-
ValidateAmazonIAPReceipt(request: ValidateAmazonReceiptRequest,
|
4444
|
+
ValidateAmazonIAPReceipt(request: ValidateAmazonReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateAmazonReceiptResult>;
|
4445
4445
|
/**
|
4446
4446
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4447
4447
|
* version 2._ Validates a Google Play purchase and gives the corresponding item to the player.
|
4448
4448
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase
|
4449
4449
|
*/
|
4450
|
-
ValidateGooglePlayPurchase(request: ValidateGooglePlayPurchaseRequest,
|
4450
|
+
ValidateGooglePlayPurchase(request: ValidateGooglePlayPurchaseRequest, extraHeaders?: Record<string, string>): Promise<ValidateGooglePlayPurchaseResult>;
|
4451
4451
|
/**
|
4452
4452
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4453
4453
|
* version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the
|
4454
4454
|
* purchased catalog item
|
4455
4455
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt
|
4456
4456
|
*/
|
4457
|
-
ValidateIOSReceipt(request: ValidateIOSReceiptRequest,
|
4457
|
+
ValidateIOSReceipt(request: ValidateIOSReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateIOSReceiptResult>;
|
4458
4458
|
/**
|
4459
4459
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
4460
4460
|
* version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it
|
4461
4461
|
* matches the purchased catalog item
|
4462
4462
|
* https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt
|
4463
4463
|
*/
|
4464
|
-
ValidateWindowsStoreReceipt(request: ValidateWindowsReceiptRequest,
|
4464
|
+
ValidateWindowsStoreReceipt(request: ValidateWindowsReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateWindowsReceiptResult>;
|
4465
4465
|
/**
|
4466
4466
|
* Writes a character-based event into PlayStream.
|
4467
4467
|
* https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent
|
4468
4468
|
*/
|
4469
|
-
WriteCharacterEvent(request: WriteClientCharacterEventRequest,
|
4469
|
+
WriteCharacterEvent(request: WriteClientCharacterEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
4470
4470
|
/**
|
4471
4471
|
* Writes a player-based event into PlayStream.
|
4472
4472
|
* https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent
|
4473
4473
|
*/
|
4474
|
-
WritePlayerEvent(request: WriteClientPlayerEventRequest,
|
4474
|
+
WritePlayerEvent(request: WriteClientPlayerEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
4475
4475
|
/**
|
4476
4476
|
* Writes a title-based event into PlayStream.
|
4477
4477
|
* https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent
|
4478
4478
|
*/
|
4479
|
-
WriteTitleEvent(request: WriteTitleEventRequest,
|
4479
|
+
WriteTitleEvent(request: WriteTitleEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
4480
4480
|
}
|
4481
4481
|
|
4482
4482
|
export { PlayFabClientApi as default };
|