async-playfab-web-sdk 1.192.250526-1
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 +591 -0
- package/dist/Addon.js +452 -0
- package/dist/Addon.js.map +1 -0
- package/dist/Admin.d.ts +3484 -0
- package/dist/Admin.js +1112 -0
- package/dist/Admin.js.map +1 -0
- package/dist/Authentication.d.ts +109 -0
- package/dist/Authentication.js +290 -0
- package/dist/Authentication.js.map +1 -0
- package/dist/Client.d.ts +4482 -0
- package/dist/Client.js +1893 -0
- package/dist/Client.js.map +1 -0
- package/dist/CloudScript.d.ts +511 -0
- package/dist/CloudScript.js +349 -0
- package/dist/CloudScript.js.map +1 -0
- package/dist/Data.d.ts +228 -0
- package/dist/Data.js +291 -0
- package/dist/Data.js.map +1 -0
- package/dist/Economy.d.ts +1865 -0
- package/dist/Economy.js +614 -0
- package/dist/Economy.js.map +1 -0
- package/dist/Events.d.ts +307 -0
- package/dist/Events.js +327 -0
- package/dist/Events.js.map +1 -0
- package/dist/Experimentation.d.ts +357 -0
- package/dist/Experimentation.js +333 -0
- package/dist/Experimentation.js.map +1 -0
- package/dist/Groups.d.ts +546 -0
- package/dist/Groups.js +417 -0
- package/dist/Groups.js.map +1 -0
- package/dist/Insights.d.ts +141 -0
- package/dist/Insights.js +286 -0
- package/dist/Insights.js.map +1 -0
- package/dist/Localization.d.ts +20 -0
- package/dist/Localization.js +249 -0
- package/dist/Localization.js.map +1 -0
- package/dist/Multiplayer.d.ts +3059 -0
- package/dist/Multiplayer.js +862 -0
- package/dist/Multiplayer.js.map +1 -0
- package/dist/PlayFabCommon-BUv4zqXf.d.ts +72 -0
- package/dist/Profiles.d.ts +278 -0
- package/dist/Profiles.js +306 -0
- package/dist/Profiles.js.map +1 -0
- package/dist/Progression.d.ts +598 -0
- package/dist/Progression.js +404 -0
- package/dist/Progression.js.map +1 -0
- package/dist/Server.d.ts +3889 -0
- package/dist/Server.js +1377 -0
- package/dist/Server.js.map +1 -0
- package/dist/index.d.ts +17 -0
- package/dist/index.js +6007 -0
- package/dist/index.js.map +1 -0
- package/package.json +23 -0
- package/readme.md +25 -0
@@ -0,0 +1,598 @@
|
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.js';
|
2
|
+
|
3
|
+
interface CreateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
|
4
|
+
/**
|
5
|
+
* Leaderboard columns describing the sort directions, cannot be changed after creation. A maximum of 5 columns are
|
6
|
+
* allowed.
|
7
|
+
*/
|
8
|
+
Columns: LeaderboardColumn[];
|
9
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
10
|
+
CustomTags?: Record<string, string | null>;
|
11
|
+
/**
|
12
|
+
* The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
|
13
|
+
* 'external' as the type.
|
14
|
+
*/
|
15
|
+
EntityType: string;
|
16
|
+
/** A name for the leaderboard, unique per title. */
|
17
|
+
Name: string;
|
18
|
+
/** Maximum number of entries on this leaderboard */
|
19
|
+
SizeLimit: number;
|
20
|
+
/** The version reset configuration for the leaderboard definition. */
|
21
|
+
VersionConfiguration: VersionConfiguration;
|
22
|
+
}
|
23
|
+
interface CreateStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
24
|
+
/**
|
25
|
+
* [In Preview]: The list of statistic definition names whose scores must be aggregated towards this stat. If
|
26
|
+
* AggregationSource is specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently,
|
27
|
+
* only one aggregation source can be specified.
|
28
|
+
*/
|
29
|
+
AggregationSources?: string[];
|
30
|
+
/** The columns for the statistic defining the aggregation method for each column. A maximum of 5 columns are allowed. */
|
31
|
+
Columns?: StatisticColumn[];
|
32
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
33
|
+
CustomTags?: Record<string, string | null>;
|
34
|
+
/** The entity type allowed to have score(s) for this statistic. */
|
35
|
+
EntityType?: string;
|
36
|
+
/** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
|
37
|
+
Name: string;
|
38
|
+
/** The version reset configuration for the statistic definition. */
|
39
|
+
VersionConfiguration?: VersionConfiguration;
|
40
|
+
}
|
41
|
+
interface DeleteLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
|
42
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
43
|
+
CustomTags?: Record<string, string | null>;
|
44
|
+
/** The name of the leaderboard definition to delete. */
|
45
|
+
Name: string;
|
46
|
+
}
|
47
|
+
interface DeleteLeaderboardEntriesRequest extends IPlayFabRequestCommon {
|
48
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
49
|
+
CustomTags?: Record<string, string | null>;
|
50
|
+
/** The unique Ids of the entries to delete from the leaderboard. */
|
51
|
+
EntityIds?: string[];
|
52
|
+
/** The name of the leaderboard. */
|
53
|
+
Name: string;
|
54
|
+
}
|
55
|
+
interface DeleteStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
56
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
57
|
+
CustomTags?: Record<string, string | null>;
|
58
|
+
/** Name of the statistic to delete. */
|
59
|
+
Name: string;
|
60
|
+
}
|
61
|
+
interface DeleteStatisticsRequest extends IPlayFabRequestCommon {
|
62
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
63
|
+
CustomTags?: Record<string, string | null>;
|
64
|
+
/** The optional entity to perform this action on. Defaults to the currently logged in entity. */
|
65
|
+
Entity?: EntityKey;
|
66
|
+
/** Collection of statistics to remove from this entity. */
|
67
|
+
Statistics: StatisticDelete[];
|
68
|
+
}
|
69
|
+
interface DeleteStatisticsResponse extends IPlayFabResultCommon {
|
70
|
+
/** The entity id and type. */
|
71
|
+
Entity?: EntityKey;
|
72
|
+
}
|
73
|
+
interface EntityKey {
|
74
|
+
/** Unique ID of the entity. */
|
75
|
+
Id: string;
|
76
|
+
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
77
|
+
Type?: string;
|
78
|
+
}
|
79
|
+
interface EntityLeaderboardEntry {
|
80
|
+
/** Entity's display name. */
|
81
|
+
DisplayName?: string;
|
82
|
+
/** Entity identifier. */
|
83
|
+
Entity?: EntityKey;
|
84
|
+
/** The time at which the last update to the entry was recorded on the server. */
|
85
|
+
LastUpdated: string;
|
86
|
+
/** An opaque blob of data stored on the leaderboard entry. Note that the metadata is not used for ranking purposes. */
|
87
|
+
Metadata?: string;
|
88
|
+
/** Position on the leaderboard. */
|
89
|
+
Rank: number;
|
90
|
+
/** Scores for the entry. */
|
91
|
+
Scores?: string[];
|
92
|
+
}
|
93
|
+
interface EntityStatistics {
|
94
|
+
/** Entity key */
|
95
|
+
EntityKey?: EntityKey;
|
96
|
+
/** All statistics for the given entitykey */
|
97
|
+
Statistics?: EntityStatisticValue[];
|
98
|
+
}
|
99
|
+
interface EntityStatisticValue {
|
100
|
+
/** Metadata associated with the Statistic. */
|
101
|
+
Metadata?: string;
|
102
|
+
/** Statistic name */
|
103
|
+
Name?: string;
|
104
|
+
/** Statistic scores */
|
105
|
+
Scores?: string[];
|
106
|
+
/** Statistic version */
|
107
|
+
Version: number;
|
108
|
+
}
|
109
|
+
interface GetEntityLeaderboardRequest extends IPlayFabRequestCommon {
|
110
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
111
|
+
CustomTags?: Record<string, string | null>;
|
112
|
+
/** Name of the leaderboard. */
|
113
|
+
LeaderboardName: string;
|
114
|
+
/** Maximum number of results to return from the leaderboard. Minimum 1, maximum 100. */
|
115
|
+
PageSize: number;
|
116
|
+
/** Index position to start from. 1 is beginning of leaderboard. */
|
117
|
+
StartingPosition?: number;
|
118
|
+
/** Optional version of the leaderboard, defaults to current version. */
|
119
|
+
Version?: number;
|
120
|
+
}
|
121
|
+
interface GetEntityLeaderboardResponse extends IPlayFabResultCommon {
|
122
|
+
/** Leaderboard columns describing the sort directions. */
|
123
|
+
Columns?: LeaderboardColumn[];
|
124
|
+
/** The number of entries on the leaderboard. */
|
125
|
+
EntryCount: number;
|
126
|
+
/** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
|
127
|
+
NextReset?: string;
|
128
|
+
/** Individual entity rankings in the leaderboard, in sorted order by rank. */
|
129
|
+
Rankings?: EntityLeaderboardEntry[];
|
130
|
+
/** Version of the leaderboard being returned. */
|
131
|
+
Version: number;
|
132
|
+
}
|
133
|
+
interface GetFriendLeaderboardForEntityRequest extends IPlayFabRequestCommon {
|
134
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
135
|
+
CustomTags?: Record<string, string | null>;
|
136
|
+
/** The optional entity to perform this action on. Defaults to the currently logged in entity. */
|
137
|
+
Entity?: EntityKey;
|
138
|
+
/**
|
139
|
+
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
140
|
+
* comma-separated list of platforms.
|
141
|
+
*/
|
142
|
+
ExternalFriendSources?: string;
|
143
|
+
/** Name of the leaderboard. */
|
144
|
+
LeaderboardName: string;
|
145
|
+
/** Optional version of the leaderboard, defaults to current version. */
|
146
|
+
Version?: number;
|
147
|
+
/** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
|
148
|
+
XboxToken?: string;
|
149
|
+
}
|
150
|
+
interface GetLeaderboardAroundEntityRequest extends IPlayFabRequestCommon {
|
151
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
152
|
+
CustomTags?: Record<string, string | null>;
|
153
|
+
/** The optional entity to perform this action on. Defaults to the currently logged in entity. */
|
154
|
+
Entity?: EntityKey;
|
155
|
+
/** Name of the leaderboard. */
|
156
|
+
LeaderboardName: string;
|
157
|
+
/**
|
158
|
+
* Number of surrounding entries to return (in addition to specified entity). In general, the number of ranks above and
|
159
|
+
* below will be split into half. For example, if the specified value is 10, 5 ranks above and 5 ranks below will be
|
160
|
+
* retrieved. However, the numbers will get skewed in either direction when the specified entity is towards the top or
|
161
|
+
* bottom of the leaderboard. Also, the number of entries returned can be lower than the value specified for entries at the
|
162
|
+
* bottom of the leaderboard.
|
163
|
+
*/
|
164
|
+
MaxSurroundingEntries: number;
|
165
|
+
/** Optional version of the leaderboard, defaults to current. */
|
166
|
+
Version?: number;
|
167
|
+
}
|
168
|
+
interface GetLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
|
169
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
170
|
+
CustomTags?: Record<string, string | null>;
|
171
|
+
/** The name of the leaderboard to retrieve the definition for. */
|
172
|
+
Name: string;
|
173
|
+
}
|
174
|
+
interface GetLeaderboardDefinitionResponse extends IPlayFabResultCommon {
|
175
|
+
/** Sort direction of the leaderboard columns, cannot be changed after creation. */
|
176
|
+
Columns: LeaderboardColumn[];
|
177
|
+
/** Created time, in UTC */
|
178
|
+
Created: string;
|
179
|
+
/**
|
180
|
+
* The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
|
181
|
+
* 'external' as the type.
|
182
|
+
*/
|
183
|
+
EntityType: string;
|
184
|
+
/** Last time, in UTC, leaderboard version was incremented. */
|
185
|
+
LastResetTime?: string;
|
186
|
+
/** A name for the leaderboard, unique per title. */
|
187
|
+
Name: string;
|
188
|
+
/** Maximum number of entries on this leaderboard */
|
189
|
+
SizeLimit: number;
|
190
|
+
/** Latest Leaderboard version. */
|
191
|
+
Version: number;
|
192
|
+
/** The version reset configuration for the leaderboard definition. */
|
193
|
+
VersionConfiguration: VersionConfiguration;
|
194
|
+
}
|
195
|
+
interface GetLeaderboardForEntitiesRequest extends IPlayFabRequestCommon {
|
196
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
197
|
+
CustomTags?: Record<string, string | null>;
|
198
|
+
/** Collection of Entity IDs to include in the leaderboard. */
|
199
|
+
EntityIds: string[];
|
200
|
+
/** Name of the leaderboard. */
|
201
|
+
LeaderboardName: string;
|
202
|
+
/** Optional version of the leaderboard, defaults to current. */
|
203
|
+
Version?: number;
|
204
|
+
}
|
205
|
+
interface GetStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
206
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
207
|
+
CustomTags?: Record<string, string | null>;
|
208
|
+
/** Name of the statistic. Must be less than 150 characters. */
|
209
|
+
Name: string;
|
210
|
+
}
|
211
|
+
interface GetStatisticDefinitionResponse extends IPlayFabResultCommon {
|
212
|
+
/** The list of statistic definitions names this definition aggregates to. */
|
213
|
+
AggregationDestinations?: string[];
|
214
|
+
/**
|
215
|
+
* The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is
|
216
|
+
* specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation
|
217
|
+
* source can be specified.
|
218
|
+
*/
|
219
|
+
AggregationSources?: string[];
|
220
|
+
/** The columns for the statistic defining the aggregation method for each column. */
|
221
|
+
Columns?: StatisticColumn[];
|
222
|
+
/** Created time, in UTC */
|
223
|
+
Created: string;
|
224
|
+
/** The entity type that can have this statistic. */
|
225
|
+
EntityType?: string;
|
226
|
+
/** Last time, in UTC, statistic version was incremented. */
|
227
|
+
LastResetTime?: string;
|
228
|
+
/** The list of leaderboards that are linked to this statistic definition. */
|
229
|
+
LinkedLeaderboardNames?: string[];
|
230
|
+
/** Name of the statistic. */
|
231
|
+
Name?: string;
|
232
|
+
/** Statistic version. */
|
233
|
+
Version: number;
|
234
|
+
/** The version reset configuration for the leaderboard definition. */
|
235
|
+
VersionConfiguration?: VersionConfiguration;
|
236
|
+
}
|
237
|
+
interface GetStatisticsForEntitiesRequest extends IPlayFabRequestCommon {
|
238
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
239
|
+
CustomTags?: Record<string, string | null>;
|
240
|
+
/** Collection of Entity IDs to retrieve statistics for. */
|
241
|
+
Entities: EntityKey[];
|
242
|
+
}
|
243
|
+
interface GetStatisticsForEntitiesResponse extends IPlayFabResultCommon {
|
244
|
+
/** A mapping of statistic name to the columns defined in the corresponding definition. */
|
245
|
+
ColumnDetails?: Record<string, StatisticColumnCollection>;
|
246
|
+
/** List of entities mapped to their statistics. Only the latest version of a statistic is returned. */
|
247
|
+
EntitiesStatistics?: EntityStatistics[];
|
248
|
+
}
|
249
|
+
interface GetStatisticsRequest extends IPlayFabRequestCommon {
|
250
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
251
|
+
CustomTags?: Record<string, string | null>;
|
252
|
+
/** The optional entity to perform this action on. Defaults to the currently logged in entity. */
|
253
|
+
Entity?: EntityKey;
|
254
|
+
}
|
255
|
+
interface GetStatisticsResponse extends IPlayFabResultCommon {
|
256
|
+
/** A mapping of statistic name to the columns defined in the corresponding definition. */
|
257
|
+
ColumnDetails?: Record<string, StatisticColumnCollection>;
|
258
|
+
/** The entity id and type. */
|
259
|
+
Entity?: EntityKey;
|
260
|
+
/** List of statistics keyed by Name. Only the latest version of a statistic is returned. */
|
261
|
+
Statistics?: Record<string, EntityStatisticValue>;
|
262
|
+
}
|
263
|
+
interface IncrementLeaderboardVersionRequest extends IPlayFabRequestCommon {
|
264
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
265
|
+
CustomTags?: Record<string, string | null>;
|
266
|
+
/** The name of the leaderboard to increment the version for. */
|
267
|
+
Name: string;
|
268
|
+
}
|
269
|
+
interface IncrementLeaderboardVersionResponse extends IPlayFabResultCommon {
|
270
|
+
/** New Leaderboard version. */
|
271
|
+
Version: number;
|
272
|
+
}
|
273
|
+
interface IncrementStatisticVersionRequest extends IPlayFabRequestCommon {
|
274
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
275
|
+
CustomTags?: Record<string, string | null>;
|
276
|
+
/** Name of the statistic to increment the version of. */
|
277
|
+
Name: string;
|
278
|
+
}
|
279
|
+
interface IncrementStatisticVersionResponse extends IPlayFabResultCommon {
|
280
|
+
/** New statistic version. */
|
281
|
+
Version: number;
|
282
|
+
}
|
283
|
+
interface LeaderboardColumn {
|
284
|
+
/**
|
285
|
+
* If the value for this column is sourced from a statistic, details of the linked column. Null if the leaderboard is not
|
286
|
+
* linked.
|
287
|
+
*/
|
288
|
+
LinkedStatisticColumn?: LinkedStatisticColumn;
|
289
|
+
/** A name for the leaderboard column, unique per leaderboard definition. */
|
290
|
+
Name: string;
|
291
|
+
/** The sort direction for this column. */
|
292
|
+
SortDirection: string;
|
293
|
+
}
|
294
|
+
interface LeaderboardDefinition {
|
295
|
+
/** Sort direction of the leaderboard columns, cannot be changed after creation. */
|
296
|
+
Columns: LeaderboardColumn[];
|
297
|
+
/** Created time, in UTC */
|
298
|
+
Created: string;
|
299
|
+
/**
|
300
|
+
* The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
|
301
|
+
* 'external' as the type.
|
302
|
+
*/
|
303
|
+
EntityType: string;
|
304
|
+
/** Last time, in UTC, leaderboard version was incremented. */
|
305
|
+
LastResetTime?: string;
|
306
|
+
/** A name for the leaderboard, unique per title. */
|
307
|
+
Name: string;
|
308
|
+
/** Maximum number of entries on this leaderboard */
|
309
|
+
SizeLimit: number;
|
310
|
+
/** Latest Leaderboard version. */
|
311
|
+
Version: number;
|
312
|
+
/** The version reset configuration for the leaderboard definition. */
|
313
|
+
VersionConfiguration: VersionConfiguration;
|
314
|
+
}
|
315
|
+
interface LeaderboardEntryUpdate {
|
316
|
+
/** The unique Id for the entry. If using PlayFab Entities, this would be the entityId of the entity. */
|
317
|
+
EntityId: string;
|
318
|
+
/**
|
319
|
+
* Arbitrary metadata to store along side the leaderboard entry, will be returned by all Leaderboard APIs. Must be less
|
320
|
+
* than 50 UTF8 encoded characters.
|
321
|
+
*/
|
322
|
+
Metadata?: string;
|
323
|
+
/**
|
324
|
+
* The scores for the leaderboard. The number of values provided here must match the number of columns in the Leaderboard
|
325
|
+
* definition.
|
326
|
+
*/
|
327
|
+
Scores?: string[];
|
328
|
+
}
|
329
|
+
interface LinkedStatisticColumn {
|
330
|
+
/** The name of the statistic column that this leaderboard column is sourced from. */
|
331
|
+
LinkedStatisticColumnName: string;
|
332
|
+
/** The name of the statistic. */
|
333
|
+
LinkedStatisticName: string;
|
334
|
+
}
|
335
|
+
interface ListLeaderboardDefinitionsRequest extends IPlayFabRequestCommon {
|
336
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
337
|
+
CustomTags?: Record<string, string | null>;
|
338
|
+
}
|
339
|
+
interface ListLeaderboardDefinitionsResponse extends IPlayFabResultCommon {
|
340
|
+
/** List of leaderboard definitions for the title. */
|
341
|
+
LeaderboardDefinitions?: LeaderboardDefinition[];
|
342
|
+
}
|
343
|
+
interface ListStatisticDefinitionsRequest extends IPlayFabRequestCommon {
|
344
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
345
|
+
CustomTags?: Record<string, string | null>;
|
346
|
+
}
|
347
|
+
interface ListStatisticDefinitionsResponse extends IPlayFabResultCommon {
|
348
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
349
|
+
CustomTags?: Record<string, string | null>;
|
350
|
+
/** List of statistic definitions for the title. */
|
351
|
+
StatisticDefinitions?: StatisticDefinition[];
|
352
|
+
}
|
353
|
+
interface StatisticColumn {
|
354
|
+
/** Aggregation method for calculating new value of a statistic. */
|
355
|
+
AggregationMethod: string;
|
356
|
+
/** Name of the statistic column, as originally configured. */
|
357
|
+
Name: string;
|
358
|
+
}
|
359
|
+
interface StatisticColumnCollection {
|
360
|
+
/** Columns for the statistic defining the aggregation method for each column. */
|
361
|
+
Columns?: StatisticColumn[];
|
362
|
+
}
|
363
|
+
interface StatisticDefinition {
|
364
|
+
/** The list of statistic definitions names this definition aggregates to. */
|
365
|
+
AggregationDestinations?: string[];
|
366
|
+
/**
|
367
|
+
* The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is
|
368
|
+
* specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation
|
369
|
+
* source can be specified.
|
370
|
+
*/
|
371
|
+
AggregationSources?: string[];
|
372
|
+
/** The columns for the statistic defining the aggregation method for each column. */
|
373
|
+
Columns?: StatisticColumn[];
|
374
|
+
/** Created time, in UTC */
|
375
|
+
Created: string;
|
376
|
+
/** The entity type that can have this statistic. */
|
377
|
+
EntityType?: string;
|
378
|
+
/** Last time, in UTC, statistic version was incremented. */
|
379
|
+
LastResetTime?: string;
|
380
|
+
/** The list of leaderboards that are linked to this statistic definition. */
|
381
|
+
LinkedLeaderboardNames?: string[];
|
382
|
+
/** Name of the statistic. */
|
383
|
+
Name?: string;
|
384
|
+
/** Statistic version. */
|
385
|
+
Version: number;
|
386
|
+
/** The version reset configuration for the leaderboard definition. */
|
387
|
+
VersionConfiguration?: VersionConfiguration;
|
388
|
+
}
|
389
|
+
interface StatisticDelete {
|
390
|
+
/** Name of the statistic, as originally configured. */
|
391
|
+
Name: string;
|
392
|
+
}
|
393
|
+
interface StatisticUpdate {
|
394
|
+
/**
|
395
|
+
* Arbitrary metadata to store along side the statistic, will be returned by all Leaderboard APIs. Must be less than 50
|
396
|
+
* UTF8 encoded characters.
|
397
|
+
*/
|
398
|
+
Metadata?: string;
|
399
|
+
/** Name of the statistic, as originally configured. */
|
400
|
+
Name: string;
|
401
|
+
/**
|
402
|
+
* Statistic scores for the entity. This will be used in accordance with the aggregation method configured for the
|
403
|
+
* statistics.The maximum value allowed for each individual score is 9223372036854775807. The minimum value for each
|
404
|
+
* individual score is -9223372036854775807The values are formatted as strings to avoid interop issues with client
|
405
|
+
* libraries unable to handle 64bit integers.
|
406
|
+
*/
|
407
|
+
Scores?: string[];
|
408
|
+
/** Optional field to indicate the version of the statistic to set. When empty defaults to the statistic's current version. */
|
409
|
+
Version?: number;
|
410
|
+
}
|
411
|
+
interface UnlinkLeaderboardFromStatisticRequest extends IPlayFabRequestCommon {
|
412
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
413
|
+
CustomTags?: Record<string, string | null>;
|
414
|
+
/** The name of the leaderboard definition to unlink. */
|
415
|
+
Name: string;
|
416
|
+
/** The name of the statistic definition to unlink. */
|
417
|
+
StatisticName: string;
|
418
|
+
}
|
419
|
+
interface UpdateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
|
420
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
421
|
+
CustomTags?: Record<string, string | null>;
|
422
|
+
/** The name of the leaderboard to update the definition for. */
|
423
|
+
Name: string;
|
424
|
+
/** Maximum number of entries on this leaderboard */
|
425
|
+
SizeLimit?: number;
|
426
|
+
/** The version reset configuration for the leaderboard definition. */
|
427
|
+
VersionConfiguration?: VersionConfiguration;
|
428
|
+
}
|
429
|
+
interface UpdateLeaderboardEntriesRequest extends IPlayFabRequestCommon {
|
430
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
431
|
+
CustomTags?: Record<string, string | null>;
|
432
|
+
/** The entries to add or update on the leaderboard. */
|
433
|
+
Entries?: LeaderboardEntryUpdate[];
|
434
|
+
/** The name of the leaderboard. */
|
435
|
+
LeaderboardName: string;
|
436
|
+
}
|
437
|
+
interface UpdateStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
438
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
439
|
+
CustomTags?: Record<string, string | null>;
|
440
|
+
/** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
|
441
|
+
Name: string;
|
442
|
+
/** The version reset configuration for the statistic definition. */
|
443
|
+
VersionConfiguration?: VersionConfiguration;
|
444
|
+
}
|
445
|
+
interface UpdateStatisticsRequest extends IPlayFabRequestCommon {
|
446
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
447
|
+
CustomTags?: Record<string, string | null>;
|
448
|
+
/** The optional entity to perform this action on. Defaults to the currently logged in entity. */
|
449
|
+
Entity?: EntityKey;
|
450
|
+
/** Collection of statistics to update, maximum 50. */
|
451
|
+
Statistics: StatisticUpdate[];
|
452
|
+
/**
|
453
|
+
* Optional transactionId of this update which can be used to ensure idempotence. Using this field is still in testing
|
454
|
+
* stage.
|
455
|
+
*/
|
456
|
+
TransactionId?: string;
|
457
|
+
}
|
458
|
+
interface UpdateStatisticsResponse extends IPlayFabResultCommon {
|
459
|
+
/** A mapping of statistic name to the columns defined in the corresponding definition. */
|
460
|
+
ColumnDetails?: Record<string, StatisticColumnCollection>;
|
461
|
+
/** The entity id and type. */
|
462
|
+
Entity?: EntityKey;
|
463
|
+
/** Updated entity profile statistics. */
|
464
|
+
Statistics?: Record<string, EntityStatisticValue>;
|
465
|
+
}
|
466
|
+
interface VersionConfiguration {
|
467
|
+
/** The maximum number of versions of this leaderboard/statistic that can be queried. */
|
468
|
+
MaxQueryableVersions: number;
|
469
|
+
/**
|
470
|
+
* Reset interval that statistics or leaderboards will reset on. When using Manual intervalthe reset can only be increased
|
471
|
+
* by calling the Increase version API. When using Hour interval the resetwill occur at the start of the next hour UTC
|
472
|
+
* time. When using Day interval the reset will occur at thestart of the next day in UTC time. When using the Week interval
|
473
|
+
* the reset will occur at the start ofthe next Monday in UTC time. When using Month interval the reset will occur at the
|
474
|
+
* start of the nextmonth in UTC time.
|
475
|
+
*/
|
476
|
+
ResetInterval: string;
|
477
|
+
}
|
478
|
+
|
479
|
+
declare class PlayFabProgressionApi extends PlayFabCommon {
|
480
|
+
/**
|
481
|
+
* Creates a new leaderboard definition.
|
482
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/createleaderboarddefinition
|
483
|
+
*/
|
484
|
+
CreateLeaderboardDefinition(request: CreateLeaderboardDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
485
|
+
/**
|
486
|
+
* Create a new entity statistic definition.
|
487
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/createstatisticdefinition
|
488
|
+
*/
|
489
|
+
CreateStatisticDefinition(request: CreateStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
490
|
+
/**
|
491
|
+
* Deletes a leaderboard definition.
|
492
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboarddefinition
|
493
|
+
*/
|
494
|
+
DeleteLeaderboardDefinition(request: DeleteLeaderboardDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
495
|
+
/**
|
496
|
+
* Deletes the specified entries from the given leaderboard.
|
497
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboardentries
|
498
|
+
*/
|
499
|
+
DeleteLeaderboardEntries(request: DeleteLeaderboardEntriesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
500
|
+
/**
|
501
|
+
* Delete an entity statistic definition. Will delete all statistics on entity profiles and leaderboards.
|
502
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/deletestatisticdefinition
|
503
|
+
*/
|
504
|
+
DeleteStatisticDefinition(request: DeleteStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
505
|
+
/**
|
506
|
+
* Delete statistics on an entity profile. This will remove all rankings from associated leaderboards.
|
507
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/deletestatistics
|
508
|
+
*/
|
509
|
+
DeleteStatistics(request: DeleteStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteStatisticsResponse>;
|
510
|
+
/**
|
511
|
+
* Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard.
|
512
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getfriendleaderboardforentity
|
513
|
+
*/
|
514
|
+
GetFriendLeaderboardForEntity(request: GetFriendLeaderboardForEntityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
|
515
|
+
/**
|
516
|
+
* Get the leaderboard for a specific entity type and statistic.
|
517
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboard
|
518
|
+
*/
|
519
|
+
GetLeaderboard(request: GetEntityLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
|
520
|
+
/**
|
521
|
+
* Get the leaderboard around a specific entity.
|
522
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboardaroundentity
|
523
|
+
*/
|
524
|
+
GetLeaderboardAroundEntity(request: GetLeaderboardAroundEntityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
|
525
|
+
/**
|
526
|
+
* Gets the specified leaderboard definition.
|
527
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboarddefinition
|
528
|
+
*/
|
529
|
+
GetLeaderboardDefinition(request: GetLeaderboardDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardDefinitionResponse>;
|
530
|
+
/**
|
531
|
+
* Get the leaderboard limited to a set of entities.
|
532
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboardforentities
|
533
|
+
*/
|
534
|
+
GetLeaderboardForEntities(request: GetLeaderboardForEntitiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
|
535
|
+
/**
|
536
|
+
* Get current statistic definition information
|
537
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinition
|
538
|
+
*/
|
539
|
+
GetStatisticDefinition(request: GetStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStatisticDefinitionResponse>;
|
540
|
+
/**
|
541
|
+
* Gets statistics for the specified entity.
|
542
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatistics
|
543
|
+
*/
|
544
|
+
GetStatistics(request: GetStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStatisticsResponse>;
|
545
|
+
/**
|
546
|
+
* Gets statistics for the specified collection of entities.
|
547
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticsforentities
|
548
|
+
*/
|
549
|
+
GetStatisticsForEntities(request: GetStatisticsForEntitiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStatisticsForEntitiesResponse>;
|
550
|
+
/**
|
551
|
+
* Increment a leaderboard version.
|
552
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/incrementleaderboardversion
|
553
|
+
*/
|
554
|
+
IncrementLeaderboardVersion(request: IncrementLeaderboardVersionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<IncrementLeaderboardVersionResponse>;
|
555
|
+
/**
|
556
|
+
* Increment an entity statistic definition version.
|
557
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/incrementstatisticversion
|
558
|
+
*/
|
559
|
+
IncrementStatisticVersion(request: IncrementStatisticVersionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<IncrementStatisticVersionResponse>;
|
560
|
+
/**
|
561
|
+
* Lists the leaderboard definitions defined for the Title.
|
562
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/listleaderboarddefinitions
|
563
|
+
*/
|
564
|
+
ListLeaderboardDefinitions(request: ListLeaderboardDefinitionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListLeaderboardDefinitionsResponse>;
|
565
|
+
/**
|
566
|
+
* Get all current statistic definitions information
|
567
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/liststatisticdefinitions
|
568
|
+
*/
|
569
|
+
ListStatisticDefinitions(request: ListStatisticDefinitionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListStatisticDefinitionsResponse>;
|
570
|
+
/**
|
571
|
+
* Unlinks a leaderboard definition from it's linked statistic definition.
|
572
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/unlinkleaderboardfromstatistic
|
573
|
+
*/
|
574
|
+
UnlinkLeaderboardFromStatistic(request: UnlinkLeaderboardFromStatisticRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
575
|
+
/**
|
576
|
+
* Updates a leaderboard definition.
|
577
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboarddefinition
|
578
|
+
*/
|
579
|
+
UpdateLeaderboardDefinition(request: UpdateLeaderboardDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
580
|
+
/**
|
581
|
+
* Adds or updates entries on the specified leaderboard.
|
582
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboardentries
|
583
|
+
*/
|
584
|
+
UpdateLeaderboardEntries(request: UpdateLeaderboardEntriesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
585
|
+
/**
|
586
|
+
* Update an existing entity statistic definition.
|
587
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatisticdefinition
|
588
|
+
*/
|
589
|
+
UpdateStatisticDefinition(request: UpdateStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
590
|
+
/**
|
591
|
+
* Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on
|
592
|
+
* various leaderboards.
|
593
|
+
* https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatistics
|
594
|
+
*/
|
595
|
+
UpdateStatistics(request: UpdateStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateStatisticsResponse>;
|
596
|
+
}
|
597
|
+
|
598
|
+
export { PlayFabProgressionApi as default };
|