async-playfab-web-sdk 1.192.250526-1 → 1.192.250526-3
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 +4 -448
- package/dist/Addon.js.map +1 -1
- package/dist/Admin.d.ts +118 -118
- package/dist/Admin.js +4 -1108
- package/dist/Admin.js.map +1 -1
- package/dist/Authentication.d.ts +5 -5
- package/dist/Authentication.js +4 -286
- package/dist/Authentication.js.map +1 -1
- package/dist/Client.d.ts +174 -174
- package/dist/Client.js +4 -1889
- package/dist/Client.js.map +1 -1
- package/dist/CloudScript.d.ts +16 -16
- package/dist/CloudScript.js +4 -345
- package/dist/CloudScript.js.map +1 -1
- package/dist/Data.d.ts +8 -8
- package/dist/Data.js +4 -287
- package/dist/Data.js.map +1 -1
- package/dist/Economy.d.ts +47 -47
- package/dist/Economy.js +4 -610
- package/dist/Economy.js.map +1 -1
- package/dist/Events.d.ts +13 -13
- package/dist/Events.js +4 -323
- package/dist/Events.js.map +1 -1
- package/dist/Experimentation.d.ts +14 -14
- package/dist/Experimentation.js +4 -329
- package/dist/Experimentation.js.map +1 -1
- package/dist/Groups.d.ts +26 -26
- package/dist/Groups.js +4 -413
- package/dist/Groups.js.map +1 -1
- package/dist/Insights.d.ts +7 -7
- package/dist/Insights.js +4 -282
- package/dist/Insights.js.map +1 -1
- package/dist/Localization.d.ts +2 -2
- package/dist/Localization.js +4 -245
- package/dist/Localization.js.map +1 -1
- package/dist/Multiplayer.d.ts +88 -88
- package/dist/Multiplayer.js +4 -858
- package/dist/Multiplayer.js.map +1 -1
- package/dist/{PlayFabCommon-BUv4zqXf.d.ts → PlayFabCommon-BX3jSqGx.d.ts} +4 -6
- package/dist/Profiles.d.ts +10 -10
- package/dist/Profiles.js +4 -302
- package/dist/Profiles.js.map +1 -1
- package/dist/Progression.d.ts +24 -24
- package/dist/Progression.js +4 -400
- package/dist/Progression.js.map +1 -1
- package/dist/Server.d.ts +150 -150
- package/dist/Server.js +4 -1373
- package/dist/Server.js.map +1 -1
- package/dist/chunk-3FCAP7OZ.js +187 -0
- package/dist/chunk-3FCAP7OZ.js.map +1 -0
- package/dist/chunk-62SULWOK.js +195 -0
- package/dist/chunk-62SULWOK.js.map +1 -0
- package/dist/chunk-A7VD6ALV.js +222 -0
- package/dist/chunk-A7VD6ALV.js.map +1 -0
- package/dist/chunk-BX65UND2.js +632 -0
- package/dist/chunk-BX65UND2.js.map +1 -0
- package/dist/chunk-J4QS5VX5.js +19 -0
- package/dist/chunk-J4QS5VX5.js.map +1 -0
- package/dist/chunk-JGDO2ZE3.js +1663 -0
- package/dist/chunk-JGDO2ZE3.js.map +1 -0
- package/dist/chunk-POMI7LEF.js +76 -0
- package/dist/chunk-POMI7LEF.js.map +1 -0
- package/dist/chunk-Q3OF3AOJ.js +97 -0
- package/dist/chunk-Q3OF3AOJ.js.map +1 -0
- package/dist/chunk-QUZHVSVZ.js +174 -0
- package/dist/chunk-QUZHVSVZ.js.map +1 -0
- package/dist/chunk-QVLIVSO4.js +1147 -0
- package/dist/chunk-QVLIVSO4.js.map +1 -0
- package/dist/chunk-R7V7DFCF.js +103 -0
- package/dist/chunk-R7V7DFCF.js.map +1 -0
- package/dist/chunk-SGSEOIKS.js +56 -0
- package/dist/chunk-SGSEOIKS.js.map +1 -0
- package/dist/chunk-UOHHNVCJ.js +119 -0
- package/dist/chunk-UOHHNVCJ.js.map +1 -0
- package/dist/chunk-USKFWNQK.js +384 -0
- package/dist/chunk-USKFWNQK.js.map +1 -0
- package/dist/chunk-UX7LFJCX.js +61 -0
- package/dist/chunk-UX7LFJCX.js.map +1 -0
- package/dist/chunk-X34XZJB6.js +60 -0
- package/dist/chunk-X34XZJB6.js.map +1 -0
- package/dist/chunk-YNZF3WXS.js +882 -0
- package/dist/chunk-YNZF3WXS.js.map +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +49 -5988
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/Server.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BX3jSqGx.js';
|
2
2
|
|
3
3
|
interface AdCampaignAttribution {
|
4
4
|
/** UTC time stamp of attribution */
|
@@ -3052,25 +3052,25 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3052
3052
|
* version 2._ Increments the character's balance of the specified virtual currency by the stated amount
|
3053
3053
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency
|
3054
3054
|
*/
|
3055
|
-
AddCharacterVirtualCurrency(request: AddCharacterVirtualCurrencyRequest,
|
3055
|
+
AddCharacterVirtualCurrency(request: AddCharacterVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
|
3056
3056
|
/**
|
3057
3057
|
* Adds the Friend user to the friendlist of the user with PlayFabId. At least one of
|
3058
3058
|
* FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
|
3059
3059
|
* https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend
|
3060
3060
|
*/
|
3061
|
-
AddFriend(request: AddFriendRequest,
|
3061
|
+
AddFriend(request: AddFriendRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3062
3062
|
/**
|
3063
3063
|
* Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
|
3064
3064
|
* ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
|
3065
3065
|
* authentication credentials, as the intent is that it is easily accessible by other players.
|
3066
3066
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid
|
3067
3067
|
*/
|
3068
|
-
AddGenericID(request: AddGenericIDRequest,
|
3068
|
+
AddGenericID(request: AddGenericIDRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3069
3069
|
/**
|
3070
3070
|
* Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
3071
3071
|
* https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag
|
3072
3072
|
*/
|
3073
|
-
AddPlayerTag(request: AddPlayerTagRequest,
|
3073
|
+
AddPlayerTag(request: AddPlayerTagRequest, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
|
3074
3074
|
/**
|
3075
3075
|
* 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
|
3076
3076
|
* in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small
|
@@ -3078,35 +3078,35 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3078
3078
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3079
3079
|
* https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/addsharedgroupmembers
|
3080
3080
|
*/
|
3081
|
-
AddSharedGroupMembers(request: AddSharedGroupMembersRequest,
|
3081
|
+
AddSharedGroupMembers(request: AddSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
|
3082
3082
|
/**
|
3083
3083
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3084
3084
|
* version 2._ Increments the user's balance of the specified virtual currency by the stated amount
|
3085
3085
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/adduservirtualcurrency
|
3086
3086
|
*/
|
3087
|
-
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest,
|
3087
|
+
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
3088
3088
|
/**
|
3089
3089
|
* Validated a client's session ticket, and if successful, returns details for that user
|
3090
3090
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket
|
3091
3091
|
*/
|
3092
|
-
AuthenticateSessionTicket(request: AuthenticateSessionTicketRequest,
|
3092
|
+
AuthenticateSessionTicket(request: AuthenticateSessionTicketRequest, extraHeaders?: Record<string, string>): Promise<AuthenticateSessionTicketResult>;
|
3093
3093
|
/**
|
3094
3094
|
* Awards the specified users the specified Steam achievements
|
3095
3095
|
* https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement
|
3096
3096
|
*/
|
3097
|
-
AwardSteamAchievement(request: AwardSteamAchievementRequest,
|
3097
|
+
AwardSteamAchievement(request: AwardSteamAchievementRequest, extraHeaders?: Record<string, string>): Promise<AwardSteamAchievementResult>;
|
3098
3098
|
/**
|
3099
3099
|
* Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
|
3100
3100
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers
|
3101
3101
|
*/
|
3102
|
-
BanUsers(request: BanUsersRequest,
|
3102
|
+
BanUsers(request: BanUsersRequest, extraHeaders?: Record<string, string>): Promise<BanUsersResult>;
|
3103
3103
|
/**
|
3104
3104
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3105
3105
|
* version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
|
3106
3106
|
* inventory.
|
3107
3107
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/consumeitem
|
3108
3108
|
*/
|
3109
|
-
ConsumeItem(request: ConsumeItemRequest,
|
3109
|
+
ConsumeItem(request: ConsumeItemRequest, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
|
3110
3110
|
/**
|
3111
3111
|
* Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
|
3112
3112
|
* group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data
|
@@ -3114,34 +3114,34 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3114
3114
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3115
3115
|
* https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/createsharedgroup
|
3116
3116
|
*/
|
3117
|
-
CreateSharedGroup(request: CreateSharedGroupRequest,
|
3117
|
+
CreateSharedGroup(request: CreateSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
|
3118
3118
|
/**
|
3119
3119
|
* Deletes the specific character ID from the specified user.
|
3120
3120
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser
|
3121
3121
|
*/
|
3122
|
-
DeleteCharacterFromUser(request: DeleteCharacterFromUserRequest,
|
3122
|
+
DeleteCharacterFromUser(request: DeleteCharacterFromUserRequest, extraHeaders?: Record<string, string>): Promise<DeleteCharacterFromUserResult>;
|
3123
3123
|
/**
|
3124
3124
|
* Removes a user's player account from a title and deletes all associated data
|
3125
3125
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer
|
3126
3126
|
*/
|
3127
|
-
DeletePlayer(request: DeletePlayerRequest,
|
3127
|
+
DeletePlayer(request: DeletePlayerRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerResult>;
|
3128
3128
|
/**
|
3129
3129
|
* Deletes title-specific custom properties for a player
|
3130
3130
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties
|
3131
3131
|
*/
|
3132
|
-
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest,
|
3132
|
+
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
|
3133
3133
|
/**
|
3134
3134
|
* Deletes push notification template for title
|
3135
3135
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate
|
3136
3136
|
*/
|
3137
|
-
DeletePushNotificationTemplate(request: DeletePushNotificationTemplateRequest,
|
3137
|
+
DeletePushNotificationTemplate(request: DeletePushNotificationTemplateRequest, extraHeaders?: Record<string, string>): Promise<DeletePushNotificationTemplateResult>;
|
3138
3138
|
/**
|
3139
3139
|
* Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for
|
3140
3140
|
* sharing data between a very small number of players, please see our guide:
|
3141
3141
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3142
3142
|
* https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/deletesharedgroup
|
3143
3143
|
*/
|
3144
|
-
DeleteSharedGroup(request: DeleteSharedGroupRequest,
|
3144
|
+
DeleteSharedGroup(request: DeleteSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3145
3145
|
/**
|
3146
3146
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3147
3147
|
* version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would
|
@@ -3149,62 +3149,62 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3149
3149
|
* UnlockContainer.
|
3150
3150
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable
|
3151
3151
|
*/
|
3152
|
-
EvaluateRandomResultTable(request: EvaluateRandomResultTableRequest,
|
3152
|
+
EvaluateRandomResultTable(request: EvaluateRandomResultTableRequest, extraHeaders?: Record<string, string>): Promise<EvaluateRandomResultTableResult>;
|
3153
3153
|
/**
|
3154
3154
|
* Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
|
3155
3155
|
* PlayFab ID is the entity ID of the player's master_player_account entity.
|
3156
3156
|
* https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript
|
3157
3157
|
*/
|
3158
|
-
ExecuteCloudScript(request: ExecuteCloudScriptServerRequest,
|
3158
|
+
ExecuteCloudScript(request: ExecuteCloudScriptServerRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
|
3159
3159
|
/**
|
3160
3160
|
* Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
|
3161
3161
|
* GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
|
3162
3162
|
* https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments
|
3163
3163
|
*/
|
3164
|
-
GetAllSegments(request: GetAllSegmentsRequest,
|
3164
|
+
GetAllSegments(request: GetAllSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
|
3165
3165
|
/**
|
3166
3166
|
* Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
|
3167
3167
|
* evaluated with the parent PlayFabId to guarantee uniqueness.
|
3168
3168
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/getalluserscharacters
|
3169
3169
|
*/
|
3170
|
-
GetAllUsersCharacters(request: ListUsersCharactersRequest,
|
3170
|
+
GetAllUsersCharacters(request: ListUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
|
3171
3171
|
/**
|
3172
3172
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3173
3173
|
* version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
|
3174
3174
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getcatalogitems
|
3175
3175
|
*/
|
3176
|
-
GetCatalogItems(request: GetCatalogItemsRequest,
|
3176
|
+
GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
|
3177
3177
|
/**
|
3178
3178
|
* Retrieves the title-specific custom data for the user which is readable and writable by the client
|
3179
3179
|
* https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata
|
3180
3180
|
*/
|
3181
|
-
GetCharacterData(request: GetCharacterDataRequest,
|
3181
|
+
GetCharacterData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3182
3182
|
/**
|
3183
3183
|
* Retrieves the title-specific custom data for the user's character which cannot be accessed by the client
|
3184
3184
|
* https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata
|
3185
3185
|
*/
|
3186
|
-
GetCharacterInternalData(request: GetCharacterDataRequest,
|
3186
|
+
GetCharacterInternalData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3187
3187
|
/**
|
3188
3188
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3189
3189
|
* version 2._ Retrieves the specified character's current inventory of virtual goods
|
3190
3190
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getcharacterinventory
|
3191
3191
|
*/
|
3192
|
-
GetCharacterInventory(request: GetCharacterInventoryRequest,
|
3192
|
+
GetCharacterInventory(request: GetCharacterInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
|
3193
3193
|
/**
|
3194
3194
|
* Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
|
3195
3195
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterleaderboard
|
3196
3196
|
*/
|
3197
|
-
GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest,
|
3197
|
+
GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
|
3198
3198
|
/**
|
3199
3199
|
* Retrieves the title-specific custom data for the user's character which can only be read by the client
|
3200
3200
|
* https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata
|
3201
3201
|
*/
|
3202
|
-
GetCharacterReadOnlyData(request: GetCharacterDataRequest,
|
3202
|
+
GetCharacterReadOnlyData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
|
3203
3203
|
/**
|
3204
3204
|
* Retrieves the details of all title-specific statistics for the specific character
|
3205
3205
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics
|
3206
3206
|
*/
|
3207
|
-
GetCharacterStatistics(request: GetCharacterStatisticsRequest,
|
3207
|
+
GetCharacterStatistics(request: GetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
|
3208
3208
|
/**
|
3209
3209
|
* This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
|
3210
3210
|
* URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
|
@@ -3214,60 +3214,60 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3214
3214
|
* please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
|
3215
3215
|
* https://docs.microsoft.com/rest/api/playfab/server/content/getcontentdownloadurl
|
3216
3216
|
*/
|
3217
|
-
GetContentDownloadUrl(request: GetContentDownloadUrlRequest,
|
3217
|
+
GetContentDownloadUrl(request: GetContentDownloadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
|
3218
3218
|
/**
|
3219
3219
|
* Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the
|
3220
3220
|
* leaderboard
|
3221
3221
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard
|
3222
3222
|
*/
|
3223
|
-
GetFriendLeaderboard(request: GetFriendLeaderboardRequest,
|
3223
|
+
GetFriendLeaderboard(request: GetFriendLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
|
3224
3224
|
/**
|
3225
3225
|
* Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from
|
3226
3226
|
* linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
|
3227
3227
|
* https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/getfriendslist
|
3228
3228
|
*/
|
3229
|
-
GetFriendsList(request: GetFriendsListRequest,
|
3229
|
+
GetFriendsList(request: GetFriendsListRequest, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
|
3230
3230
|
/**
|
3231
3231
|
* Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
|
3232
3232
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboard
|
3233
3233
|
*/
|
3234
|
-
GetLeaderboard(request: GetLeaderboardRequest,
|
3234
|
+
GetLeaderboard(request: GetLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
|
3235
3235
|
/**
|
3236
3236
|
* Retrieves a list of ranked characters for the given statistic, centered on the requested user
|
3237
3237
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter
|
3238
3238
|
*/
|
3239
|
-
GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest,
|
3239
|
+
GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
|
3240
3240
|
/**
|
3241
3241
|
* Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
|
3242
3242
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser
|
3243
3243
|
*/
|
3244
|
-
GetLeaderboardAroundUser(request: GetLeaderboardAroundUserRequest,
|
3244
|
+
GetLeaderboardAroundUser(request: GetLeaderboardAroundUserRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundUserResult>;
|
3245
3245
|
/**
|
3246
3246
|
* Retrieves a list of all of the user's characters for the given statistic.
|
3247
3247
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters
|
3248
3248
|
*/
|
3249
|
-
GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest,
|
3249
|
+
GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
|
3250
3250
|
/**
|
3251
3251
|
* Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be
|
3252
3252
|
* returned. All parameters default to false.
|
3253
3253
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo
|
3254
3254
|
*/
|
3255
|
-
GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest,
|
3255
|
+
GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCombinedInfoResult>;
|
3256
3256
|
/**
|
3257
3257
|
* Retrieves a title-specific custom property value for a player.
|
3258
3258
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty
|
3259
3259
|
*/
|
3260
|
-
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest,
|
3260
|
+
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
|
3261
3261
|
/**
|
3262
3262
|
* Retrieves the player's profile
|
3263
3263
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile
|
3264
3264
|
*/
|
3265
|
-
GetPlayerProfile(request: GetPlayerProfileRequest,
|
3265
|
+
GetPlayerProfile(request: GetPlayerProfileRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
|
3266
3266
|
/**
|
3267
3267
|
* List all segments that a player currently belongs to at this moment in time.
|
3268
3268
|
* https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments
|
3269
3269
|
*/
|
3270
|
-
GetPlayerSegments(request: GetPlayersSegmentsRequest,
|
3270
|
+
GetPlayerSegments(request: GetPlayersSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
|
3271
3271
|
/**
|
3272
3272
|
* Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
|
3273
3273
|
* the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
|
@@ -3276,358 +3276,358 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3276
3276
|
* called 30 times in one minute. You will be returned an error if you exceed this threshold.
|
3277
3277
|
* https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment
|
3278
3278
|
*/
|
3279
|
-
GetPlayersInSegment(request: GetPlayersInSegmentRequest,
|
3279
|
+
GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
|
3280
3280
|
/**
|
3281
3281
|
* Retrieves the current version and values for the indicated statistics, for the local player.
|
3282
3282
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics
|
3283
3283
|
*/
|
3284
|
-
GetPlayerStatistics(request: GetPlayerStatisticsRequest,
|
3284
|
+
GetPlayerStatistics(request: GetPlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticsResult>;
|
3285
3285
|
/**
|
3286
3286
|
* Retrieves the information on the available versions of the specified statistic.
|
3287
3287
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions
|
3288
3288
|
*/
|
3289
|
-
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest,
|
3289
|
+
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
|
3290
3290
|
/**
|
3291
3291
|
* Get all tags with a given Namespace (optional) from a player profile.
|
3292
3292
|
* https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags
|
3293
3293
|
*/
|
3294
|
-
GetPlayerTags(request: GetPlayerTagsRequest,
|
3294
|
+
GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
|
3295
3295
|
/**
|
3296
3296
|
* Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
|
3297
3297
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids
|
3298
3298
|
*/
|
3299
|
-
GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest,
|
3299
|
+
GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromBattleNetAccountIdsResult>;
|
3300
3300
|
/**
|
3301
3301
|
* Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
|
3302
3302
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids
|
3303
3303
|
*/
|
3304
|
-
GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest,
|
3304
|
+
GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookIDsResult>;
|
3305
3305
|
/**
|
3306
3306
|
* Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.
|
3307
3307
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids
|
3308
3308
|
*/
|
3309
|
-
GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest,
|
3309
|
+
GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
|
3310
3310
|
/**
|
3311
3311
|
* Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
|
3312
3312
|
* service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
|
3313
3313
|
* added to the player account.
|
3314
3314
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromgenericids
|
3315
3315
|
*/
|
3316
|
-
GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest,
|
3316
|
+
GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGenericIDsResult>;
|
3317
3317
|
/**
|
3318
3318
|
* Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
|
3319
3319
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids
|
3320
3320
|
*/
|
3321
|
-
GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest,
|
3321
|
+
GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoServiceAccountIdsResult>;
|
3322
3322
|
/**
|
3323
3323
|
* Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
|
3324
3324
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids
|
3325
3325
|
*/
|
3326
|
-
GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest,
|
3326
|
+
GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoSwitchDeviceIdsResult>;
|
3327
3327
|
/**
|
3328
3328
|
* Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
|
3329
3329
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids
|
3330
3330
|
*/
|
3331
|
-
GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest,
|
3331
|
+
GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNAccountIDsResult>;
|
3332
3332
|
/**
|
3333
3333
|
* Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
|
3334
3334
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids
|
3335
3335
|
*/
|
3336
|
-
GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest,
|
3336
|
+
GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNOnlineIDsResult>;
|
3337
3337
|
/**
|
3338
3338
|
* Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
|
3339
3339
|
* IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
|
3340
3340
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids
|
3341
3341
|
*/
|
3342
|
-
GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest,
|
3342
|
+
GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamIDsResult>;
|
3343
3343
|
/**
|
3344
3344
|
* Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
|
3345
3345
|
* names.
|
3346
3346
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames
|
3347
3347
|
*/
|
3348
|
-
GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest,
|
3348
|
+
GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamNamesResult>;
|
3349
3349
|
/**
|
3350
3350
|
* Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
|
3351
3351
|
* the user accounts, available as "_id" from the Twitch API methods (ex:
|
3352
3352
|
* https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
|
3353
3353
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromtwitchids
|
3354
3354
|
*/
|
3355
|
-
GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest,
|
3355
|
+
GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromTwitchIDsResult>;
|
3356
3356
|
/**
|
3357
3357
|
* Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
|
3358
3358
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids
|
3359
3359
|
*/
|
3360
|
-
GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest,
|
3360
|
+
GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromXboxLiveIDsResult>;
|
3361
3361
|
/**
|
3362
3362
|
* Retrieves the key-value store of custom publisher settings
|
3363
3363
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata
|
3364
3364
|
*/
|
3365
|
-
GetPublisherData(request: GetPublisherDataRequest,
|
3365
|
+
GetPublisherData(request: GetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
|
3366
3366
|
/**
|
3367
3367
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3368
3368
|
* version 2._ Retrieves the configuration information for the specified random results tables for the title, including all
|
3369
3369
|
* ItemId values and weights
|
3370
3370
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables
|
3371
3371
|
*/
|
3372
|
-
GetRandomResultTables(request: GetRandomResultTablesRequest,
|
3372
|
+
GetRandomResultTables(request: GetRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
|
3373
3373
|
/**
|
3374
3374
|
* Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
|
3375
3375
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids
|
3376
3376
|
*/
|
3377
|
-
GetServerCustomIDsFromPlayFabIDs(request: GetServerCustomIDsFromPlayFabIDsRequest,
|
3377
|
+
GetServerCustomIDsFromPlayFabIDs(request: GetServerCustomIDsFromPlayFabIDsRequest, extraHeaders?: Record<string, string>): Promise<GetServerCustomIDsFromPlayFabIDsResult>;
|
3378
3378
|
/**
|
3379
3379
|
* Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all
|
3380
3380
|
* public and private group data. Shared Groups are designed for sharing data between a very small number of players,
|
3381
3381
|
* please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3382
3382
|
* https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/getsharedgroupdata
|
3383
3383
|
*/
|
3384
|
-
GetSharedGroupData(request: GetSharedGroupDataRequest,
|
3384
|
+
GetSharedGroupData(request: GetSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<GetSharedGroupDataResult>;
|
3385
3385
|
/**
|
3386
3386
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3387
3387
|
* version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified
|
3388
3388
|
* player
|
3389
3389
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems
|
3390
3390
|
*/
|
3391
|
-
GetStoreItems(request: GetStoreItemsServerRequest,
|
3391
|
+
GetStoreItems(request: GetStoreItemsServerRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
|
3392
3392
|
/**
|
3393
3393
|
* Retrieves the current server time
|
3394
3394
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime
|
3395
3395
|
*/
|
3396
|
-
GetTime(request: GetTimeRequest,
|
3396
|
+
GetTime(request: GetTimeRequest, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
|
3397
3397
|
/**
|
3398
3398
|
* Retrieves the key-value store of custom title settings
|
3399
3399
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata
|
3400
3400
|
*/
|
3401
|
-
GetTitleData(request: GetTitleDataRequest,
|
3401
|
+
GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3402
3402
|
/**
|
3403
3403
|
* Retrieves the key-value store of custom internal title settings
|
3404
3404
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata
|
3405
3405
|
*/
|
3406
|
-
GetTitleInternalData(request: GetTitleDataRequest,
|
3406
|
+
GetTitleInternalData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3407
3407
|
/**
|
3408
3408
|
* Retrieves the title news feed, as configured in the developer portal
|
3409
3409
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews
|
3410
3410
|
*/
|
3411
|
-
GetTitleNews(request: GetTitleNewsRequest,
|
3411
|
+
GetTitleNews(request: GetTitleNewsRequest, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
|
3412
3412
|
/**
|
3413
3413
|
* Retrieves the relevant details for a specified user
|
3414
3414
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo
|
3415
3415
|
*/
|
3416
|
-
GetUserAccountInfo(request: GetUserAccountInfoRequest,
|
3416
|
+
GetUserAccountInfo(request: GetUserAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<GetUserAccountInfoResult>;
|
3417
3417
|
/**
|
3418
3418
|
* Gets all bans for a user.
|
3419
3419
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans
|
3420
3420
|
*/
|
3421
|
-
GetUserBans(request: GetUserBansRequest,
|
3421
|
+
GetUserBans(request: GetUserBansRequest, extraHeaders?: Record<string, string>): Promise<GetUserBansResult>;
|
3422
3422
|
/**
|
3423
3423
|
* Retrieves the title-specific custom data for the user which is readable and writable by the client
|
3424
3424
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata
|
3425
3425
|
*/
|
3426
|
-
GetUserData(request: GetUserDataRequest,
|
3426
|
+
GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3427
3427
|
/**
|
3428
3428
|
* Retrieves the title-specific custom data for the user which cannot be accessed by the client
|
3429
3429
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata
|
3430
3430
|
*/
|
3431
|
-
GetUserInternalData(request: GetUserDataRequest,
|
3431
|
+
GetUserInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3432
3432
|
/**
|
3433
3433
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3434
3434
|
* version 2._ Retrieves the specified user's current inventory of virtual goods
|
3435
3435
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory
|
3436
3436
|
*/
|
3437
|
-
GetUserInventory(request: GetUserInventoryRequest,
|
3437
|
+
GetUserInventory(request: GetUserInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
|
3438
3438
|
/**
|
3439
3439
|
* Retrieves the publisher-specific custom data for the user which is readable and writable by the client
|
3440
3440
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherdata
|
3441
3441
|
*/
|
3442
|
-
GetUserPublisherData(request: GetUserDataRequest,
|
3442
|
+
GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3443
3443
|
/**
|
3444
3444
|
* Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
|
3445
3445
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata
|
3446
3446
|
*/
|
3447
|
-
GetUserPublisherInternalData(request: GetUserDataRequest,
|
3447
|
+
GetUserPublisherInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3448
3448
|
/**
|
3449
3449
|
* Retrieves the publisher-specific custom data for the user which can only be read by the client
|
3450
3450
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherreadonlydata
|
3451
3451
|
*/
|
3452
|
-
GetUserPublisherReadOnlyData(request: GetUserDataRequest,
|
3452
|
+
GetUserPublisherReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3453
3453
|
/**
|
3454
3454
|
* Retrieves the title-specific custom data for the user which can only be read by the client
|
3455
3455
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserreadonlydata
|
3456
3456
|
*/
|
3457
|
-
GetUserReadOnlyData(request: GetUserDataRequest,
|
3457
|
+
GetUserReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3458
3458
|
/**
|
3459
3459
|
* Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
|
3460
3460
|
* with the parent PlayFabId to guarantee uniqueness.
|
3461
3461
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/grantcharactertouser
|
3462
3462
|
*/
|
3463
|
-
GrantCharacterToUser(request: GrantCharacterToUserRequest,
|
3463
|
+
GrantCharacterToUser(request: GrantCharacterToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
|
3464
3464
|
/**
|
3465
3465
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3466
3466
|
* version 2._ Adds the specified items to the specified character's inventory
|
3467
3467
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter
|
3468
3468
|
*/
|
3469
|
-
GrantItemsToCharacter(request: GrantItemsToCharacterRequest,
|
3469
|
+
GrantItemsToCharacter(request: GrantItemsToCharacterRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToCharacterResult>;
|
3470
3470
|
/**
|
3471
3471
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3472
3472
|
* version 2._ Adds the specified items to the specified user's inventory
|
3473
3473
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser
|
3474
3474
|
*/
|
3475
|
-
GrantItemsToUser(request: GrantItemsToUserRequest,
|
3475
|
+
GrantItemsToUser(request: GrantItemsToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUserResult>;
|
3476
3476
|
/**
|
3477
3477
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3478
3478
|
* version 2._ Adds the specified items to the specified user inventories
|
3479
3479
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers
|
3480
3480
|
*/
|
3481
|
-
GrantItemsToUsers(request: GrantItemsToUsersRequest,
|
3481
|
+
GrantItemsToUsers(request: GrantItemsToUsersRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUsersResult>;
|
3482
3482
|
/**
|
3483
3483
|
* Links the Battle.net account associated with the token to the user's PlayFab account.
|
3484
3484
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount
|
3485
3485
|
*/
|
3486
|
-
LinkBattleNetAccount(request: LinkBattleNetAccountRequest,
|
3486
|
+
LinkBattleNetAccount(request: LinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3487
3487
|
/**
|
3488
3488
|
* Links the Nintendo account associated with the token to the user's PlayFab account
|
3489
3489
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount
|
3490
3490
|
*/
|
3491
|
-
LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest,
|
3491
|
+
LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3492
3492
|
/**
|
3493
3493
|
* Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account
|
3494
3494
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject
|
3495
3495
|
*/
|
3496
|
-
LinkNintendoServiceAccountSubject(request: LinkNintendoServiceAccountSubjectRequest,
|
3496
|
+
LinkNintendoServiceAccountSubject(request: LinkNintendoServiceAccountSubjectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3497
3497
|
/**
|
3498
3498
|
* Links the NintendoSwitchDeviceId to the user's PlayFab account
|
3499
3499
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid
|
3500
3500
|
*/
|
3501
|
-
LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest,
|
3501
|
+
LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
|
3502
3502
|
/**
|
3503
3503
|
* Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
|
3504
3504
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnaccount
|
3505
3505
|
*/
|
3506
|
-
LinkPSNAccount(request: LinkPSNAccountRequest,
|
3506
|
+
LinkPSNAccount(request: LinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
|
3507
3507
|
/**
|
3508
3508
|
* Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account
|
3509
3509
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid
|
3510
3510
|
*/
|
3511
|
-
LinkPSNId(request: LinkPSNIdRequest,
|
3511
|
+
LinkPSNId(request: LinkPSNIdRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNIdResponse>;
|
3512
3512
|
/**
|
3513
3513
|
* Links the custom server identifier, generated by the title, to the user's PlayFab account.
|
3514
3514
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid
|
3515
3515
|
*/
|
3516
|
-
LinkServerCustomId(request: LinkServerCustomIdRequest,
|
3516
|
+
LinkServerCustomId(request: LinkServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<LinkServerCustomIdResult>;
|
3517
3517
|
/**
|
3518
3518
|
* Links the Steam account associated with the provided Steam ID to the user's PlayFab account
|
3519
3519
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid
|
3520
3520
|
*/
|
3521
|
-
LinkSteamId(request: LinkSteamIdRequest,
|
3521
|
+
LinkSteamId(request: LinkSteamIdRequest, extraHeaders?: Record<string, string>): Promise<LinkSteamIdResult>;
|
3522
3522
|
/**
|
3523
3523
|
* Links the Xbox Live account associated with the provided access code to the user's PlayFab account
|
3524
3524
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount
|
3525
3525
|
*/
|
3526
|
-
LinkXboxAccount(request: LinkXboxAccountRequest,
|
3526
|
+
LinkXboxAccount(request: LinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
|
3527
3527
|
/**
|
3528
3528
|
* Retrieves title-specific custom property values for a player.
|
3529
3529
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties
|
3530
3530
|
*/
|
3531
|
-
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest,
|
3531
|
+
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
|
3532
3532
|
/**
|
3533
3533
|
* Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
|
3534
3534
|
* API calls which require an authenticated user
|
3535
3535
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid
|
3536
3536
|
*/
|
3537
|
-
LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest,
|
3537
|
+
LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3538
3538
|
/**
|
3539
3539
|
* Sign in the user with a Battle.net identity token
|
3540
3540
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet
|
3541
3541
|
*/
|
3542
|
-
LoginWithBattleNet(request: LoginWithBattleNetRequest,
|
3542
|
+
LoginWithBattleNet(request: LoginWithBattleNetRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3543
3543
|
/**
|
3544
3544
|
* Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
|
3545
3545
|
* subsequently be used for API calls which require an authenticated user
|
3546
3546
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid
|
3547
3547
|
*/
|
3548
|
-
LoginWithCustomID(request: LoginWithCustomIDRequest,
|
3548
|
+
LoginWithCustomID(request: LoginWithCustomIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3549
3549
|
/**
|
3550
3550
|
* Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API
|
3551
3551
|
* calls which require an authenticated user
|
3552
3552
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid
|
3553
3553
|
*/
|
3554
|
-
LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest,
|
3554
|
+
LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3555
3555
|
/**
|
3556
3556
|
* Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
|
3557
3557
|
* subsequently be used for API calls which require an authenticated user
|
3558
3558
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithpsn
|
3559
3559
|
*/
|
3560
|
-
LoginWithPSN(request: LoginWithPSNRequest,
|
3560
|
+
LoginWithPSN(request: LoginWithPSNRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3561
3561
|
/**
|
3562
3562
|
* Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID
|
3563
3563
|
* and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
|
3564
3564
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid
|
3565
3565
|
*/
|
3566
|
-
LoginWithServerCustomId(request: LoginWithServerCustomIdRequest,
|
3566
|
+
LoginWithServerCustomId(request: LoginWithServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3567
3567
|
/**
|
3568
3568
|
* Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which
|
3569
3569
|
* require an authenticated user
|
3570
3570
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid
|
3571
3571
|
*/
|
3572
|
-
LoginWithSteamId(request: LoginWithSteamIdRequest,
|
3572
|
+
LoginWithSteamId(request: LoginWithSteamIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3573
3573
|
/**
|
3574
3574
|
* Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can
|
3575
3575
|
* subsequently be used for API calls which require an authenticated user
|
3576
3576
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox
|
3577
3577
|
*/
|
3578
|
-
LoginWithXbox(request: LoginWithXboxRequest,
|
3578
|
+
LoginWithXbox(request: LoginWithXboxRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3579
3579
|
/**
|
3580
3580
|
* Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API
|
3581
3581
|
* calls which require an authenticated user
|
3582
3582
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid
|
3583
3583
|
*/
|
3584
|
-
LoginWithXboxId(request: LoginWithXboxIdRequest,
|
3584
|
+
LoginWithXboxId(request: LoginWithXboxIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
|
3585
3585
|
/**
|
3586
3586
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3587
3587
|
* version 2._ Modifies the number of remaining uses of a player's inventory item
|
3588
3588
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses
|
3589
3589
|
*/
|
3590
|
-
ModifyItemUses(request: ModifyItemUsesRequest,
|
3590
|
+
ModifyItemUses(request: ModifyItemUsesRequest, extraHeaders?: Record<string, string>): Promise<ModifyItemUsesResult>;
|
3591
3591
|
/**
|
3592
3592
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3593
3593
|
* version 2._ Moves an item from a character's inventory into another of the users's character's inventory.
|
3594
3594
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter
|
3595
3595
|
*/
|
3596
|
-
MoveItemToCharacterFromCharacter(request: MoveItemToCharacterFromCharacterRequest,
|
3596
|
+
MoveItemToCharacterFromCharacter(request: MoveItemToCharacterFromCharacterRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromCharacterResult>;
|
3597
3597
|
/**
|
3598
3598
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3599
3599
|
* version 2._ Moves an item from a user's inventory into their character's inventory.
|
3600
3600
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser
|
3601
3601
|
*/
|
3602
|
-
MoveItemToCharacterFromUser(request: MoveItemToCharacterFromUserRequest,
|
3602
|
+
MoveItemToCharacterFromUser(request: MoveItemToCharacterFromUserRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromUserResult>;
|
3603
3603
|
/**
|
3604
3604
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3605
3605
|
* version 2._ Moves an item from a character's inventory into the owning user's inventory.
|
3606
3606
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter
|
3607
3607
|
*/
|
3608
|
-
MoveItemToUserFromCharacter(request: MoveItemToUserFromCharacterRequest,
|
3608
|
+
MoveItemToUserFromCharacter(request: MoveItemToUserFromCharacterRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToUserFromCharacterResult>;
|
3609
3609
|
/**
|
3610
3610
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3611
3611
|
* version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
|
3612
3612
|
* Economy->Catalogs tab in the PlayFab Game Manager.
|
3613
3613
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/redeemcoupon
|
3614
3614
|
*/
|
3615
|
-
RedeemCoupon(request: RedeemCouponRequest,
|
3615
|
+
RedeemCoupon(request: RedeemCouponRequest, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
|
3616
3616
|
/**
|
3617
3617
|
* Removes the specified friend from the the user's friend list
|
3618
3618
|
* https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend
|
3619
3619
|
*/
|
3620
|
-
RemoveFriend(request: RemoveFriendRequest,
|
3620
|
+
RemoveFriend(request: RemoveFriendRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3621
3621
|
/**
|
3622
3622
|
* Removes the specified generic service identifier from the player's PlayFab account.
|
3623
3623
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid
|
3624
3624
|
*/
|
3625
|
-
RemoveGenericID(request: RemoveGenericIDRequest,
|
3625
|
+
RemoveGenericID(request: RemoveGenericIDRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
3626
3626
|
/**
|
3627
3627
|
* Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
3628
3628
|
* https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag
|
3629
3629
|
*/
|
3630
|
-
RemovePlayerTag(request: RemovePlayerTagRequest,
|
3630
|
+
RemovePlayerTag(request: RemovePlayerTagRequest, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
|
3631
3631
|
/**
|
3632
3632
|
* 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
|
3633
3633
|
* group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
|
@@ -3635,138 +3635,138 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3635
3635
|
* guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3636
3636
|
* https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/removesharedgroupmembers
|
3637
3637
|
*/
|
3638
|
-
RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest,
|
3638
|
+
RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
|
3639
3639
|
/**
|
3640
3640
|
* Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service
|
3641
3641
|
* representatives for the title can take action concerning potentially toxic players.
|
3642
3642
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer
|
3643
3643
|
*/
|
3644
|
-
ReportPlayer(request: ReportPlayerServerRequest,
|
3644
|
+
ReportPlayer(request: ReportPlayerServerRequest, extraHeaders?: Record<string, string>): Promise<ReportPlayerServerResult>;
|
3645
3645
|
/**
|
3646
3646
|
* Revoke all active bans for a user.
|
3647
3647
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser
|
3648
3648
|
*/
|
3649
|
-
RevokeAllBansForUser(request: RevokeAllBansForUserRequest,
|
3649
|
+
RevokeAllBansForUser(request: RevokeAllBansForUserRequest, extraHeaders?: Record<string, string>): Promise<RevokeAllBansForUserResult>;
|
3650
3650
|
/**
|
3651
3651
|
* Revoke all active bans specified with BanId.
|
3652
3652
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans
|
3653
3653
|
*/
|
3654
|
-
RevokeBans(request: RevokeBansRequest,
|
3654
|
+
RevokeBans(request: RevokeBansRequest, extraHeaders?: Record<string, string>): Promise<RevokeBansResult>;
|
3655
3655
|
/**
|
3656
3656
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3657
3657
|
* version 2._ Revokes access to an item in a user's inventory
|
3658
3658
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem
|
3659
3659
|
*/
|
3660
|
-
RevokeInventoryItem(request: RevokeInventoryItemRequest,
|
3660
|
+
RevokeInventoryItem(request: RevokeInventoryItemRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryResult>;
|
3661
3661
|
/**
|
3662
3662
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3663
3663
|
* version 2._ Revokes access for up to 25 items across multiple users and characters.
|
3664
3664
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems
|
3665
3665
|
*/
|
3666
|
-
RevokeInventoryItems(request: RevokeInventoryItemsRequest,
|
3666
|
+
RevokeInventoryItems(request: RevokeInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
|
3667
3667
|
/**
|
3668
3668
|
* Saves push notification template for title
|
3669
3669
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate
|
3670
3670
|
*/
|
3671
|
-
SavePushNotificationTemplate(request: SavePushNotificationTemplateRequest,
|
3671
|
+
SavePushNotificationTemplate(request: SavePushNotificationTemplateRequest, extraHeaders?: Record<string, string>): Promise<SavePushNotificationTemplateResult>;
|
3672
3672
|
/**
|
3673
3673
|
* Forces an email to be sent to the registered contact email address for the user's account based on an account recovery
|
3674
3674
|
* email template
|
3675
3675
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail
|
3676
3676
|
*/
|
3677
|
-
SendCustomAccountRecoveryEmail(request: SendCustomAccountRecoveryEmailRequest,
|
3677
|
+
SendCustomAccountRecoveryEmail(request: SendCustomAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendCustomAccountRecoveryEmailResult>;
|
3678
3678
|
/**
|
3679
3679
|
* Sends an email based on an email template to a player's contact email
|
3680
3680
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate
|
3681
3681
|
*/
|
3682
|
-
SendEmailFromTemplate(request: SendEmailFromTemplateRequest,
|
3682
|
+
SendEmailFromTemplate(request: SendEmailFromTemplateRequest, extraHeaders?: Record<string, string>): Promise<SendEmailFromTemplateResult>;
|
3683
3683
|
/**
|
3684
3684
|
* Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push
|
3685
3685
|
* Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
|
3686
3686
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification
|
3687
3687
|
*/
|
3688
|
-
SendPushNotification(request: SendPushNotificationRequest,
|
3688
|
+
SendPushNotification(request: SendPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
|
3689
3689
|
/**
|
3690
3690
|
* Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push
|
3691
3691
|
* Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
|
3692
3692
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate
|
3693
3693
|
*/
|
3694
|
-
SendPushNotificationFromTemplate(request: SendPushNotificationFromTemplateRequest,
|
3694
|
+
SendPushNotificationFromTemplate(request: SendPushNotificationFromTemplateRequest, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
|
3695
3695
|
/**
|
3696
3696
|
* Updates the tag list for a specified user in the friend list of another user
|
3697
3697
|
* https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags
|
3698
3698
|
*/
|
3699
|
-
SetFriendTags(request: SetFriendTagsRequest,
|
3699
|
+
SetFriendTags(request: SetFriendTagsRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3700
3700
|
/**
|
3701
3701
|
* Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
|
3702
3702
|
* secret use the Admin or Server API method SetPlayerSecret.
|
3703
3703
|
* https://docs.microsoft.com/rest/api/playfab/server/authentication/setplayersecret
|
3704
3704
|
*/
|
3705
|
-
SetPlayerSecret(request: SetPlayerSecretRequest,
|
3705
|
+
SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
|
3706
3706
|
/**
|
3707
3707
|
* Updates the key-value store of custom publisher settings
|
3708
3708
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata
|
3709
3709
|
*/
|
3710
|
-
SetPublisherData(request: SetPublisherDataRequest,
|
3710
|
+
SetPublisherData(request: SetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
|
3711
3711
|
/**
|
3712
3712
|
* Updates the key-value store of custom title settings
|
3713
3713
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata
|
3714
3714
|
*/
|
3715
|
-
SetTitleData(request: SetTitleDataRequest,
|
3715
|
+
SetTitleData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3716
3716
|
/**
|
3717
3717
|
* Updates the key-value store of custom title settings
|
3718
3718
|
* https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata
|
3719
3719
|
*/
|
3720
|
-
SetTitleInternalData(request: SetTitleDataRequest,
|
3720
|
+
SetTitleInternalData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3721
3721
|
/**
|
3722
3722
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3723
3723
|
* version 2._ Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to
|
3724
3724
|
* make a VC balance negative with this API.
|
3725
3725
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractcharactervirtualcurrency
|
3726
3726
|
*/
|
3727
|
-
SubtractCharacterVirtualCurrency(request: SubtractCharacterVirtualCurrencyRequest,
|
3727
|
+
SubtractCharacterVirtualCurrency(request: SubtractCharacterVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
|
3728
3728
|
/**
|
3729
3729
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3730
3730
|
* version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
|
3731
3731
|
* a VC balance negative with this API.
|
3732
3732
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency
|
3733
3733
|
*/
|
3734
|
-
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest,
|
3734
|
+
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
3735
3735
|
/**
|
3736
3736
|
* Unlinks the related Battle.net account from the user's PlayFab account.
|
3737
3737
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount
|
3738
3738
|
*/
|
3739
|
-
UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest,
|
3739
|
+
UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3740
3740
|
/**
|
3741
3741
|
* Unlinks the related Nintendo account from the user's PlayFab account
|
3742
3742
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount
|
3743
3743
|
*/
|
3744
|
-
UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest,
|
3744
|
+
UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3745
3745
|
/**
|
3746
3746
|
* Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
|
3747
3747
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoswitchdeviceid
|
3748
3748
|
*/
|
3749
|
-
UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest,
|
3749
|
+
UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
|
3750
3750
|
/**
|
3751
3751
|
* Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
|
3752
3752
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount
|
3753
3753
|
*/
|
3754
|
-
UnlinkPSNAccount(request: UnlinkPSNAccountRequest,
|
3754
|
+
UnlinkPSNAccount(request: UnlinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
|
3755
3755
|
/**
|
3756
3756
|
* Unlinks the custom server identifier from the user's PlayFab account.
|
3757
3757
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid
|
3758
3758
|
*/
|
3759
|
-
UnlinkServerCustomId(request: UnlinkServerCustomIdRequest,
|
3759
|
+
UnlinkServerCustomId(request: UnlinkServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkServerCustomIdResult>;
|
3760
3760
|
/**
|
3761
3761
|
* Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account
|
3762
3762
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid
|
3763
3763
|
*/
|
3764
|
-
UnlinkSteamId(request: UnlinkSteamIdRequest,
|
3764
|
+
UnlinkSteamId(request: UnlinkSteamIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkSteamIdResult>;
|
3765
3765
|
/**
|
3766
3766
|
* Unlinks the related Xbox Live account from the user's PlayFab account
|
3767
3767
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount
|
3768
3768
|
*/
|
3769
|
-
UnlinkXboxAccount(request: UnlinkXboxAccountRequest,
|
3769
|
+
UnlinkXboxAccount(request: UnlinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
|
3770
3770
|
/**
|
3771
3771
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3772
3772
|
* version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when
|
@@ -3774,7 +3774,7 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3774
3774
|
* (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
|
3775
3775
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontainerinstance
|
3776
3776
|
*/
|
3777
|
-
UnlockContainerInstance(request: UnlockContainerInstanceRequest,
|
3777
|
+
UnlockContainerInstance(request: UnlockContainerInstanceRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
|
3778
3778
|
/**
|
3779
3779
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3780
3780
|
* version 2._ Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary
|
@@ -3783,47 +3783,47 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3783
3783
|
* ConsumeItem.
|
3784
3784
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontaineritem
|
3785
3785
|
*/
|
3786
|
-
UnlockContainerItem(request: UnlockContainerItemRequest,
|
3786
|
+
UnlockContainerItem(request: UnlockContainerItemRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
|
3787
3787
|
/**
|
3788
3788
|
* Update the avatar URL of the specified player
|
3789
3789
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl
|
3790
3790
|
*/
|
3791
|
-
UpdateAvatarUrl(request: UpdateAvatarUrlRequest,
|
3791
|
+
UpdateAvatarUrl(request: UpdateAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3792
3792
|
/**
|
3793
3793
|
* Updates information of a list of existing bans specified with Ban Ids.
|
3794
3794
|
* https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans
|
3795
3795
|
*/
|
3796
|
-
UpdateBans(request: UpdateBansRequest,
|
3796
|
+
UpdateBans(request: UpdateBansRequest, extraHeaders?: Record<string, string>): Promise<UpdateBansResult>;
|
3797
3797
|
/**
|
3798
3798
|
* Updates the title-specific custom data for the user's character which is readable and writable by the client
|
3799
3799
|
* https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterdata
|
3800
3800
|
*/
|
3801
|
-
UpdateCharacterData(request: UpdateCharacterDataRequest,
|
3801
|
+
UpdateCharacterData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
|
3802
3802
|
/**
|
3803
3803
|
* Updates the title-specific custom data for the user's character which cannot be accessed by the client
|
3804
3804
|
* https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata
|
3805
3805
|
*/
|
3806
|
-
UpdateCharacterInternalData(request: UpdateCharacterDataRequest,
|
3806
|
+
UpdateCharacterInternalData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
|
3807
3807
|
/**
|
3808
3808
|
* Updates the title-specific custom data for the user's character which can only be read by the client
|
3809
3809
|
* https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata
|
3810
3810
|
*/
|
3811
|
-
UpdateCharacterReadOnlyData(request: UpdateCharacterDataRequest,
|
3811
|
+
UpdateCharacterReadOnlyData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
|
3812
3812
|
/**
|
3813
3813
|
* Updates the values of the specified title-specific statistics for the specific character
|
3814
3814
|
* https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics
|
3815
3815
|
*/
|
3816
|
-
UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest,
|
3816
|
+
UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterStatisticsResult>;
|
3817
3817
|
/**
|
3818
3818
|
* Updates the title-specific custom property values for a player
|
3819
3819
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties
|
3820
3820
|
*/
|
3821
|
-
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest,
|
3821
|
+
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
|
3822
3822
|
/**
|
3823
3823
|
* Updates the values of the specified title-specific statistics for the user
|
3824
3824
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics
|
3825
3825
|
*/
|
3826
|
-
UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest,
|
3826
|
+
UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
|
3827
3827
|
/**
|
3828
3828
|
* Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
|
3829
3829
|
* or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
|
@@ -3832,58 +3832,58 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
3832
3832
|
* https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
|
3833
3833
|
* https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/updatesharedgroupdata
|
3834
3834
|
*/
|
3835
|
-
UpdateSharedGroupData(request: UpdateSharedGroupDataRequest,
|
3835
|
+
UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
|
3836
3836
|
/**
|
3837
3837
|
* Updates the title-specific custom data for the user which is readable and writable by the client
|
3838
3838
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata
|
3839
3839
|
*/
|
3840
|
-
UpdateUserData(request: UpdateUserDataRequest,
|
3840
|
+
UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3841
3841
|
/**
|
3842
3842
|
* Updates the title-specific custom data for the user which cannot be accessed by the client
|
3843
3843
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata
|
3844
3844
|
*/
|
3845
|
-
UpdateUserInternalData(request: UpdateUserInternalDataRequest,
|
3845
|
+
UpdateUserInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3846
3846
|
/**
|
3847
3847
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3848
3848
|
* version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.
|
3849
3849
|
* https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata
|
3850
3850
|
*/
|
3851
|
-
UpdateUserInventoryItemCustomData(request: UpdateUserInventoryItemDataRequest,
|
3851
|
+
UpdateUserInventoryItemCustomData(request: UpdateUserInventoryItemDataRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3852
3852
|
/**
|
3853
3853
|
* Updates the publisher-specific custom data for the user which is readable and writable by the client
|
3854
3854
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata
|
3855
3855
|
*/
|
3856
|
-
UpdateUserPublisherData(request: UpdateUserDataRequest,
|
3856
|
+
UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3857
3857
|
/**
|
3858
3858
|
* Updates the publisher-specific custom data for the user which cannot be accessed by the client
|
3859
3859
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata
|
3860
3860
|
*/
|
3861
|
-
UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest,
|
3861
|
+
UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3862
3862
|
/**
|
3863
3863
|
* Updates the publisher-specific custom data for the user which can only be read by the client
|
3864
3864
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata
|
3865
3865
|
*/
|
3866
|
-
UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest,
|
3866
|
+
UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3867
3867
|
/**
|
3868
3868
|
* Updates the title-specific custom data for the user which can only be read by the client
|
3869
3869
|
* https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata
|
3870
3870
|
*/
|
3871
|
-
UpdateUserReadOnlyData(request: UpdateUserDataRequest,
|
3871
|
+
UpdateUserReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3872
3872
|
/**
|
3873
3873
|
* Writes a character-based event into PlayStream.
|
3874
3874
|
* https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent
|
3875
3875
|
*/
|
3876
|
-
WriteCharacterEvent(request: WriteServerCharacterEventRequest,
|
3876
|
+
WriteCharacterEvent(request: WriteServerCharacterEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
3877
3877
|
/**
|
3878
3878
|
* Writes a player-based event into PlayStream.
|
3879
3879
|
* https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent
|
3880
3880
|
*/
|
3881
|
-
WritePlayerEvent(request: WriteServerPlayerEventRequest,
|
3881
|
+
WritePlayerEvent(request: WriteServerPlayerEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
3882
3882
|
/**
|
3883
3883
|
* Writes a title-based event into PlayStream.
|
3884
3884
|
* https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent
|
3885
3885
|
*/
|
3886
|
-
WriteTitleEvent(request: WriteTitleEventRequest,
|
3886
|
+
WriteTitleEvent(request: WriteTitleEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
|
3887
3887
|
}
|
3888
3888
|
|
3889
3889
|
export { PlayFabServerApi as default };
|