async-playfab-web-sdk 1.192.250526 → 1.193.250606-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.mts → Addon.d.ts} +213 -73
- package/dist/Addon.js +8 -0
- package/dist/Addon.js.map +1 -1
- package/dist/{Admin.d.mts → Admin.d.ts} +2547 -356
- package/dist/Admin.js +8 -0
- package/dist/Admin.js.map +1 -1
- package/dist/{Authentication.d.mts → Authentication.d.ts} +36 -9
- package/dist/Authentication.js +8 -0
- package/dist/Authentication.js.map +1 -1
- package/dist/{Client.d.mts → Client.d.ts} +2473 -557
- package/dist/Client.js +8 -0
- package/dist/Client.js.map +1 -1
- package/dist/{CloudScript.d.mts → CloudScript.d.ts} +214 -46
- package/dist/CloudScript.js +8 -0
- package/dist/CloudScript.js.map +1 -1
- package/dist/{Data.d.mts → Data.d.ts} +144 -25
- package/dist/Data.js +8 -0
- package/dist/Data.js.map +1 -1
- package/dist/{Economy.d.mts → Economy.d.ts} +1218 -173
- package/dist/Economy.js +8 -0
- package/dist/Economy.js.map +1 -1
- package/dist/{Events.d.mts → Events.d.ts} +212 -25
- package/dist/Events.js +8 -0
- package/dist/Events.js.map +1 -1
- package/dist/{Experimentation.d.mts → Experimentation.d.ts} +177 -30
- package/dist/Experimentation.js +8 -0
- package/dist/Experimentation.js.map +1 -1
- package/dist/{Groups.d.mts → Groups.d.ts} +306 -67
- package/dist/Groups.js +8 -0
- package/dist/Groups.js.map +1 -1
- package/dist/{Insights.d.mts → Insights.d.ts} +39 -13
- package/dist/Insights.js +8 -0
- package/dist/Insights.js.map +1 -1
- package/dist/{Localization.d.mts → Localization.d.ts} +6 -3
- package/dist/Localization.js +8 -0
- package/dist/Localization.js.map +1 -1
- package/dist/Matchmaker.d.ts +271 -0
- package/dist/Matchmaker.js +8 -0
- package/dist/Matchmaker.js.map +1 -0
- package/dist/{Multiplayer.d.mts → Multiplayer.d.ts} +2829 -301
- package/dist/Multiplayer.js +8 -0
- package/dist/Multiplayer.js.map +1 -1
- package/dist/{PlayFabCommon-BUv4zqXf.d.mts → PlayFabCommon-Dnp_xHg5.d.ts} +6 -10
- package/dist/{Profiles.d.mts → Profiles.d.ts} +172 -28
- package/dist/Profiles.js +8 -0
- package/dist/Profiles.js.map +1 -1
- package/dist/{Progression.d.mts → Progression.d.ts} +337 -73
- package/dist/Progression.js +8 -0
- package/dist/Progression.js.map +1 -1
- package/dist/{Server.d.mts → Server.d.ts} +2120 -458
- package/dist/Server.js +8 -0
- package/dist/Server.js.map +1 -1
- package/dist/chunk-4E2KRRDD.js +357 -0
- package/dist/chunk-4E2KRRDD.js.map +1 -0
- package/dist/chunk-7CBRLK5L.js +22 -0
- package/dist/chunk-7CBRLK5L.js.map +1 -0
- package/dist/{Localization.mjs → chunk-B6REENP7.js} +43 -94
- package/dist/chunk-B6REENP7.js.map +1 -0
- package/dist/chunk-DXAOLJHK.js +82 -0
- package/dist/chunk-DXAOLJHK.js.map +1 -0
- package/dist/chunk-EBJBJXQD.js +421 -0
- package/dist/chunk-EBJBJXQD.js.map +1 -0
- package/dist/chunk-GJBETVD4.js +237 -0
- package/dist/chunk-GJBETVD4.js.map +1 -0
- package/dist/chunk-JBOTM62B.js +2387 -0
- package/dist/chunk-JBOTM62B.js.map +1 -0
- package/dist/chunk-JOLCAGAW.js +2970 -0
- package/dist/chunk-JOLCAGAW.js.map +1 -0
- package/dist/chunk-KGYLMZG2.js +175 -0
- package/dist/chunk-KGYLMZG2.js.map +1 -0
- package/dist/chunk-PDLKO3WE.js +2477 -0
- package/dist/chunk-PDLKO3WE.js.map +1 -0
- package/dist/chunk-PSQSJQ3D.js +2673 -0
- package/dist/chunk-PSQSJQ3D.js.map +1 -0
- package/dist/chunk-RGHAECKS.js +197 -0
- package/dist/chunk-RGHAECKS.js.map +1 -0
- package/dist/chunk-SFUUCWPC.js +76 -0
- package/dist/chunk-SFUUCWPC.js.map +1 -0
- package/dist/chunk-SYWVDBNU.js +270 -0
- package/dist/chunk-SYWVDBNU.js.map +1 -0
- package/dist/chunk-T5SJ77OD.js +225 -0
- package/dist/chunk-T5SJ77OD.js.map +1 -0
- package/dist/chunk-VSRO2RWK.js +1048 -0
- package/dist/chunk-VSRO2RWK.js.map +1 -0
- package/dist/chunk-XPNV2H5D.js +421 -0
- package/dist/chunk-XPNV2H5D.js.map +1 -0
- package/dist/chunk-Z7SMY2UK.js +82 -0
- package/dist/chunk-Z7SMY2UK.js.map +1 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.js +72 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
- package/dist/Addon.mjs +0 -452
- package/dist/Addon.mjs.map +0 -1
- package/dist/Admin.mjs +0 -1112
- package/dist/Admin.mjs.map +0 -1
- package/dist/Authentication.mjs +0 -290
- package/dist/Authentication.mjs.map +0 -1
- package/dist/Client.mjs +0 -1893
- package/dist/Client.mjs.map +0 -1
- package/dist/CloudScript.mjs +0 -349
- package/dist/CloudScript.mjs.map +0 -1
- package/dist/Data.mjs +0 -291
- package/dist/Data.mjs.map +0 -1
- package/dist/Economy.mjs +0 -614
- package/dist/Economy.mjs.map +0 -1
- package/dist/Events.mjs +0 -327
- package/dist/Events.mjs.map +0 -1
- package/dist/Experimentation.mjs +0 -333
- package/dist/Experimentation.mjs.map +0 -1
- package/dist/Groups.mjs +0 -417
- package/dist/Groups.mjs.map +0 -1
- package/dist/Insights.mjs +0 -286
- package/dist/Insights.mjs.map +0 -1
- package/dist/Localization.mjs.map +0 -1
- package/dist/Multiplayer.mjs +0 -862
- package/dist/Multiplayer.mjs.map +0 -1
- package/dist/Profiles.mjs +0 -306
- package/dist/Profiles.mjs.map +0 -1
- package/dist/Progression.mjs +0 -404
- package/dist/Progression.mjs.map +0 -1
- package/dist/Server.mjs +0 -1377
- package/dist/Server.mjs.map +0 -1
- package/dist/index.d.mts +0 -17
- package/dist/index.mjs +0 -6007
- package/dist/index.mjs.map +0 -1
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
|
2
2
|
|
3
3
|
interface AcceptGroupApplicationRequest extends IPlayFabRequestCommon {
|
4
4
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
@@ -107,7 +107,7 @@ interface CreateGroupRoleRequest extends IPlayFabRequestCommon {
|
|
107
107
|
Group: EntityKey;
|
108
108
|
/**
|
109
109
|
* The ID of the role. This must be unique within the group and cannot be changed. Role IDs must be between 1 and 64
|
110
|
-
* characters long and are restricted to a-Z, A-Z, 0-9,
|
110
|
+
* characters long and are restricted to a-Z, A-Z, 0-9, '(', ')', '_', '-' and '.'.
|
111
111
|
*/
|
112
112
|
RoleId: string;
|
113
113
|
/**
|
@@ -143,6 +143,11 @@ interface EntityKey {
|
|
143
143
|
Id: string;
|
144
144
|
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
145
145
|
Type?: string;
|
146
|
+
/**
|
147
|
+
* Alternate name for Type.
|
148
|
+
* @deprecated Please use Type instead.
|
149
|
+
*/
|
150
|
+
TypeString?: string;
|
146
151
|
}
|
147
152
|
interface EntityMemberRole {
|
148
153
|
/** The list of members in the role */
|
@@ -234,7 +239,7 @@ interface InviteToGroupRequest extends IPlayFabRequestCommon {
|
|
234
239
|
/** The identifier of the group */
|
235
240
|
Group: EntityKey;
|
236
241
|
/**
|
237
|
-
* Optional. ID of an existing a role in the group to assign the user to. The group
|
242
|
+
* Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this
|
238
243
|
* is not specified. Role IDs must be between 1 and 64 characters long.
|
239
244
|
*/
|
240
245
|
RoleId?: string;
|
@@ -418,129 +423,363 @@ interface UpdateGroupRoleResponse extends IPlayFabResultCommon {
|
|
418
423
|
declare class PlayFabGroupsApi extends PlayFabCommon {
|
419
424
|
/**
|
420
425
|
* Accepts an outstanding invitation to to join a group
|
421
|
-
*
|
422
|
-
|
423
|
-
|
426
|
+
*
|
427
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupapplication Microsoft Documentation}
|
428
|
+
* @example
|
429
|
+
* await groupClient.AcceptGroupApplication({
|
430
|
+
* "Group": {
|
431
|
+
* "Id": "ABC1234ABC"
|
432
|
+
* },
|
433
|
+
* "Entity": {
|
434
|
+
* "Id": "90901000",
|
435
|
+
* "Type": "title_player_account",
|
436
|
+
* "TypeString": "title_player_account"
|
437
|
+
* }
|
438
|
+
* });
|
439
|
+
*/
|
440
|
+
AcceptGroupApplication(request: AcceptGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
424
441
|
/**
|
425
442
|
* Accepts an invitation to join a group
|
426
|
-
*
|
443
|
+
*
|
444
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupinvitation Microsoft Documentation}
|
445
|
+
* @example
|
446
|
+
* await groupClient.AcceptGroupInvitation({
|
447
|
+
* "Group": {
|
448
|
+
* "Id": "ABC1234ABC"
|
449
|
+
* }
|
450
|
+
* });
|
427
451
|
*/
|
428
|
-
AcceptGroupInvitation(request: AcceptGroupInvitationRequest,
|
452
|
+
AcceptGroupInvitation(request: AcceptGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
429
453
|
/**
|
430
454
|
* Adds members to a group or role.
|
431
|
-
*
|
432
|
-
|
433
|
-
|
455
|
+
*
|
456
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/addmembers Microsoft Documentation}
|
457
|
+
* @example
|
458
|
+
* await groupClient.AddMembers({
|
459
|
+
* "Group": {
|
460
|
+
* "Id": "ABC1234ABC"
|
461
|
+
* },
|
462
|
+
* "Members": [
|
463
|
+
* {
|
464
|
+
* "Id": "90901000",
|
465
|
+
* "Type": "title_player_account",
|
466
|
+
* "TypeString": "title_player_account"
|
467
|
+
* }
|
468
|
+
* ]
|
469
|
+
* });
|
470
|
+
*/
|
471
|
+
AddMembers(request: AddMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
434
472
|
/**
|
435
473
|
* Applies to join a group
|
436
|
-
*
|
474
|
+
*
|
475
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/applytogroup Microsoft Documentation}
|
476
|
+
* @example
|
477
|
+
* await groupClient.ApplyToGroup({
|
478
|
+
* "Group": {
|
479
|
+
* "Id": "ABC1234ABC"
|
480
|
+
* }
|
481
|
+
* });
|
437
482
|
*/
|
438
|
-
ApplyToGroup(request: ApplyToGroupRequest,
|
483
|
+
ApplyToGroup(request: ApplyToGroupRequest, extraHeaders?: Record<string, string>): Promise<ApplyToGroupResponse>;
|
439
484
|
/**
|
440
485
|
* Blocks a list of entities from joining a group.
|
441
|
-
*
|
442
|
-
|
443
|
-
|
486
|
+
*
|
487
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/blockentity Microsoft Documentation}
|
488
|
+
* @example
|
489
|
+
* await groupClient.BlockEntity({
|
490
|
+
* "Group": {
|
491
|
+
* "Id": "ABC1234ABC"
|
492
|
+
* },
|
493
|
+
* "Entity": {
|
494
|
+
* "Id": "90901000",
|
495
|
+
* "Type": "title_player_account",
|
496
|
+
* "TypeString": "title_player_account"
|
497
|
+
* }
|
498
|
+
* });
|
499
|
+
*/
|
500
|
+
BlockEntity(request: BlockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
444
501
|
/**
|
445
502
|
* Changes the role membership of a list of entities from one role to another.
|
446
|
-
*
|
447
|
-
|
448
|
-
|
503
|
+
*
|
504
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/changememberrole Microsoft Documentation}
|
505
|
+
* @example
|
506
|
+
* await groupClient.ChangeMemberRole({
|
507
|
+
* "Group": {
|
508
|
+
* "Id": "ABC1234ABC"
|
509
|
+
* },
|
510
|
+
* "OriginRoleId": "awesomepeople",
|
511
|
+
* "DestinationRoleId": "members",
|
512
|
+
* "Members": [
|
513
|
+
* {
|
514
|
+
* "Id": "90901000",
|
515
|
+
* "Type": "title_player_account",
|
516
|
+
* "TypeString": "title_player_account"
|
517
|
+
* }
|
518
|
+
* ]
|
519
|
+
* });
|
520
|
+
*/
|
521
|
+
ChangeMemberRole(request: ChangeMemberRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
449
522
|
/**
|
450
523
|
* Creates a new group.
|
451
|
-
*
|
524
|
+
*
|
525
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/creategroup Microsoft Documentation}
|
526
|
+
* @example
|
527
|
+
* await groupClient.CreateGroup({
|
528
|
+
* "GroupName": "Example Group"
|
529
|
+
* });
|
452
530
|
*/
|
453
|
-
CreateGroup(request: CreateGroupRequest,
|
531
|
+
CreateGroup(request: CreateGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupResponse>;
|
454
532
|
/**
|
455
533
|
* Creates a new group role.
|
456
|
-
*
|
457
|
-
|
458
|
-
|
534
|
+
*
|
535
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/createrole Microsoft Documentation}
|
536
|
+
* @example
|
537
|
+
* await groupClient.CreateRole({
|
538
|
+
* "RoleId": "example",
|
539
|
+
* "RoleName": "Example Role",
|
540
|
+
* "Group": {
|
541
|
+
* "Id": "ABC1234ABC"
|
542
|
+
* }
|
543
|
+
* });
|
544
|
+
*/
|
545
|
+
CreateRole(request: CreateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupRoleResponse>;
|
459
546
|
/**
|
460
547
|
* Deletes a group and all roles, invitations, join requests, and blocks associated with it.
|
461
|
-
*
|
548
|
+
*
|
549
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deletegroup Microsoft Documentation}
|
550
|
+
* @example
|
551
|
+
* await groupClient.DeleteGroup({
|
552
|
+
* "Group": {
|
553
|
+
* "Id": "ABC1234ABC"
|
554
|
+
* }
|
555
|
+
* });
|
462
556
|
*/
|
463
|
-
DeleteGroup(request: DeleteGroupRequest,
|
557
|
+
DeleteGroup(request: DeleteGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
464
558
|
/**
|
465
559
|
* Deletes an existing role in a group.
|
466
|
-
*
|
467
|
-
|
468
|
-
|
560
|
+
*
|
561
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deleterole Microsoft Documentation}
|
562
|
+
* @example
|
563
|
+
* await groupClient.DeleteRole({
|
564
|
+
* "Group": {
|
565
|
+
* "Id": "ABC1234ABC"
|
566
|
+
* },
|
567
|
+
* "RoleId": "ABC1234DEF"
|
568
|
+
* });
|
569
|
+
*/
|
570
|
+
DeleteRole(request: DeleteRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
469
571
|
/**
|
470
572
|
* Gets information about a group and its roles
|
471
|
-
*
|
573
|
+
*
|
574
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/getgroup Microsoft Documentation}
|
575
|
+
* @example
|
576
|
+
* await groupClient.GetGroup({
|
577
|
+
* "Group": {
|
578
|
+
* "Id": "ABC1234ABC"
|
579
|
+
* }
|
580
|
+
* });
|
472
581
|
*/
|
473
|
-
GetGroup(request: GetGroupRequest,
|
582
|
+
GetGroup(request: GetGroupRequest, extraHeaders?: Record<string, string>): Promise<GetGroupResponse>;
|
474
583
|
/**
|
475
584
|
* Invites a player to join a group
|
476
|
-
*
|
477
|
-
|
478
|
-
|
585
|
+
*
|
586
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/invitetogroup Microsoft Documentation}
|
587
|
+
* @example
|
588
|
+
* await groupClient.InviteToGroup({
|
589
|
+
* "Group": {
|
590
|
+
* "Id": "ABC1234ABC"
|
591
|
+
* },
|
592
|
+
* "RoleId": "awesomepeople",
|
593
|
+
* "Entity": {
|
594
|
+
* "Id": "90901000",
|
595
|
+
* "Type": "title_player_account",
|
596
|
+
* "TypeString": "title_player_account"
|
597
|
+
* }
|
598
|
+
* });
|
599
|
+
*/
|
600
|
+
InviteToGroup(request: InviteToGroupRequest, extraHeaders?: Record<string, string>): Promise<InviteToGroupResponse>;
|
479
601
|
/**
|
480
602
|
* Checks to see if an entity is a member of a group or role within the group
|
481
|
-
*
|
482
|
-
|
483
|
-
|
603
|
+
*
|
604
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/ismember Microsoft Documentation}
|
605
|
+
* @example
|
606
|
+
* await groupClient.IsMember({
|
607
|
+
* "Group": {
|
608
|
+
* "Id": "ABC1234ABC"
|
609
|
+
* },
|
610
|
+
* "RoleId": "ABC1234DEF",
|
611
|
+
* "Entity": {
|
612
|
+
* "Id": "90901000",
|
613
|
+
* "Type": "title_player_account",
|
614
|
+
* "TypeString": "title_player_account"
|
615
|
+
* }
|
616
|
+
* });
|
617
|
+
*/
|
618
|
+
IsMember(request: IsMemberRequest, extraHeaders?: Record<string, string>): Promise<IsMemberResponse>;
|
484
619
|
/**
|
485
620
|
* Lists all outstanding requests to join a group
|
486
|
-
*
|
621
|
+
*
|
622
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupapplications Microsoft Documentation}
|
623
|
+
* @example
|
624
|
+
* await groupClient.ListGroupApplications({
|
625
|
+
* "Group": {
|
626
|
+
* "Id": "ABC1234ABC"
|
627
|
+
* }
|
628
|
+
* });
|
487
629
|
*/
|
488
|
-
ListGroupApplications(request: ListGroupApplicationsRequest,
|
630
|
+
ListGroupApplications(request: ListGroupApplicationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupApplicationsResponse>;
|
489
631
|
/**
|
490
632
|
* Lists all entities blocked from joining a group
|
491
|
-
*
|
633
|
+
*
|
634
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupblocks Microsoft Documentation}
|
635
|
+
* @example
|
636
|
+
* await groupClient.ListGroupBlocks({
|
637
|
+
* "Group": {
|
638
|
+
* "Id": "ABC1234ABC"
|
639
|
+
* }
|
640
|
+
* });
|
492
641
|
*/
|
493
|
-
ListGroupBlocks(request: ListGroupBlocksRequest,
|
642
|
+
ListGroupBlocks(request: ListGroupBlocksRequest, extraHeaders?: Record<string, string>): Promise<ListGroupBlocksResponse>;
|
494
643
|
/**
|
495
644
|
* Lists all outstanding invitations for a group
|
496
|
-
*
|
645
|
+
*
|
646
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupinvitations Microsoft Documentation}
|
647
|
+
* @example
|
648
|
+
* await groupClient.ListGroupInvitations({
|
649
|
+
* "Group": {
|
650
|
+
* "Id": "ABC1234ABC"
|
651
|
+
* }
|
652
|
+
* });
|
497
653
|
*/
|
498
|
-
ListGroupInvitations(request: ListGroupInvitationsRequest,
|
654
|
+
ListGroupInvitations(request: ListGroupInvitationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupInvitationsResponse>;
|
499
655
|
/**
|
500
656
|
* Lists all members for a group
|
501
|
-
*
|
657
|
+
*
|
658
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupmembers Microsoft Documentation}
|
659
|
+
* @example
|
660
|
+
* await groupClient.ListGroupMembers({
|
661
|
+
* "Group": {
|
662
|
+
* "Id": "ABC1234ABC"
|
663
|
+
* }
|
664
|
+
* });
|
502
665
|
*/
|
503
|
-
ListGroupMembers(request: ListGroupMembersRequest,
|
666
|
+
ListGroupMembers(request: ListGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<ListGroupMembersResponse>;
|
504
667
|
/**
|
505
668
|
* Lists all groups and roles for an entity
|
506
|
-
*
|
669
|
+
*
|
670
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembership Microsoft Documentation}
|
671
|
+
* @example
|
672
|
+
* await groupClient.ListMembership({});
|
507
673
|
*/
|
508
|
-
ListMembership(request: ListMembershipRequest,
|
674
|
+
ListMembership(request: ListMembershipRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipResponse>;
|
509
675
|
/**
|
510
676
|
* Lists all outstanding invitations and group applications for an entity
|
511
|
-
*
|
677
|
+
*
|
678
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembershipopportunities Microsoft Documentation}
|
679
|
+
* @example
|
680
|
+
* await groupClient.ListMembershipOpportunities({});
|
512
681
|
*/
|
513
|
-
ListMembershipOpportunities(request: ListMembershipOpportunitiesRequest,
|
682
|
+
ListMembershipOpportunities(request: ListMembershipOpportunitiesRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipOpportunitiesResponse>;
|
514
683
|
/**
|
515
684
|
* Removes an application to join a group
|
516
|
-
*
|
517
|
-
|
518
|
-
|
685
|
+
*
|
686
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupapplication Microsoft Documentation}
|
687
|
+
* @example
|
688
|
+
* await groupClient.RemoveGroupApplication({
|
689
|
+
* "Group": {
|
690
|
+
* "Id": "ABC1234ABC"
|
691
|
+
* },
|
692
|
+
* "Entity": {
|
693
|
+
* "Id": "90901000",
|
694
|
+
* "Type": "title_player_account",
|
695
|
+
* "TypeString": "title_player_account"
|
696
|
+
* }
|
697
|
+
* });
|
698
|
+
*/
|
699
|
+
RemoveGroupApplication(request: RemoveGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
519
700
|
/**
|
520
701
|
* Removes an invitation join a group
|
521
|
-
*
|
522
|
-
|
523
|
-
|
702
|
+
*
|
703
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupinvitation Microsoft Documentation}
|
704
|
+
* @example
|
705
|
+
* await groupClient.RemoveGroupInvitation({
|
706
|
+
* "Group": {
|
707
|
+
* "Id": "ABC1234ABC"
|
708
|
+
* },
|
709
|
+
* "Entity": {
|
710
|
+
* "Id": "90901000",
|
711
|
+
* "Type": "title_player_account",
|
712
|
+
* "TypeString": "title_player_account"
|
713
|
+
* }
|
714
|
+
* });
|
715
|
+
*/
|
716
|
+
RemoveGroupInvitation(request: RemoveGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
524
717
|
/**
|
525
718
|
* Removes members from a group.
|
526
|
-
*
|
527
|
-
|
528
|
-
|
719
|
+
*
|
720
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removemembers Microsoft Documentation}
|
721
|
+
* @example
|
722
|
+
* await groupClient.RemoveMembers({
|
723
|
+
* "Group": {
|
724
|
+
* "Id": "ABC1234ABC"
|
725
|
+
* },
|
726
|
+
* "RoleId": "ABC1234DEF",
|
727
|
+
* "Members": [
|
728
|
+
* {
|
729
|
+
* "Id": "90901000",
|
730
|
+
* "Type": "title_player_account",
|
731
|
+
* "TypeString": "title_player_account"
|
732
|
+
* }
|
733
|
+
* ]
|
734
|
+
* });
|
735
|
+
*/
|
736
|
+
RemoveMembers(request: RemoveMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
529
737
|
/**
|
530
738
|
* Unblocks a list of entities from joining a group
|
531
|
-
*
|
532
|
-
|
533
|
-
|
739
|
+
*
|
740
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/unblockentity Microsoft Documentation}
|
741
|
+
* @example
|
742
|
+
* await groupClient.UnblockEntity({
|
743
|
+
* "Group": {
|
744
|
+
* "Id": "ABC1234ABC"
|
745
|
+
* },
|
746
|
+
* "Entity": {
|
747
|
+
* "Id": "90901000",
|
748
|
+
* "Type": "title_player_account",
|
749
|
+
* "TypeString": "title_player_account"
|
750
|
+
* }
|
751
|
+
* });
|
752
|
+
*/
|
753
|
+
UnblockEntity(request: UnblockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
534
754
|
/**
|
535
755
|
* Updates non-membership data about a group.
|
536
|
-
*
|
537
|
-
|
538
|
-
|
756
|
+
*
|
757
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updategroup Microsoft Documentation}
|
758
|
+
* @example
|
759
|
+
* await groupClient.UpdateGroup({
|
760
|
+
* "Group": {
|
761
|
+
* "Id": "ABC1234ABC"
|
762
|
+
* },
|
763
|
+
* "GroupName": "My New Group Name",
|
764
|
+
* "ExpectedProfileVersion": 17
|
765
|
+
* });
|
766
|
+
*/
|
767
|
+
UpdateGroup(request: UpdateGroupRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupResponse>;
|
539
768
|
/**
|
540
769
|
* Updates metadata about a role.
|
541
|
-
*
|
542
|
-
|
543
|
-
|
770
|
+
*
|
771
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updaterole Microsoft Documentation}
|
772
|
+
* @example
|
773
|
+
* await groupClient.UpdateRole({
|
774
|
+
* "Group": {
|
775
|
+
* "Id": "ABC1234ABC"
|
776
|
+
* },
|
777
|
+
* "RoleId": "ABC1234DEF",
|
778
|
+
* "RoleName": "My New Role Name",
|
779
|
+
* "ExpectedProfileVersion": 17
|
780
|
+
* });
|
781
|
+
*/
|
782
|
+
UpdateRole(request: UpdateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupRoleResponse>;
|
544
783
|
}
|
545
784
|
|
546
785
|
export { PlayFabGroupsApi as default };
|
package/dist/Groups.js
ADDED
package/dist/Groups.js.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"sources":["../src/apis/PlayFabGroupsApi.ts","../src/constants.ts","../src/PlayFabContext.ts","../src/PlayFabCommon.ts"],"sourcesContent":["import type { EmptyResponse } from \"../types/PlayFab\";\nimport type {\n\n AcceptGroupApplicationRequest,\n AcceptGroupInvitationRequest,\n AddMembersRequest,\n ApplyToGroupRequest,\n BlockEntityRequest,\n ChangeMemberRoleRequest,\n CreateGroupRequest,\n CreateGroupRoleRequest,\n DeleteGroupRequest,\n DeleteRoleRequest,\n GetGroupRequest,\n InviteToGroupRequest,\n IsMemberRequest,\n ListGroupApplicationsRequest,\n ListGroupBlocksRequest,\n ListGroupInvitationsRequest,\n ListGroupMembersRequest,\n ListMembershipRequest,\n ListMembershipOpportunitiesRequest,\n RemoveGroupApplicationRequest,\n RemoveGroupInvitationRequest,\n RemoveMembersRequest,\n UnblockEntityRequest,\n UpdateGroupRequest,\n UpdateGroupRoleRequest,\n ApplyToGroupResponse,\n CreateGroupResponse,\n CreateGroupRoleResponse,\n GetGroupResponse,\n InviteToGroupResponse,\n IsMemberResponse,\n ListGroupApplicationsResponse,\n ListGroupBlocksResponse,\n ListGroupInvitationsResponse,\n ListGroupMembersResponse,\n ListMembershipResponse,\n ListMembershipOpportunitiesResponse,\n UpdateGroupResponse,\n UpdateGroupRoleResponse,\n} from \"../types/PlayFabGroupsApi\";\nimport { PlayFabCommon } from \"../PlayFabCommon\";\n\nexport default class PlayFabGroupsApi extends PlayFabCommon {\n\n /**\n * Accepts an outstanding invitation to to join a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupapplication\n */\n AcceptGroupApplication (request: AcceptGroupApplicationRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/AcceptGroupApplication\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Accepts an invitation to join a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupinvitation\n */\n AcceptGroupInvitation (request: AcceptGroupInvitationRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/AcceptGroupInvitation\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Adds members to a group or role.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/addmembers\n */\n AddMembers (request: AddMembersRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/AddMembers\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Applies to join a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/applytogroup\n */\n ApplyToGroup (request: ApplyToGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ApplyToGroupResponse>(\"/Group/ApplyToGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Blocks a list of entities from joining a group.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/blockentity\n */\n BlockEntity (request: BlockEntityRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/BlockEntity\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Changes the role membership of a list of entities from one role to another.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/changememberrole\n */\n ChangeMemberRole (request: ChangeMemberRoleRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/ChangeMemberRole\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Creates a new group.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/creategroup\n */\n CreateGroup (request: CreateGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<CreateGroupResponse>(\"/Group/CreateGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Creates a new group role.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/createrole\n */\n CreateRole (request: CreateGroupRoleRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<CreateGroupRoleResponse>(\"/Group/CreateRole\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Deletes a group and all roles, invitations, join requests, and blocks associated with it.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/deletegroup\n */\n DeleteGroup (request: DeleteGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/DeleteGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Deletes an existing role in a group.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/deleterole\n */\n DeleteRole (request: DeleteRoleRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/DeleteRole\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Gets information about a group and its roles\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/getgroup\n */\n GetGroup (request: GetGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<GetGroupResponse>(\"/Group/GetGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Invites a player to join a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/invitetogroup\n */\n InviteToGroup (request: InviteToGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<InviteToGroupResponse>(\"/Group/InviteToGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Checks to see if an entity is a member of a group or role within the group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/ismember\n */\n IsMember (request: IsMemberRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<IsMemberResponse>(\"/Group/IsMember\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Lists all outstanding requests to join a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupapplications\n */\n ListGroupApplications (request: ListGroupApplicationsRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListGroupApplicationsResponse>(\"/Group/ListGroupApplications\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Lists all entities blocked from joining a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupblocks\n */\n ListGroupBlocks (request: ListGroupBlocksRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListGroupBlocksResponse>(\"/Group/ListGroupBlocks\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Lists all outstanding invitations for a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupinvitations\n */\n ListGroupInvitations (request: ListGroupInvitationsRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListGroupInvitationsResponse>(\"/Group/ListGroupInvitations\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Lists all members for a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupmembers\n */\n ListGroupMembers (request: ListGroupMembersRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListGroupMembersResponse>(\"/Group/ListGroupMembers\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Lists all groups and roles for an entity\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembership\n */\n ListMembership (request: ListMembershipRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListMembershipResponse>(\"/Group/ListMembership\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Lists all outstanding invitations and group applications for an entity\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembershipopportunities\n */\n ListMembershipOpportunities (request: ListMembershipOpportunitiesRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListMembershipOpportunitiesResponse>(\"/Group/ListMembershipOpportunities\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Removes an application to join a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupapplication\n */\n RemoveGroupApplication (request: RemoveGroupApplicationRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/RemoveGroupApplication\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Removes an invitation join a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupinvitation\n */\n RemoveGroupInvitation (request: RemoveGroupInvitationRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/RemoveGroupInvitation\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Removes members from a group.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/removemembers\n */\n RemoveMembers (request: RemoveMembersRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/RemoveMembers\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Unblocks a list of entities from joining a group\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/unblockentity\n */\n UnblockEntity (request: UnblockEntityRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResponse>(\"/Group/UnblockEntity\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Updates non-membership data about a group.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/updategroup\n */\n UpdateGroup (request: UpdateGroupRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<UpdateGroupResponse>(\"/Group/UpdateGroup\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n /**\n * Updates metadata about a role.\n * https://docs.microsoft.com/rest/api/playfab/groups/groups/updaterole\n */\n UpdateRole (request: UpdateGroupRoleRequest, customData?: any, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<UpdateGroupRoleResponse>(\"/Group/UpdateRole\", request, \"X-EntityToken\", customData, extraHeaders);\n }\n\n};\n","export interface ISettings {\n /** You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) */\n titleId: string;\n /** For security reasons you must never expose this value to the client or players - You must set this value for Server-APIs to work properly (Found in the Game Manager for your title, at the PlayFab Website) */\n developerSecretKey: string;\n productionServerUrl: string;\n GlobalHeaderInjection?: { [key: string]: string };\n /** The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this */\n verticalName?: string | null;\n}\n\nexport const AuthInfoMap = {\n \"X-EntityToken\": {\n authAttr: \"entityToken\",\n authError: \"errorEntityToken\",\n },\n \"X-Authorization\": {\n authAttr: \"sessionTicket\",\n authError: \"errorLoggedIn\",\n },\n \"X-SecretKey\": {\n authAttr: \"developerSecretKey\",\n authError: \"errorSecretKey\",\n },\n};\n\nexport default {\n sdkVersion: \"1.192.250526\",\n sdkFingerprint: \"JavaScriptSDK-1.192.250526\",\n buildIdentifier: \"custom_async-javascriptsdk\",\n defaultSettings: {\n titleId: \"\",\n developerSecretKey: \"\",\n GlobalHeaderInjection: {},\n productionServerUrl: \".playfabapi.com\",\n verticalName: null\n } as ISettings\n};\n","import constants, { type ISettings } from \"./constants\";\n\nexport type AuthContext = {\n PlayFabId: string | null;\n EntityId: string | null;\n EntityType: string | null;\n SessionTicket: string | null;\n EntityToken: string | null;\n};\n\nexport class PlayFabContext {\n private static _instance: PlayFabContext;\n\n settings: ISettings = constants.defaultSettings;\n\n authenticationContext: AuthContext = {\n PlayFabId: null,\n EntityId: null,\n EntityType: null,\n SessionTicket: null,\n EntityToken: null,\n };\n\n sessionTicket: string | null = null;\n\n entityToken: string | null = null;\n\n private constructor() {}\n\n public static get instance(): PlayFabContext {\n if (!PlayFabContext._instance) {\n PlayFabContext._instance = new PlayFabContext();\n }\n\n return PlayFabContext._instance;\n }\n}\n","import constants, { ISettings, AuthInfoMap } from \"./constants\";\nimport { AuthContext, PlayFabContext } from \"./PlayFabContext\";\nimport { IPlayFabError, IPlayFabResultCommon } from \"./types/PlayFab\";\n\nexport class PlayFabCommon {\n buildIdentifier: string = constants.buildIdentifier;\n requestGetParams = {\n sdk: constants.sdkFingerprint,\n } as const;\n errorTitleId = \"Must be have settings.titleId set to call this method\";\n errorLoggedIn = \"Must be logged in to call this method\";\n errorEntityToken =\n \"You must successfully call GetEntityToken before calling this\";\n errorSecretKey =\n \"Must have settings.developerSecretKey set to call this method\";\n private _context = PlayFabContext.instance;\n\n constructor(settings: Partial<ISettings> | undefined = undefined) {\n if (settings) {\n Object.assign(this._context.settings, settings);\n }\n }\n\n get settings() {\n return this._context.settings;\n }\n\n get authenticationContext() {\n return this._context.authenticationContext;\n }\n\n get sessionTicket() {\n return this._context.sessionTicket;\n }\n\n set sessionTicket(value: string | null) {\n this._context.sessionTicket = value;\n }\n\n get entityToken() {\n return this._context.entityToken;\n }\n\n set entityToken(value: string | null) {\n this._context.entityToken = value;\n }\n\n GetServerUrl() {\n if (!(this.settings.productionServerUrl.substring(0, 4) === \"http\")) {\n return `https://${this.settings.verticalName || this.settings.titleId}${\n this.settings.productionServerUrl\n }`;\n } else {\n return this.settings.productionServerUrl;\n }\n }\n\n InjectHeaders(\n xhr: XMLHttpRequest,\n headersObj: Record<string, string> | undefined\n ) {\n if (!headersObj) return;\n\n for (const headerKey in headersObj) {\n try {\n xhr.setRequestHeader(headerKey, headersObj[headerKey]);\n } catch (e) {\n console.log(\n `Failed to append header: ${headerKey} = ${headersObj[headerKey]} Error: ${e}`\n );\n }\n }\n }\n\n ExecuteRequest<T extends IPlayFabResultCommon>(\n url: string,\n body: any,\n authkey: string | null,\n authValue: string | null,\n customData: any,\n extraHeaders?: Record<string, string>\n ): Promise<T> {\n return new Promise((resolve, reject) => {\n if (body == null) body = {};\n\n var startTime = new Date().getTime();\n var requestBody = JSON.stringify(body);\n\n var urlArr = [url];\n var getParams = this.requestGetParams;\n if (getParams != null) {\n var firstParam = true;\n for (var key in getParams) {\n if (firstParam) {\n urlArr.push(\"?\");\n firstParam = false;\n } else {\n urlArr.push(\"&\");\n }\n urlArr.push(key);\n urlArr.push(\"=\");\n urlArr.push(getParams[key as keyof typeof getParams]);\n }\n }\n\n var completeUrl = urlArr.join(\"\");\n\n var xhr = new XMLHttpRequest();\n xhr.open(\"POST\", completeUrl, true);\n\n xhr.setRequestHeader(\"Content-Type\", \"application/json\");\n xhr.setRequestHeader(\n \"X-PlayFabSDK\",\n \"JavaScriptSDK-\" + constants.sdkVersion\n );\n if (authkey != null) {\n xhr.setRequestHeader(authkey, authValue!);\n }\n this.InjectHeaders(xhr, this.settings.GlobalHeaderInjection);\n this.InjectHeaders(xhr, extraHeaders);\n\n xhr.onloadend = () => {\n var result = this.GetPlayFabResponse(body, xhr, startTime, customData);\n if (result.code === 200) {\n resolve(result.data || result);\n } else {\n reject(result);\n }\n };\n\n xhr.onerror = () => {\n var result = this.GetPlayFabResponse(body, xhr, startTime, customData);\n reject(result);\n };\n\n xhr.send(requestBody);\n });\n }\n\n GetPlayFabResponse(\n request: any,\n xhr: XMLHttpRequest,\n startTime: number,\n customData: any\n ) {\n var result = null as any;\n try {\n // window.console.log(\"parsing json result: \" + xhr.responseText);\n result = JSON.parse(xhr.responseText);\n } catch (e) {\n result = {\n code: 503, // Service Unavailable\n status: \"Service Unavailable\",\n error: \"Connection error\",\n errorCode: 2, // PlayFabErrorCode.ConnectionError\n errorMessage: xhr.responseText,\n };\n }\n\n result.CallBackTimeMS = new Date().getTime() - startTime;\n result.Request = request;\n result.CustomData = customData;\n return result;\n }\n\n UpdateAuthenticationContext(currentAuthContext: AuthContext, result: any) {\n var authenticationContextUpdates = {} as AuthContext;\n if (result?.PlayFabId) {\n authenticationContextUpdates.PlayFabId = result.PlayFabId;\n }\n if (result?.SessionTicket) {\n authenticationContextUpdates.SessionTicket = result.SessionTicket;\n }\n if (result?.EntityToken) {\n authenticationContextUpdates.EntityId = result.EntityToken.Entity.Id;\n authenticationContextUpdates.EntityType = result.EntityToken.Entity.Type;\n authenticationContextUpdates.EntityToken = result.EntityToken.EntityToken;\n }\n // Update the authenticationContext with values from the result\n currentAuthContext = Object.assign(\n currentAuthContext,\n authenticationContextUpdates\n );\n\n this._context.authenticationContext = currentAuthContext;\n\n return currentAuthContext;\n }\n\n GetAuthInfo(request: any, authKey: string) {\n // Use the most-recently saved authKey, unless one was provided in the request via the AuthenticationContext\n var authError = AuthInfoMap[authKey as keyof typeof AuthInfoMap].authError;\n var authAttr = AuthInfoMap[authKey as keyof typeof AuthInfoMap].authAttr;\n var defaultAuthValue: string | null = null;\n if (authAttr === \"entityToken\") defaultAuthValue = this.entityToken;\n else if (authAttr === \"sessionTicket\")\n defaultAuthValue = this.sessionTicket;\n else if (authAttr === \"developerSecretKey\")\n defaultAuthValue = this.settings.developerSecretKey;\n var authValue = request.AuthenticationContext\n ? request.AuthenticationContext[authAttr]\n : defaultAuthValue;\n return { authKey, authValue, authError };\n }\n\n ExecuteRequestWrapper<T extends IPlayFabResultCommon>(\n apiURL: string,\n request: any,\n authKey: string | null,\n customData: any,\n extraHeaders?: Record<string, string>\n ) {\n var authValue = null;\n if (authKey !== null) {\n const { authError, ...authInfo } = this.GetAuthInfo(request, authKey);\n authKey = authInfo.authKey;\n authValue = authInfo.authValue;\n if (!authValue) throw authError;\n }\n return this.ExecuteRequest<T>(\n this.GetServerUrl() + apiURL,\n request,\n authKey,\n authValue,\n customData,\n extraHeaders\n );\n }\n\n GenerateErrorReport(error: IPlayFabError | null): string {\n if (error == null) return \"\";\n var fullErrors = error.errorMessage;\n for (var paramName in error.errorDetails)\n for (var msgIdx in error.errorDetails[paramName])\n fullErrors +=\n \"\\n\" + paramName + \": \" + error.errorDetails[paramName][msgIdx];\n return fullErrors;\n }\n\n ForgetAllCredentials() {\n this._context.sessionTicket = null;\n this._context.entityToken = null;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACWO,IAAM,cAAc;AAAA,EACzB,iBAAiB;AAAA,IACf,UAAU;AAAA,IACV,WAAW;AAAA,EACb;AAAA,EACA,mBAAmB;AAAA,IACjB,UAAU;AAAA,IACV,WAAW;AAAA,EACb;AAAA,EACA,eAAe;AAAA,IACb,UAAU;AAAA,IACV,WAAW;AAAA,EACb;AACF;AAEA,IAAO,oBAAQ;AAAA,EACb,YAAY;AAAA,EACZ,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,IACf,SAAS;AAAA,IACT,oBAAoB;AAAA,IACpB,uBAAuB,CAAC;AAAA,IACxB,qBAAqB;AAAA,IACrB,cAAc;AAAA,EAChB;AACF;;;AC3BO,IAAM,iBAAN,MAAM,gBAAe;AAAA,EAiBlB,cAAc;AAdtB,oBAAsB,kBAAU;AAEhC,iCAAqC;AAAA,MACnC,WAAW;AAAA,MACX,UAAU;AAAA,MACV,YAAY;AAAA,MACZ,eAAe;AAAA,MACf,aAAa;AAAA,IACf;AAEA,yBAA+B;AAE/B,uBAA6B;AAAA,EAEN;AAAA,EAEvB,WAAkB,WAA2B;AAC3C,QAAI,CAAC,gBAAe,WAAW;AAC7B,sBAAe,YAAY,IAAI,gBAAe;AAAA,IAChD;AAEA,WAAO,gBAAe;AAAA,EACxB;AACF;;;AChCO,IAAM,gBAAN,MAAoB;AAAA,EAazB,YAAY,WAA2C,QAAW;AAZlE,2BAA0B,kBAAU;AACpC,4BAAmB;AAAA,MACjB,KAAK,kBAAU;AAAA,IACjB;AACA,wBAAe;AACf,yBAAgB;AAChB,4BACE;AACF,0BACE;AACF,SAAQ,WAAW,eAAe;AAGhC,QAAI,UAAU;AACZ,aAAO,OAAO,KAAK,SAAS,UAAU,QAAQ;AAAA,IAChD;AAAA,EACF;AAAA,EAEA,IAAI,WAAW;AACb,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,wBAAwB;AAC1B,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,gBAAgB;AAClB,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,cAAc,OAAsB;AACtC,SAAK,SAAS,gBAAgB;AAAA,EAChC;AAAA,EAEA,IAAI,cAAc;AAChB,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,YAAY,OAAsB;AACpC,SAAK,SAAS,cAAc;AAAA,EAC9B;AAAA,EAEA,eAAe;AACb,QAAI,EAAE,KAAK,SAAS,oBAAoB,UAAU,GAAG,CAAC,MAAM,SAAS;AACnE,aAAO,WAAW,KAAK,SAAS,gBAAgB,KAAK,SAAS,OAAO,GACnE,KAAK,SAAS,mBAChB;AAAA,IACF,OAAO;AACL,aAAO,KAAK,SAAS;AAAA,IACvB;AAAA,EACF;AAAA,EAEA,cACE,KACA,YACA;AACA,QAAI,CAAC,WAAY;AAEjB,eAAW,aAAa,YAAY;AAClC,UAAI;AACF,YAAI,iBAAiB,WAAW,WAAW,SAAS,CAAC;AAAA,MACvD,SAAS,GAAG;AACV,gBAAQ;AAAA,UACN,4BAA4B,SAAS,MAAM,WAAW,SAAS,CAAC,WAAW,CAAC;AAAA,QAC9E;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,eACE,KACA,MACA,SACA,WACA,YACA,cACY;AACZ,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,QAAQ,KAAM,QAAO,CAAC;AAE1B,UAAI,aAAY,oBAAI,KAAK,GAAE,QAAQ;AACnC,UAAI,cAAc,KAAK,UAAU,IAAI;AAErC,UAAI,SAAS,CAAC,GAAG;AACjB,UAAI,YAAY,KAAK;AACrB,UAAI,aAAa,MAAM;AACrB,YAAI,aAAa;AACjB,iBAAS,OAAO,WAAW;AACzB,cAAI,YAAY;AACd,mBAAO,KAAK,GAAG;AACf,yBAAa;AAAA,UACf,OAAO;AACL,mBAAO,KAAK,GAAG;AAAA,UACjB;AACA,iBAAO,KAAK,GAAG;AACf,iBAAO,KAAK,GAAG;AACf,iBAAO,KAAK,UAAU,GAA6B,CAAC;AAAA,QACtD;AAAA,MACF;AAEA,UAAI,cAAc,OAAO,KAAK,EAAE;AAEhC,UAAI,MAAM,IAAI,eAAe;AAC7B,UAAI,KAAK,QAAQ,aAAa,IAAI;AAElC,UAAI,iBAAiB,gBAAgB,kBAAkB;AACvD,UAAI;AAAA,QACF;AAAA,QACA,mBAAmB,kBAAU;AAAA,MAC/B;AACA,UAAI,WAAW,MAAM;AACnB,YAAI,iBAAiB,SAAS,SAAU;AAAA,MAC1C;AACA,WAAK,cAAc,KAAK,KAAK,SAAS,qBAAqB;AAC3D,WAAK,cAAc,KAAK,YAAY;AAEpC,UAAI,YAAY,MAAM;AACpB,YAAI,SAAS,KAAK,mBAAmB,MAAM,KAAK,WAAW,UAAU;AACrE,YAAI,OAAO,SAAS,KAAK;AACvB,kBAAQ,OAAO,QAAQ,MAAM;AAAA,QAC/B,OAAO;AACL,iBAAO,MAAM;AAAA,QACf;AAAA,MACF;AAEA,UAAI,UAAU,MAAM;AAClB,YAAI,SAAS,KAAK,mBAAmB,MAAM,KAAK,WAAW,UAAU;AACrE,eAAO,MAAM;AAAA,MACf;AAEA,UAAI,KAAK,WAAW;AAAA,IACtB,CAAC;AAAA,EACH;AAAA,EAEA,mBACE,SACA,KACA,WACA,YACA;AACA,QAAI,SAAS;AACb,QAAI;AAEF,eAAS,KAAK,MAAM,IAAI,YAAY;AAAA,IACtC,SAAS,GAAG;AACV,eAAS;AAAA,QACP,MAAM;AAAA;AAAA,QACN,QAAQ;AAAA,QACR,OAAO;AAAA,QACP,WAAW;AAAA;AAAA,QACX,cAAc,IAAI;AAAA,MACpB;AAAA,IACF;AAEA,WAAO,kBAAiB,oBAAI,KAAK,GAAE,QAAQ,IAAI;AAC/C,WAAO,UAAU;AACjB,WAAO,aAAa;AACpB,WAAO;AAAA,EACT;AAAA,EAEA,4BAA4B,oBAAiC,QAAa;AACxE,QAAI,+BAA+B,CAAC;AACpC,QAAI,iCAAQ,WAAW;AACrB,mCAA6B,YAAY,OAAO;AAAA,IAClD;AACA,QAAI,iCAAQ,eAAe;AACzB,mCAA6B,gBAAgB,OAAO;AAAA,IACtD;AACA,QAAI,iCAAQ,aAAa;AACvB,mCAA6B,WAAW,OAAO,YAAY,OAAO;AAClE,mCAA6B,aAAa,OAAO,YAAY,OAAO;AACpE,mCAA6B,cAAc,OAAO,YAAY;AAAA,IAChE;AAEA,yBAAqB,OAAO;AAAA,MAC1B;AAAA,MACA;AAAA,IACF;AAEA,SAAK,SAAS,wBAAwB;AAEtC,WAAO;AAAA,EACT;AAAA,EAEA,YAAY,SAAc,SAAiB;AAEzC,QAAI,YAAY,YAAY,OAAmC,EAAE;AACjE,QAAI,WAAW,YAAY,OAAmC,EAAE;AAChE,QAAI,mBAAkC;AACtC,QAAI,aAAa,cAAe,oBAAmB,KAAK;AAAA,aAC/C,aAAa;AACpB,yBAAmB,KAAK;AAAA,aACjB,aAAa;AACpB,yBAAmB,KAAK,SAAS;AACnC,QAAI,YAAY,QAAQ,wBACpB,QAAQ,sBAAsB,QAAQ,IACtC;AACJ,WAAO,EAAE,SAAS,WAAW,UAAU;AAAA,EACzC;AAAA,EAEA,sBACE,QACA,SACA,SACA,YACA,cACA;AACA,QAAI,YAAY;AAChB,QAAI,YAAY,MAAM;AACpB,YAAM,EAAE,WAAW,GAAG,SAAS,IAAI,KAAK,YAAY,SAAS,OAAO;AACpE,gBAAU,SAAS;AACnB,kBAAY,SAAS;AACrB,UAAI,CAAC,UAAW,OAAM;AAAA,IACxB;AACA,WAAO,KAAK;AAAA,MACV,KAAK,aAAa,IAAI;AAAA,MACtB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,oBAAoB,OAAqC;AACvD,QAAI,SAAS,KAAM,QAAO;AAC1B,QAAI,aAAa,MAAM;AACvB,aAAS,aAAa,MAAM;AAC1B,eAAS,UAAU,MAAM,aAAa,SAAS;AAC7C,sBACE,OAAO,YAAY,OAAO,MAAM,aAAa,SAAS,EAAE,MAAM;AACpE,WAAO;AAAA,EACT;AAAA,EAEA,uBAAuB;AACrB,SAAK,SAAS,gBAAgB;AAC9B,SAAK,SAAS,cAAc;AAAA,EAC9B;AACF;;;AHtMA,IAAqB,mBAArB,cAA8C,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA,EAMxD,uBAAwB,SAAwC,YAAkB,cAAuC;AACrH,WAAO,KAAK,sBAAqC,iCAAiC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACxI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,sBAAuB,SAAuC,YAAkB,cAAuC;AACnH,WAAO,KAAK,sBAAqC,gCAAgC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACvI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAY,SAA4B,YAAkB,cAAuC;AAC7F,WAAO,KAAK,sBAAqC,qBAAqB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC5H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAc,SAA8B,YAAkB,cAAuC;AACjG,WAAO,KAAK,sBAA4C,uBAAuB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACrI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAa,SAA6B,YAAkB,cAAuC;AAC/F,WAAO,KAAK,sBAAqC,sBAAsB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC7H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAkB,SAAkC,YAAkB,cAAuC;AACzG,WAAO,KAAK,sBAAqC,2BAA2B,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAClI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAa,SAA6B,YAAkB,cAAuC;AAC/F,WAAO,KAAK,sBAA2C,sBAAsB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACnI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAY,SAAiC,YAAkB,cAAuC;AAClG,WAAO,KAAK,sBAA+C,qBAAqB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACtI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAa,SAA6B,YAAkB,cAAuC;AAC/F,WAAO,KAAK,sBAAqC,sBAAsB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC7H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAY,SAA4B,YAAkB,cAAuC;AAC7F,WAAO,KAAK,sBAAqC,qBAAqB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC5H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAU,SAA0B,YAAkB,cAAuC;AACzF,WAAO,KAAK,sBAAwC,mBAAmB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC7H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAe,SAA+B,YAAkB,cAAuC;AACnG,WAAO,KAAK,sBAA6C,wBAAwB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACvI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAU,SAA0B,YAAkB,cAAuC;AACzF,WAAO,KAAK,sBAAwC,mBAAmB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC7H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,sBAAuB,SAAuC,YAAkB,cAAuC;AACnH,WAAO,KAAK,sBAAqD,gCAAgC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACvJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAiB,SAAiC,YAAkB,cAAuC;AACvG,WAAO,KAAK,sBAA+C,0BAA0B,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC3I;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,qBAAsB,SAAsC,YAAkB,cAAuC;AACjH,WAAO,KAAK,sBAAoD,+BAA+B,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACrJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAkB,SAAkC,YAAkB,cAAuC;AACzG,WAAO,KAAK,sBAAgD,2BAA2B,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC7I;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,eAAgB,SAAgC,YAAkB,cAAuC;AACrG,WAAO,KAAK,sBAA8C,yBAAyB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACzI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,4BAA6B,SAA6C,YAAkB,cAAuC;AAC/H,WAAO,KAAK,sBAA2D,sCAAsC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACnK;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,uBAAwB,SAAwC,YAAkB,cAAuC;AACrH,WAAO,KAAK,sBAAqC,iCAAiC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACxI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,sBAAuB,SAAuC,YAAkB,cAAuC;AACnH,WAAO,KAAK,sBAAqC,gCAAgC,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACvI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAe,SAA+B,YAAkB,cAAuC;AACnG,WAAO,KAAK,sBAAqC,wBAAwB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC/H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,cAAe,SAA+B,YAAkB,cAAuC;AACnG,WAAO,KAAK,sBAAqC,wBAAwB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EAC/H;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAa,SAA6B,YAAkB,cAAuC;AAC/F,WAAO,KAAK,sBAA2C,sBAAsB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACnI;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAY,SAAiC,YAAkB,cAAuC;AAClG,WAAO,KAAK,sBAA+C,qBAAqB,SAAS,iBAAiB,YAAY,YAAY;AAAA,EACtI;AAEJ;","names":[]}
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
2
2
|
|
3
3
|
interface InsightsEmptyRequest extends IPlayFabRequestCommon {
|
4
4
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
@@ -107,35 +107,61 @@ declare class PlayFabInsightsApi extends PlayFabCommon {
|
|
107
107
|
/**
|
108
108
|
* Gets the current values for the Insights performance and data storage retention, list of pending operations, and the
|
109
109
|
* performance and data storage retention limits.
|
110
|
-
*
|
110
|
+
*
|
111
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getdetails Microsoft Documentation}
|
112
|
+
* @example
|
113
|
+
* await insightsClient.GetDetails({});
|
111
114
|
*/
|
112
|
-
GetDetails(request: InsightsEmptyRequest,
|
115
|
+
GetDetails(request: InsightsEmptyRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetDetailsResponse>;
|
113
116
|
/**
|
114
117
|
* Retrieves the range of allowed values for performance and data storage retention values as well as the submeter details
|
115
118
|
* for each performance level.
|
116
|
-
*
|
119
|
+
*
|
120
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getlimits Microsoft Documentation}
|
121
|
+
* @example
|
122
|
+
* await insightsClient.GetLimits({});
|
117
123
|
*/
|
118
|
-
GetLimits(request: InsightsEmptyRequest,
|
124
|
+
GetLimits(request: InsightsEmptyRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetLimitsResponse>;
|
119
125
|
/**
|
120
126
|
* Gets the status of a SetPerformance or SetStorageRetention operation.
|
121
|
-
*
|
127
|
+
*
|
128
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getoperationstatus Microsoft Documentation}
|
129
|
+
* @example
|
130
|
+
* await insightsClient.GetOperationStatus({
|
131
|
+
* "OperationId": "3ee468c4-ad09-4bb1-bccf-209ef5abfb96"
|
132
|
+
* });
|
122
133
|
*/
|
123
|
-
GetOperationStatus(request: InsightsGetOperationStatusRequest,
|
134
|
+
GetOperationStatus(request: InsightsGetOperationStatusRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetOperationStatusResponse>;
|
124
135
|
/**
|
125
136
|
* Gets a list of pending SetPerformance and/or SetStorageRetention operations for the title.
|
126
|
-
*
|
137
|
+
*
|
138
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getpendingoperations Microsoft Documentation}
|
139
|
+
* @example
|
140
|
+
* await insightsClient.GetPendingOperations({
|
141
|
+
* "OperationType": "SetPerformance"
|
142
|
+
* });
|
127
143
|
*/
|
128
|
-
GetPendingOperations(request: InsightsGetPendingOperationsRequest,
|
144
|
+
GetPendingOperations(request: InsightsGetPendingOperationsRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetPendingOperationsResponse>;
|
129
145
|
/**
|
130
146
|
* Sets the Insights performance level value for the title.
|
131
|
-
*
|
147
|
+
*
|
148
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/setperformance Microsoft Documentation}
|
149
|
+
* @example
|
150
|
+
* await insightsClient.SetPerformance({
|
151
|
+
* "PerformanceLevel": 3
|
152
|
+
* });
|
132
153
|
*/
|
133
|
-
SetPerformance(request: InsightsSetPerformanceRequest,
|
154
|
+
SetPerformance(request: InsightsSetPerformanceRequest, extraHeaders?: Record<string, string>): Promise<InsightsOperationResponse>;
|
134
155
|
/**
|
135
156
|
* Sets the Insights data storage retention days value for the title.
|
136
|
-
*
|
157
|
+
*
|
158
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/setstorageretention Microsoft Documentation}
|
159
|
+
* @example
|
160
|
+
* await insightsClient.SetStorageRetention({
|
161
|
+
* "RetentionDays": 30
|
162
|
+
* });
|
137
163
|
*/
|
138
|
-
SetStorageRetention(request: InsightsSetStorageRetentionRequest,
|
164
|
+
SetStorageRetention(request: InsightsSetStorageRetentionRequest, extraHeaders?: Record<string, string>): Promise<InsightsOperationResponse>;
|
139
165
|
}
|
140
166
|
|
141
167
|
export { PlayFabInsightsApi as default };
|