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,3059 @@
|
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.js';
|
2
|
+
|
3
|
+
interface AssetReference {
|
4
|
+
/** The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. */
|
5
|
+
FileName?: string;
|
6
|
+
/** The asset's mount path. */
|
7
|
+
MountPath?: string;
|
8
|
+
}
|
9
|
+
interface AssetReferenceParams {
|
10
|
+
/** The asset's file name. */
|
11
|
+
FileName: string;
|
12
|
+
/** The asset's mount path. */
|
13
|
+
MountPath?: string;
|
14
|
+
}
|
15
|
+
interface AssetSummary {
|
16
|
+
/** The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. */
|
17
|
+
FileName?: string;
|
18
|
+
/** The metadata associated with the asset. */
|
19
|
+
Metadata?: Record<string, string | null>;
|
20
|
+
}
|
21
|
+
interface BuildAliasDetailsResponse extends IPlayFabResultCommon {
|
22
|
+
/** The guid string alias Id of the alias to be created or updated. */
|
23
|
+
AliasId?: string;
|
24
|
+
/** The alias name. */
|
25
|
+
AliasName?: string;
|
26
|
+
/** Array of build selection criteria. */
|
27
|
+
BuildSelectionCriteria?: BuildSelectionCriterion[];
|
28
|
+
}
|
29
|
+
interface BuildAliasParams {
|
30
|
+
/** The guid string alias ID to use for the request. */
|
31
|
+
AliasId: string;
|
32
|
+
}
|
33
|
+
interface BuildRegion {
|
34
|
+
/** The current multiplayer server stats for the region. */
|
35
|
+
CurrentServerStats?: CurrentServerStats;
|
36
|
+
/** Optional settings to control dynamic adjustment of standby target */
|
37
|
+
DynamicStandbySettings?: DynamicStandbySettings;
|
38
|
+
/** Whether the game assets provided for the build have been replicated to this region. */
|
39
|
+
IsAssetReplicationComplete: boolean;
|
40
|
+
/** The maximum number of multiplayer servers for the region. */
|
41
|
+
MaxServers: number;
|
42
|
+
/** Regional override for the number of multiplayer servers to host on a single VM of the build. */
|
43
|
+
MultiplayerServerCountPerVm?: number;
|
44
|
+
/** The build region. */
|
45
|
+
Region?: string;
|
46
|
+
/** Optional settings to set the standby target to specified values during the supplied schedules */
|
47
|
+
ScheduledStandbySettings?: ScheduledStandbySettings;
|
48
|
+
/** The target number of standby multiplayer servers for the region. */
|
49
|
+
StandbyServers: number;
|
50
|
+
/**
|
51
|
+
* The status of multiplayer servers in the build region. Valid values are - Unknown, Initialized, Deploying, Deployed,
|
52
|
+
* Unhealthy, Deleting, Deleted.
|
53
|
+
*/
|
54
|
+
Status?: string;
|
55
|
+
/** Regional override for the VM size the build was created on. */
|
56
|
+
VmSize?: string;
|
57
|
+
}
|
58
|
+
interface BuildRegionParams {
|
59
|
+
/** Optional settings to control dynamic adjustment of standby target. If not specified, dynamic standby is disabled */
|
60
|
+
DynamicStandbySettings?: DynamicStandbySettings;
|
61
|
+
/** The maximum number of multiplayer servers for the region. */
|
62
|
+
MaxServers: number;
|
63
|
+
/** Regional override for the number of multiplayer servers to host on a single VM of the build. */
|
64
|
+
MultiplayerServerCountPerVm?: number;
|
65
|
+
/** The build region. */
|
66
|
+
Region: string;
|
67
|
+
/** Optional settings to set the standby target to specified values during the supplied schedules */
|
68
|
+
ScheduledStandbySettings?: ScheduledStandbySettings;
|
69
|
+
/** The number of standby multiplayer servers for the region. */
|
70
|
+
StandbyServers: number;
|
71
|
+
/** Regional override for the VM size the build was created on. */
|
72
|
+
VmSize?: string;
|
73
|
+
}
|
74
|
+
interface BuildSelectionCriterion {
|
75
|
+
/** Dictionary of build ids and their respective weights for distribution of allocation requests. */
|
76
|
+
BuildWeightDistribution?: Record<string, number>;
|
77
|
+
}
|
78
|
+
interface BuildSummary {
|
79
|
+
/** The guid string build ID of the build. */
|
80
|
+
BuildId?: string;
|
81
|
+
/** The build name. */
|
82
|
+
BuildName?: string;
|
83
|
+
/** The time the build was created in UTC. */
|
84
|
+
CreationTime?: string;
|
85
|
+
/** The metadata of the build. */
|
86
|
+
Metadata?: Record<string, string | null>;
|
87
|
+
/** The configuration and status for each region in the build. */
|
88
|
+
RegionConfigurations?: BuildRegion[];
|
89
|
+
}
|
90
|
+
interface CancelAllMatchmakingTicketsForPlayerRequest extends IPlayFabRequestCommon {
|
91
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
92
|
+
CustomTags?: Record<string, string | null>;
|
93
|
+
/** The entity key of the player whose tickets should be canceled. */
|
94
|
+
Entity?: EntityKey;
|
95
|
+
/** The name of the queue from which a player's tickets should be canceled. */
|
96
|
+
QueueName: string;
|
97
|
+
}
|
98
|
+
interface CancelAllMatchmakingTicketsForPlayerResult extends IPlayFabResultCommon {
|
99
|
+
}
|
100
|
+
interface CancelAllServerBackfillTicketsForPlayerRequest extends IPlayFabRequestCommon {
|
101
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
102
|
+
CustomTags?: Record<string, string | null>;
|
103
|
+
/** The entity key of the player whose backfill tickets should be canceled. */
|
104
|
+
Entity: EntityKey;
|
105
|
+
/** The name of the queue from which a player's backfill tickets should be canceled. */
|
106
|
+
QueueName: string;
|
107
|
+
}
|
108
|
+
interface CancelAllServerBackfillTicketsForPlayerResult extends IPlayFabResultCommon {
|
109
|
+
}
|
110
|
+
interface CancelMatchmakingTicketRequest extends IPlayFabRequestCommon {
|
111
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
112
|
+
CustomTags?: Record<string, string | null>;
|
113
|
+
/** The name of the queue the ticket is in. */
|
114
|
+
QueueName: string;
|
115
|
+
/** The Id of the ticket to find a match for. */
|
116
|
+
TicketId: string;
|
117
|
+
}
|
118
|
+
interface CancelMatchmakingTicketResult extends IPlayFabResultCommon {
|
119
|
+
}
|
120
|
+
interface CancelServerBackfillTicketRequest extends IPlayFabRequestCommon {
|
121
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
122
|
+
CustomTags?: Record<string, string | null>;
|
123
|
+
/** The name of the queue the ticket is in. */
|
124
|
+
QueueName: string;
|
125
|
+
/** The Id of the ticket to find a match for. */
|
126
|
+
TicketId: string;
|
127
|
+
}
|
128
|
+
interface CancelServerBackfillTicketResult extends IPlayFabResultCommon {
|
129
|
+
}
|
130
|
+
interface Certificate {
|
131
|
+
/** Base64 encoded string contents of the certificate. */
|
132
|
+
Base64EncodedValue: string;
|
133
|
+
/** A name for the certificate. This is used to reference certificates in build configurations. */
|
134
|
+
Name: string;
|
135
|
+
/**
|
136
|
+
* If required for your PFX certificate, use this field to provide a password that will be used to install the certificate
|
137
|
+
* on the container.
|
138
|
+
*/
|
139
|
+
Password?: string;
|
140
|
+
}
|
141
|
+
interface CertificateSummary {
|
142
|
+
/** The name of the certificate. */
|
143
|
+
Name?: string;
|
144
|
+
/** The thumbprint for the certificate. */
|
145
|
+
Thumbprint?: string;
|
146
|
+
}
|
147
|
+
interface ConnectedPlayer {
|
148
|
+
/** The player ID of the player connected to the multiplayer server. */
|
149
|
+
PlayerId?: string;
|
150
|
+
}
|
151
|
+
interface ContainerImageReference {
|
152
|
+
/** The container image name. */
|
153
|
+
ImageName: string;
|
154
|
+
/** The container tag. */
|
155
|
+
Tag?: string;
|
156
|
+
}
|
157
|
+
interface CoreCapacity {
|
158
|
+
/** The available core capacity for the (Region, VmFamily) */
|
159
|
+
Available: number;
|
160
|
+
/** The AzureRegion */
|
161
|
+
Region?: string;
|
162
|
+
/** The total core capacity for the (Region, VmFamily) */
|
163
|
+
Total: number;
|
164
|
+
/** The AzureVmFamily */
|
165
|
+
VmFamily?: string;
|
166
|
+
}
|
167
|
+
interface CoreCapacityChange {
|
168
|
+
/** New quota core limit for the given vm family/region. */
|
169
|
+
NewCoreLimit: number;
|
170
|
+
/** Region to change. */
|
171
|
+
Region: string;
|
172
|
+
/** Virtual machine family to change. */
|
173
|
+
VmFamily: string;
|
174
|
+
}
|
175
|
+
interface CreateBuildAliasRequest extends IPlayFabRequestCommon {
|
176
|
+
/** The alias name. */
|
177
|
+
AliasName: string;
|
178
|
+
/** Array of build selection criteria. */
|
179
|
+
BuildSelectionCriteria?: BuildSelectionCriterion[];
|
180
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
181
|
+
CustomTags?: Record<string, string | null>;
|
182
|
+
}
|
183
|
+
interface CreateBuildWithCustomContainerRequest extends IPlayFabRequestCommon {
|
184
|
+
/**
|
185
|
+
* When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or
|
186
|
+
* will have the same assets mounted in the container.
|
187
|
+
*/
|
188
|
+
AreAssetsReadonly?: boolean;
|
189
|
+
/** The build name. */
|
190
|
+
BuildName: string;
|
191
|
+
/** The flavor of container to create a build from. */
|
192
|
+
ContainerFlavor?: string;
|
193
|
+
/** The container reference, consisting of the image name and tag. */
|
194
|
+
ContainerImageReference?: ContainerImageReference;
|
195
|
+
/** The container command to run when the multiplayer server has been allocated, including any arguments. */
|
196
|
+
ContainerRunCommand?: string;
|
197
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
198
|
+
CustomTags?: Record<string, string | null>;
|
199
|
+
/** The list of game assets related to the build. */
|
200
|
+
GameAssetReferences?: AssetReferenceParams[];
|
201
|
+
/** The game certificates for the build. */
|
202
|
+
GameCertificateReferences?: GameCertificateReferenceParams[];
|
203
|
+
/** The game secrets for the build. */
|
204
|
+
GameSecretReferences?: GameSecretReferenceParams[];
|
205
|
+
/** The Linux instrumentation configuration for the build. */
|
206
|
+
LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration;
|
207
|
+
/**
|
208
|
+
* Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through
|
209
|
+
* Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100
|
210
|
+
*/
|
211
|
+
Metadata?: Record<string, string | null>;
|
212
|
+
/** The configuration for the monitoring application on the build */
|
213
|
+
MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams;
|
214
|
+
/** The number of multiplayer servers to host on a single VM. */
|
215
|
+
MultiplayerServerCountPerVm: number;
|
216
|
+
/** The ports to map the build on. */
|
217
|
+
Ports: Port[];
|
218
|
+
/** The region configurations for the build. */
|
219
|
+
RegionConfigurations: BuildRegionParams[];
|
220
|
+
/** The resource constraints to apply to each server on the VM (EXPERIMENTAL API) */
|
221
|
+
ServerResourceConstraints?: ServerResourceConstraintParams;
|
222
|
+
/** The VM size to create the build on. */
|
223
|
+
VmSize?: string;
|
224
|
+
/** The configuration for the VmStartupScript for the build */
|
225
|
+
VmStartupScriptConfiguration?: VmStartupScriptParams;
|
226
|
+
}
|
227
|
+
interface CreateBuildWithCustomContainerResponse extends IPlayFabResultCommon {
|
228
|
+
/**
|
229
|
+
* When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or
|
230
|
+
* will have the same assets mounted in the container.
|
231
|
+
*/
|
232
|
+
AreAssetsReadonly?: boolean;
|
233
|
+
/** The guid string build ID. Must be unique for every build. */
|
234
|
+
BuildId?: string;
|
235
|
+
/** The build name. */
|
236
|
+
BuildName?: string;
|
237
|
+
/** The flavor of container of the build. */
|
238
|
+
ContainerFlavor?: string;
|
239
|
+
/** The container command to run when the multiplayer server has been allocated, including any arguments. */
|
240
|
+
ContainerRunCommand?: string;
|
241
|
+
/** The time the build was created in UTC. */
|
242
|
+
CreationTime?: string;
|
243
|
+
/** The custom game container image reference information. */
|
244
|
+
CustomGameContainerImage?: ContainerImageReference;
|
245
|
+
/** The game assets for the build. */
|
246
|
+
GameAssetReferences?: AssetReference[];
|
247
|
+
/** The game certificates for the build. */
|
248
|
+
GameCertificateReferences?: GameCertificateReference[];
|
249
|
+
/** The game secrets for the build. */
|
250
|
+
GameSecretReferences?: GameSecretReference[];
|
251
|
+
/** The Linux instrumentation configuration for this build. */
|
252
|
+
LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration;
|
253
|
+
/** The metadata of the build. */
|
254
|
+
Metadata?: Record<string, string | null>;
|
255
|
+
/** The configuration for the monitoring application for the build */
|
256
|
+
MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration;
|
257
|
+
/** The number of multiplayer servers to host on a single VM of the build. */
|
258
|
+
MultiplayerServerCountPerVm: number;
|
259
|
+
/** The OS platform used for running the game process. */
|
260
|
+
OsPlatform?: string;
|
261
|
+
/** The ports the build is mapped on. */
|
262
|
+
Ports?: Port[];
|
263
|
+
/** The region configuration for the build. */
|
264
|
+
RegionConfigurations?: BuildRegion[];
|
265
|
+
/** The resource constraints to apply to each server on the VM (EXPERIMENTAL API) */
|
266
|
+
ServerResourceConstraints?: ServerResourceConstraintParams;
|
267
|
+
/** The type of game server being hosted. */
|
268
|
+
ServerType?: string;
|
269
|
+
/**
|
270
|
+
* When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to
|
271
|
+
* disc.
|
272
|
+
*/
|
273
|
+
UseStreamingForAssetDownloads?: boolean;
|
274
|
+
/** The VM size the build was created on. */
|
275
|
+
VmSize?: string;
|
276
|
+
/** The configuration for the VmStartupScript feature for the build */
|
277
|
+
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
278
|
+
}
|
279
|
+
interface CreateBuildWithManagedContainerRequest extends IPlayFabRequestCommon {
|
280
|
+
/**
|
281
|
+
* When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or
|
282
|
+
* will have the same assets mounted in the container.
|
283
|
+
*/
|
284
|
+
AreAssetsReadonly?: boolean;
|
285
|
+
/** The build name. */
|
286
|
+
BuildName: string;
|
287
|
+
/** The flavor of container to create a build from. */
|
288
|
+
ContainerFlavor?: string;
|
289
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
290
|
+
CustomTags?: Record<string, string | null>;
|
291
|
+
/** The list of game assets related to the build. */
|
292
|
+
GameAssetReferences: AssetReferenceParams[];
|
293
|
+
/** The game certificates for the build. */
|
294
|
+
GameCertificateReferences?: GameCertificateReferenceParams[];
|
295
|
+
/** The game secrets for the build. */
|
296
|
+
GameSecretReferences?: GameSecretReferenceParams[];
|
297
|
+
/**
|
298
|
+
* The directory containing the game executable. This would be the start path of the game assets that contain the main game
|
299
|
+
* server executable. If not provided, a best effort will be made to extract it from the start game command.
|
300
|
+
*/
|
301
|
+
GameWorkingDirectory?: string;
|
302
|
+
/** The instrumentation configuration for the build. */
|
303
|
+
InstrumentationConfiguration?: InstrumentationConfiguration;
|
304
|
+
/**
|
305
|
+
* Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through
|
306
|
+
* Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100
|
307
|
+
*/
|
308
|
+
Metadata?: Record<string, string | null>;
|
309
|
+
/** The configuration for the monitoring application on the build */
|
310
|
+
MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams;
|
311
|
+
/** The number of multiplayer servers to host on a single VM. */
|
312
|
+
MultiplayerServerCountPerVm: number;
|
313
|
+
/** The ports to map the build on. */
|
314
|
+
Ports: Port[];
|
315
|
+
/** The region configurations for the build. */
|
316
|
+
RegionConfigurations: BuildRegionParams[];
|
317
|
+
/** The resource constraints to apply to each server on the VM (EXPERIMENTAL API) */
|
318
|
+
ServerResourceConstraints?: ServerResourceConstraintParams;
|
319
|
+
/** The command to run when the multiplayer server is started, including any arguments. */
|
320
|
+
StartMultiplayerServerCommand: string;
|
321
|
+
/** The VM size to create the build on. */
|
322
|
+
VmSize?: string;
|
323
|
+
/** The configuration for the VmStartupScript for the build */
|
324
|
+
VmStartupScriptConfiguration?: VmStartupScriptParams;
|
325
|
+
/** The crash dump configuration for the build. */
|
326
|
+
WindowsCrashDumpConfiguration?: WindowsCrashDumpConfiguration;
|
327
|
+
}
|
328
|
+
interface CreateBuildWithManagedContainerResponse extends IPlayFabResultCommon {
|
329
|
+
/**
|
330
|
+
* When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or
|
331
|
+
* will have the same assets mounted in the container.
|
332
|
+
*/
|
333
|
+
AreAssetsReadonly?: boolean;
|
334
|
+
/** The guid string build ID. Must be unique for every build. */
|
335
|
+
BuildId?: string;
|
336
|
+
/** The build name. */
|
337
|
+
BuildName?: string;
|
338
|
+
/** The flavor of container of the build. */
|
339
|
+
ContainerFlavor?: string;
|
340
|
+
/** The time the build was created in UTC. */
|
341
|
+
CreationTime?: string;
|
342
|
+
/** The game assets for the build. */
|
343
|
+
GameAssetReferences?: AssetReference[];
|
344
|
+
/** The game certificates for the build. */
|
345
|
+
GameCertificateReferences?: GameCertificateReference[];
|
346
|
+
/** The game secrets for the build. */
|
347
|
+
GameSecretReferences?: GameSecretReference[];
|
348
|
+
/**
|
349
|
+
* The directory containing the game executable. This would be the start path of the game assets that contain the main game
|
350
|
+
* server executable. If not provided, a best effort will be made to extract it from the start game command.
|
351
|
+
*/
|
352
|
+
GameWorkingDirectory?: string;
|
353
|
+
/** The instrumentation configuration for this build. */
|
354
|
+
InstrumentationConfiguration?: InstrumentationConfiguration;
|
355
|
+
/** The metadata of the build. */
|
356
|
+
Metadata?: Record<string, string | null>;
|
357
|
+
/** The configuration for the monitoring application for the build */
|
358
|
+
MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration;
|
359
|
+
/** The number of multiplayer servers to host on a single VM of the build. */
|
360
|
+
MultiplayerServerCountPerVm: number;
|
361
|
+
/** The OS platform used for running the game process. */
|
362
|
+
OsPlatform?: string;
|
363
|
+
/** The ports the build is mapped on. */
|
364
|
+
Ports?: Port[];
|
365
|
+
/** The region configuration for the build. */
|
366
|
+
RegionConfigurations?: BuildRegion[];
|
367
|
+
/** The resource constraints to apply to each server on the VM (EXPERIMENTAL API) */
|
368
|
+
ServerResourceConstraints?: ServerResourceConstraintParams;
|
369
|
+
/** The type of game server being hosted. */
|
370
|
+
ServerType?: string;
|
371
|
+
/** The command to run when the multiplayer server has been allocated, including any arguments. */
|
372
|
+
StartMultiplayerServerCommand?: string;
|
373
|
+
/**
|
374
|
+
* When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to
|
375
|
+
* disc.
|
376
|
+
*/
|
377
|
+
UseStreamingForAssetDownloads?: boolean;
|
378
|
+
/** The VM size the build was created on. */
|
379
|
+
VmSize?: string;
|
380
|
+
/** The configuration for the VmStartupScript feature for the build */
|
381
|
+
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
382
|
+
}
|
383
|
+
interface CreateBuildWithProcessBasedServerRequest extends IPlayFabRequestCommon {
|
384
|
+
/**
|
385
|
+
* When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or
|
386
|
+
* will have the same assets mounted in the container.
|
387
|
+
*/
|
388
|
+
AreAssetsReadonly?: boolean;
|
389
|
+
/** The build name. */
|
390
|
+
BuildName: string;
|
391
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
392
|
+
CustomTags?: Record<string, string | null>;
|
393
|
+
/** The list of game assets related to the build. */
|
394
|
+
GameAssetReferences: AssetReferenceParams[];
|
395
|
+
/** The game certificates for the build. */
|
396
|
+
GameCertificateReferences?: GameCertificateReferenceParams[];
|
397
|
+
/** The game secrets for the build. */
|
398
|
+
GameSecretReferences?: GameSecretReferenceParams[];
|
399
|
+
/**
|
400
|
+
* The working directory for the game process. If this is not provided, the working directory will be set based on the
|
401
|
+
* mount path of the game server executable.
|
402
|
+
*/
|
403
|
+
GameWorkingDirectory?: string;
|
404
|
+
/** The instrumentation configuration for the Build. Used only if it is a Windows Build. */
|
405
|
+
InstrumentationConfiguration?: InstrumentationConfiguration;
|
406
|
+
/**
|
407
|
+
* Indicates whether this build will be created using the OS Preview versionPreview OS is recommended for dev builds to
|
408
|
+
* detect any breaking changes before they are released to retail. Retail builds should set this value to false.
|
409
|
+
*/
|
410
|
+
IsOSPreview?: boolean;
|
411
|
+
/** The Linux instrumentation configuration for the Build. Used only if it is a Linux Build. */
|
412
|
+
LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration;
|
413
|
+
/**
|
414
|
+
* Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through
|
415
|
+
* Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100
|
416
|
+
*/
|
417
|
+
Metadata?: Record<string, string | null>;
|
418
|
+
/** The configuration for the monitoring application on the build */
|
419
|
+
MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams;
|
420
|
+
/** The number of multiplayer servers to host on a single VM. */
|
421
|
+
MultiplayerServerCountPerVm: number;
|
422
|
+
/** The OS platform used for running the game process. */
|
423
|
+
OsPlatform?: string;
|
424
|
+
/** The ports to map the build on. */
|
425
|
+
Ports: Port[];
|
426
|
+
/** The region configurations for the build. */
|
427
|
+
RegionConfigurations: BuildRegionParams[];
|
428
|
+
/**
|
429
|
+
* The command to run when the multiplayer server is started, including any arguments. The path to any executable should be
|
430
|
+
* relative to the root asset folder when unzipped.
|
431
|
+
*/
|
432
|
+
StartMultiplayerServerCommand: string;
|
433
|
+
/** The VM size to create the build on. */
|
434
|
+
VmSize?: string;
|
435
|
+
/** The configuration for the VmStartupScript for the build */
|
436
|
+
VmStartupScriptConfiguration?: VmStartupScriptParams;
|
437
|
+
}
|
438
|
+
interface CreateBuildWithProcessBasedServerResponse extends IPlayFabResultCommon {
|
439
|
+
/**
|
440
|
+
* When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or
|
441
|
+
* will have the same assets mounted in the container.
|
442
|
+
*/
|
443
|
+
AreAssetsReadonly?: boolean;
|
444
|
+
/** The guid string build ID. Must be unique for every build. */
|
445
|
+
BuildId?: string;
|
446
|
+
/** The build name. */
|
447
|
+
BuildName?: string;
|
448
|
+
/** The flavor of container of the build. */
|
449
|
+
ContainerFlavor?: string;
|
450
|
+
/** The time the build was created in UTC. */
|
451
|
+
CreationTime?: string;
|
452
|
+
/** The game assets for the build. */
|
453
|
+
GameAssetReferences?: AssetReference[];
|
454
|
+
/** The game certificates for the build. */
|
455
|
+
GameCertificateReferences?: GameCertificateReference[];
|
456
|
+
/** The game secrets for the build. */
|
457
|
+
GameSecretReferences?: GameSecretReference[];
|
458
|
+
/**
|
459
|
+
* The working directory for the game process. If this is not provided, the working directory will be set based on the
|
460
|
+
* mount path of the game server executable.
|
461
|
+
*/
|
462
|
+
GameWorkingDirectory?: string;
|
463
|
+
/** The instrumentation configuration for this build. */
|
464
|
+
InstrumentationConfiguration?: InstrumentationConfiguration;
|
465
|
+
/**
|
466
|
+
* Indicates whether this build will be created using the OS Preview versionPreview OS is recommended for dev builds to
|
467
|
+
* detect any breaking changes before they are released to retail. Retail builds should set this value to false.
|
468
|
+
*/
|
469
|
+
IsOSPreview?: boolean;
|
470
|
+
/** The Linux instrumentation configuration for this build. */
|
471
|
+
LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration;
|
472
|
+
/** The metadata of the build. */
|
473
|
+
Metadata?: Record<string, string | null>;
|
474
|
+
/** The configuration for the monitoring application for the build */
|
475
|
+
MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration;
|
476
|
+
/** The number of multiplayer servers to host on a single VM of the build. */
|
477
|
+
MultiplayerServerCountPerVm: number;
|
478
|
+
/** The OS platform used for running the game process. */
|
479
|
+
OsPlatform?: string;
|
480
|
+
/** The ports the build is mapped on. */
|
481
|
+
Ports?: Port[];
|
482
|
+
/** The region configuration for the build. */
|
483
|
+
RegionConfigurations?: BuildRegion[];
|
484
|
+
/** The type of game server being hosted. */
|
485
|
+
ServerType?: string;
|
486
|
+
/**
|
487
|
+
* The command to run when the multiplayer server is started, including any arguments. The path to any executable is
|
488
|
+
* relative to the root asset folder when unzipped.
|
489
|
+
*/
|
490
|
+
StartMultiplayerServerCommand?: string;
|
491
|
+
/**
|
492
|
+
* When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to
|
493
|
+
* disc.
|
494
|
+
*/
|
495
|
+
UseStreamingForAssetDownloads?: boolean;
|
496
|
+
/** The VM size the build was created on. */
|
497
|
+
VmSize?: string;
|
498
|
+
/** The configuration for the VmStartupScript feature for the build */
|
499
|
+
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
500
|
+
}
|
501
|
+
interface CreateLobbyRequest extends IPlayFabRequestCommon {
|
502
|
+
/**
|
503
|
+
* The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or
|
504
|
+
* 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
|
505
|
+
* means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve
|
506
|
+
* its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
|
507
|
+
* join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
|
508
|
+
*/
|
509
|
+
AccessPolicy?: string;
|
510
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
511
|
+
CustomTags?: Record<string, string | null>;
|
512
|
+
/**
|
513
|
+
* The private key-value pairs which are visible to all entities in the lobby. At most 30 key-value pairs may be stored
|
514
|
+
* here, keys are limited to 30 characters and values to 1000. The total size of all lobbyData values may not exceed 4096
|
515
|
+
* bytes. Keys are case sensitive.
|
516
|
+
*/
|
517
|
+
LobbyData?: Record<string, string | null>;
|
518
|
+
/** The maximum number of players allowed in the lobby. The value must be between 2 and 128. */
|
519
|
+
MaxPlayers: number;
|
520
|
+
/**
|
521
|
+
* The member initially added to the lobby. Client must specify exactly one member, which is the creator's entity and
|
522
|
+
* member data. Member PubSubConnectionHandle must be null or empty. Game servers must not specify any members.
|
523
|
+
*/
|
524
|
+
Members?: Member[];
|
525
|
+
/** The lobby owner. Must be the calling entity. */
|
526
|
+
Owner: EntityKey;
|
527
|
+
/**
|
528
|
+
* The policy for how a new owner is chosen. May be 'Automatic', 'Manual' or 'None'. Can only be specified by clients. If
|
529
|
+
* client-owned and 'Automatic' - The Lobby service will automatically assign another connected owner when the current
|
530
|
+
* owner leaves or disconnects. The useConnections property must be true. If client - owned and 'Manual' - Ownership is
|
531
|
+
* protected as long as the current owner is connected. If the current owner leaves or disconnects any member may set
|
532
|
+
* themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can
|
533
|
+
* set ownership. The useConnections property can be either true or false.
|
534
|
+
*/
|
535
|
+
OwnerMigrationPolicy?: string;
|
536
|
+
/**
|
537
|
+
* A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner
|
538
|
+
* can send invites. When false or not specified, any member can send invites. Defaults to false if not specified.
|
539
|
+
* Restricted to client owned lobbies.
|
540
|
+
*/
|
541
|
+
RestrictInvitesToLobbyOwner: boolean;
|
542
|
+
/**
|
543
|
+
* The public key-value pairs which allow queries to differentiate between lobbies. Queries will refer to these key-value
|
544
|
+
* pairs in their filter and order by clauses to retrieve lobbies fitting the specified criteria. At most 30 key-value
|
545
|
+
* pairs may be stored here. Keys are of the format string_key1, string_key2 ... string_key30 for string values, or
|
546
|
+
* number_key1, number_key2, ... number_key30 for numeric values.Numeric values are floats. Values can be at most 256
|
547
|
+
* characters long. The total size of all searchData values may not exceed 1024 bytes.
|
548
|
+
*/
|
549
|
+
SearchData?: Record<string, string | null>;
|
550
|
+
/**
|
551
|
+
* A setting to control whether connections are used. Defaults to true. When true, notifications are sent to subscribed
|
552
|
+
* players, disconnect detection removes connectionHandles, only owner migration policies using connections are allowed,
|
553
|
+
* and lobbies must have at least one connected member to be searchable or be a server hosted lobby with a connected
|
554
|
+
* server. If false, then notifications are not sent, connections are not allowed, and lobbies do not need connections to
|
555
|
+
* be searchable.
|
556
|
+
*/
|
557
|
+
UseConnections: boolean;
|
558
|
+
}
|
559
|
+
interface CreateLobbyResult extends IPlayFabResultCommon {
|
560
|
+
/** A field which indicates which lobby the user will be joining. */
|
561
|
+
ConnectionString: string;
|
562
|
+
/** Id to uniquely identify a lobby. */
|
563
|
+
LobbyId: string;
|
564
|
+
}
|
565
|
+
interface CreateMatchmakingTicketRequest extends IPlayFabRequestCommon {
|
566
|
+
/** The User who created this ticket. */
|
567
|
+
Creator: MatchmakingPlayer;
|
568
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
569
|
+
CustomTags?: Record<string, string | null>;
|
570
|
+
/** How long to attempt matching this ticket in seconds. */
|
571
|
+
GiveUpAfterSeconds: number;
|
572
|
+
/** A list of Entity Keys of other users to match with. */
|
573
|
+
MembersToMatchWith?: EntityKey[];
|
574
|
+
/** The Id of a match queue. */
|
575
|
+
QueueName: string;
|
576
|
+
}
|
577
|
+
interface CreateMatchmakingTicketResult extends IPlayFabResultCommon {
|
578
|
+
/** The Id of the ticket to find a match for. */
|
579
|
+
TicketId: string;
|
580
|
+
}
|
581
|
+
interface CreateRemoteUserRequest extends IPlayFabRequestCommon {
|
582
|
+
/** The guid string build ID of to create the remote user for. */
|
583
|
+
BuildId: string;
|
584
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
585
|
+
CustomTags?: Record<string, string | null>;
|
586
|
+
/** The expiration time for the remote user created. Defaults to expiring in one day if not specified. */
|
587
|
+
ExpirationTime?: string;
|
588
|
+
/** The region of virtual machine to create the remote user for. */
|
589
|
+
Region: string;
|
590
|
+
/** The username to create the remote user with. */
|
591
|
+
Username: string;
|
592
|
+
/** The virtual machine ID the multiplayer server is located on. */
|
593
|
+
VmId: string;
|
594
|
+
}
|
595
|
+
interface CreateRemoteUserResponse extends IPlayFabResultCommon {
|
596
|
+
/** The expiration time for the remote user created. */
|
597
|
+
ExpirationTime?: string;
|
598
|
+
/** The generated password for the remote user that was created. */
|
599
|
+
Password?: string;
|
600
|
+
/** The username for the remote user that was created. */
|
601
|
+
Username?: string;
|
602
|
+
}
|
603
|
+
interface CreateServerBackfillTicketRequest extends IPlayFabRequestCommon {
|
604
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
605
|
+
CustomTags?: Record<string, string | null>;
|
606
|
+
/** How long to attempt matching this ticket in seconds. */
|
607
|
+
GiveUpAfterSeconds: number;
|
608
|
+
/** The users who will be part of this ticket, along with their team assignments. */
|
609
|
+
Members: MatchmakingPlayerWithTeamAssignment[];
|
610
|
+
/** The Id of a match queue. */
|
611
|
+
QueueName: string;
|
612
|
+
/** The details of the server the members are connected to. */
|
613
|
+
ServerDetails?: ServerDetails;
|
614
|
+
}
|
615
|
+
interface CreateServerBackfillTicketResult extends IPlayFabResultCommon {
|
616
|
+
/** The Id of the ticket to find a match for. */
|
617
|
+
TicketId: string;
|
618
|
+
}
|
619
|
+
interface CreateServerMatchmakingTicketRequest extends IPlayFabRequestCommon {
|
620
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
621
|
+
CustomTags?: Record<string, string | null>;
|
622
|
+
/** How long to attempt matching this ticket in seconds. */
|
623
|
+
GiveUpAfterSeconds: number;
|
624
|
+
/** The users who will be part of this ticket. */
|
625
|
+
Members: MatchmakingPlayer[];
|
626
|
+
/** The Id of a match queue. */
|
627
|
+
QueueName: string;
|
628
|
+
}
|
629
|
+
interface CreateTitleMultiplayerServersQuotaChangeRequest extends IPlayFabRequestCommon {
|
630
|
+
/** A brief description of the requested changes. */
|
631
|
+
ChangeDescription?: string;
|
632
|
+
/** Changes to make to the titles cores quota. */
|
633
|
+
Changes: CoreCapacityChange[];
|
634
|
+
/** Email to be contacted by our team about this request. Only required when a request is not approved. */
|
635
|
+
ContactEmail?: string;
|
636
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
637
|
+
CustomTags?: Record<string, string | null>;
|
638
|
+
/** Additional information about this request that our team can use to better understand the requirements. */
|
639
|
+
Notes?: string;
|
640
|
+
/** When these changes would need to be in effect. Only required when a request is not approved. */
|
641
|
+
StartDate?: string;
|
642
|
+
}
|
643
|
+
interface CreateTitleMultiplayerServersQuotaChangeResponse extends IPlayFabResultCommon {
|
644
|
+
/** Id of the change request that was created. */
|
645
|
+
RequestId?: string;
|
646
|
+
/** Determines if the request was approved or not. When false, our team is reviewing and may respond within 2 business days. */
|
647
|
+
WasApproved: boolean;
|
648
|
+
}
|
649
|
+
interface CurrentServerStats {
|
650
|
+
/** The number of active multiplayer servers. */
|
651
|
+
Active: number;
|
652
|
+
/** The number of multiplayer servers still downloading game resources (such as assets). */
|
653
|
+
Propping: number;
|
654
|
+
/** The number of standingby multiplayer servers. */
|
655
|
+
StandingBy: number;
|
656
|
+
/** The total number of multiplayer servers. */
|
657
|
+
Total: number;
|
658
|
+
}
|
659
|
+
interface CustomDifferenceRuleExpansion {
|
660
|
+
/** Manually specify the values to use for each expansion interval (this overrides Difference, Delta, and MaxDifference). */
|
661
|
+
DifferenceOverrides: OverrideDouble[];
|
662
|
+
/** How many seconds before this rule is expanded. */
|
663
|
+
SecondsBetweenExpansions: number;
|
664
|
+
}
|
665
|
+
interface CustomRegionSelectionRuleExpansion {
|
666
|
+
/** Manually specify the maximum latency to use for each expansion interval. */
|
667
|
+
MaxLatencyOverrides: OverrideUnsignedInt[];
|
668
|
+
/** How many seconds before this rule is expanded. */
|
669
|
+
SecondsBetweenExpansions: number;
|
670
|
+
}
|
671
|
+
interface CustomSetIntersectionRuleExpansion {
|
672
|
+
/** Manually specify the values to use for each expansion interval. */
|
673
|
+
MinIntersectionSizeOverrides: OverrideUnsignedInt[];
|
674
|
+
/** How many seconds before this rule is expanded. */
|
675
|
+
SecondsBetweenExpansions: number;
|
676
|
+
}
|
677
|
+
interface CustomTeamDifferenceRuleExpansion {
|
678
|
+
/** Manually specify the team difference value to use for each expansion interval. */
|
679
|
+
DifferenceOverrides: OverrideDouble[];
|
680
|
+
/** How many seconds before this rule is expanded. */
|
681
|
+
SecondsBetweenExpansions: number;
|
682
|
+
}
|
683
|
+
interface CustomTeamSizeBalanceRuleExpansion {
|
684
|
+
/** Manually specify the team size difference to use for each expansion interval. */
|
685
|
+
DifferenceOverrides: OverrideUnsignedInt[];
|
686
|
+
/** How many seconds before this rule is expanded. */
|
687
|
+
SecondsBetweenExpansions: number;
|
688
|
+
}
|
689
|
+
interface DeleteAssetRequest extends IPlayFabRequestCommon {
|
690
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
691
|
+
CustomTags?: Record<string, string | null>;
|
692
|
+
/** The filename of the asset to delete. */
|
693
|
+
FileName: string;
|
694
|
+
}
|
695
|
+
interface DeleteBuildAliasRequest extends IPlayFabRequestCommon {
|
696
|
+
/** The guid string alias ID of the alias to perform the action on. */
|
697
|
+
AliasId: string;
|
698
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
699
|
+
CustomTags?: Record<string, string | null>;
|
700
|
+
}
|
701
|
+
interface DeleteBuildRegionRequest extends IPlayFabRequestCommon {
|
702
|
+
/** The guid string ID of the build we want to update regions for. */
|
703
|
+
BuildId: string;
|
704
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
705
|
+
CustomTags?: Record<string, string | null>;
|
706
|
+
/** The build region to delete. */
|
707
|
+
Region: string;
|
708
|
+
}
|
709
|
+
interface DeleteBuildRequest extends IPlayFabRequestCommon {
|
710
|
+
/** The guid string build ID of the build to delete. */
|
711
|
+
BuildId: string;
|
712
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
713
|
+
CustomTags?: Record<string, string | null>;
|
714
|
+
}
|
715
|
+
interface DeleteCertificateRequest extends IPlayFabRequestCommon {
|
716
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
717
|
+
CustomTags?: Record<string, string | null>;
|
718
|
+
/** The name of the certificate. */
|
719
|
+
Name: string;
|
720
|
+
}
|
721
|
+
interface DeleteContainerImageRequest extends IPlayFabRequestCommon {
|
722
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
723
|
+
CustomTags?: Record<string, string | null>;
|
724
|
+
/** The container image repository we want to delete. */
|
725
|
+
ImageName?: string;
|
726
|
+
}
|
727
|
+
interface DeleteLobbyRequest extends IPlayFabRequestCommon {
|
728
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
729
|
+
CustomTags?: Record<string, string | null>;
|
730
|
+
/** The id of the lobby. */
|
731
|
+
LobbyId?: string;
|
732
|
+
}
|
733
|
+
interface DeleteRemoteUserRequest extends IPlayFabRequestCommon {
|
734
|
+
/** The guid string build ID of the multiplayer server where the remote user is to delete. */
|
735
|
+
BuildId: string;
|
736
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
737
|
+
CustomTags?: Record<string, string | null>;
|
738
|
+
/** The region of the multiplayer server where the remote user is to delete. */
|
739
|
+
Region: string;
|
740
|
+
/** The username of the remote user to delete. */
|
741
|
+
Username: string;
|
742
|
+
/** The virtual machine ID the multiplayer server is located on. */
|
743
|
+
VmId: string;
|
744
|
+
}
|
745
|
+
interface DeleteSecretRequest extends IPlayFabRequestCommon {
|
746
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
747
|
+
CustomTags?: Record<string, string | null>;
|
748
|
+
/** The name of the secret. */
|
749
|
+
Name: string;
|
750
|
+
}
|
751
|
+
interface DifferenceRule {
|
752
|
+
/** Description of the attribute used by this rule to match tickets. */
|
753
|
+
Attribute: QueueRuleAttribute;
|
754
|
+
/**
|
755
|
+
* Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
|
756
|
+
* profile.
|
757
|
+
*/
|
758
|
+
AttributeNotSpecifiedBehavior: string;
|
759
|
+
/**
|
760
|
+
* Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this
|
761
|
+
* is set, Difference is ignored.
|
762
|
+
*/
|
763
|
+
CustomExpansion?: CustomDifferenceRuleExpansion;
|
764
|
+
/**
|
765
|
+
* The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that
|
766
|
+
* AttributeNotSpecifiedBehavior is false). Optional.
|
767
|
+
*/
|
768
|
+
DefaultAttributeValue?: number;
|
769
|
+
/** The allowed difference between any two tickets at the start of matchmaking. */
|
770
|
+
Difference: number;
|
771
|
+
/** Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. */
|
772
|
+
LinearExpansion?: LinearDifferenceRuleExpansion;
|
773
|
+
/** How values are treated when there are multiple players in a single ticket. */
|
774
|
+
MergeFunction: string;
|
775
|
+
/** Friendly name chosen by developer. */
|
776
|
+
Name: string;
|
777
|
+
/**
|
778
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
779
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
780
|
+
*/
|
781
|
+
SecondsUntilOptional?: number;
|
782
|
+
/** The relative weight of this rule compared to others. */
|
783
|
+
Weight: number;
|
784
|
+
}
|
785
|
+
interface DynamicStandbySettings {
|
786
|
+
/**
|
787
|
+
* List of auto standing by trigger values and corresponding standing by multiplier. Defaults to 1.5X at 50%, 3X at 25%,
|
788
|
+
* and 4X at 5%
|
789
|
+
*/
|
790
|
+
DynamicFloorMultiplierThresholds?: DynamicStandbyThreshold[];
|
791
|
+
/** When true, dynamic standby will be enabled */
|
792
|
+
IsEnabled: boolean;
|
793
|
+
/** The time it takes to reduce target standing by to configured floor value after an increase. Defaults to 30 minutes */
|
794
|
+
RampDownSeconds?: number;
|
795
|
+
}
|
796
|
+
interface DynamicStandbyThreshold {
|
797
|
+
/** When the trigger threshold is reached, multiply by this value */
|
798
|
+
Multiplier: number;
|
799
|
+
/** The multiplier will be applied when the actual standby divided by target standby floor is less than this value */
|
800
|
+
TriggerThresholdPercentage: number;
|
801
|
+
}
|
802
|
+
interface EnableMultiplayerServersForTitleRequest extends IPlayFabRequestCommon {
|
803
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
804
|
+
CustomTags?: Record<string, string | null>;
|
805
|
+
}
|
806
|
+
interface EnableMultiplayerServersForTitleResponse extends IPlayFabResultCommon {
|
807
|
+
/** The enabled status for the multiplayer server features for the title. */
|
808
|
+
Status?: string;
|
809
|
+
}
|
810
|
+
interface EntityKey {
|
811
|
+
/** Unique ID of the entity. */
|
812
|
+
Id: string;
|
813
|
+
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
814
|
+
Type?: string;
|
815
|
+
}
|
816
|
+
interface FindFriendLobbiesRequest extends IPlayFabRequestCommon {
|
817
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
818
|
+
CustomTags?: Record<string, string | null>;
|
819
|
+
/** Indicates which other platforms' friends this query should link to. */
|
820
|
+
ExternalPlatformFriends?: string;
|
821
|
+
/**
|
822
|
+
* OData style string that contains one or more filters. Only the following operators are supported: "and" (logical and),
|
823
|
+
* "eq" (equal), "ne" (not equals), "ge" (greater than or equal), "gt" (greater than), "le" (less than or equal), and "lt"
|
824
|
+
* (less than). The left-hand side of each OData logical expression should be either a search property key (e.g.
|
825
|
+
* string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by "lobby/":
|
826
|
+
* lobby/memberCount (number of players in a lobby), lobby/maxMemberCount (maximum number of players allowed in a lobby),
|
827
|
+
* lobby/memberCountRemaining (remaining number of players who can be allowed in a lobby), lobby/membershipLock (must equal
|
828
|
+
* 'Unlocked' or 'Locked'), lobby/amOwner (required to equal "true"), lobby/amMember (required to equal "true").
|
829
|
+
*/
|
830
|
+
Filter?: string;
|
831
|
+
/**
|
832
|
+
* OData style string that contains sorting for this query in either ascending ("asc") or descending ("desc") order.
|
833
|
+
* OrderBy clauses are of the form "number_key1 asc" or the pre-defined search key "lobby/memberCount asc",
|
834
|
+
* "lobby/memberCountRemaining desc" and "lobby/maxMemberCount desc". To sort by closest, a moniker `distance{number_key1 =
|
835
|
+
* 5}` can be used to sort by distance from the given number. This field only supports either one sort clause or one
|
836
|
+
* distance clause.
|
837
|
+
*/
|
838
|
+
OrderBy?: string;
|
839
|
+
/** Request pagination information. */
|
840
|
+
Pagination?: PaginationRequest;
|
841
|
+
/** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
|
842
|
+
XboxToken?: string;
|
843
|
+
}
|
844
|
+
interface FindFriendLobbiesResult extends IPlayFabResultCommon {
|
845
|
+
/** Array of lobbies found that matched FindFriendLobbies request. */
|
846
|
+
Lobbies: FriendLobbySummary[];
|
847
|
+
/** Pagination response for FindFriendLobbies request. */
|
848
|
+
Pagination: PaginationResponse;
|
849
|
+
}
|
850
|
+
interface FindLobbiesRequest extends IPlayFabRequestCommon {
|
851
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
852
|
+
CustomTags?: Record<string, string | null>;
|
853
|
+
/**
|
854
|
+
* OData style string that contains one or more filters. Only the following operators are supported: "and" (logical and),
|
855
|
+
* "eq" (equal), "ne" (not equals), "ge" (greater than or equal), "gt" (greater than), "le" (less than or equal), and "lt"
|
856
|
+
* (less than). The left-hand side of each OData logical expression should be either a search property key (e.g.
|
857
|
+
* string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by "lobby/":
|
858
|
+
* lobby/memberCount (number of players in a lobby), lobby/maxMemberCount (maximum number of players allowed in a lobby),
|
859
|
+
* lobby/memberCountRemaining (remaining number of players who can be allowed in a lobby), lobby/membershipLock (must equal
|
860
|
+
* 'Unlocked' or 'Locked'), lobby/amOwner (required to equal "true"), lobby/amMember (required to equal "true").
|
861
|
+
*/
|
862
|
+
Filter?: string;
|
863
|
+
/**
|
864
|
+
* OData style string that contains sorting for this query in either ascending ("asc") or descending ("desc") order.
|
865
|
+
* OrderBy clauses are of the form "number_key1 asc" or the pre-defined search key "lobby/memberCount asc",
|
866
|
+
* "lobby/memberCountRemaining desc" and "lobby/maxMemberCount desc". To sort by closest, a moniker `distance{number_key1 =
|
867
|
+
* 5}` can be used to sort by distance from the given number. This field only supports either one sort clause or one
|
868
|
+
* distance clause.
|
869
|
+
*/
|
870
|
+
OrderBy?: string;
|
871
|
+
/** Request pagination information. */
|
872
|
+
Pagination?: PaginationRequest;
|
873
|
+
}
|
874
|
+
interface FindLobbiesResult extends IPlayFabResultCommon {
|
875
|
+
/** Array of lobbies found that matched FindLobbies request. */
|
876
|
+
Lobbies: LobbySummary[];
|
877
|
+
/** Pagination response for FindLobbies request. */
|
878
|
+
Pagination: PaginationResponse;
|
879
|
+
}
|
880
|
+
interface FriendLobbySummary {
|
881
|
+
/**
|
882
|
+
* A string used to join the lobby.This field is populated by the Lobby service.Invites are performed by communicating this
|
883
|
+
* connectionString to other players.
|
884
|
+
*/
|
885
|
+
ConnectionString: string;
|
886
|
+
/** The current number of players in the lobby. */
|
887
|
+
CurrentPlayers: number;
|
888
|
+
/** Friends in Lobby. */
|
889
|
+
Friends?: EntityKey[];
|
890
|
+
/** Id to uniquely identify a lobby. */
|
891
|
+
LobbyId: string;
|
892
|
+
/** The maximum number of players allowed in the lobby. */
|
893
|
+
MaxPlayers: number;
|
894
|
+
/** A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining. */
|
895
|
+
MembershipLock?: string;
|
896
|
+
/** The client or server entity which owns this lobby. */
|
897
|
+
Owner: EntityKey;
|
898
|
+
/** Search data. */
|
899
|
+
SearchData?: Record<string, string | null>;
|
900
|
+
}
|
901
|
+
interface GameCertificateReference {
|
902
|
+
/**
|
903
|
+
* An alias for the game certificate. The game server will reference this alias via GSDK config to retrieve the game
|
904
|
+
* certificate. This alias is used as an identifier in game server code to allow a new certificate with different Name
|
905
|
+
* field to be uploaded without the need to change any game server code to reference the new Name.
|
906
|
+
*/
|
907
|
+
GsdkAlias?: string;
|
908
|
+
/**
|
909
|
+
* The name of the game certificate. This name should match the name of a certificate that was previously uploaded to this
|
910
|
+
* title.
|
911
|
+
*/
|
912
|
+
Name?: string;
|
913
|
+
}
|
914
|
+
interface GameCertificateReferenceParams {
|
915
|
+
/**
|
916
|
+
* An alias for the game certificate. The game server will reference this alias via GSDK config to retrieve the game
|
917
|
+
* certificate. This alias is used as an identifier in game server code to allow a new certificate with different Name
|
918
|
+
* field to be uploaded without the need to change any game server code to reference the new Name.
|
919
|
+
*/
|
920
|
+
GsdkAlias: string;
|
921
|
+
/**
|
922
|
+
* The name of the game certificate. This name should match the name of a certificate that was previously uploaded to this
|
923
|
+
* title.
|
924
|
+
*/
|
925
|
+
Name: string;
|
926
|
+
}
|
927
|
+
interface GameSecretReference {
|
928
|
+
/** The name of the game secret. This name should match the name of a secret that was previously added to this title. */
|
929
|
+
Name?: string;
|
930
|
+
}
|
931
|
+
interface GameSecretReferenceParams {
|
932
|
+
/** The name of the game secret. This name should match the name of a secret that was previously added to this title. */
|
933
|
+
Name: string;
|
934
|
+
}
|
935
|
+
interface GetAssetDownloadUrlRequest extends IPlayFabRequestCommon {
|
936
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
937
|
+
CustomTags?: Record<string, string | null>;
|
938
|
+
/** The asset's file name to get the download URL for. */
|
939
|
+
FileName: string;
|
940
|
+
}
|
941
|
+
interface GetAssetDownloadUrlResponse extends IPlayFabResultCommon {
|
942
|
+
/** The asset's download URL. */
|
943
|
+
AssetDownloadUrl?: string;
|
944
|
+
/** The asset's file name to get the download URL for. */
|
945
|
+
FileName?: string;
|
946
|
+
}
|
947
|
+
interface GetAssetUploadUrlRequest extends IPlayFabRequestCommon {
|
948
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
949
|
+
CustomTags?: Record<string, string | null>;
|
950
|
+
/** The asset's file name to get the upload URL for. */
|
951
|
+
FileName: string;
|
952
|
+
}
|
953
|
+
interface GetAssetUploadUrlResponse extends IPlayFabResultCommon {
|
954
|
+
/** The asset's upload URL. */
|
955
|
+
AssetUploadUrl?: string;
|
956
|
+
/** The asset's file name to get the upload URL for. */
|
957
|
+
FileName?: string;
|
958
|
+
}
|
959
|
+
interface GetBuildAliasRequest extends IPlayFabRequestCommon {
|
960
|
+
/** The guid string alias ID of the alias to perform the action on. */
|
961
|
+
AliasId: string;
|
962
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
963
|
+
CustomTags?: Record<string, string | null>;
|
964
|
+
}
|
965
|
+
interface GetBuildRequest extends IPlayFabRequestCommon {
|
966
|
+
/** The guid string build ID of the build to get. */
|
967
|
+
BuildId: string;
|
968
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
969
|
+
CustomTags?: Record<string, string | null>;
|
970
|
+
}
|
971
|
+
interface GetBuildResponse extends IPlayFabResultCommon {
|
972
|
+
/**
|
973
|
+
* When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or
|
974
|
+
* will have the same assets mounted in the container.
|
975
|
+
*/
|
976
|
+
AreAssetsReadonly?: boolean;
|
977
|
+
/** The guid string build ID of the build. */
|
978
|
+
BuildId?: string;
|
979
|
+
/** The build name. */
|
980
|
+
BuildName?: string;
|
981
|
+
/** The current build status. Valid values are - Deploying, Deployed, DeletingRegion, Unhealthy. */
|
982
|
+
BuildStatus?: string;
|
983
|
+
/** The flavor of container of he build. */
|
984
|
+
ContainerFlavor?: string;
|
985
|
+
/**
|
986
|
+
* The container command to run when the multiplayer server has been allocated, including any arguments. This only applies
|
987
|
+
* to custom builds. If the build is a managed build, this field will be null.
|
988
|
+
*/
|
989
|
+
ContainerRunCommand?: string;
|
990
|
+
/** The time the build was created in UTC. */
|
991
|
+
CreationTime?: string;
|
992
|
+
/** The custom game container image for a custom build. */
|
993
|
+
CustomGameContainerImage?: ContainerImageReference;
|
994
|
+
/** The game assets for the build. */
|
995
|
+
GameAssetReferences?: AssetReference[];
|
996
|
+
/** The game certificates for the build. */
|
997
|
+
GameCertificateReferences?: GameCertificateReference[];
|
998
|
+
/** The instrumentation configuration of the build. */
|
999
|
+
InstrumentationConfiguration?: InstrumentationConfiguration;
|
1000
|
+
/**
|
1001
|
+
* Metadata of the build. The keys are case insensitive. The build metadata is made available to the server through Game
|
1002
|
+
* Server SDK (GSDK).
|
1003
|
+
*/
|
1004
|
+
Metadata?: Record<string, string | null>;
|
1005
|
+
/** The number of multiplayer servers to hosted on a single VM of the build. */
|
1006
|
+
MultiplayerServerCountPerVm: number;
|
1007
|
+
/** The OS platform used for running the game process. */
|
1008
|
+
OsPlatform?: string;
|
1009
|
+
/** The ports the build is mapped on. */
|
1010
|
+
Ports?: Port[];
|
1011
|
+
/** The region configuration for the build. */
|
1012
|
+
RegionConfigurations?: BuildRegion[];
|
1013
|
+
/** The resource constraints to apply to each server on the VM. */
|
1014
|
+
ServerResourceConstraints?: ServerResourceConstraintParams;
|
1015
|
+
/** The type of game server being hosted. */
|
1016
|
+
ServerType?: string;
|
1017
|
+
/**
|
1018
|
+
* The command to run when the multiplayer server has been allocated, including any arguments. This only applies to managed
|
1019
|
+
* builds. If the build is a custom build, this field will be null.
|
1020
|
+
*/
|
1021
|
+
StartMultiplayerServerCommand?: string;
|
1022
|
+
/** The VM size the build was created on. */
|
1023
|
+
VmSize?: string;
|
1024
|
+
/** The configuration for the VmStartupScript feature for the build */
|
1025
|
+
VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
|
1026
|
+
}
|
1027
|
+
interface GetContainerRegistryCredentialsRequest extends IPlayFabRequestCommon {
|
1028
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1029
|
+
CustomTags?: Record<string, string | null>;
|
1030
|
+
}
|
1031
|
+
interface GetContainerRegistryCredentialsResponse extends IPlayFabResultCommon {
|
1032
|
+
/** The url of the container registry. */
|
1033
|
+
DnsName?: string;
|
1034
|
+
/** The password for accessing the container registry. */
|
1035
|
+
Password?: string;
|
1036
|
+
/** The username for accessing the container registry. */
|
1037
|
+
Username?: string;
|
1038
|
+
}
|
1039
|
+
interface GetLobbyRequest extends IPlayFabRequestCommon {
|
1040
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1041
|
+
CustomTags?: Record<string, string | null>;
|
1042
|
+
/** The id of the lobby. */
|
1043
|
+
LobbyId?: string;
|
1044
|
+
}
|
1045
|
+
interface GetLobbyResult extends IPlayFabResultCommon {
|
1046
|
+
/** The information pertaining to the requested lobby. */
|
1047
|
+
Lobby: Lobby;
|
1048
|
+
}
|
1049
|
+
interface GetMatchmakingQueueRequest extends IPlayFabRequestCommon {
|
1050
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1051
|
+
CustomTags?: Record<string, string | null>;
|
1052
|
+
/** The Id of the matchmaking queue to retrieve. */
|
1053
|
+
QueueName?: string;
|
1054
|
+
}
|
1055
|
+
interface GetMatchmakingQueueResult extends IPlayFabResultCommon {
|
1056
|
+
/** The matchmaking queue config. */
|
1057
|
+
MatchmakingQueue?: MatchmakingQueueConfig;
|
1058
|
+
}
|
1059
|
+
interface GetMatchmakingTicketRequest extends IPlayFabRequestCommon {
|
1060
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1061
|
+
CustomTags?: Record<string, string | null>;
|
1062
|
+
/**
|
1063
|
+
* Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON
|
1064
|
+
* object.
|
1065
|
+
*/
|
1066
|
+
EscapeObject: boolean;
|
1067
|
+
/** The name of the queue to find a match for. */
|
1068
|
+
QueueName: string;
|
1069
|
+
/** The Id of the ticket to find a match for. */
|
1070
|
+
TicketId: string;
|
1071
|
+
}
|
1072
|
+
interface GetMatchmakingTicketResult extends IPlayFabResultCommon {
|
1073
|
+
/**
|
1074
|
+
* The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state. Please retry
|
1075
|
+
* if CancellationReason is RetryRequired.
|
1076
|
+
*/
|
1077
|
+
CancellationReasonString?: string;
|
1078
|
+
/** Change number used for differentiating older matchmaking status updates from newer ones. */
|
1079
|
+
ChangeNumber?: number;
|
1080
|
+
/** The server date and time at which ticket was created. */
|
1081
|
+
Created: string;
|
1082
|
+
/** The Creator's entity key. */
|
1083
|
+
Creator: EntityKey;
|
1084
|
+
/** How long to attempt matching this ticket in seconds. */
|
1085
|
+
GiveUpAfterSeconds: number;
|
1086
|
+
/** The Id of a match. */
|
1087
|
+
MatchId?: string;
|
1088
|
+
/** A list of Users that have joined this ticket. */
|
1089
|
+
Members: MatchmakingPlayer[];
|
1090
|
+
/** A list of PlayFab Ids of Users to match with. */
|
1091
|
+
MembersToMatchWith?: EntityKey[];
|
1092
|
+
/** The Id of a match queue. */
|
1093
|
+
QueueName: string;
|
1094
|
+
/**
|
1095
|
+
* The current ticket status. Possible values are: WaitingForPlayers, WaitingForMatch, WaitingForServer, Canceled and
|
1096
|
+
* Matched.
|
1097
|
+
*/
|
1098
|
+
Status: string;
|
1099
|
+
/** The Id of the ticket to find a match for. */
|
1100
|
+
TicketId: string;
|
1101
|
+
}
|
1102
|
+
interface GetMatchRequest extends IPlayFabRequestCommon {
|
1103
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1104
|
+
CustomTags?: Record<string, string | null>;
|
1105
|
+
/**
|
1106
|
+
* Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON
|
1107
|
+
* object.
|
1108
|
+
*/
|
1109
|
+
EscapeObject: boolean;
|
1110
|
+
/** The Id of a match. */
|
1111
|
+
MatchId: string;
|
1112
|
+
/** The name of the queue to join. */
|
1113
|
+
QueueName: string;
|
1114
|
+
/** Determines whether the matchmaking attributes for each user should be returned in the response for match request. */
|
1115
|
+
ReturnMemberAttributes: boolean;
|
1116
|
+
}
|
1117
|
+
interface GetMatchResult extends IPlayFabResultCommon {
|
1118
|
+
/** A string that is used by players that are matched together to join an arranged lobby. */
|
1119
|
+
ArrangementString?: string;
|
1120
|
+
/** The Id of a match. */
|
1121
|
+
MatchId: string;
|
1122
|
+
/** A list of Users that are matched together, along with their team assignments. */
|
1123
|
+
Members: MatchmakingPlayerWithTeamAssignment[];
|
1124
|
+
/**
|
1125
|
+
* A list of regions that the match could be played in sorted by preference. This value is only set if the queue has a
|
1126
|
+
* region selection rule.
|
1127
|
+
*/
|
1128
|
+
RegionPreferences?: string[];
|
1129
|
+
/** The details of the server that the match has been allocated to. */
|
1130
|
+
ServerDetails?: ServerDetails;
|
1131
|
+
}
|
1132
|
+
interface GetMultiplayerServerDetailsRequest extends IPlayFabRequestCommon {
|
1133
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1134
|
+
CustomTags?: Record<string, string | null>;
|
1135
|
+
/**
|
1136
|
+
* The title generated guid string session ID of the multiplayer server to get details for. This is to keep track of
|
1137
|
+
* multiplayer server sessions.
|
1138
|
+
*/
|
1139
|
+
SessionId: string;
|
1140
|
+
}
|
1141
|
+
interface GetMultiplayerServerDetailsResponse extends IPlayFabResultCommon {
|
1142
|
+
/** The identity of the build in which the server was allocated. */
|
1143
|
+
BuildId?: string;
|
1144
|
+
/** The connected players in the multiplayer server. */
|
1145
|
+
ConnectedPlayers?: ConnectedPlayer[];
|
1146
|
+
/** The fully qualified domain name of the virtual machine that is hosting this multiplayer server. */
|
1147
|
+
FQDN?: string;
|
1148
|
+
/** The public IPv4 address of the virtual machine that is hosting this multiplayer server. */
|
1149
|
+
IPV4Address?: string;
|
1150
|
+
/** The time (UTC) at which a change in the multiplayer server state was observed. */
|
1151
|
+
LastStateTransitionTime?: string;
|
1152
|
+
/** The ports the multiplayer server uses. */
|
1153
|
+
Ports?: Port[];
|
1154
|
+
/** The list of public Ipv4 addresses associated with the server. */
|
1155
|
+
PublicIPV4Addresses?: PublicIpAddress[];
|
1156
|
+
/** The region the multiplayer server is located in. */
|
1157
|
+
Region?: string;
|
1158
|
+
/** The string server ID of the multiplayer server generated by PlayFab. */
|
1159
|
+
ServerId?: string;
|
1160
|
+
/** The guid string session ID of the multiplayer server. */
|
1161
|
+
SessionId?: string;
|
1162
|
+
/** The state of the multiplayer server. */
|
1163
|
+
State?: string;
|
1164
|
+
/** The virtual machine ID that the multiplayer server is located on. */
|
1165
|
+
VmId?: string;
|
1166
|
+
}
|
1167
|
+
interface GetMultiplayerServerLogsRequest extends IPlayFabRequestCommon {
|
1168
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1169
|
+
CustomTags?: Record<string, string | null>;
|
1170
|
+
/** The server ID of multiplayer server to get logs for. */
|
1171
|
+
ServerId: string;
|
1172
|
+
}
|
1173
|
+
interface GetMultiplayerServerLogsResponse extends IPlayFabResultCommon {
|
1174
|
+
/** URL for logs download. */
|
1175
|
+
LogDownloadUrl?: string;
|
1176
|
+
}
|
1177
|
+
interface GetMultiplayerSessionLogsBySessionIdRequest extends IPlayFabRequestCommon {
|
1178
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1179
|
+
CustomTags?: Record<string, string | null>;
|
1180
|
+
/** The server ID of multiplayer server to get logs for. */
|
1181
|
+
SessionId: string;
|
1182
|
+
}
|
1183
|
+
interface GetQueueStatisticsRequest extends IPlayFabRequestCommon {
|
1184
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1185
|
+
CustomTags?: Record<string, string | null>;
|
1186
|
+
/** The name of the queue. */
|
1187
|
+
QueueName: string;
|
1188
|
+
}
|
1189
|
+
interface GetQueueStatisticsResult extends IPlayFabResultCommon {
|
1190
|
+
/** The current number of players in the matchmaking queue, who are waiting to be matched. */
|
1191
|
+
NumberOfPlayersMatching?: number;
|
1192
|
+
/** Statistics representing the time (in seconds) it takes for tickets to find a match. */
|
1193
|
+
TimeToMatchStatisticsInSeconds?: Statistics;
|
1194
|
+
}
|
1195
|
+
interface GetRemoteLoginEndpointRequest extends IPlayFabRequestCommon {
|
1196
|
+
/** The guid string build ID of the multiplayer server to get remote login information for. */
|
1197
|
+
BuildId: string;
|
1198
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1199
|
+
CustomTags?: Record<string, string | null>;
|
1200
|
+
/** The region of the multiplayer server to get remote login information for. */
|
1201
|
+
Region: string;
|
1202
|
+
/** The virtual machine ID the multiplayer server is located on. */
|
1203
|
+
VmId: string;
|
1204
|
+
}
|
1205
|
+
interface GetRemoteLoginEndpointResponse extends IPlayFabResultCommon {
|
1206
|
+
/** The remote login IPV4 address of multiplayer server. */
|
1207
|
+
IPV4Address?: string;
|
1208
|
+
/** The remote login port of multiplayer server. */
|
1209
|
+
Port: number;
|
1210
|
+
}
|
1211
|
+
interface GetServerBackfillTicketRequest extends IPlayFabRequestCommon {
|
1212
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1213
|
+
CustomTags?: Record<string, string | null>;
|
1214
|
+
/**
|
1215
|
+
* Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON
|
1216
|
+
* object.
|
1217
|
+
*/
|
1218
|
+
EscapeObject: boolean;
|
1219
|
+
/** The name of the queue to find a match for. */
|
1220
|
+
QueueName: string;
|
1221
|
+
/** The Id of the ticket to find a match for. */
|
1222
|
+
TicketId: string;
|
1223
|
+
}
|
1224
|
+
interface GetServerBackfillTicketResult extends IPlayFabResultCommon {
|
1225
|
+
/** The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state. */
|
1226
|
+
CancellationReasonString?: string;
|
1227
|
+
/** The server date and time at which ticket was created. */
|
1228
|
+
Created: string;
|
1229
|
+
/** How long to attempt matching this ticket in seconds. */
|
1230
|
+
GiveUpAfterSeconds: number;
|
1231
|
+
/** The Id of a match. */
|
1232
|
+
MatchId?: string;
|
1233
|
+
/** A list of Users that are part of this ticket, along with their team assignments. */
|
1234
|
+
Members: MatchmakingPlayerWithTeamAssignment[];
|
1235
|
+
/** The Id of a match queue. */
|
1236
|
+
QueueName: string;
|
1237
|
+
/** The details of the server the members are connected to. */
|
1238
|
+
ServerDetails: ServerDetails;
|
1239
|
+
/** The current ticket status. Possible values are: WaitingForMatch, Canceled and Matched. */
|
1240
|
+
Status: string;
|
1241
|
+
/** The Id of the ticket to find a match for. */
|
1242
|
+
TicketId: string;
|
1243
|
+
}
|
1244
|
+
interface GetTitleEnabledForMultiplayerServersStatusRequest extends IPlayFabRequestCommon {
|
1245
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1246
|
+
CustomTags?: Record<string, string | null>;
|
1247
|
+
}
|
1248
|
+
interface GetTitleEnabledForMultiplayerServersStatusResponse extends IPlayFabResultCommon {
|
1249
|
+
/** The enabled status for the multiplayer server features for the title. */
|
1250
|
+
Status?: string;
|
1251
|
+
}
|
1252
|
+
interface GetTitleMultiplayerServersQuotaChangeRequest extends IPlayFabRequestCommon {
|
1253
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1254
|
+
CustomTags?: Record<string, string | null>;
|
1255
|
+
/** Id of the change request to get. */
|
1256
|
+
RequestId: string;
|
1257
|
+
}
|
1258
|
+
interface GetTitleMultiplayerServersQuotaChangeResponse extends IPlayFabResultCommon {
|
1259
|
+
/** The change request for this title. */
|
1260
|
+
Change?: QuotaChange;
|
1261
|
+
}
|
1262
|
+
interface GetTitleMultiplayerServersQuotasRequest extends IPlayFabRequestCommon {
|
1263
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1264
|
+
CustomTags?: Record<string, string | null>;
|
1265
|
+
}
|
1266
|
+
interface GetTitleMultiplayerServersQuotasResponse extends IPlayFabResultCommon {
|
1267
|
+
/** The various quotas for multiplayer servers for the title. */
|
1268
|
+
Quotas?: TitleMultiplayerServersQuotas;
|
1269
|
+
}
|
1270
|
+
interface InstrumentationConfiguration {
|
1271
|
+
/** Designates whether windows instrumentation configuration will be enabled for this Build */
|
1272
|
+
IsEnabled?: boolean;
|
1273
|
+
/**
|
1274
|
+
* This property is deprecated, use IsEnabled. The list of processes to be monitored on a VM for this build. Providing
|
1275
|
+
* processes will turn on performance metrics collection for this build. Process names should not include extensions. If
|
1276
|
+
* the game server process is: GameServer.exe; then, ProcessesToMonitor = [ GameServer ]
|
1277
|
+
*/
|
1278
|
+
ProcessesToMonitor?: string[];
|
1279
|
+
}
|
1280
|
+
interface InviteToLobbyRequest extends IPlayFabRequestCommon {
|
1281
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1282
|
+
CustomTags?: Record<string, string | null>;
|
1283
|
+
/** The entity invited to the lobby. */
|
1284
|
+
InviteeEntity?: EntityKey;
|
1285
|
+
/** The id of the lobby. */
|
1286
|
+
LobbyId?: string;
|
1287
|
+
/** The member entity sending the invite. Must be a member of the lobby. */
|
1288
|
+
MemberEntity?: EntityKey;
|
1289
|
+
}
|
1290
|
+
interface JoinArrangedLobbyRequest extends IPlayFabRequestCommon {
|
1291
|
+
/**
|
1292
|
+
* The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or
|
1293
|
+
* 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
|
1294
|
+
* means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve
|
1295
|
+
* its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
|
1296
|
+
* join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
|
1297
|
+
*/
|
1298
|
+
AccessPolicy?: string;
|
1299
|
+
/**
|
1300
|
+
* A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service
|
1301
|
+
* and the creator of the arrangementString (Matchmaking). This string defines a unique identifier for the arranged lobby
|
1302
|
+
* as well as the title and member the string is valid for. Arrangement strings have an expiration.
|
1303
|
+
*/
|
1304
|
+
ArrangementString: string;
|
1305
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1306
|
+
CustomTags?: Record<string, string | null>;
|
1307
|
+
/** The maximum number of players allowed in the lobby. The value must be between 2 and 128. */
|
1308
|
+
MaxPlayers: number;
|
1309
|
+
/**
|
1310
|
+
* The private key-value pairs used by the member to communicate information to other members and the owner. Visible to all
|
1311
|
+
* entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to
|
1312
|
+
* 1000. The total size of all memberData values may not exceed 4096 bytes. Keys are case sensitive.
|
1313
|
+
*/
|
1314
|
+
MemberData?: Record<string, string | null>;
|
1315
|
+
/** The member entity who is joining the lobby. The first member to join will be the lobby owner. */
|
1316
|
+
MemberEntity: EntityKey;
|
1317
|
+
/**
|
1318
|
+
* The policy for how a new owner is chosen. May be 'Automatic', 'Manual' or 'None'. Can only be specified by clients. If
|
1319
|
+
* client-owned and 'Automatic' - The Lobby service will automatically assign another connected owner when the current
|
1320
|
+
* owner leaves or disconnects. The useConnections property must be true. If client - owned and 'Manual' - Ownership is
|
1321
|
+
* protected as long as the current owner is connected. If the current owner leaves or disconnects any member may set
|
1322
|
+
* themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can
|
1323
|
+
* set ownership. The useConnections property can be either true or false.
|
1324
|
+
*/
|
1325
|
+
OwnerMigrationPolicy?: string;
|
1326
|
+
/**
|
1327
|
+
* A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner
|
1328
|
+
* can send invites. When false or not specified, any member can send invites. Defaults to false if not specified.
|
1329
|
+
* Restricted to client owned lobbies.
|
1330
|
+
*/
|
1331
|
+
RestrictInvitesToLobbyOwner: boolean;
|
1332
|
+
/**
|
1333
|
+
* A setting to control whether connections are used. Defaults to true. When true, notifications are sent to subscribed
|
1334
|
+
* players, disconnect detection removes connectionHandles, only owner migration policies using connections are allowed,
|
1335
|
+
* and lobbies must have at least one connected member to be searchable or be a server hosted lobby with a connected
|
1336
|
+
* server. If false, then notifications are not sent, connections are not allowed, and lobbies do not need connections to
|
1337
|
+
* be searchable.
|
1338
|
+
*/
|
1339
|
+
UseConnections: boolean;
|
1340
|
+
}
|
1341
|
+
interface JoinLobbyAsServerRequest extends IPlayFabRequestCommon {
|
1342
|
+
/**
|
1343
|
+
* A field which indicates which lobby the game_server will be joining. This field is opaque to everyone except the Lobby
|
1344
|
+
* service.
|
1345
|
+
*/
|
1346
|
+
ConnectionString: string;
|
1347
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1348
|
+
CustomTags?: Record<string, string | null>;
|
1349
|
+
/**
|
1350
|
+
* The private key-value pairs which are visible to all entities in the lobby but can only be modified by the joined
|
1351
|
+
* server.At most 30 key - value pairs may be stored here, keys are limited to 30 characters and values to 1000.The total
|
1352
|
+
* size of all serverData values may not exceed 4096 bytes.
|
1353
|
+
*/
|
1354
|
+
ServerData?: Record<string, string | null>;
|
1355
|
+
/**
|
1356
|
+
* The game_server entity which is joining the Lobby. If a different game_server entity has already joined the request will
|
1357
|
+
* fail unless the joined entity is disconnected, in which case the incoming game_server entity will replace the
|
1358
|
+
* disconnected entity.
|
1359
|
+
*/
|
1360
|
+
ServerEntity: EntityKey;
|
1361
|
+
}
|
1362
|
+
interface JoinLobbyAsServerResult extends IPlayFabResultCommon {
|
1363
|
+
/** Successfully joined lobby's id. */
|
1364
|
+
LobbyId: string;
|
1365
|
+
}
|
1366
|
+
interface JoinLobbyRequest extends IPlayFabRequestCommon {
|
1367
|
+
/** A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service. */
|
1368
|
+
ConnectionString?: string;
|
1369
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1370
|
+
CustomTags?: Record<string, string | null>;
|
1371
|
+
/**
|
1372
|
+
* The private key-value pairs used by the member to communicate information to other members and the owner. Visible to all
|
1373
|
+
* entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to
|
1374
|
+
* 1000. The total size of all memberData values may not exceed 4096 bytes.Keys are case sensitive.
|
1375
|
+
*/
|
1376
|
+
MemberData?: Record<string, string | null>;
|
1377
|
+
/** The member entity who is joining the lobby. */
|
1378
|
+
MemberEntity?: EntityKey;
|
1379
|
+
}
|
1380
|
+
interface JoinLobbyResult extends IPlayFabResultCommon {
|
1381
|
+
/** Successfully joined lobby's id. */
|
1382
|
+
LobbyId: string;
|
1383
|
+
}
|
1384
|
+
interface JoinMatchmakingTicketRequest extends IPlayFabRequestCommon {
|
1385
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1386
|
+
CustomTags?: Record<string, string | null>;
|
1387
|
+
/** The User who wants to join the ticket. Their Id must be listed in PlayFabIdsToMatchWith. */
|
1388
|
+
Member: MatchmakingPlayer;
|
1389
|
+
/** The name of the queue to join. */
|
1390
|
+
QueueName: string;
|
1391
|
+
/** The Id of the ticket to find a match for. */
|
1392
|
+
TicketId: string;
|
1393
|
+
}
|
1394
|
+
interface JoinMatchmakingTicketResult extends IPlayFabResultCommon {
|
1395
|
+
}
|
1396
|
+
interface LeaveLobbyAsServerRequest extends IPlayFabRequestCommon {
|
1397
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1398
|
+
CustomTags?: Record<string, string | null>;
|
1399
|
+
/** The id of the lobby. */
|
1400
|
+
LobbyId: string;
|
1401
|
+
/**
|
1402
|
+
* The game_server entity leaving the lobby. If the game_server was subscribed to notifications, it will be unsubscribed.
|
1403
|
+
* If a the given game_server entity is not in the lobby, it will fail.
|
1404
|
+
*/
|
1405
|
+
ServerEntity: EntityKey;
|
1406
|
+
}
|
1407
|
+
interface LeaveLobbyRequest extends IPlayFabRequestCommon {
|
1408
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1409
|
+
CustomTags?: Record<string, string | null>;
|
1410
|
+
/** The id of the lobby. */
|
1411
|
+
LobbyId?: string;
|
1412
|
+
/** The member entity leaving the lobby. */
|
1413
|
+
MemberEntity?: EntityKey;
|
1414
|
+
}
|
1415
|
+
interface LinearDifferenceRuleExpansion {
|
1416
|
+
/** This value gets added to Difference at every expansion interval. */
|
1417
|
+
Delta: number;
|
1418
|
+
/** Once the total difference reaches this value, expansion stops. Optional. */
|
1419
|
+
Limit?: number;
|
1420
|
+
/** How many seconds before this rule is expanded. */
|
1421
|
+
SecondsBetweenExpansions: number;
|
1422
|
+
}
|
1423
|
+
interface LinearRegionSelectionRuleExpansion {
|
1424
|
+
/** This value gets added to MaxLatency at every expansion interval. */
|
1425
|
+
Delta: number;
|
1426
|
+
/** Once the max Latency reaches this value, expansion stops. */
|
1427
|
+
Limit: number;
|
1428
|
+
/** How many seconds before this rule is expanded. */
|
1429
|
+
SecondsBetweenExpansions: number;
|
1430
|
+
}
|
1431
|
+
interface LinearSetIntersectionRuleExpansion {
|
1432
|
+
/** This value gets added to MinIntersectionSize at every expansion interval. */
|
1433
|
+
Delta: number;
|
1434
|
+
/** How many seconds before this rule is expanded. */
|
1435
|
+
SecondsBetweenExpansions: number;
|
1436
|
+
}
|
1437
|
+
interface LinearTeamDifferenceRuleExpansion {
|
1438
|
+
/** This value gets added to Difference at every expansion interval. */
|
1439
|
+
Delta: number;
|
1440
|
+
/** Once the total difference reaches this value, expansion stops. Optional. */
|
1441
|
+
Limit?: number;
|
1442
|
+
/** How many seconds before this rule is expanded. */
|
1443
|
+
SecondsBetweenExpansions: number;
|
1444
|
+
}
|
1445
|
+
interface LinearTeamSizeBalanceRuleExpansion {
|
1446
|
+
/** This value gets added to Difference at every expansion interval. */
|
1447
|
+
Delta: number;
|
1448
|
+
/** Once the total difference reaches this value, expansion stops. Optional. */
|
1449
|
+
Limit?: number;
|
1450
|
+
/** How many seconds before this rule is expanded. */
|
1451
|
+
SecondsBetweenExpansions: number;
|
1452
|
+
}
|
1453
|
+
interface LinuxInstrumentationConfiguration {
|
1454
|
+
/** Designates whether Linux instrumentation configuration will be enabled for this Build */
|
1455
|
+
IsEnabled: boolean;
|
1456
|
+
}
|
1457
|
+
interface ListAssetSummariesRequest extends IPlayFabRequestCommon {
|
1458
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1459
|
+
CustomTags?: Record<string, string | null>;
|
1460
|
+
/** The page size for the request. */
|
1461
|
+
PageSize?: number;
|
1462
|
+
/** The skip token for the paged request. */
|
1463
|
+
SkipToken?: string;
|
1464
|
+
}
|
1465
|
+
interface ListAssetSummariesResponse extends IPlayFabResultCommon {
|
1466
|
+
/** The list of asset summaries. */
|
1467
|
+
AssetSummaries?: AssetSummary[];
|
1468
|
+
/** The page size on the response. */
|
1469
|
+
PageSize: number;
|
1470
|
+
/** The skip token for the paged response. */
|
1471
|
+
SkipToken?: string;
|
1472
|
+
}
|
1473
|
+
interface ListBuildAliasesRequest extends IPlayFabRequestCommon {
|
1474
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1475
|
+
CustomTags?: Record<string, string | null>;
|
1476
|
+
/** The page size for the request. */
|
1477
|
+
PageSize?: number;
|
1478
|
+
/** The skip token for the paged request. */
|
1479
|
+
SkipToken?: string;
|
1480
|
+
}
|
1481
|
+
interface ListBuildAliasesResponse extends IPlayFabResultCommon {
|
1482
|
+
/** The list of build aliases for the title */
|
1483
|
+
BuildAliases?: BuildAliasDetailsResponse[];
|
1484
|
+
/** The page size on the response. */
|
1485
|
+
PageSize: number;
|
1486
|
+
/** The skip token for the paged response. */
|
1487
|
+
SkipToken?: string;
|
1488
|
+
}
|
1489
|
+
interface ListBuildSummariesRequest extends IPlayFabRequestCommon {
|
1490
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1491
|
+
CustomTags?: Record<string, string | null>;
|
1492
|
+
/** The page size for the request. */
|
1493
|
+
PageSize?: number;
|
1494
|
+
/** The skip token for the paged request. */
|
1495
|
+
SkipToken?: string;
|
1496
|
+
}
|
1497
|
+
interface ListBuildSummariesResponse extends IPlayFabResultCommon {
|
1498
|
+
/** The list of build summaries for a title. */
|
1499
|
+
BuildSummaries?: BuildSummary[];
|
1500
|
+
/** The page size on the response. */
|
1501
|
+
PageSize: number;
|
1502
|
+
/** The skip token for the paged response. */
|
1503
|
+
SkipToken?: string;
|
1504
|
+
}
|
1505
|
+
interface ListCertificateSummariesRequest extends IPlayFabRequestCommon {
|
1506
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1507
|
+
CustomTags?: Record<string, string | null>;
|
1508
|
+
/** The page size for the request. */
|
1509
|
+
PageSize?: number;
|
1510
|
+
/** The skip token for the paged request. */
|
1511
|
+
SkipToken?: string;
|
1512
|
+
}
|
1513
|
+
interface ListCertificateSummariesResponse extends IPlayFabResultCommon {
|
1514
|
+
/** The list of game certificates. */
|
1515
|
+
CertificateSummaries?: CertificateSummary[];
|
1516
|
+
/** The page size on the response. */
|
1517
|
+
PageSize: number;
|
1518
|
+
/** The skip token for the paged response. */
|
1519
|
+
SkipToken?: string;
|
1520
|
+
}
|
1521
|
+
interface ListContainerImagesRequest extends IPlayFabRequestCommon {
|
1522
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1523
|
+
CustomTags?: Record<string, string | null>;
|
1524
|
+
/** The page size for the request. */
|
1525
|
+
PageSize?: number;
|
1526
|
+
/** The skip token for the paged request. */
|
1527
|
+
SkipToken?: string;
|
1528
|
+
}
|
1529
|
+
interface ListContainerImagesResponse extends IPlayFabResultCommon {
|
1530
|
+
/** The list of container images. */
|
1531
|
+
Images?: string[];
|
1532
|
+
/** The page size on the response. */
|
1533
|
+
PageSize: number;
|
1534
|
+
/** The skip token for the paged response. */
|
1535
|
+
SkipToken?: string;
|
1536
|
+
}
|
1537
|
+
interface ListContainerImageTagsRequest extends IPlayFabRequestCommon {
|
1538
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1539
|
+
CustomTags?: Record<string, string | null>;
|
1540
|
+
/** The container images we want to list tags for. */
|
1541
|
+
ImageName?: string;
|
1542
|
+
/** The page size for the request. */
|
1543
|
+
PageSize?: number;
|
1544
|
+
/** The skip token for the paged request. */
|
1545
|
+
SkipToken?: string;
|
1546
|
+
}
|
1547
|
+
interface ListContainerImageTagsResponse extends IPlayFabResultCommon {
|
1548
|
+
/** The page size on the response. */
|
1549
|
+
PageSize: number;
|
1550
|
+
/** The skip token for the paged response. */
|
1551
|
+
SkipToken?: string;
|
1552
|
+
/** The list of tags for a particular container image. */
|
1553
|
+
Tags?: string[];
|
1554
|
+
}
|
1555
|
+
interface ListMatchmakingQueuesRequest extends IPlayFabRequestCommon {
|
1556
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1557
|
+
CustomTags?: Record<string, string | null>;
|
1558
|
+
}
|
1559
|
+
interface ListMatchmakingQueuesResult extends IPlayFabResultCommon {
|
1560
|
+
/** The list of matchmaking queue configs for this title. */
|
1561
|
+
MatchMakingQueues?: MatchmakingQueueConfig[];
|
1562
|
+
}
|
1563
|
+
interface ListMatchmakingTicketsForPlayerRequest extends IPlayFabRequestCommon {
|
1564
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1565
|
+
CustomTags?: Record<string, string | null>;
|
1566
|
+
/** The entity key for which to find the ticket Ids. */
|
1567
|
+
Entity?: EntityKey;
|
1568
|
+
/** The name of the queue to find a match for. */
|
1569
|
+
QueueName: string;
|
1570
|
+
}
|
1571
|
+
interface ListMatchmakingTicketsForPlayerResult extends IPlayFabResultCommon {
|
1572
|
+
/** The list of ticket Ids the user is a member of. */
|
1573
|
+
TicketIds: string[];
|
1574
|
+
}
|
1575
|
+
interface ListMultiplayerServersRequest extends IPlayFabRequestCommon {
|
1576
|
+
/** The guid string build ID of the multiplayer servers to list. */
|
1577
|
+
BuildId: string;
|
1578
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1579
|
+
CustomTags?: Record<string, string | null>;
|
1580
|
+
/** The page size for the request. */
|
1581
|
+
PageSize?: number;
|
1582
|
+
/** The region the multiplayer servers to list. */
|
1583
|
+
Region: string;
|
1584
|
+
/** The skip token for the paged request. */
|
1585
|
+
SkipToken?: string;
|
1586
|
+
}
|
1587
|
+
interface ListMultiplayerServersResponse extends IPlayFabResultCommon {
|
1588
|
+
/** The list of multiplayer server summary details. */
|
1589
|
+
MultiplayerServerSummaries?: MultiplayerServerSummary[];
|
1590
|
+
/** The page size on the response. */
|
1591
|
+
PageSize: number;
|
1592
|
+
/** The skip token for the paged response. */
|
1593
|
+
SkipToken?: string;
|
1594
|
+
}
|
1595
|
+
interface ListPartyQosServersRequest extends IPlayFabRequestCommon {
|
1596
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1597
|
+
CustomTags?: Record<string, string | null>;
|
1598
|
+
}
|
1599
|
+
interface ListPartyQosServersResponse extends IPlayFabResultCommon {
|
1600
|
+
/** The page size on the response. */
|
1601
|
+
PageSize: number;
|
1602
|
+
/** The list of QoS servers. */
|
1603
|
+
QosServers?: QosServer[];
|
1604
|
+
/** The skip token for the paged response. */
|
1605
|
+
SkipToken?: string;
|
1606
|
+
}
|
1607
|
+
interface ListQosServersForTitleRequest extends IPlayFabRequestCommon {
|
1608
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1609
|
+
CustomTags?: Record<string, string | null>;
|
1610
|
+
/**
|
1611
|
+
* Indicates that the response should contain Qos servers for all regions, including those where there are no builds
|
1612
|
+
* deployed for the title.
|
1613
|
+
*/
|
1614
|
+
IncludeAllRegions?: boolean;
|
1615
|
+
/** Indicates the Routing Preference used by the Qos servers. The default Routing Preference is Microsoft */
|
1616
|
+
RoutingPreference?: string;
|
1617
|
+
}
|
1618
|
+
interface ListQosServersForTitleResponse extends IPlayFabResultCommon {
|
1619
|
+
/** The page size on the response. */
|
1620
|
+
PageSize: number;
|
1621
|
+
/** The list of QoS servers. */
|
1622
|
+
QosServers?: QosServer[];
|
1623
|
+
/** The skip token for the paged response. */
|
1624
|
+
SkipToken?: string;
|
1625
|
+
}
|
1626
|
+
interface ListSecretSummariesRequest extends IPlayFabRequestCommon {
|
1627
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1628
|
+
CustomTags?: Record<string, string | null>;
|
1629
|
+
/** The page size for the request. */
|
1630
|
+
PageSize?: number;
|
1631
|
+
/** The skip token for the paged request. */
|
1632
|
+
SkipToken?: string;
|
1633
|
+
}
|
1634
|
+
interface ListSecretSummariesResponse extends IPlayFabResultCommon {
|
1635
|
+
/** The page size on the response. */
|
1636
|
+
PageSize: number;
|
1637
|
+
/** The list of game secret. */
|
1638
|
+
SecretSummaries?: SecretSummary[];
|
1639
|
+
/** The skip token for the paged response. */
|
1640
|
+
SkipToken?: string;
|
1641
|
+
}
|
1642
|
+
interface ListServerBackfillTicketsForPlayerRequest extends IPlayFabRequestCommon {
|
1643
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1644
|
+
CustomTags?: Record<string, string | null>;
|
1645
|
+
/** The entity key for which to find the ticket Ids. */
|
1646
|
+
Entity: EntityKey;
|
1647
|
+
/** The name of the queue the tickets are in. */
|
1648
|
+
QueueName: string;
|
1649
|
+
}
|
1650
|
+
interface ListServerBackfillTicketsForPlayerResult extends IPlayFabResultCommon {
|
1651
|
+
/** The list of backfill ticket Ids the user is a member of. */
|
1652
|
+
TicketIds: string[];
|
1653
|
+
}
|
1654
|
+
interface ListTitleMultiplayerServersQuotaChangesRequest extends IPlayFabRequestCommon {
|
1655
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1656
|
+
CustomTags?: Record<string, string | null>;
|
1657
|
+
}
|
1658
|
+
interface ListTitleMultiplayerServersQuotaChangesResponse extends IPlayFabResultCommon {
|
1659
|
+
/** All change requests for this title. */
|
1660
|
+
Changes?: QuotaChange[];
|
1661
|
+
}
|
1662
|
+
interface ListVirtualMachineSummariesRequest extends IPlayFabRequestCommon {
|
1663
|
+
/** The guid string build ID of the virtual machines to list. */
|
1664
|
+
BuildId: string;
|
1665
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1666
|
+
CustomTags?: Record<string, string | null>;
|
1667
|
+
/** The page size for the request. */
|
1668
|
+
PageSize?: number;
|
1669
|
+
/** The region of the virtual machines to list. */
|
1670
|
+
Region: string;
|
1671
|
+
/** The skip token for the paged request. */
|
1672
|
+
SkipToken?: string;
|
1673
|
+
}
|
1674
|
+
interface ListVirtualMachineSummariesResponse extends IPlayFabResultCommon {
|
1675
|
+
/** The page size on the response. */
|
1676
|
+
PageSize: number;
|
1677
|
+
/** The skip token for the paged response. */
|
1678
|
+
SkipToken?: string;
|
1679
|
+
/** The list of virtual machine summaries. */
|
1680
|
+
VirtualMachines?: VirtualMachineSummary[];
|
1681
|
+
}
|
1682
|
+
interface Lobby {
|
1683
|
+
/** A setting indicating who is allowed to join this lobby, as well as see it in queries. */
|
1684
|
+
AccessPolicy: string;
|
1685
|
+
/** A number that increments once for each request that modifies the lobby. */
|
1686
|
+
ChangeNumber: number;
|
1687
|
+
/**
|
1688
|
+
* A string used to join the lobby. This field is populated by the Lobby service. Invites are performed by communicating
|
1689
|
+
* this connectionString to other players.
|
1690
|
+
*/
|
1691
|
+
ConnectionString: string;
|
1692
|
+
/** Lobby data. */
|
1693
|
+
LobbyData?: Record<string, string | null>;
|
1694
|
+
/** Id to uniquely identify a lobby. */
|
1695
|
+
LobbyId: string;
|
1696
|
+
/** The maximum number of players allowed in the lobby. */
|
1697
|
+
MaxPlayers: number;
|
1698
|
+
/** Array of all lobby members. */
|
1699
|
+
Members?: Member[];
|
1700
|
+
/** A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining. */
|
1701
|
+
MembershipLock: string;
|
1702
|
+
/** The client or server entity which owns this lobby. */
|
1703
|
+
Owner?: EntityKey;
|
1704
|
+
/** A setting indicating the owner migration policy. If server owned, this field is not present. */
|
1705
|
+
OwnerMigrationPolicy?: string;
|
1706
|
+
/**
|
1707
|
+
* An opaque string stored on a SubscribeToLobbyResource call, which indicates the connection an owner or member has with
|
1708
|
+
* PubSub.
|
1709
|
+
*/
|
1710
|
+
PubSubConnectionHandle?: string;
|
1711
|
+
/**
|
1712
|
+
* A setting that controls lobby invites. When true only owners can invite new players, when false all members area allowed
|
1713
|
+
* to invite.
|
1714
|
+
*/
|
1715
|
+
RestrictInvitesToLobbyOwner: boolean;
|
1716
|
+
/** Search data. */
|
1717
|
+
SearchData?: Record<string, string | null>;
|
1718
|
+
/** Preview: Lobby joined server. This is not the server owner, rather the server that has joined a client owned lobby. */
|
1719
|
+
Server?: LobbyServer;
|
1720
|
+
/** A flag which determines if connections are used. Defaults to true. Only set on create. */
|
1721
|
+
UseConnections: boolean;
|
1722
|
+
}
|
1723
|
+
interface LobbyEmptyResult extends IPlayFabResultCommon {
|
1724
|
+
}
|
1725
|
+
interface LobbyServer {
|
1726
|
+
/** Opaque string, stored on a Subscribe call, which indicates the connection a joined server has with PubSub. */
|
1727
|
+
PubSubConnectionHandle?: string;
|
1728
|
+
/** Key-value pairs specific to the joined server. */
|
1729
|
+
ServerData?: Record<string, string | null>;
|
1730
|
+
/** The server entity key. */
|
1731
|
+
ServerEntity?: EntityKey;
|
1732
|
+
}
|
1733
|
+
interface LobbySummary {
|
1734
|
+
/**
|
1735
|
+
* A string used to join the lobby.This field is populated by the Lobby service.Invites are performed by communicating this
|
1736
|
+
* connectionString to other players.
|
1737
|
+
*/
|
1738
|
+
ConnectionString: string;
|
1739
|
+
/** The current number of players in the lobby. */
|
1740
|
+
CurrentPlayers: number;
|
1741
|
+
/** Id to uniquely identify a lobby. */
|
1742
|
+
LobbyId: string;
|
1743
|
+
/** The maximum number of players allowed in the lobby. */
|
1744
|
+
MaxPlayers: number;
|
1745
|
+
/** A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining. */
|
1746
|
+
MembershipLock?: string;
|
1747
|
+
/** The client or server entity which owns this lobby. */
|
1748
|
+
Owner: EntityKey;
|
1749
|
+
/** Search data. */
|
1750
|
+
SearchData?: Record<string, string | null>;
|
1751
|
+
}
|
1752
|
+
interface MatchmakingPlayer {
|
1753
|
+
/** The user's attributes custom to the title. */
|
1754
|
+
Attributes?: MatchmakingPlayerAttributes;
|
1755
|
+
/** The entity key of the matchmaking user. */
|
1756
|
+
Entity: EntityKey;
|
1757
|
+
}
|
1758
|
+
interface MatchmakingPlayerAttributes {
|
1759
|
+
/** A data object representing a user's attributes. */
|
1760
|
+
DataObject?: any;
|
1761
|
+
/** An escaped data object representing a user's attributes. */
|
1762
|
+
EscapedDataObject?: string;
|
1763
|
+
}
|
1764
|
+
interface MatchmakingPlayerWithTeamAssignment {
|
1765
|
+
/**
|
1766
|
+
* The user's attributes custom to the title. These attributes will be null unless the request has ReturnMemberAttributes
|
1767
|
+
* flag set to true.
|
1768
|
+
*/
|
1769
|
+
Attributes?: MatchmakingPlayerAttributes;
|
1770
|
+
/** The entity key of the matchmaking user. */
|
1771
|
+
Entity: EntityKey;
|
1772
|
+
/** The Id of the team the User is assigned to. */
|
1773
|
+
TeamId?: string;
|
1774
|
+
}
|
1775
|
+
interface MatchmakingQueueConfig {
|
1776
|
+
/** This is the buildAlias that will be used to allocate the multiplayer server for the match. */
|
1777
|
+
BuildAliasParams?: BuildAliasParams;
|
1778
|
+
/** This is the buildId that will be used to allocate the multiplayer server for the match. */
|
1779
|
+
BuildId?: string;
|
1780
|
+
/** List of difference rules used to find an optimal match. */
|
1781
|
+
DifferenceRules?: DifferenceRule[];
|
1782
|
+
/** List of match total rules used to find an optimal match. */
|
1783
|
+
MatchTotalRules?: MatchTotalRule[];
|
1784
|
+
/** Maximum number of players in a match. */
|
1785
|
+
MaxMatchSize: number;
|
1786
|
+
/** Maximum number of players in a ticket. Optional. */
|
1787
|
+
MaxTicketSize?: number;
|
1788
|
+
/** Minimum number of players in a match. */
|
1789
|
+
MinMatchSize: number;
|
1790
|
+
/** Unique identifier for a Queue. Chosen by the developer. */
|
1791
|
+
Name: string;
|
1792
|
+
/** Region selection rule used to find an optimal match. */
|
1793
|
+
RegionSelectionRule?: RegionSelectionRule;
|
1794
|
+
/** Boolean flag to enable server allocation for the queue. */
|
1795
|
+
ServerAllocationEnabled: boolean;
|
1796
|
+
/** List of set intersection rules used to find an optimal match. */
|
1797
|
+
SetIntersectionRules?: SetIntersectionRule[];
|
1798
|
+
/** Controls which statistics are visible to players. */
|
1799
|
+
StatisticsVisibilityToPlayers?: StatisticsVisibilityToPlayers;
|
1800
|
+
/** List of string equality rules used to find an optimal match. */
|
1801
|
+
StringEqualityRules?: StringEqualityRule[];
|
1802
|
+
/** List of team difference rules used to find an optimal match. */
|
1803
|
+
TeamDifferenceRules?: TeamDifferenceRule[];
|
1804
|
+
/** The team configuration for a match. This may be null if there are no teams. */
|
1805
|
+
Teams?: MatchmakingQueueTeam[];
|
1806
|
+
/** Team size balance rule used to find an optimal match. */
|
1807
|
+
TeamSizeBalanceRule?: TeamSizeBalanceRule;
|
1808
|
+
/** Team ticket size similarity rule used to find an optimal match. */
|
1809
|
+
TeamTicketSizeSimilarityRule?: TeamTicketSizeSimilarityRule;
|
1810
|
+
}
|
1811
|
+
interface MatchmakingQueueTeam {
|
1812
|
+
/** The maximum number of players required for the team. */
|
1813
|
+
MaxTeamSize: number;
|
1814
|
+
/** The minimum number of players required for the team. */
|
1815
|
+
MinTeamSize: number;
|
1816
|
+
/** A name to identify the team. This is case insensitive. */
|
1817
|
+
Name: string;
|
1818
|
+
}
|
1819
|
+
interface MatchTotalRule {
|
1820
|
+
/** Description of the attribute used by this rule to match tickets. */
|
1821
|
+
Attribute: QueueRuleAttribute;
|
1822
|
+
/** Collection of fields relating to expanding this rule at set intervals. */
|
1823
|
+
Expansion?: MatchTotalRuleExpansion;
|
1824
|
+
/** The maximum total value for a group. Must be >= Min. */
|
1825
|
+
Max: number;
|
1826
|
+
/** The minimum total value for a group. Must be >=2. */
|
1827
|
+
Min: number;
|
1828
|
+
/** Friendly name chosen by developer. */
|
1829
|
+
Name: string;
|
1830
|
+
/**
|
1831
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
1832
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
1833
|
+
*/
|
1834
|
+
SecondsUntilOptional?: number;
|
1835
|
+
/** The relative weight of this rule compared to others. */
|
1836
|
+
Weight: number;
|
1837
|
+
}
|
1838
|
+
interface MatchTotalRuleExpansion {
|
1839
|
+
/** Manually specify the values to use for each expansion interval. When this is set, Max is ignored. */
|
1840
|
+
MaxOverrides?: OverrideDouble[];
|
1841
|
+
/** Manually specify the values to use for each expansion interval. When this is set, Min is ignored. */
|
1842
|
+
MinOverrides?: OverrideDouble[];
|
1843
|
+
/** How many seconds before this rule is expanded. */
|
1844
|
+
SecondsBetweenExpansions: number;
|
1845
|
+
}
|
1846
|
+
interface Member {
|
1847
|
+
/** Key-value pairs specific to member. */
|
1848
|
+
MemberData?: Record<string, string | null>;
|
1849
|
+
/** The member entity key. */
|
1850
|
+
MemberEntity?: EntityKey;
|
1851
|
+
/** Opaque string, stored on a Subscribe call, which indicates the connection an owner or member has with PubSub. */
|
1852
|
+
PubSubConnectionHandle?: string;
|
1853
|
+
}
|
1854
|
+
interface MonitoringApplicationConfiguration {
|
1855
|
+
/** Asset which contains the monitoring application files and scripts. */
|
1856
|
+
AssetReference: AssetReference;
|
1857
|
+
/** Execution script name, this will be the main executable for the monitoring application. */
|
1858
|
+
ExecutionScriptName: string;
|
1859
|
+
/** Installation script name, this will be run before the ExecutionScript. */
|
1860
|
+
InstallationScriptName?: string;
|
1861
|
+
/** Timespan the monitoring application will be kept alive when running from the start of the VM */
|
1862
|
+
OnStartRuntimeInMinutes?: number;
|
1863
|
+
}
|
1864
|
+
interface MonitoringApplicationConfigurationParams {
|
1865
|
+
/** Asset which contains the monitoring application files and scripts. */
|
1866
|
+
AssetReference: AssetReferenceParams;
|
1867
|
+
/** Execution script name, this will be the main executable for the monitoring application. */
|
1868
|
+
ExecutionScriptName: string;
|
1869
|
+
/** Installation script name, this will be run before the ExecutionScript. */
|
1870
|
+
InstallationScriptName?: string;
|
1871
|
+
/** Timespan the monitoring application will be kept alive when running from the start of the VM */
|
1872
|
+
OnStartRuntimeInMinutes?: number;
|
1873
|
+
}
|
1874
|
+
interface MultiplayerServerSummary {
|
1875
|
+
/** The connected players in the multiplayer server. */
|
1876
|
+
ConnectedPlayers?: ConnectedPlayer[];
|
1877
|
+
/** The time (UTC) at which a change in the multiplayer server state was observed. */
|
1878
|
+
LastStateTransitionTime?: string;
|
1879
|
+
/** The region the multiplayer server is located in. */
|
1880
|
+
Region?: string;
|
1881
|
+
/** The string server ID of the multiplayer server generated by PlayFab. */
|
1882
|
+
ServerId?: string;
|
1883
|
+
/** The title generated guid string session ID of the multiplayer server. */
|
1884
|
+
SessionId?: string;
|
1885
|
+
/** The state of the multiplayer server. */
|
1886
|
+
State?: string;
|
1887
|
+
/** The virtual machine ID that the multiplayer server is located on. */
|
1888
|
+
VmId?: string;
|
1889
|
+
}
|
1890
|
+
interface OverrideDouble {
|
1891
|
+
/** The custom expansion value. */
|
1892
|
+
Value: number;
|
1893
|
+
}
|
1894
|
+
interface OverrideUnsignedInt {
|
1895
|
+
/** The custom expansion value. */
|
1896
|
+
Value: number;
|
1897
|
+
}
|
1898
|
+
interface PaginationRequest {
|
1899
|
+
/** Continuation token returned as a result in a previous FindLobbies call. Cannot be specified by clients. */
|
1900
|
+
ContinuationToken?: string;
|
1901
|
+
/** The number of lobbies that should be retrieved. Cannot be specified by servers, clients may specify any value up to 50 */
|
1902
|
+
PageSizeRequested?: number;
|
1903
|
+
}
|
1904
|
+
interface PaginationResponse {
|
1905
|
+
/** Continuation token returned by server call. Not returned for clients */
|
1906
|
+
ContinuationToken?: string;
|
1907
|
+
/** The number of lobbies that matched the search request. */
|
1908
|
+
TotalMatchedLobbyCount?: number;
|
1909
|
+
}
|
1910
|
+
interface PartyInvitationConfiguration {
|
1911
|
+
/**
|
1912
|
+
* The list of PlayFab EntityKeys that the invitation allows to authenticate into the network. If this list is empty, all
|
1913
|
+
* users are allowed to authenticate using the invitation's identifier. This list may contain no more than 1024 items.
|
1914
|
+
*/
|
1915
|
+
EntityKeys?: EntityKey[];
|
1916
|
+
/** The invite identifier for this party. If this value is specified, it must be no longer than 127 characters. */
|
1917
|
+
Identifier?: string;
|
1918
|
+
/** Controls which participants can revoke this invite. */
|
1919
|
+
Revocability?: string;
|
1920
|
+
}
|
1921
|
+
interface PartyNetworkConfiguration {
|
1922
|
+
/** Controls whether and how to support direct peer-to-peer connection attempts among devices in the network. */
|
1923
|
+
DirectPeerConnectivityOptions?: string;
|
1924
|
+
/** The maximum number of devices allowed to connect to the network. Must be between 1 and 128, inclusive. */
|
1925
|
+
MaxDevices: number;
|
1926
|
+
/** The maximum number of devices allowed per user. Must be greater than 0. */
|
1927
|
+
MaxDevicesPerUser: number;
|
1928
|
+
/** The maximum number of endpoints allowed per device. Must be between 0 and 32, inclusive. */
|
1929
|
+
MaxEndpointsPerDevice: number;
|
1930
|
+
/** The maximum number of unique users allowed in the network. Must be greater than 0. */
|
1931
|
+
MaxUsers: number;
|
1932
|
+
/** The maximum number of users allowed per device. Must be between 1 and 8, inclusive. */
|
1933
|
+
MaxUsersPerDevice: number;
|
1934
|
+
/**
|
1935
|
+
* An optionally-specified configuration for the initial invitation for this party. If not provided, default configuration
|
1936
|
+
* values will be used: a title-unique invitation identifier will be generated, the revocability will be Anyone, and the
|
1937
|
+
* EntityID list will be empty.
|
1938
|
+
*/
|
1939
|
+
PartyInvitationConfiguration?: PartyInvitationConfiguration;
|
1940
|
+
}
|
1941
|
+
interface Port {
|
1942
|
+
/** The name for the port. */
|
1943
|
+
Name: string;
|
1944
|
+
/** The number for the port. */
|
1945
|
+
Num: number;
|
1946
|
+
/** The protocol for the port. */
|
1947
|
+
Protocol: string;
|
1948
|
+
}
|
1949
|
+
interface PublicIpAddress {
|
1950
|
+
/** FQDN of the public IP */
|
1951
|
+
FQDN: string;
|
1952
|
+
/** Server IP Address */
|
1953
|
+
IpAddress: string;
|
1954
|
+
/** Routing Type of the public IP. */
|
1955
|
+
RoutingType: string;
|
1956
|
+
}
|
1957
|
+
interface QosServer {
|
1958
|
+
/** The region the QoS server is located in. */
|
1959
|
+
Region?: string;
|
1960
|
+
/** The QoS server URL. */
|
1961
|
+
ServerUrl?: string;
|
1962
|
+
}
|
1963
|
+
interface QueueRuleAttribute {
|
1964
|
+
/** Specifies which attribute in a ticket to use. */
|
1965
|
+
Path: string;
|
1966
|
+
/** Specifies which source the attribute comes from. */
|
1967
|
+
Source: string;
|
1968
|
+
}
|
1969
|
+
interface QuotaChange {
|
1970
|
+
/** A brief description of the requested changes. */
|
1971
|
+
ChangeDescription?: string;
|
1972
|
+
/** Requested changes to make to the titles cores quota. */
|
1973
|
+
Changes?: CoreCapacityChange[];
|
1974
|
+
/** Whether or not this request is pending a review. */
|
1975
|
+
IsPendingReview: boolean;
|
1976
|
+
/** Additional information about this request that our team can use to better understand the requirements. */
|
1977
|
+
Notes?: string;
|
1978
|
+
/** Id of the change request. */
|
1979
|
+
RequestId?: string;
|
1980
|
+
/** Comments by our team when a request is reviewed. */
|
1981
|
+
ReviewComments?: string;
|
1982
|
+
/** Whether or not this request was approved. */
|
1983
|
+
WasApproved: boolean;
|
1984
|
+
}
|
1985
|
+
interface RegionSelectionRule {
|
1986
|
+
/**
|
1987
|
+
* Controls how the Max Latency parameter expands over time. Only one expansion can be set per rule. When this is set,
|
1988
|
+
* MaxLatency is ignored.
|
1989
|
+
*/
|
1990
|
+
CustomExpansion?: CustomRegionSelectionRuleExpansion;
|
1991
|
+
/** Controls how the Max Latency parameter expands over time. Only one expansion can be set per rule. */
|
1992
|
+
LinearExpansion?: LinearRegionSelectionRuleExpansion;
|
1993
|
+
/** Specifies the maximum latency that is allowed between the client and the selected server. The value is in milliseconds. */
|
1994
|
+
MaxLatency: number;
|
1995
|
+
/** Friendly name chosen by developer. */
|
1996
|
+
Name: string;
|
1997
|
+
/** Specifies which attribute in a ticket to use. */
|
1998
|
+
Path: string;
|
1999
|
+
/**
|
2000
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
2001
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
2002
|
+
*/
|
2003
|
+
SecondsUntilOptional?: number;
|
2004
|
+
/** The relative weight of this rule compared to others. */
|
2005
|
+
Weight: number;
|
2006
|
+
}
|
2007
|
+
interface RemoveMatchmakingQueueRequest extends IPlayFabRequestCommon {
|
2008
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2009
|
+
CustomTags?: Record<string, string | null>;
|
2010
|
+
/** The Id of the matchmaking queue to remove. */
|
2011
|
+
QueueName?: string;
|
2012
|
+
}
|
2013
|
+
interface RemoveMatchmakingQueueResult extends IPlayFabResultCommon {
|
2014
|
+
}
|
2015
|
+
interface RemoveMemberFromLobbyRequest extends IPlayFabRequestCommon {
|
2016
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2017
|
+
CustomTags?: Record<string, string | null>;
|
2018
|
+
/** The id of the lobby. */
|
2019
|
+
LobbyId?: string;
|
2020
|
+
/** The member entity to be removed from the lobby. */
|
2021
|
+
MemberEntity?: EntityKey;
|
2022
|
+
/** If true, removed member can never rejoin this lobby. */
|
2023
|
+
PreventRejoin: boolean;
|
2024
|
+
}
|
2025
|
+
interface RequestMultiplayerServerRequest extends IPlayFabRequestCommon {
|
2026
|
+
/** The identifiers of the build alias to use for the request. */
|
2027
|
+
BuildAliasParams?: BuildAliasParams;
|
2028
|
+
/** The guid string build ID of the multiplayer server to request. */
|
2029
|
+
BuildId?: string;
|
2030
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2031
|
+
CustomTags?: Record<string, string | null>;
|
2032
|
+
/**
|
2033
|
+
* Initial list of players (potentially matchmade) allowed to connect to the game. This list is passed to the game server
|
2034
|
+
* when requested (via GSDK) and can be used to validate players connecting to it.
|
2035
|
+
*/
|
2036
|
+
InitialPlayers?: string[];
|
2037
|
+
/**
|
2038
|
+
* The preferred regions to request a multiplayer server from. The Multiplayer Service will iterate through the regions in
|
2039
|
+
* the specified order and allocate a server from the first one that has servers available.
|
2040
|
+
*/
|
2041
|
+
PreferredRegions: string[];
|
2042
|
+
/**
|
2043
|
+
* Data encoded as a string that is passed to the game server when requested. This can be used to to communicate
|
2044
|
+
* information such as game mode or map through the request flow.
|
2045
|
+
*/
|
2046
|
+
SessionCookie?: string;
|
2047
|
+
/** A guid string session ID created track the multiplayer server session over its life. */
|
2048
|
+
SessionId: string;
|
2049
|
+
}
|
2050
|
+
interface RequestMultiplayerServerResponse extends IPlayFabResultCommon {
|
2051
|
+
/** The identity of the build in which the server was allocated. */
|
2052
|
+
BuildId?: string;
|
2053
|
+
/** The connected players in the multiplayer server. */
|
2054
|
+
ConnectedPlayers?: ConnectedPlayer[];
|
2055
|
+
/** The fully qualified domain name of the virtual machine that is hosting this multiplayer server. */
|
2056
|
+
FQDN?: string;
|
2057
|
+
/** The public IPv4 address of the virtual machine that is hosting this multiplayer server. */
|
2058
|
+
IPV4Address?: string;
|
2059
|
+
/** The time (UTC) at which a change in the multiplayer server state was observed. */
|
2060
|
+
LastStateTransitionTime?: string;
|
2061
|
+
/** The ports the multiplayer server uses. */
|
2062
|
+
Ports?: Port[];
|
2063
|
+
/** The list of public Ipv4 addresses associated with the server. */
|
2064
|
+
PublicIPV4Addresses?: PublicIpAddress[];
|
2065
|
+
/** The region the multiplayer server is located in. */
|
2066
|
+
Region?: string;
|
2067
|
+
/** The string server ID of the multiplayer server generated by PlayFab. */
|
2068
|
+
ServerId?: string;
|
2069
|
+
/** The guid string session ID of the multiplayer server. */
|
2070
|
+
SessionId?: string;
|
2071
|
+
/** The state of the multiplayer server. */
|
2072
|
+
State?: string;
|
2073
|
+
/** The virtual machine ID that the multiplayer server is located on. */
|
2074
|
+
VmId?: string;
|
2075
|
+
}
|
2076
|
+
interface RequestPartyServiceRequest extends IPlayFabRequestCommon {
|
2077
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2078
|
+
CustomTags?: Record<string, string | null>;
|
2079
|
+
/** The network configuration for this request. */
|
2080
|
+
NetworkConfiguration: PartyNetworkConfiguration;
|
2081
|
+
/** A guid string party ID created track the party session over its life. */
|
2082
|
+
PartyId?: string;
|
2083
|
+
/**
|
2084
|
+
* The preferred regions to request a party session from. The party service will iterate through the regions in the
|
2085
|
+
* specified order and allocate a party session from the first one that is available.
|
2086
|
+
*/
|
2087
|
+
PreferredRegions: string[];
|
2088
|
+
}
|
2089
|
+
interface RequestPartyServiceResponse extends IPlayFabResultCommon {
|
2090
|
+
/**
|
2091
|
+
* The invitation identifier supplied in the PartyInvitationConfiguration, or the PlayFab-generated guid if none was
|
2092
|
+
* supplied.
|
2093
|
+
*/
|
2094
|
+
InvitationId?: string;
|
2095
|
+
/** The guid string party ID of the party session. */
|
2096
|
+
PartyId?: string;
|
2097
|
+
/** A base-64 encoded string containing the serialized network descriptor for this party. */
|
2098
|
+
SerializedNetworkDescriptor?: string;
|
2099
|
+
}
|
2100
|
+
interface RolloverContainerRegistryCredentialsRequest extends IPlayFabRequestCommon {
|
2101
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2102
|
+
CustomTags?: Record<string, string | null>;
|
2103
|
+
}
|
2104
|
+
interface RolloverContainerRegistryCredentialsResponse extends IPlayFabResultCommon {
|
2105
|
+
/** The url of the container registry. */
|
2106
|
+
DnsName?: string;
|
2107
|
+
/** The password for accessing the container registry. */
|
2108
|
+
Password?: string;
|
2109
|
+
/** The username for accessing the container registry. */
|
2110
|
+
Username?: string;
|
2111
|
+
}
|
2112
|
+
interface Schedule {
|
2113
|
+
/** A short description about this schedule. For example, "Game launch on July 15th". */
|
2114
|
+
Description?: string;
|
2115
|
+
/**
|
2116
|
+
* The date and time in UTC at which the schedule ends. If IsRecurringWeekly is true, this schedule will keep renewing for
|
2117
|
+
* future weeks until disabled or removed.
|
2118
|
+
*/
|
2119
|
+
EndTime: string;
|
2120
|
+
/** Disables the schedule. */
|
2121
|
+
IsDisabled: boolean;
|
2122
|
+
/** If true, the StartTime and EndTime will get renewed every week. */
|
2123
|
+
IsRecurringWeekly: boolean;
|
2124
|
+
/** The date and time in UTC at which the schedule starts. */
|
2125
|
+
StartTime: string;
|
2126
|
+
/** The standby target to maintain for the duration of the schedule. */
|
2127
|
+
TargetStandby: number;
|
2128
|
+
}
|
2129
|
+
interface ScheduledStandbySettings {
|
2130
|
+
/** When true, scheduled standby will be enabled */
|
2131
|
+
IsEnabled: boolean;
|
2132
|
+
/** A list of non-overlapping schedules */
|
2133
|
+
ScheduleList?: Schedule[];
|
2134
|
+
}
|
2135
|
+
interface Secret {
|
2136
|
+
/** Optional secret expiration date. */
|
2137
|
+
ExpirationDate?: string;
|
2138
|
+
/** A name for the secret. This is used to reference secrets in build configurations. */
|
2139
|
+
Name: string;
|
2140
|
+
/** Secret value. */
|
2141
|
+
Value: string;
|
2142
|
+
}
|
2143
|
+
interface SecretSummary {
|
2144
|
+
/** Optional secret expiration date. */
|
2145
|
+
ExpirationDate?: string;
|
2146
|
+
/** The name of the secret. */
|
2147
|
+
Name?: string;
|
2148
|
+
/** The secret version auto-generated after upload. */
|
2149
|
+
Version?: string;
|
2150
|
+
}
|
2151
|
+
interface ServerDetails {
|
2152
|
+
/** The fully qualified domain name of the virtual machine that is hosting this multiplayer server. */
|
2153
|
+
Fqdn?: string;
|
2154
|
+
/** The IPv4 address of the virtual machine that is hosting this multiplayer server. */
|
2155
|
+
IPV4Address?: string;
|
2156
|
+
/** The ports the multiplayer server uses. */
|
2157
|
+
Ports?: Port[];
|
2158
|
+
/** The server's region. */
|
2159
|
+
Region?: string;
|
2160
|
+
/** The string server ID of the multiplayer server generated by PlayFab. */
|
2161
|
+
ServerId?: string;
|
2162
|
+
}
|
2163
|
+
interface ServerResourceConstraintParams {
|
2164
|
+
/** The maximum number of cores that each server is allowed to use. */
|
2165
|
+
CpuLimit: number;
|
2166
|
+
/**
|
2167
|
+
* The maximum number of GiB of memory that each server is allowed to use. WARNING: After exceeding this limit, the server
|
2168
|
+
* will be killed
|
2169
|
+
*/
|
2170
|
+
MemoryLimitGB: number;
|
2171
|
+
}
|
2172
|
+
interface SetIntersectionRule {
|
2173
|
+
/** Description of the attribute used by this rule to match tickets. */
|
2174
|
+
Attribute: QueueRuleAttribute;
|
2175
|
+
/**
|
2176
|
+
* Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
|
2177
|
+
* profile.
|
2178
|
+
*/
|
2179
|
+
AttributeNotSpecifiedBehavior: string;
|
2180
|
+
/**
|
2181
|
+
* Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this
|
2182
|
+
* is set, MinIntersectionSize is ignored.
|
2183
|
+
*/
|
2184
|
+
CustomExpansion?: CustomSetIntersectionRuleExpansion;
|
2185
|
+
/**
|
2186
|
+
* The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that
|
2187
|
+
* AttributeNotSpecifiedBehavior is UseDefault). Values must be unique.
|
2188
|
+
*/
|
2189
|
+
DefaultAttributeValue?: string[];
|
2190
|
+
/** Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. */
|
2191
|
+
LinearExpansion?: LinearSetIntersectionRuleExpansion;
|
2192
|
+
/** The minimum number of values that must match between sets. */
|
2193
|
+
MinIntersectionSize: number;
|
2194
|
+
/** Friendly name chosen by developer. */
|
2195
|
+
Name: string;
|
2196
|
+
/**
|
2197
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
2198
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
2199
|
+
*/
|
2200
|
+
SecondsUntilOptional?: number;
|
2201
|
+
/** The relative weight of this rule compared to others. */
|
2202
|
+
Weight: number;
|
2203
|
+
}
|
2204
|
+
interface SetMatchmakingQueueRequest extends IPlayFabRequestCommon {
|
2205
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2206
|
+
CustomTags?: Record<string, string | null>;
|
2207
|
+
/** The matchmaking queue config. */
|
2208
|
+
MatchmakingQueue: MatchmakingQueueConfig;
|
2209
|
+
}
|
2210
|
+
interface SetMatchmakingQueueResult extends IPlayFabResultCommon {
|
2211
|
+
}
|
2212
|
+
interface ShutdownMultiplayerServerRequest extends IPlayFabRequestCommon {
|
2213
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2214
|
+
CustomTags?: Record<string, string | null>;
|
2215
|
+
/** A guid string session ID of the multiplayer server to shut down. */
|
2216
|
+
SessionId: string;
|
2217
|
+
}
|
2218
|
+
interface Statistics {
|
2219
|
+
/** The average. */
|
2220
|
+
Average: number;
|
2221
|
+
/** The 50th percentile. */
|
2222
|
+
Percentile50: number;
|
2223
|
+
/** The 90th percentile. */
|
2224
|
+
Percentile90: number;
|
2225
|
+
/** The 99th percentile. */
|
2226
|
+
Percentile99: number;
|
2227
|
+
}
|
2228
|
+
interface StatisticsVisibilityToPlayers {
|
2229
|
+
/** Whether to allow players to view the current number of players in the matchmaking queue. */
|
2230
|
+
ShowNumberOfPlayersMatching: boolean;
|
2231
|
+
/** Whether to allow players to view statistics representing the time it takes for tickets to find a match. */
|
2232
|
+
ShowTimeToMatch: boolean;
|
2233
|
+
}
|
2234
|
+
interface StringEqualityRule {
|
2235
|
+
/** Description of the attribute used by this rule to match tickets. */
|
2236
|
+
Attribute: QueueRuleAttribute;
|
2237
|
+
/**
|
2238
|
+
* Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
|
2239
|
+
* profile.
|
2240
|
+
*/
|
2241
|
+
AttributeNotSpecifiedBehavior: string;
|
2242
|
+
/**
|
2243
|
+
* The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that
|
2244
|
+
* AttributeNotSpecifiedBehavior is false).
|
2245
|
+
*/
|
2246
|
+
DefaultAttributeValue?: string;
|
2247
|
+
/**
|
2248
|
+
* Collection of fields relating to expanding this rule at set intervals. For StringEqualityRules, this is limited to
|
2249
|
+
* turning the rule off or on during different intervals.
|
2250
|
+
*/
|
2251
|
+
Expansion?: StringEqualityRuleExpansion;
|
2252
|
+
/** Friendly name chosen by developer. */
|
2253
|
+
Name: string;
|
2254
|
+
/**
|
2255
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
2256
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
2257
|
+
*/
|
2258
|
+
SecondsUntilOptional?: number;
|
2259
|
+
/** The relative weight of this rule compared to others. */
|
2260
|
+
Weight: number;
|
2261
|
+
}
|
2262
|
+
interface StringEqualityRuleExpansion {
|
2263
|
+
/** List of bools specifying whether the rule is applied during this expansion. */
|
2264
|
+
EnabledOverrides: boolean[];
|
2265
|
+
/** How many seconds before this rule is expanded. */
|
2266
|
+
SecondsBetweenExpansions: number;
|
2267
|
+
}
|
2268
|
+
interface SubscribeToLobbyResourceRequest extends IPlayFabRequestCommon {
|
2269
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2270
|
+
CustomTags?: Record<string, string | null>;
|
2271
|
+
/** The entity performing the subscription. */
|
2272
|
+
EntityKey: EntityKey;
|
2273
|
+
/** Opaque string, given to a client upon creating a connection with PubSub. */
|
2274
|
+
PubSubConnectionHandle: string;
|
2275
|
+
/**
|
2276
|
+
* The name of the resource to subscribe to. For LobbyChange subscriptions this is the lobbyId. For LobbyInvite
|
2277
|
+
* subscriptions this should always be "@me".
|
2278
|
+
*/
|
2279
|
+
ResourceId: string;
|
2280
|
+
/** Version number for the subscription of this resource. */
|
2281
|
+
SubscriptionVersion: number;
|
2282
|
+
/**
|
2283
|
+
* Subscription type. "LobbyChange" subscriptions allow a member or owner to receive notifications of lobby data, member or
|
2284
|
+
* owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a
|
2285
|
+
* member of a lobby to receive lobby invites.
|
2286
|
+
*/
|
2287
|
+
Type: string;
|
2288
|
+
}
|
2289
|
+
interface SubscribeToLobbyResourceResult extends IPlayFabResultCommon {
|
2290
|
+
/** Topic will be returned in all notifications that are the result of this subscription. */
|
2291
|
+
Topic: string;
|
2292
|
+
}
|
2293
|
+
interface SubscribeToMatchResourceRequest extends IPlayFabRequestCommon {
|
2294
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2295
|
+
CustomTags?: Record<string, string | null>;
|
2296
|
+
/** The entity performing the subscription. The entity must be authorized to use this connectionHandle. */
|
2297
|
+
EntityKey: EntityKey;
|
2298
|
+
/**
|
2299
|
+
* Opaque string, given to a client upon creating a connection with PubSub. Notifications will be sent to the connection
|
2300
|
+
* associated with this handle.
|
2301
|
+
*/
|
2302
|
+
PubSubConnectionHandle: string;
|
2303
|
+
/**
|
2304
|
+
* The name of the resource to subscribe to. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange. For
|
2305
|
+
* MatchInvite, ResourceId is @me.
|
2306
|
+
*/
|
2307
|
+
ResourceId: string;
|
2308
|
+
/** Version number for the subscription of this resource. Current supported version must be 1. */
|
2309
|
+
SubscriptionVersion: number;
|
2310
|
+
/**
|
2311
|
+
* Subscription type. MatchInvite subscriptions are per-player. MatchTicketStatusChange subscriptions are per-ticket.
|
2312
|
+
* Subscribe calls are idempotent. Subscribing on the same resource for the same connection results in success.
|
2313
|
+
*/
|
2314
|
+
Type: string;
|
2315
|
+
}
|
2316
|
+
interface SubscribeToMatchResourceResult extends IPlayFabResultCommon {
|
2317
|
+
/** Matchmaking resource */
|
2318
|
+
Topic: string;
|
2319
|
+
}
|
2320
|
+
interface TeamDifferenceRule {
|
2321
|
+
/** Description of the attribute used by this rule to match teams. */
|
2322
|
+
Attribute: QueueRuleAttribute;
|
2323
|
+
/**
|
2324
|
+
* Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this
|
2325
|
+
* is set, Difference is ignored.
|
2326
|
+
*/
|
2327
|
+
CustomExpansion?: CustomTeamDifferenceRuleExpansion;
|
2328
|
+
/**
|
2329
|
+
* The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that
|
2330
|
+
* AttributeNotSpecifiedBehavior is false).
|
2331
|
+
*/
|
2332
|
+
DefaultAttributeValue: number;
|
2333
|
+
/** The allowed difference between any two teams at the start of matchmaking. */
|
2334
|
+
Difference: number;
|
2335
|
+
/** Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. */
|
2336
|
+
LinearExpansion?: LinearTeamDifferenceRuleExpansion;
|
2337
|
+
/** Friendly name chosen by developer. */
|
2338
|
+
Name: string;
|
2339
|
+
/**
|
2340
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
2341
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
2342
|
+
*/
|
2343
|
+
SecondsUntilOptional?: number;
|
2344
|
+
}
|
2345
|
+
interface TeamSizeBalanceRule {
|
2346
|
+
/**
|
2347
|
+
* Controls how the Difference parameter expands over time. Only one expansion can be set per rule. When this is set,
|
2348
|
+
* Difference is ignored.
|
2349
|
+
*/
|
2350
|
+
CustomExpansion?: CustomTeamSizeBalanceRuleExpansion;
|
2351
|
+
/** The allowed difference in team size between any two teams. */
|
2352
|
+
Difference: number;
|
2353
|
+
/** Controls how the Difference parameter expands over time. Only one expansion can be set per rule. */
|
2354
|
+
LinearExpansion?: LinearTeamSizeBalanceRuleExpansion;
|
2355
|
+
/** Friendly name chosen by developer. */
|
2356
|
+
Name: string;
|
2357
|
+
/**
|
2358
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
2359
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
2360
|
+
*/
|
2361
|
+
SecondsUntilOptional?: number;
|
2362
|
+
}
|
2363
|
+
interface TeamTicketSizeSimilarityRule {
|
2364
|
+
/** Friendly name chosen by developer. */
|
2365
|
+
Name: string;
|
2366
|
+
/**
|
2367
|
+
* How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
|
2368
|
+
* prioritized over those that don't). Leave blank if this rule is always enforced.
|
2369
|
+
*/
|
2370
|
+
SecondsUntilOptional?: number;
|
2371
|
+
}
|
2372
|
+
interface TitleMultiplayerServersQuotas {
|
2373
|
+
/** The core capacity for the various regions and VM Family */
|
2374
|
+
CoreCapacities?: CoreCapacity[];
|
2375
|
+
}
|
2376
|
+
interface UnsubscribeFromLobbyResourceRequest extends IPlayFabRequestCommon {
|
2377
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2378
|
+
CustomTags?: Record<string, string | null>;
|
2379
|
+
/** The entity which performed the subscription. */
|
2380
|
+
EntityKey: EntityKey;
|
2381
|
+
/** Opaque string, given to a client upon creating a connection with PubSub. */
|
2382
|
+
PubSubConnectionHandle: string;
|
2383
|
+
/** The name of the resource to unsubscribe from. */
|
2384
|
+
ResourceId: string;
|
2385
|
+
/** Version number passed for the subscription of this resource. */
|
2386
|
+
SubscriptionVersion: number;
|
2387
|
+
/** Subscription type. */
|
2388
|
+
Type: string;
|
2389
|
+
}
|
2390
|
+
interface UnsubscribeFromMatchResourceRequest extends IPlayFabRequestCommon {
|
2391
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2392
|
+
CustomTags?: Record<string, string | null>;
|
2393
|
+
/** The entity performing the unsubscription. The entity must be authorized to use this connectionHandle. */
|
2394
|
+
EntityKey: EntityKey;
|
2395
|
+
/** Opaque string, given to a client upon creating a connection with PubSub. */
|
2396
|
+
PubSubConnectionHandle: string;
|
2397
|
+
/**
|
2398
|
+
* The name of the resource to unsubscribe from. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange.
|
2399
|
+
* For MatchInvite, ResourceId is @me.
|
2400
|
+
*/
|
2401
|
+
ResourceId: string;
|
2402
|
+
/** Version number for the unsubscription from this resource. */
|
2403
|
+
SubscriptionVersion: number;
|
2404
|
+
/** Type of the subscription to be canceled. */
|
2405
|
+
Type: string;
|
2406
|
+
}
|
2407
|
+
interface UnsubscribeFromMatchResourceResult extends IPlayFabResultCommon {
|
2408
|
+
}
|
2409
|
+
interface UntagContainerImageRequest extends IPlayFabRequestCommon {
|
2410
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2411
|
+
CustomTags?: Record<string, string | null>;
|
2412
|
+
/** The container image which tag we want to remove. */
|
2413
|
+
ImageName?: string;
|
2414
|
+
/** The tag we want to remove. */
|
2415
|
+
Tag?: string;
|
2416
|
+
}
|
2417
|
+
interface UpdateBuildAliasRequest extends IPlayFabRequestCommon {
|
2418
|
+
/** The guid string alias Id of the alias to be updated. */
|
2419
|
+
AliasId: string;
|
2420
|
+
/** The alias name. */
|
2421
|
+
AliasName?: string;
|
2422
|
+
/** Array of build selection criteria. */
|
2423
|
+
BuildSelectionCriteria?: BuildSelectionCriterion[];
|
2424
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2425
|
+
CustomTags?: Record<string, string | null>;
|
2426
|
+
}
|
2427
|
+
interface UpdateBuildNameRequest extends IPlayFabRequestCommon {
|
2428
|
+
/** The guid string ID of the build we want to update the name of. */
|
2429
|
+
BuildId: string;
|
2430
|
+
/** The build name. */
|
2431
|
+
BuildName: string;
|
2432
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2433
|
+
CustomTags?: Record<string, string | null>;
|
2434
|
+
}
|
2435
|
+
interface UpdateBuildRegionRequest extends IPlayFabRequestCommon {
|
2436
|
+
/** The guid string ID of the build we want to update regions for. */
|
2437
|
+
BuildId: string;
|
2438
|
+
/** The updated region configuration that should be applied to the specified build. */
|
2439
|
+
BuildRegion: BuildRegionParams;
|
2440
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2441
|
+
CustomTags?: Record<string, string | null>;
|
2442
|
+
}
|
2443
|
+
interface UpdateBuildRegionsRequest extends IPlayFabRequestCommon {
|
2444
|
+
/** The guid string ID of the build we want to update regions for. */
|
2445
|
+
BuildId: string;
|
2446
|
+
/** The updated region configuration that should be applied to the specified build. */
|
2447
|
+
BuildRegions: BuildRegionParams[];
|
2448
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2449
|
+
CustomTags?: Record<string, string | null>;
|
2450
|
+
}
|
2451
|
+
interface UpdateLobbyAsServerRequest extends IPlayFabRequestCommon {
|
2452
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2453
|
+
CustomTags?: Record<string, string | null>;
|
2454
|
+
/** The id of the lobby. */
|
2455
|
+
LobbyId: string;
|
2456
|
+
/**
|
2457
|
+
* The private key-value pairs which are visible to all entities in the lobby and modifiable by the joined server.
|
2458
|
+
* Optional. Sets or updates key-value pairs on the lobby. Only the current lobby lobby server can set serverData. Keys may
|
2459
|
+
* be an arbitrary string of at most 30 characters. The total size of all serverData values may not exceed 4096 bytes.
|
2460
|
+
* Values are not individually limited. There can be up to 30 key-value pairs stored here. Keys are case sensitive.
|
2461
|
+
*/
|
2462
|
+
ServerData?: Record<string, string | null>;
|
2463
|
+
/**
|
2464
|
+
* The keys to delete from the lobby serverData. Optional. Optional. Deletes key-value pairs on the lobby. Only the current
|
2465
|
+
* joined lobby server can delete serverData. All the specified keys will be removed from the serverData. Keys that do not
|
2466
|
+
* exist in the lobby are a no-op. If the key to delete exists in the serverData (same request) it will result in a bad
|
2467
|
+
* request.
|
2468
|
+
*/
|
2469
|
+
ServerDataToDelete?: string[];
|
2470
|
+
/**
|
2471
|
+
* The lobby server. Optional. Set a different server as the joined server of the lobby (there can only be 1 joined
|
2472
|
+
* server). When changing the server the previous server will automatically be unsubscribed.
|
2473
|
+
*/
|
2474
|
+
ServerEntity?: EntityKey;
|
2475
|
+
}
|
2476
|
+
interface UpdateLobbyRequest extends IPlayFabRequestCommon {
|
2477
|
+
/**
|
2478
|
+
* The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or
|
2479
|
+
* 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
|
2480
|
+
* means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve
|
2481
|
+
* its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
|
2482
|
+
* join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
|
2483
|
+
*/
|
2484
|
+
AccessPolicy?: string;
|
2485
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2486
|
+
CustomTags?: Record<string, string | null>;
|
2487
|
+
/**
|
2488
|
+
* The private key-value pairs which are visible to all entities in the lobby. Optional. Sets or updates key-value pairs on
|
2489
|
+
* the lobby. Only the current lobby owner can set lobby data. Keys may be an arbitrary string of at most 30 characters.
|
2490
|
+
* The total size of all lobbyData values may not exceed 4096 bytes. Values are not individually limited. There can be up
|
2491
|
+
* to 30 key-value pairs stored here. Keys are case sensitive.
|
2492
|
+
*/
|
2493
|
+
LobbyData?: Record<string, string | null>;
|
2494
|
+
/** The keys to delete from the lobby LobbyData. Optional. Behaves similar to searchDataToDelete, but applies to lobbyData. */
|
2495
|
+
LobbyDataToDelete?: string[];
|
2496
|
+
/** The id of the lobby. */
|
2497
|
+
LobbyId?: string;
|
2498
|
+
/**
|
2499
|
+
* The maximum number of players allowed in the lobby. Updates the maximum allowed number of players in the lobby. Only the
|
2500
|
+
* current lobby owner can set this. If set, the value must be greater than or equal to the number of members currently in
|
2501
|
+
* the lobby.
|
2502
|
+
*/
|
2503
|
+
MaxPlayers?: number;
|
2504
|
+
/**
|
2505
|
+
* The private key-value pairs used by the member to communicate information to other members and the owner. Optional. Sets
|
2506
|
+
* or updates new key-value pairs on the caller's member data. New keys will be added with their values and existing keys
|
2507
|
+
* will be updated with the new values. Visible to all entities in the lobby. At most 30 key-value pairs may be stored
|
2508
|
+
* here, keys are limited to 30 characters and values to 1000. The total size of all memberData values may not exceed 4096
|
2509
|
+
* bytes. Keys are case sensitive. Servers cannot specifiy this.
|
2510
|
+
*/
|
2511
|
+
MemberData?: Record<string, string | null>;
|
2512
|
+
/**
|
2513
|
+
* The keys to delete from the lobby MemberData. Optional. Deletes key-value pairs on the caller's member data. All the
|
2514
|
+
* specified keys will be removed from the caller's member data. Keys that do not exist are a no-op. If the key to delete
|
2515
|
+
* exists in the memberData (same request) it will result in a bad request. Servers cannot specifiy this.
|
2516
|
+
*/
|
2517
|
+
MemberDataToDelete?: string[];
|
2518
|
+
/** The member entity whose data is being modified. Servers cannot specify this. */
|
2519
|
+
MemberEntity?: EntityKey;
|
2520
|
+
/**
|
2521
|
+
* A setting indicating whether the lobby is locked. May be 'Unlocked' or 'Locked'. When Locked new members are not allowed
|
2522
|
+
* to join. Defaults to 'Unlocked' on creation. Can only be changed by the lobby owner.
|
2523
|
+
*/
|
2524
|
+
MembershipLock?: string;
|
2525
|
+
/**
|
2526
|
+
* The lobby owner. Optional. Set to transfer ownership of the lobby. If client - owned and 'Automatic' - The Lobby service
|
2527
|
+
* will automatically assign another connected owner when the current owner leaves or disconnects. useConnections must be
|
2528
|
+
* true. If client - owned and 'Manual' - Ownership is protected as long as the current owner is connected. If the current
|
2529
|
+
* owner leaves or disconnects any member may set themselves as the current owner. The useConnections property must be
|
2530
|
+
* true. If client-owned and 'None' - Any member can set ownership. The useConnections property can be either true or
|
2531
|
+
* false. For all client-owned lobbies when the owner leaves and a new owner can not be automatically selected - The owner
|
2532
|
+
* field is set to null. For all client-owned lobbies when the owner disconnects and a new owner can not be automatically
|
2533
|
+
* selected - The owner field remains unchanged and the current owner retains all owner abilities for the lobby. If
|
2534
|
+
* server-owned (must be 'Server') - Any server can set ownership. The useConnections property must be true.
|
2535
|
+
*/
|
2536
|
+
Owner?: EntityKey;
|
2537
|
+
/**
|
2538
|
+
* The public key-value pairs which allow queries to differentiate between lobbies. Optional. Sets or updates key-value
|
2539
|
+
* pairs on the lobby for use with queries. Only the current lobby owner can set search data. New keys will be added with
|
2540
|
+
* their values and existing keys will be updated with the new values. There can be up to 30 key-value pairs stored here.
|
2541
|
+
* Keys are of the format string_key1, string_key2... string_key30 for string values, or number_key1, number_key2, ...
|
2542
|
+
* number_key30 for numeric values. Numeric values are floats. Values can be at most 256 characters long. The total size of
|
2543
|
+
* all searchData values may not exceed 1024 bytes.Keys are case sensitive.
|
2544
|
+
*/
|
2545
|
+
SearchData?: Record<string, string | null>;
|
2546
|
+
/**
|
2547
|
+
* The keys to delete from the lobby SearchData. Optional. Deletes key-value pairs on the lobby. Only the current lobby
|
2548
|
+
* owner can delete search data. All the specified keys will be removed from the search data. Keys that do not exist in the
|
2549
|
+
* lobby are a no-op.If the key to delete exists in the searchData (same request) it will result in a bad request.
|
2550
|
+
*/
|
2551
|
+
SearchDataToDelete?: string[];
|
2552
|
+
}
|
2553
|
+
interface UploadCertificateRequest extends IPlayFabRequestCommon {
|
2554
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2555
|
+
CustomTags?: Record<string, string | null>;
|
2556
|
+
/** Forces the certificate renewal if the certificate already exists. Default is false */
|
2557
|
+
ForceUpdate?: boolean;
|
2558
|
+
/** The game certificate to upload. */
|
2559
|
+
GameCertificate: Certificate;
|
2560
|
+
}
|
2561
|
+
interface UploadSecretRequest extends IPlayFabRequestCommon {
|
2562
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2563
|
+
CustomTags?: Record<string, string | null>;
|
2564
|
+
/** Forces the secret renewal if the secret already exists. Default is false */
|
2565
|
+
ForceUpdate?: boolean;
|
2566
|
+
/** The game secret to add. */
|
2567
|
+
GameSecret: Secret;
|
2568
|
+
}
|
2569
|
+
interface VirtualMachineSummary {
|
2570
|
+
/** The virtual machine health status. */
|
2571
|
+
HealthStatus?: string;
|
2572
|
+
/** The virtual machine state. */
|
2573
|
+
State?: string;
|
2574
|
+
/** The virtual machine ID. */
|
2575
|
+
VmId?: string;
|
2576
|
+
}
|
2577
|
+
interface VmStartupScriptConfiguration {
|
2578
|
+
/** Optional port requests (name/protocol) that will be used by the VmStartupScript. Max of 5 requests. */
|
2579
|
+
PortRequests?: VmStartupScriptPortRequest[];
|
2580
|
+
/** Asset which contains the VmStartupScript script and any other required files. */
|
2581
|
+
VmStartupScriptAssetReference: AssetReference;
|
2582
|
+
}
|
2583
|
+
interface VmStartupScriptParams {
|
2584
|
+
/** Optional port requests (name/protocol) that will be used by the VmStartupScript. Max of 5 requests. */
|
2585
|
+
PortRequests?: VmStartupScriptPortRequestParams[];
|
2586
|
+
/** Asset which contains the VmStartupScript script and any other required files. */
|
2587
|
+
VmStartupScriptAssetReference: AssetReferenceParams;
|
2588
|
+
}
|
2589
|
+
interface VmStartupScriptPortRequest {
|
2590
|
+
/** The name for the port. */
|
2591
|
+
Name: string;
|
2592
|
+
/** The protocol for the port. */
|
2593
|
+
Protocol: string;
|
2594
|
+
}
|
2595
|
+
interface VmStartupScriptPortRequestParams {
|
2596
|
+
/** The name for the port. */
|
2597
|
+
Name: string;
|
2598
|
+
/** The protocol for the port. */
|
2599
|
+
Protocol: string;
|
2600
|
+
}
|
2601
|
+
interface WindowsCrashDumpConfiguration {
|
2602
|
+
/** See https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps for valid values. */
|
2603
|
+
CustomDumpFlags?: number;
|
2604
|
+
/** See https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps for valid values. */
|
2605
|
+
DumpType?: number;
|
2606
|
+
/** Designates whether automatic crash dump capturing will be enabled for this Build. */
|
2607
|
+
IsEnabled: boolean;
|
2608
|
+
}
|
2609
|
+
|
2610
|
+
declare class PlayFabMultiplayerApi extends PlayFabCommon {
|
2611
|
+
/**
|
2612
|
+
* Cancel all active tickets the player is a member of in a given queue.
|
2613
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelallmatchmakingticketsforplayer
|
2614
|
+
*/
|
2615
|
+
CancelAllMatchmakingTicketsForPlayer(request: CancelAllMatchmakingTicketsForPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CancelAllMatchmakingTicketsForPlayerResult>;
|
2616
|
+
/**
|
2617
|
+
* Cancel all active backfill tickets the player is a member of in a given queue.
|
2618
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelallserverbackfillticketsforplayer
|
2619
|
+
*/
|
2620
|
+
CancelAllServerBackfillTicketsForPlayer(request: CancelAllServerBackfillTicketsForPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CancelAllServerBackfillTicketsForPlayerResult>;
|
2621
|
+
/**
|
2622
|
+
* Cancel a matchmaking ticket.
|
2623
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelmatchmakingticket
|
2624
|
+
*/
|
2625
|
+
CancelMatchmakingTicket(request: CancelMatchmakingTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CancelMatchmakingTicketResult>;
|
2626
|
+
/**
|
2627
|
+
* Cancel a server backfill ticket.
|
2628
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelserverbackfillticket
|
2629
|
+
*/
|
2630
|
+
CancelServerBackfillTicket(request: CancelServerBackfillTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CancelServerBackfillTicketResult>;
|
2631
|
+
/**
|
2632
|
+
* Creates a multiplayer server build alias.
|
2633
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildalias
|
2634
|
+
*/
|
2635
|
+
CreateBuildAlias(request: CreateBuildAliasRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BuildAliasDetailsResponse>;
|
2636
|
+
/**
|
2637
|
+
* Creates a multiplayer server build with a custom container.
|
2638
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithcustomcontainer
|
2639
|
+
*/
|
2640
|
+
CreateBuildWithCustomContainer(request: CreateBuildWithCustomContainerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateBuildWithCustomContainerResponse>;
|
2641
|
+
/**
|
2642
|
+
* Creates a multiplayer server build with a managed container.
|
2643
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithmanagedcontainer
|
2644
|
+
*/
|
2645
|
+
CreateBuildWithManagedContainer(request: CreateBuildWithManagedContainerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateBuildWithManagedContainerResponse>;
|
2646
|
+
/**
|
2647
|
+
* Creates a multiplayer server build with the server running as a process.
|
2648
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithprocessbasedserver
|
2649
|
+
*/
|
2650
|
+
CreateBuildWithProcessBasedServer(request: CreateBuildWithProcessBasedServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateBuildWithProcessBasedServerResponse>;
|
2651
|
+
/**
|
2652
|
+
* Create a lobby.
|
2653
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/createlobby
|
2654
|
+
*/
|
2655
|
+
CreateLobby(request: CreateLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateLobbyResult>;
|
2656
|
+
/**
|
2657
|
+
* Create a matchmaking ticket as a client.
|
2658
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/creatematchmakingticket
|
2659
|
+
*/
|
2660
|
+
CreateMatchmakingTicket(request: CreateMatchmakingTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateMatchmakingTicketResult>;
|
2661
|
+
/**
|
2662
|
+
* Creates a remote user to log on to a VM for a multiplayer server build.
|
2663
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createremoteuser
|
2664
|
+
*/
|
2665
|
+
CreateRemoteUser(request: CreateRemoteUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateRemoteUserResponse>;
|
2666
|
+
/**
|
2667
|
+
* Create a backfill matchmaking ticket as a server. A backfill ticket represents an ongoing game. The matchmaking service
|
2668
|
+
* automatically starts matching the backfill ticket against other matchmaking tickets. Backfill tickets cannot match with
|
2669
|
+
* other backfill tickets.
|
2670
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/createserverbackfillticket
|
2671
|
+
*/
|
2672
|
+
CreateServerBackfillTicket(request: CreateServerBackfillTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateServerBackfillTicketResult>;
|
2673
|
+
/**
|
2674
|
+
* Create a matchmaking ticket as a server. The matchmaking service automatically starts matching the ticket against other
|
2675
|
+
* matchmaking tickets.
|
2676
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/createservermatchmakingticket
|
2677
|
+
*/
|
2678
|
+
CreateServerMatchmakingTicket(request: CreateServerMatchmakingTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateMatchmakingTicketResult>;
|
2679
|
+
/**
|
2680
|
+
* Creates a request to change a title's multiplayer server quotas.
|
2681
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createtitlemultiplayerserversquotachange
|
2682
|
+
*/
|
2683
|
+
CreateTitleMultiplayerServersQuotaChange(request: CreateTitleMultiplayerServersQuotaChangeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateTitleMultiplayerServersQuotaChangeResponse>;
|
2684
|
+
/**
|
2685
|
+
* Deletes a multiplayer server game asset for a title.
|
2686
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deleteasset
|
2687
|
+
*/
|
2688
|
+
DeleteAsset(request: DeleteAssetRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2689
|
+
/**
|
2690
|
+
* Deletes a multiplayer server build.
|
2691
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuild
|
2692
|
+
*/
|
2693
|
+
DeleteBuild(request: DeleteBuildRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2694
|
+
/**
|
2695
|
+
* Deletes a multiplayer server build alias.
|
2696
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuildalias
|
2697
|
+
*/
|
2698
|
+
DeleteBuildAlias(request: DeleteBuildAliasRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2699
|
+
/**
|
2700
|
+
* Removes a multiplayer server build's region.
|
2701
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuildregion
|
2702
|
+
*/
|
2703
|
+
DeleteBuildRegion(request: DeleteBuildRegionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2704
|
+
/**
|
2705
|
+
* Deletes a multiplayer server game certificate.
|
2706
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletecertificate
|
2707
|
+
*/
|
2708
|
+
DeleteCertificate(request: DeleteCertificateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2709
|
+
/**
|
2710
|
+
* Deletes a container image repository.
|
2711
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletecontainerimagerepository
|
2712
|
+
*/
|
2713
|
+
DeleteContainerImageRepository(request: DeleteContainerImageRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2714
|
+
/**
|
2715
|
+
* Delete a lobby.
|
2716
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/deletelobby
|
2717
|
+
*/
|
2718
|
+
DeleteLobby(request: DeleteLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
2719
|
+
/**
|
2720
|
+
* Deletes a remote user to log on to a VM for a multiplayer server build.
|
2721
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deleteremoteuser
|
2722
|
+
*/
|
2723
|
+
DeleteRemoteUser(request: DeleteRemoteUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2724
|
+
/**
|
2725
|
+
* Deletes a multiplayer server game secret.
|
2726
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletesecret
|
2727
|
+
*/
|
2728
|
+
DeleteSecret(request: DeleteSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2729
|
+
/**
|
2730
|
+
* Enables the multiplayer server feature for a title.
|
2731
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/enablemultiplayerserversfortitle
|
2732
|
+
*/
|
2733
|
+
EnableMultiplayerServersForTitle(request: EnableMultiplayerServersForTitleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EnableMultiplayerServersForTitleResponse>;
|
2734
|
+
/**
|
2735
|
+
* Find lobbies which match certain criteria, and which friends are in.
|
2736
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/findfriendlobbies
|
2737
|
+
*/
|
2738
|
+
FindFriendLobbies(request: FindFriendLobbiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<FindFriendLobbiesResult>;
|
2739
|
+
/**
|
2740
|
+
* Find all the lobbies that match certain criteria.
|
2741
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/findlobbies
|
2742
|
+
*/
|
2743
|
+
FindLobbies(request: FindLobbiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<FindLobbiesResult>;
|
2744
|
+
/**
|
2745
|
+
* Gets a URL that can be used to download the specified asset. A sample pre-authenticated url -
|
2746
|
+
* https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29
|
2747
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getassetdownloadurl
|
2748
|
+
*/
|
2749
|
+
GetAssetDownloadUrl(request: GetAssetDownloadUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAssetDownloadUrlResponse>;
|
2750
|
+
/**
|
2751
|
+
* Gets the URL to upload assets to. A sample pre-authenticated url -
|
2752
|
+
* https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29
|
2753
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getassetuploadurl
|
2754
|
+
*/
|
2755
|
+
GetAssetUploadUrl(request: GetAssetUploadUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAssetUploadUrlResponse>;
|
2756
|
+
/**
|
2757
|
+
* Gets a multiplayer server build.
|
2758
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getbuild
|
2759
|
+
*/
|
2760
|
+
GetBuild(request: GetBuildRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetBuildResponse>;
|
2761
|
+
/**
|
2762
|
+
* Gets a multiplayer server build alias.
|
2763
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getbuildalias
|
2764
|
+
*/
|
2765
|
+
GetBuildAlias(request: GetBuildAliasRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BuildAliasDetailsResponse>;
|
2766
|
+
/**
|
2767
|
+
* Gets the credentials to the container registry.
|
2768
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getcontainerregistrycredentials
|
2769
|
+
*/
|
2770
|
+
GetContainerRegistryCredentials(request: GetContainerRegistryCredentialsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetContainerRegistryCredentialsResponse>;
|
2771
|
+
/**
|
2772
|
+
* Get a lobby.
|
2773
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/getlobby
|
2774
|
+
*/
|
2775
|
+
GetLobby(request: GetLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLobbyResult>;
|
2776
|
+
/**
|
2777
|
+
* Get a match.
|
2778
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getmatch
|
2779
|
+
*/
|
2780
|
+
GetMatch(request: GetMatchRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetMatchResult>;
|
2781
|
+
/**
|
2782
|
+
* SDK support is limited to C# and Java for this API. Get a matchmaking queue configuration.
|
2783
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/getmatchmakingqueue
|
2784
|
+
*/
|
2785
|
+
GetMatchmakingQueue(request: GetMatchmakingQueueRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetMatchmakingQueueResult>;
|
2786
|
+
/**
|
2787
|
+
* Get a matchmaking ticket by ticket Id.
|
2788
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getmatchmakingticket
|
2789
|
+
*/
|
2790
|
+
GetMatchmakingTicket(request: GetMatchmakingTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetMatchmakingTicketResult>;
|
2791
|
+
/**
|
2792
|
+
* Gets multiplayer server session details for a build.
|
2793
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayerserverdetails
|
2794
|
+
*/
|
2795
|
+
GetMultiplayerServerDetails(request: GetMultiplayerServerDetailsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetMultiplayerServerDetailsResponse>;
|
2796
|
+
/**
|
2797
|
+
* Gets multiplayer server logs after a server has terminated.
|
2798
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayerserverlogs
|
2799
|
+
*/
|
2800
|
+
GetMultiplayerServerLogs(request: GetMultiplayerServerLogsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetMultiplayerServerLogsResponse>;
|
2801
|
+
/**
|
2802
|
+
* Gets multiplayer server logs after a server has terminated.
|
2803
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayersessionlogsbysessionid
|
2804
|
+
*/
|
2805
|
+
GetMultiplayerSessionLogsBySessionId(request: GetMultiplayerSessionLogsBySessionIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetMultiplayerServerLogsResponse>;
|
2806
|
+
/**
|
2807
|
+
* Get the statistics for a queue.
|
2808
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getqueuestatistics
|
2809
|
+
*/
|
2810
|
+
GetQueueStatistics(request: GetQueueStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetQueueStatisticsResult>;
|
2811
|
+
/**
|
2812
|
+
* Gets a remote login endpoint to a VM that is hosting a multiplayer server build.
|
2813
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getremoteloginendpoint
|
2814
|
+
*/
|
2815
|
+
GetRemoteLoginEndpoint(request: GetRemoteLoginEndpointRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetRemoteLoginEndpointResponse>;
|
2816
|
+
/**
|
2817
|
+
* Get a matchmaking backfill ticket by ticket Id.
|
2818
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getserverbackfillticket
|
2819
|
+
*/
|
2820
|
+
GetServerBackfillTicket(request: GetServerBackfillTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetServerBackfillTicketResult>;
|
2821
|
+
/**
|
2822
|
+
* Gets the status of whether a title is enabled for the multiplayer server feature.
|
2823
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitleenabledformultiplayerserversstatus
|
2824
|
+
*/
|
2825
|
+
GetTitleEnabledForMultiplayerServersStatus(request: GetTitleEnabledForMultiplayerServersStatusRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleEnabledForMultiplayerServersStatusResponse>;
|
2826
|
+
/**
|
2827
|
+
* Gets a title's server quota change request.
|
2828
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitlemultiplayerserversquotachange
|
2829
|
+
*/
|
2830
|
+
GetTitleMultiplayerServersQuotaChange(request: GetTitleMultiplayerServersQuotaChangeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleMultiplayerServersQuotaChangeResponse>;
|
2831
|
+
/**
|
2832
|
+
* Gets the quotas for a title in relation to multiplayer servers.
|
2833
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitlemultiplayerserversquotas
|
2834
|
+
*/
|
2835
|
+
GetTitleMultiplayerServersQuotas(request: GetTitleMultiplayerServersQuotasRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleMultiplayerServersQuotasResponse>;
|
2836
|
+
/**
|
2837
|
+
* Send a notification to invite a player to a lobby.
|
2838
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/invitetolobby
|
2839
|
+
*/
|
2840
|
+
InviteToLobby(request: InviteToLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
2841
|
+
/**
|
2842
|
+
* Join an Arranged lobby.
|
2843
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinarrangedlobby
|
2844
|
+
*/
|
2845
|
+
JoinArrangedLobby(request: JoinArrangedLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<JoinLobbyResult>;
|
2846
|
+
/**
|
2847
|
+
* Join a lobby.
|
2848
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinlobby
|
2849
|
+
*/
|
2850
|
+
JoinLobby(request: JoinLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<JoinLobbyResult>;
|
2851
|
+
/**
|
2852
|
+
* Preview: Join a lobby as a server entity. This is restricted to client lobbies which are using connections.
|
2853
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinlobbyasserver
|
2854
|
+
*/
|
2855
|
+
JoinLobbyAsServer(request: JoinLobbyAsServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<JoinLobbyAsServerResult>;
|
2856
|
+
/**
|
2857
|
+
* Join a matchmaking ticket.
|
2858
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/joinmatchmakingticket
|
2859
|
+
*/
|
2860
|
+
JoinMatchmakingTicket(request: JoinMatchmakingTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<JoinMatchmakingTicketResult>;
|
2861
|
+
/**
|
2862
|
+
* Leave a lobby.
|
2863
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/leavelobby
|
2864
|
+
*/
|
2865
|
+
LeaveLobby(request: LeaveLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
2866
|
+
/**
|
2867
|
+
* Preview: Request for server to leave a lobby. This is restricted to client owned lobbies which are using connections.
|
2868
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/leavelobbyasserver
|
2869
|
+
*/
|
2870
|
+
LeaveLobbyAsServer(request: LeaveLobbyAsServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
2871
|
+
/**
|
2872
|
+
* Lists archived multiplayer server sessions for a build.
|
2873
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listarchivedmultiplayerservers
|
2874
|
+
*/
|
2875
|
+
ListArchivedMultiplayerServers(request: ListMultiplayerServersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListMultiplayerServersResponse>;
|
2876
|
+
/**
|
2877
|
+
* Lists multiplayer server game assets for a title.
|
2878
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listassetsummaries
|
2879
|
+
*/
|
2880
|
+
ListAssetSummaries(request: ListAssetSummariesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListAssetSummariesResponse>;
|
2881
|
+
/**
|
2882
|
+
* Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows
|
2883
|
+
* game client to request list of builds with player entity token.
|
2884
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listbuildaliases
|
2885
|
+
*/
|
2886
|
+
ListBuildAliases(request: ListBuildAliasesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListBuildAliasesResponse>;
|
2887
|
+
/**
|
2888
|
+
* Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client
|
2889
|
+
* access is enabled, allows game client to request list of builds with player entity token.
|
2890
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listbuildsummariesv2
|
2891
|
+
*/
|
2892
|
+
ListBuildSummariesV2(request: ListBuildSummariesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListBuildSummariesResponse>;
|
2893
|
+
/**
|
2894
|
+
* Lists multiplayer server game certificates for a title.
|
2895
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcertificatesummaries
|
2896
|
+
*/
|
2897
|
+
ListCertificateSummaries(request: ListCertificateSummariesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListCertificateSummariesResponse>;
|
2898
|
+
/**
|
2899
|
+
* Lists custom container images for a title.
|
2900
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcontainerimages
|
2901
|
+
*/
|
2902
|
+
ListContainerImages(request: ListContainerImagesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListContainerImagesResponse>;
|
2903
|
+
/**
|
2904
|
+
* Lists the tags for a custom container image.
|
2905
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcontainerimagetags
|
2906
|
+
*/
|
2907
|
+
ListContainerImageTags(request: ListContainerImageTagsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListContainerImageTagsResponse>;
|
2908
|
+
/**
|
2909
|
+
* SDK support is limited to C# and Java for this API. List all matchmaking queue configs.
|
2910
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/listmatchmakingqueues
|
2911
|
+
*/
|
2912
|
+
ListMatchmakingQueues(request: ListMatchmakingQueuesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListMatchmakingQueuesResult>;
|
2913
|
+
/**
|
2914
|
+
* List all matchmaking ticket Ids the user is a member of.
|
2915
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/listmatchmakingticketsforplayer
|
2916
|
+
*/
|
2917
|
+
ListMatchmakingTicketsForPlayer(request: ListMatchmakingTicketsForPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListMatchmakingTicketsForPlayerResult>;
|
2918
|
+
/**
|
2919
|
+
* Lists multiplayer server sessions for a build.
|
2920
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listmultiplayerservers
|
2921
|
+
*/
|
2922
|
+
ListMultiplayerServers(request: ListMultiplayerServersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListMultiplayerServersResponse>;
|
2923
|
+
/**
|
2924
|
+
* Lists quality of service servers for party.
|
2925
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listpartyqosservers
|
2926
|
+
*/
|
2927
|
+
ListPartyQosServers(request: ListPartyQosServersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListPartyQosServersResponse>;
|
2928
|
+
/**
|
2929
|
+
* Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer
|
2930
|
+
* Servers build has been deployed.
|
2931
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listqosserversfortitle
|
2932
|
+
*/
|
2933
|
+
ListQosServersForTitle(request: ListQosServersForTitleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListQosServersForTitleResponse>;
|
2934
|
+
/**
|
2935
|
+
* Lists multiplayer server game secrets for a title.
|
2936
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listsecretsummaries
|
2937
|
+
*/
|
2938
|
+
ListSecretSummaries(request: ListSecretSummariesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListSecretSummariesResponse>;
|
2939
|
+
/**
|
2940
|
+
* List all server backfill ticket Ids the user is a member of.
|
2941
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/listserverbackfillticketsforplayer
|
2942
|
+
*/
|
2943
|
+
ListServerBackfillTicketsForPlayer(request: ListServerBackfillTicketsForPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListServerBackfillTicketsForPlayerResult>;
|
2944
|
+
/**
|
2945
|
+
* List all server quota change requests for a title.
|
2946
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listtitlemultiplayerserversquotachanges
|
2947
|
+
*/
|
2948
|
+
ListTitleMultiplayerServersQuotaChanges(request: ListTitleMultiplayerServersQuotaChangesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListTitleMultiplayerServersQuotaChangesResponse>;
|
2949
|
+
/**
|
2950
|
+
* Lists virtual machines for a title.
|
2951
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listvirtualmachinesummaries
|
2952
|
+
*/
|
2953
|
+
ListVirtualMachineSummaries(request: ListVirtualMachineSummariesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListVirtualMachineSummariesResponse>;
|
2954
|
+
/**
|
2955
|
+
* SDK support is limited to C# and Java for this API. Remove a matchmaking queue config.
|
2956
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/removematchmakingqueue
|
2957
|
+
*/
|
2958
|
+
RemoveMatchmakingQueue(request: RemoveMatchmakingQueueRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveMatchmakingQueueResult>;
|
2959
|
+
/**
|
2960
|
+
* Remove a member from a lobby.
|
2961
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/removemember
|
2962
|
+
*/
|
2963
|
+
RemoveMember(request: RemoveMemberFromLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
2964
|
+
/**
|
2965
|
+
* Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client
|
2966
|
+
* to request a server with player entity token.
|
2967
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/requestmultiplayerserver
|
2968
|
+
*/
|
2969
|
+
RequestMultiplayerServer(request: RequestMultiplayerServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RequestMultiplayerServerResponse>;
|
2970
|
+
/**
|
2971
|
+
* Request a party session.
|
2972
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/requestpartyservice
|
2973
|
+
*/
|
2974
|
+
RequestPartyService(request: RequestPartyServiceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RequestPartyServiceResponse>;
|
2975
|
+
/**
|
2976
|
+
* Rolls over the credentials to the container registry.
|
2977
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/rollovercontainerregistrycredentials
|
2978
|
+
*/
|
2979
|
+
RolloverContainerRegistryCredentials(request: RolloverContainerRegistryCredentialsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RolloverContainerRegistryCredentialsResponse>;
|
2980
|
+
/**
|
2981
|
+
* SDK support is limited to C# and Java for this API. Create or update a matchmaking queue configuration.
|
2982
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/setmatchmakingqueue
|
2983
|
+
*/
|
2984
|
+
SetMatchmakingQueue(request: SetMatchmakingQueueRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetMatchmakingQueueResult>;
|
2985
|
+
/**
|
2986
|
+
* Shuts down a multiplayer server session.
|
2987
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/shutdownmultiplayerserver
|
2988
|
+
*/
|
2989
|
+
ShutdownMultiplayerServer(request: ShutdownMultiplayerServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2990
|
+
/**
|
2991
|
+
* Subscribe to lobby resource notifications.
|
2992
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/subscribetolobbyresource
|
2993
|
+
*/
|
2994
|
+
SubscribeToLobbyResource(request: SubscribeToLobbyResourceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SubscribeToLobbyResourceResult>;
|
2995
|
+
/**
|
2996
|
+
* Subscribe to match resource notifications.
|
2997
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/subscribetomatchmakingresource
|
2998
|
+
*/
|
2999
|
+
SubscribeToMatchmakingResource(request: SubscribeToMatchResourceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SubscribeToMatchResourceResult>;
|
3000
|
+
/**
|
3001
|
+
* Unsubscribe from lobby notifications.
|
3002
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/unsubscribefromlobbyresource
|
3003
|
+
*/
|
3004
|
+
UnsubscribeFromLobbyResource(request: UnsubscribeFromLobbyResourceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
3005
|
+
/**
|
3006
|
+
* Unsubscribe from match resource notifications.
|
3007
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/unsubscribefrommatchmakingresource
|
3008
|
+
*/
|
3009
|
+
UnsubscribeFromMatchmakingResource(request: UnsubscribeFromMatchResourceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnsubscribeFromMatchResourceResult>;
|
3010
|
+
/**
|
3011
|
+
* Untags a container image.
|
3012
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/untagcontainerimage
|
3013
|
+
*/
|
3014
|
+
UntagContainerImage(request: UntagContainerImageRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3015
|
+
/**
|
3016
|
+
* Creates a multiplayer server build alias.
|
3017
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildalias
|
3018
|
+
*/
|
3019
|
+
UpdateBuildAlias(request: UpdateBuildAliasRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BuildAliasDetailsResponse>;
|
3020
|
+
/**
|
3021
|
+
* Updates a multiplayer server build's name.
|
3022
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildname
|
3023
|
+
*/
|
3024
|
+
UpdateBuildName(request: UpdateBuildNameRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3025
|
+
/**
|
3026
|
+
* Updates a multiplayer server build's region. If the region is not yet created, it will be created
|
3027
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildregion
|
3028
|
+
*/
|
3029
|
+
UpdateBuildRegion(request: UpdateBuildRegionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3030
|
+
/**
|
3031
|
+
* Updates a multiplayer server build's regions.
|
3032
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildregions
|
3033
|
+
*/
|
3034
|
+
UpdateBuildRegions(request: UpdateBuildRegionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3035
|
+
/**
|
3036
|
+
* Update a lobby.
|
3037
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/updatelobby
|
3038
|
+
*/
|
3039
|
+
UpdateLobby(request: UpdateLobbyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
3040
|
+
/**
|
3041
|
+
* Preview: Update fields related to a joined server in the lobby the server is in. Servers can keep a lobby from expiring
|
3042
|
+
* by being the one to "update" the lobby in some way. Servers have no impact on last member leave/last member disconnect
|
3043
|
+
* behavior.
|
3044
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/updatelobbyasserver
|
3045
|
+
*/
|
3046
|
+
UpdateLobbyAsServer(request: UpdateLobbyAsServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
|
3047
|
+
/**
|
3048
|
+
* Uploads a multiplayer server game certificate.
|
3049
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/uploadcertificate
|
3050
|
+
*/
|
3051
|
+
UploadCertificate(request: UploadCertificateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3052
|
+
/**
|
3053
|
+
* Uploads a multiplayer server game secret.
|
3054
|
+
* https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/uploadsecret
|
3055
|
+
*/
|
3056
|
+
UploadSecret(request: UploadSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3057
|
+
}
|
3058
|
+
|
3059
|
+
export { PlayFabMultiplayerApi as default };
|