connected-spaces-platform.web 4.11.2 → 4.12.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.
@@ -143,6 +143,17 @@ export declare namespace Multiplayer {
143
143
  Num = 5
144
144
  }
145
145
  }
146
+ export declare namespace Multiplayer {
147
+ /**
148
+ * @description Enum specifying the type of change that occured to a user's permissions whilst in a space.
149
+ */
150
+ enum EPermissionChangeType {
151
+ Created = 0,
152
+ Updated = 1,
153
+ Removed = 2,
154
+ Invalid = 3
155
+ }
156
+ }
146
157
  export declare namespace Multiplayer {
147
158
  /**
148
159
  * @description Enum used to specify the current state of the muiltiplayer connection.
@@ -852,7 +863,8 @@ export declare namespace Systems {
852
863
  enum SpaceUserRole {
853
864
  Owner = 0,
854
865
  Moderator = 1,
855
- User = 2
866
+ User = 2,
867
+ Invalid = 3
856
868
  }
857
869
  }
858
870
  export declare namespace Systems {
@@ -3388,7 +3400,7 @@ export declare namespace Multiplayer {
3388
3400
  }
3389
3401
  export declare namespace Multiplayer {
3390
3402
  /**
3391
- * @description Class used to provide details of a changed asset in a callback.
3403
+ * @description Describes the changes an asset has undergone when the client application is connected to a space.
3392
3404
  */
3393
3405
  class AssetDetailBlobParams extends NativeClassWrapper implements INativeResource {
3394
3406
  /** @internal */
@@ -3409,7 +3421,7 @@ export declare namespace Multiplayer {
3409
3421
  }
3410
3422
  export declare namespace Multiplayer {
3411
3423
  /**
3412
- * @description Class used to provide details of a conversation message in a callback.
3424
+ * @description Class used to provide details of a conversation message that has been received whilst the client application is connected to a space.
3413
3425
  */
3414
3426
  class ConversationSystemParams extends NativeClassWrapper implements INativeResource {
3415
3427
  /** @internal */
@@ -3422,6 +3434,25 @@ export declare namespace Multiplayer {
3422
3434
  set messageValue(value: string);
3423
3435
  }
3424
3436
  }
3437
+ export declare namespace Multiplayer {
3438
+ /**
3439
+ * @description Class used to provide details of a permission change that has happened to a user whilst the client application is connected to a space.
3440
+ */
3441
+ class UserPermissionsParams extends NativeClassWrapper implements INativeResource {
3442
+ /** @internal */
3443
+ constructor(pointer: NativePointer);
3444
+ static create(): UserPermissionsParams;
3445
+ delete(): void;
3446
+ get spaceId(): string;
3447
+ set spaceId(value: string);
3448
+ get userRoles(): Common.Array<Systems.SpaceUserRole>;
3449
+ set userRoles(value: Common.Array<Systems.SpaceUserRole>);
3450
+ get changeType(): Multiplayer.EPermissionChangeType;
3451
+ set changeType(value: Multiplayer.EPermissionChangeType);
3452
+ get userId(): string;
3453
+ set userId(value: string);
3454
+ }
3455
+ }
3425
3456
  export declare namespace Multiplayer {
3426
3457
  /**
3427
3458
  @ingroup Multiplayer
@@ -3490,6 +3521,11 @@ export declare namespace Multiplayer {
3490
3521
  * Callback will have to reset the callback passed to the system to avoid "dangling objects" after use.
3491
3522
  */
3492
3523
  setConversationSystemCallback(callback: (arg1: Multiplayer.ConversationSystemParams) => void): void;
3524
+ /**
3525
+ * @description Sets a callback for an access control changed event.
3526
+ * @param callback - Callback to receive data for the user permissions that has been changed.
3527
+ */
3528
+ setUserPermissionsChangedCallback(callback: (arg1: Multiplayer.UserPermissionsParams) => void): void;
3493
3529
  /**
3494
3530
  * @description Registers a callback to listen for the named event.
3495
3531
  * @param eventName - The identifying name for the event to listen for.
@@ -9970,6 +10006,7 @@ export declare namespace Common {
9970
10006
  private TTypeName;
9971
10007
  static ofcsp_multiplayer_ReplicatedValue(): Array<Multiplayer.ReplicatedValue>;
9972
10008
  static ofcsp_multiplayer_ComponentUpdateInfo(): Array<Multiplayer.ComponentUpdateInfo>;
10009
+ static ofcsp_systems_SpaceUserRole(): Array<Systems.SpaceUserRole>;
9973
10010
  static ofcsp_multiplayer_MessageInfo(): Array<Multiplayer.MessageInfo>;
9974
10011
  static ofString(): Array<string>;
9975
10012
  static ofcsp_systems_EAssetPlatform(): Array<Systems.EAssetPlatform>;
@@ -10000,6 +10037,7 @@ export declare namespace Common {
10000
10037
  static ofcsp_common_Map_String_String(): Array<Common.Map<string, string>>;
10001
10038
  static ofcsp_multiplayer_ReplicatedValue_number(size: number): Array<Multiplayer.ReplicatedValue>;
10002
10039
  static ofcsp_multiplayer_ComponentUpdateInfo_number(size: number): Array<Multiplayer.ComponentUpdateInfo>;
10040
+ static ofcsp_systems_SpaceUserRole_number(size: number): Array<Systems.SpaceUserRole>;
10003
10041
  static ofcsp_multiplayer_MessageInfo_number(size: number): Array<Multiplayer.MessageInfo>;
10004
10042
  static ofString_number(size: number): Array<string>;
10005
10043
  static ofcsp_systems_EAssetPlatform_number(size: number): Array<Systems.EAssetPlatform>;
@@ -279,6 +279,11 @@ function csp_multiplayer_EAssetChangeTypeFactory(nativePointer) {
279
279
  }
280
280
  ProxyClassFactories["csp_multiplayer_EAssetChangeType"] =
281
281
  csp_multiplayer_EAssetChangeTypeFactory;
282
+ function csp_multiplayer_EPermissionChangeTypeFactory(nativePointer) {
283
+ return nativePointer.pointer;
284
+ }
285
+ ProxyClassFactories["csp_multiplayer_EPermissionChangeType"] =
286
+ csp_multiplayer_EPermissionChangeTypeFactory;
282
287
  function csp_multiplayer_ConnectionStateFactory(nativePointer) {
283
288
  return nativePointer.pointer;
284
289
  }
@@ -633,6 +638,11 @@ function csp_multiplayer_ConversationSystemParamsFactory(nativePointer) {
633
638
  }
634
639
  ProxyClassFactories["csp_multiplayer_ConversationSystemParams"] =
635
640
  csp_multiplayer_ConversationSystemParamsFactory;
641
+ function csp_multiplayer_UserPermissionsParamsFactory(nativePointer) {
642
+ return new Multiplayer.UserPermissionsParams(nativePointer);
643
+ }
644
+ ProxyClassFactories["csp_multiplayer_UserPermissionsParams"] =
645
+ csp_multiplayer_UserPermissionsParamsFactory;
636
646
  function csp_multiplayer_MultiplayerConnectionFactory(nativePointer) {
637
647
  return new Multiplayer.MultiplayerConnection(nativePointer);
638
648
  }
@@ -1334,6 +1344,11 @@ function csp_common_Array_csp_multiplayer_ComponentUpdateInfoFactory(nativePoint
1334
1344
  }
1335
1345
  ProxyClassFactories["csp_common_Array_csp_multiplayer_ComponentUpdateInfo"] =
1336
1346
  csp_common_Array_csp_multiplayer_ComponentUpdateInfoFactory;
1347
+ function csp_common_Array_csp_systems_SpaceUserRoleFactory(nativePointer) {
1348
+ return new Common.Array(nativePointer, csp_systems_SpaceUserRoleFactory, "csp_systems_SpaceUserRole");
1349
+ }
1350
+ ProxyClassFactories["csp_common_Array_csp_systems_SpaceUserRole"] =
1351
+ csp_common_Array_csp_systems_SpaceUserRoleFactory;
1337
1352
  function csp_common_Array_csp_multiplayer_MessageInfoFactory(nativePointer) {
1338
1353
  return new Common.Array(nativePointer, csp_multiplayer_MessageInfoFactory, "csp_multiplayer_MessageInfo");
1339
1354
  }
@@ -1577,6 +1592,18 @@ export var Multiplayer;
1577
1592
  EAssetChangeType[EAssetChangeType["Num"] = 5] = "Num";
1578
1593
  })(EAssetChangeType = Multiplayer.EAssetChangeType || (Multiplayer.EAssetChangeType = {}));
1579
1594
  })(Multiplayer || (Multiplayer = {}));
1595
+ (function (Multiplayer) {
1596
+ /**
1597
+ * @description Enum specifying the type of change that occured to a user's permissions whilst in a space.
1598
+ */
1599
+ let EPermissionChangeType;
1600
+ (function (EPermissionChangeType) {
1601
+ EPermissionChangeType[EPermissionChangeType["Created"] = 0] = "Created";
1602
+ EPermissionChangeType[EPermissionChangeType["Updated"] = 1] = "Updated";
1603
+ EPermissionChangeType[EPermissionChangeType["Removed"] = 2] = "Removed";
1604
+ EPermissionChangeType[EPermissionChangeType["Invalid"] = 3] = "Invalid";
1605
+ })(EPermissionChangeType = Multiplayer.EPermissionChangeType || (Multiplayer.EPermissionChangeType = {}));
1606
+ })(Multiplayer || (Multiplayer = {}));
1580
1607
  (function (Multiplayer) {
1581
1608
  /**
1582
1609
  * @description Enum used to specify the current state of the muiltiplayer connection.
@@ -2343,6 +2370,7 @@ export var Services;
2343
2370
  SpaceUserRole[SpaceUserRole["Owner"] = 0] = "Owner";
2344
2371
  SpaceUserRole[SpaceUserRole["Moderator"] = 1] = "Moderator";
2345
2372
  SpaceUserRole[SpaceUserRole["User"] = 2] = "User";
2373
+ SpaceUserRole[SpaceUserRole["Invalid"] = 3] = "Invalid";
2346
2374
  })(SpaceUserRole = Systems.SpaceUserRole || (Systems.SpaceUserRole = {}));
2347
2375
  })(Systems || (Systems = {}));
2348
2376
  (function (Systems) {
@@ -8654,7 +8682,7 @@ export class CSPFoundation {
8654
8682
  })(Multiplayer || (Multiplayer = {}));
8655
8683
  (function (Multiplayer) {
8656
8684
  /**
8657
- * @description Class used to provide details of a changed asset in a callback.
8685
+ * @description Describes the changes an asset has undergone when the client application is connected to a space.
8658
8686
  */
8659
8687
  class AssetDetailBlobParams extends NativeClassWrapper {
8660
8688
  /** @internal */
@@ -8713,7 +8741,7 @@ export class CSPFoundation {
8713
8741
  })(Multiplayer || (Multiplayer = {}));
8714
8742
  (function (Multiplayer) {
8715
8743
  /**
8716
- * @description Class used to provide details of a conversation message in a callback.
8744
+ * @description Class used to provide details of a conversation message that has been received whilst the client application is connected to a space.
8717
8745
  */
8718
8746
  class ConversationSystemParams extends NativeClassWrapper {
8719
8747
  /** @internal */
@@ -8749,6 +8777,60 @@ export class CSPFoundation {
8749
8777
  }
8750
8778
  Multiplayer.ConversationSystemParams = ConversationSystemParams;
8751
8779
  })(Multiplayer || (Multiplayer = {}));
8780
+ (function (Multiplayer) {
8781
+ /**
8782
+ * @description Class used to provide details of a permission change that has happened to a user whilst the client application is connected to a space.
8783
+ */
8784
+ class UserPermissionsParams extends NativeClassWrapper {
8785
+ /** @internal */
8786
+ constructor(pointer) {
8787
+ super(pointer);
8788
+ }
8789
+ static create() {
8790
+ var _ptr = Module._malloc(8);
8791
+ Module.ccall("csp_multiplayer_UserPermissionsParams_Ctor", "void", ["number"], [_ptr]);
8792
+ var _nPtr = getNativePointer(_ptr);
8793
+ return new UserPermissionsParams(_nPtr);
8794
+ }
8795
+ delete() {
8796
+ if (this.ownsPointer && !this.disposed) {
8797
+ Module.ccall("csp_multiplayer_UserPermissionsParams_Dtor", "void", ["number"], [this.pointer]);
8798
+ this.disposed = true;
8799
+ }
8800
+ }
8801
+ get spaceId() {
8802
+ let _result = Module.ccall("csp_multiplayer_UserPermissionsParams__Get_SpaceId", "string", ["number"], [this.pointer]);
8803
+ return _result;
8804
+ }
8805
+ set spaceId(value) {
8806
+ Module.ccall("csp_multiplayer_UserPermissionsParams__Set_SpaceId", "void", ["number", "string"], [this.pointer, value]);
8807
+ }
8808
+ get userRoles() {
8809
+ const _ptr = Module._malloc(8);
8810
+ Module.ccall("csp_multiplayer_UserPermissionsParams__Get_UserRoles", "void", ["number", "number"], [_ptr, this.pointer]);
8811
+ const _nPtr = getNativePointer(_ptr);
8812
+ return new Common.Array(_nPtr, csp_systems_SpaceUserRoleFactory, "csp_systems_SpaceUserRole");
8813
+ }
8814
+ set userRoles(value) {
8815
+ Module.ccall("csp_multiplayer_UserPermissionsParams__Set_UserRoles", "void", ["number", "number"], [this.pointer, value.pointer]);
8816
+ }
8817
+ get changeType() {
8818
+ let _result = Module.ccall("csp_multiplayer_UserPermissionsParams__Get_ChangeType", "number", ["number"], [this.pointer]);
8819
+ return _result;
8820
+ }
8821
+ set changeType(value) {
8822
+ Module.ccall("csp_multiplayer_UserPermissionsParams__Set_ChangeType", "void", ["number", "number"], [this.pointer, value]);
8823
+ }
8824
+ get userId() {
8825
+ let _result = Module.ccall("csp_multiplayer_UserPermissionsParams__Get_UserId", "string", ["number"], [this.pointer]);
8826
+ return _result;
8827
+ }
8828
+ set userId(value) {
8829
+ Module.ccall("csp_multiplayer_UserPermissionsParams__Set_UserId", "void", ["number", "string"], [this.pointer, value]);
8830
+ }
8831
+ }
8832
+ Multiplayer.UserPermissionsParams = UserPermissionsParams;
8833
+ })(Multiplayer || (Multiplayer = {}));
8752
8834
  (function (Multiplayer) {
8753
8835
  /**
8754
8836
  @ingroup Multiplayer
@@ -8938,6 +9020,18 @@ export class CSPFoundation {
8938
9020
  var _callbackPtr = Module.addFunction(_callback, "vii");
8939
9021
  Module.ccall("csp_multiplayer_MultiplayerConnection_SetConversationSystemCallback_void_ConversationSystemCallbackHandler", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
8940
9022
  }
9023
+ /**
9024
+ * @description Sets a callback for an access control changed event.
9025
+ * @param callback - Callback to receive data for the user permissions that has been changed.
9026
+ */
9027
+ setUserPermissionsChangedCallback(callback) {
9028
+ var _callback = (_stateObject__, arg1) => {
9029
+ var _arg1 = new Multiplayer.UserPermissionsParams(getNativePointer(arg1));
9030
+ callback(_arg1);
9031
+ };
9032
+ var _callbackPtr = Module.addFunction(_callback, "vii");
9033
+ Module.ccall("csp_multiplayer_MultiplayerConnection_SetUserPermissionsChangedCallback_void_UserPermissionsChangedCallbackHandler", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
9034
+ }
8941
9035
  /**
8942
9036
  * @description Registers a callback to listen for the named event.
8943
9037
  * @param eventName - The identifying name for the event to listen for.
@@ -18797,7 +18891,6 @@ export class CSPFoundation {
18797
18891
  var assetCollectionTypePointer = 0;
18798
18892
  if (assetCollectionType != null) {
18799
18893
  assetCollectionTypePointer = Module._malloc(4);
18800
- Module.setValue(assetCollectionTypePointer, assetCollectionType, "i32");
18801
18894
  }
18802
18895
  var resultsSkipNumberPointer = 0;
18803
18896
  if (resultsSkipNumber != null) {
@@ -18902,7 +18995,6 @@ export class CSPFoundation {
18902
18995
  var thirdPartyPlatformPointer = 0;
18903
18996
  if (thirdPartyPlatform != null) {
18904
18997
  thirdPartyPlatformPointer = Module._malloc(4);
18905
- Module.setValue(thirdPartyPlatformPointer, thirdPartyPlatform, "i32");
18906
18998
  }
18907
18999
  Module.ccall("csp_systems_AssetSystem_CreateAsset_void_AssetCollectionRC_StringRC_StringRC_EThirdPartyPlatformRC_EAssetType_AssetResultCallback", "void", [
18908
19000
  "number",
@@ -21388,7 +21480,6 @@ export class CSPFoundation {
21388
21480
  var typePointer = 0;
21389
21481
  if (type != null) {
21390
21482
  typePointer = Module._malloc(4);
21391
- Module.setValue(typePointer, type, "i32");
21392
21483
  }
21393
21484
  Module.ccall("csp_systems_SpaceSystem_UpdateSpace_void_StringRC_StringRC_StringRC_SpaceAttributesRC_BasicSpaceResultCallback", "void", ["number", "string", "string", "string", "number", "number", "number"], [
21394
21485
  this.pointer,
@@ -21480,12 +21571,10 @@ export class CSPFoundation {
21480
21571
  var isDiscoverablePointer = 0;
21481
21572
  if (isDiscoverable != null) {
21482
21573
  isDiscoverablePointer = Module._malloc(4);
21483
- Module.setValue(isDiscoverablePointer, isDiscoverable, "i32");
21484
21574
  }
21485
21575
  var requiresInvitePointer = 0;
21486
21576
  if (requiresInvite != null) {
21487
21577
  requiresInvitePointer = Module._malloc(4);
21488
- Module.setValue(requiresInvitePointer, requiresInvite, "i32");
21489
21578
  }
21490
21579
  var resultsSkipPointer = 0;
21491
21580
  if (resultsSkip != null) {
@@ -21628,7 +21717,6 @@ export class CSPFoundation {
21628
21717
  var isModeratorRolePointer = 0;
21629
21718
  if (isModeratorRole != null) {
21630
21719
  isModeratorRolePointer = Module._malloc(4);
21631
- Module.setValue(isModeratorRolePointer, isModeratorRole, "i32");
21632
21720
  }
21633
21721
  Module.ccall("csp_systems_SpaceSystem_InviteToSpace_void_StringRC_StringRC_boolRC_StringRC_NullResultCallback", "void", ["number", "string", "string", "boolean", "string", "number", "number"], [
21634
21722
  this.pointer,
@@ -22512,7 +22600,6 @@ export class CSPFoundation {
22512
22600
  var allTagsPointer = 0;
22513
22601
  if (allTags != null) {
22514
22602
  allTagsPointer = Module._malloc(4);
22515
- Module.setValue(allTagsPointer, allTags, "i32");
22516
22603
  }
22517
22604
  var skipPointer = 0;
22518
22605
  if (skip != null) {
@@ -23274,7 +23361,6 @@ export class CSPFoundation {
23274
23361
  var userHasVerifiedAgePointer = 0;
23275
23362
  if (userHasVerifiedAge != null) {
23276
23363
  userHasVerifiedAgePointer = Module._malloc(4);
23277
- Module.setValue(userHasVerifiedAgePointer, userHasVerifiedAge, "i32");
23278
23364
  }
23279
23365
  Module.ccall("csp_systems_UserSystem_Login_void_StringRC_StringRC_StringRC_boolRC_LoginStateResultCallback", "void", ["number", "string", "string", "string", "boolean", "number", "number"], [
23280
23366
  this.pointer,
@@ -23341,7 +23427,6 @@ export class CSPFoundation {
23341
23427
  var userHasVerifiedAgePointer = 0;
23342
23428
  if (userHasVerifiedAge != null) {
23343
23429
  userHasVerifiedAgePointer = Module._malloc(4);
23344
- Module.setValue(userHasVerifiedAgePointer, userHasVerifiedAge, "i32");
23345
23430
  }
23346
23431
  Module.ccall("csp_systems_UserSystem_LoginAsGuest_void_boolRC_LoginStateResultCallback", "void", ["number", "boolean", "number", "number"], [this.pointer, userHasVerifiedAgePointer, _callbackPtr, 0]);
23347
23432
  if (userHasVerifiedAgePointer) {
@@ -23419,7 +23504,6 @@ export class CSPFoundation {
23419
23504
  var userHasVerifiedAgePointer = 0;
23420
23505
  if (userHasVerifiedAge != null) {
23421
23506
  userHasVerifiedAgePointer = Module._malloc(4);
23422
- Module.setValue(userHasVerifiedAgePointer, userHasVerifiedAge, "i32");
23423
23507
  }
23424
23508
  Module.ccall("csp_systems_UserSystem_LoginToThirdPartyAuthenticationProvider_void_StringRC_StringRC_boolRC_LoginStateResultCallback", "void", ["number", "string", "string", "boolean", "number", "number"], [
23425
23509
  this.pointer,
@@ -23815,6 +23899,13 @@ export class CSPFoundation {
23815
23899
  Module._free(_ret);
23816
23900
  return _inst;
23817
23901
  }
23902
+ static ofcsp_systems_SpaceUserRole() {
23903
+ var _ret = Module._malloc(8);
23904
+ Module.ccall("csp_common_Array_Ctor_csp_systems_SpaceUserRole", "void", ["number"], [_ret]);
23905
+ var _inst = new Array(getNativePointer(_ret), csp_systems_SpaceUserRoleFactory, "csp_systems_SpaceUserRole");
23906
+ Module._free(_ret);
23907
+ return _inst;
23908
+ }
23818
23909
  static ofcsp_multiplayer_MessageInfo() {
23819
23910
  var _ret = Module._malloc(8);
23820
23911
  Module.ccall("csp_common_Array_Ctor_csp_multiplayer_MessageInfo", "void", ["number"], [_ret]);
@@ -24025,6 +24116,13 @@ export class CSPFoundation {
24025
24116
  Module._free(_ret);
24026
24117
  return _inst;
24027
24118
  }
24119
+ static ofcsp_systems_SpaceUserRole_number(size) {
24120
+ var _ret = Module._malloc(8);
24121
+ Module.ccall("csp_common_Array_Conv_size_tC_csp_systems_SpaceUserRole", "void", ["number", "number"], [_ret, size]);
24122
+ var _inst = new Array(getNativePointer(_ret), csp_systems_SpaceUserRoleFactory, "csp_systems_SpaceUserRole");
24123
+ Module._free(_ret);
24124
+ return _inst;
24125
+ }
24028
24126
  static ofcsp_multiplayer_MessageInfo_number(size) {
24029
24127
  var _ret = Module._malloc(8);
24030
24128
  Module.ccall("csp_common_Array_Conv_size_tC_csp_multiplayer_MessageInfo", "void", ["number", "number"], [_ret, size]);