connected-spaces-platform.web 5.0.0 → 5.0.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.
@@ -168,10 +168,7 @@ export class Limits {
168
168
  }
169
169
 
170
170
  class NativePointer {
171
- constructor(
172
- public pointer: number,
173
- public ownsOwnData: boolean,
174
- ) {}
171
+ constructor(public pointer: number, public ownsOwnData: boolean) {}
175
172
  }
176
173
 
177
174
  function getNativePointer(pointer: number): NativePointer {
@@ -1281,6 +1278,14 @@ function csp_systems_TicketedEventVendorAuthInfoFactory(
1281
1278
  ProxyClassFactories["csp_systems_TicketedEventVendorAuthInfo"] =
1282
1279
  csp_systems_TicketedEventVendorAuthInfoFactory;
1283
1280
 
1281
+ function csp_systems_HotspotGroupFactory(
1282
+ nativePointer: NativePointer,
1283
+ ): NativeClassWrapper {
1284
+ return new Systems.HotspotGroup(nativePointer);
1285
+ }
1286
+ ProxyClassFactories["csp_systems_HotspotGroup"] =
1287
+ csp_systems_HotspotGroupFactory;
1288
+
1284
1289
  function csp_systems_LogSystemFactory(
1285
1290
  nativePointer: NativePointer,
1286
1291
  ): NativeClassWrapper {
@@ -1964,6 +1969,30 @@ function csp_systems_GraphQLSystemFactory(
1964
1969
  ProxyClassFactories["csp_systems_GraphQLSystem"] =
1965
1970
  csp_systems_GraphQLSystemFactory;
1966
1971
 
1972
+ function csp_systems_HotspotGroupResultFactory(
1973
+ nativePointer: NativePointer,
1974
+ ): NativeClassWrapper {
1975
+ return new Systems.HotspotGroupResult(nativePointer);
1976
+ }
1977
+ ProxyClassFactories["csp_systems_HotspotGroupResult"] =
1978
+ csp_systems_HotspotGroupResultFactory;
1979
+
1980
+ function csp_systems_HotspotGroupsResultFactory(
1981
+ nativePointer: NativePointer,
1982
+ ): NativeClassWrapper {
1983
+ return new Systems.HotspotGroupsResult(nativePointer);
1984
+ }
1985
+ ProxyClassFactories["csp_systems_HotspotGroupsResult"] =
1986
+ csp_systems_HotspotGroupsResultFactory;
1987
+
1988
+ function csp_systems_HotspotSequenceSystemFactory(
1989
+ nativePointer: NativePointer,
1990
+ ): NativeClassWrapper {
1991
+ return new Systems.HotspotSequenceSystem(nativePointer);
1992
+ }
1993
+ ProxyClassFactories["csp_systems_HotspotSequenceSystem"] =
1994
+ csp_systems_HotspotSequenceSystemFactory;
1995
+
1967
1996
  function csp_systems_MaintenanceInfoResultFactory(
1968
1997
  nativePointer: NativePointer,
1969
1998
  ): NativeClassWrapper {
@@ -2527,6 +2556,18 @@ function csp_common_Array_csp_systems_TicketedEventFactory(
2527
2556
  ProxyClassFactories["csp_common_Array_csp_systems_TicketedEvent"] =
2528
2557
  csp_common_Array_csp_systems_TicketedEventFactory;
2529
2558
 
2559
+ function csp_common_Array_csp_systems_HotspotGroupFactory(
2560
+ nativePointer: NativePointer,
2561
+ ): NativeClassWrapper {
2562
+ return new Common.Array<Systems.HotspotGroup>(
2563
+ nativePointer,
2564
+ csp_systems_HotspotGroupFactory,
2565
+ "csp_systems_HotspotGroup",
2566
+ );
2567
+ }
2568
+ ProxyClassFactories["csp_common_Array_csp_systems_HotspotGroup"] =
2569
+ csp_common_Array_csp_systems_HotspotGroupFactory;
2570
+
2530
2571
  function csp_common_Array_csp_systems_MaintenanceInfoFactory(
2531
2572
  nativePointer: NativePointer,
2532
2573
  ): NativeClassWrapper {
@@ -3071,7 +3112,7 @@ export namespace Multiplayer {
3071
3112
  * @description Enumerates the list of properties that can be replicated for an animated model component.
3072
3113
  */
3073
3114
  export enum AnimatedModelPropertyKeys {
3074
- Name = 0,
3115
+ Name_DEPRECATED = 0,
3075
3116
  ExternalResourceAssetId,
3076
3117
  ExternalResourceAssetCollectionId,
3077
3118
  Position,
@@ -3209,7 +3250,7 @@ export namespace Multiplayer {
3209
3250
  * @description Enumerates the list of properties that can be replicated for a button component.
3210
3251
  */
3211
3252
  export enum ButtonPropertyKeys {
3212
- Name = 0,
3253
+ Name_DEPRECATED = 0,
3213
3254
  LabelText,
3214
3255
  IconAssetId,
3215
3256
  AssetCollectionId,
@@ -3316,7 +3357,7 @@ export namespace Multiplayer {
3316
3357
  * @description The list of properties defined within an external link component.
3317
3358
  */
3318
3359
  export enum ExternalLinkPropertyKeys {
3319
- Name = 0,
3360
+ Name_DEPRECATED = 0,
3320
3361
  LinkUrl,
3321
3362
  Position,
3322
3363
  Rotation,
@@ -3334,7 +3375,7 @@ export namespace Multiplayer {
3334
3375
  * @description Enumerates the list of properties that can be replicated for a fiducial marker space component.
3335
3376
  */
3336
3377
  export enum FiducialMarkerPropertyKeys {
3337
- Name,
3378
+ Name_DEPRECATED,
3338
3379
  MarkerAssetId,
3339
3380
  AssetCollectionId,
3340
3381
  Position,
@@ -3385,7 +3426,7 @@ export namespace Multiplayer {
3385
3426
  * @description Enumerates the list of properties that can be replicated for a Gaussian Splat component.
3386
3427
  */
3387
3428
  export enum GaussianSplatPropertyKeys {
3388
- Name = 0,
3429
+ Name_DEPRECATED = 0,
3389
3430
  ExternalResourceAssetId,
3390
3431
  ExternalResourceAssetCollectionId,
3391
3432
  Position,
@@ -3406,7 +3447,7 @@ export namespace Multiplayer {
3406
3447
  export enum HotspotPropertyKeys {
3407
3448
  Position,
3408
3449
  Rotation,
3409
- Name,
3450
+ Name_DEPRECATED,
3410
3451
  IsTeleportPoint,
3411
3452
  IsSpawnPoint,
3412
3453
  IsVisible,
@@ -3420,7 +3461,7 @@ export namespace Multiplayer {
3420
3461
  * @description Enumerates the list of properties that can be replicated for an image space component.
3421
3462
  */
3422
3463
  export enum ImagePropertyKeys {
3423
- Name,
3464
+ Name_DEPRECATED,
3424
3465
  ImageAssetId,
3425
3466
  AssetCollectionId,
3426
3467
  Position,
@@ -3486,7 +3527,7 @@ export namespace Multiplayer {
3486
3527
  * @description Enumerates the list of properties that can be replicated for a light component.
3487
3528
  */
3488
3529
  export enum LightPropertyKeys {
3489
- Name = 0,
3530
+ Name_DEPRECATED = 0,
3490
3531
  LightType,
3491
3532
  Color,
3492
3533
  Intensity,
@@ -3528,7 +3569,7 @@ export namespace Multiplayer {
3528
3569
  * @description Enumerates the list of properties that can be replicated for a reflection component.
3529
3570
  */
3530
3571
  export enum ReflectionPropertyKeys {
3531
- Name,
3572
+ Name_DEPRECATED,
3532
3573
  ReflectionAssetId,
3533
3574
  AssetCollectionId,
3534
3575
  Position,
@@ -3588,7 +3629,7 @@ export namespace Multiplayer {
3588
3629
  * @description Enumerates the list of properties that can be replicated for a static model component.
3589
3630
  */
3590
3631
  export enum StaticModelPropertyKeys {
3591
- Name = 0,
3632
+ Name_DEPRECATED = 0,
3592
3633
  ExternalResourceAssetId,
3593
3634
  ExternalResourceAssetCollectionId,
3594
3635
  Position,
@@ -3663,7 +3704,7 @@ export namespace Multiplayer {
3663
3704
  * @description Enumerates the list of properties that can be replicated for a video player component.
3664
3705
  */
3665
3706
  export enum VideoPlayerPropertyKeys {
3666
- Name = 0,
3707
+ Name_DEPRECATED = 0,
3667
3708
  VideoAssetId,
3668
3709
  VideoAssetURL,
3669
3710
  AssetCollectionId,
@@ -21362,6 +21403,40 @@ export namespace Multiplayer {
21362
21403
  [this.pointer, action, actionParams],
21363
21404
  );
21364
21405
  }
21406
+
21407
+ /**
21408
+ * @description Gets the name of the component.
21409
+ */
21410
+
21411
+ getComponentName(): string {
21412
+ let _result = Module.ccall(
21413
+ "csp_multiplayer_ComponentBase_GetComponentNameC_StringRC",
21414
+ "number",
21415
+ ["number"],
21416
+ [this.pointer],
21417
+ );
21418
+
21419
+ const _resultString = Module.UTF8ToString(_result);
21420
+ free(_result);
21421
+
21422
+ _result = _resultString;
21423
+
21424
+ return _result;
21425
+ }
21426
+
21427
+ /**
21428
+ * @description Sets the name for the component.
21429
+ * @param value - - The new name to assign to the componenent.
21430
+ */
21431
+
21432
+ setComponentName(value: string): void {
21433
+ Module.ccall(
21434
+ "csp_multiplayer_ComponentBase_SetComponentName_void_StringRC",
21435
+ "void",
21436
+ ["number", "string"],
21437
+ [this.pointer, value],
21438
+ );
21439
+ }
21365
21440
  }
21366
21441
  }
21367
21442
 
@@ -25721,6 +25796,26 @@ export namespace Systems {
25721
25796
  return _nPtr;
25722
25797
  }
25723
25798
 
25799
+ /**
25800
+ * @description Retrieves the HotspotSequenceSystem system.
25801
+ * @return Pointer to the hotspotsequencesystem system class
25802
+ */
25803
+
25804
+ getHotspotSequenceSystem(): Systems.HotspotSequenceSystem {
25805
+ var _ret = Module._malloc(8);
25806
+
25807
+ Module.ccall(
25808
+ "csp_systems_SystemsManager_GetHotspotSequenceSystem_HotspotSequenceSystemP",
25809
+ "void",
25810
+ ["number", "number"],
25811
+ [_ret, this.pointer],
25812
+ );
25813
+ var _nPtr = new Systems.HotspotSequenceSystem(getNativePointer(_ret));
25814
+ Module._free(_ret);
25815
+
25816
+ return _nPtr;
25817
+ }
25818
+
25724
25819
  getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem {
25725
25820
  var _ret = Module._malloc(8);
25726
25821
 
@@ -28910,6 +29005,85 @@ export namespace Systems {
28910
29005
  }
28911
29006
  }
28912
29007
 
29008
+ export namespace Systems {
29009
+ /**
29010
+ @ingroup HotspotSequence System
29011
+ * @description A basic class abstraction for a Hot Spot Group, including name, and items within the group.
29012
+ */
29013
+ export class HotspotGroup
29014
+ extends NativeClassWrapper
29015
+ implements INativeResource
29016
+ {
29017
+ /** @internal */
29018
+ constructor(pointer: NativePointer) {
29019
+ super(pointer);
29020
+ }
29021
+
29022
+ static create(): HotspotGroup {
29023
+ var _ptr = Module._malloc(8);
29024
+ Module.ccall("csp_systems_HotspotGroup_Ctor", "void", ["number"], [_ptr]);
29025
+ var _nPtr = getNativePointer(_ptr);
29026
+
29027
+ return new HotspotGroup(_nPtr);
29028
+ }
29029
+
29030
+ delete(): void {
29031
+ if (this.ownsPointer && !this.disposed) {
29032
+ Module.ccall(
29033
+ "csp_systems_HotspotGroup_Dtor",
29034
+ "void",
29035
+ ["number"],
29036
+ [this.pointer],
29037
+ );
29038
+
29039
+ this.disposed = true;
29040
+ }
29041
+ }
29042
+
29043
+ get name(): string {
29044
+ let _result = Module.ccall(
29045
+ "csp_systems_HotspotGroup__Get_Name",
29046
+ "string",
29047
+ ["number"],
29048
+ [this.pointer],
29049
+ );
29050
+
29051
+ return _result;
29052
+ }
29053
+
29054
+ set name(value: string) {
29055
+ Module.ccall(
29056
+ "csp_systems_HotspotGroup__Set_Name",
29057
+ "void",
29058
+ ["number", "string"],
29059
+ [this.pointer, value],
29060
+ );
29061
+ }
29062
+
29063
+ get items(): Common.Array<string> {
29064
+ const _ptr = Module._malloc(8);
29065
+ Module.ccall(
29066
+ "csp_systems_HotspotGroup__Get_Items",
29067
+ "void",
29068
+ ["number", "number"],
29069
+ [_ptr, this.pointer],
29070
+ );
29071
+
29072
+ const _nPtr = getNativePointer(_ptr);
29073
+ return new Common.Array<string>(_nPtr, StringFactory, "String");
29074
+ }
29075
+
29076
+ set items(value: Common.Array<string>) {
29077
+ Module.ccall(
29078
+ "csp_systems_HotspotGroup__Set_Items",
29079
+ "void",
29080
+ ["number", "number"],
29081
+ [this.pointer, value.pointer],
29082
+ );
29083
+ }
29084
+ }
29085
+ }
29086
+
28913
29087
  export namespace Systems {
28914
29088
  /**
28915
29089
  * @description A Connected Spaces Platform level Logger for debugging or printing to console, also handles logging to a file.
@@ -30243,6 +30417,34 @@ export namespace Systems {
30243
30417
  [this.pointer, value.pointer],
30244
30418
  );
30245
30419
  }
30420
+
30421
+ get metaData(): Common.Map<string, string> {
30422
+ const _ptr = Module._malloc(8);
30423
+ Module.ccall(
30424
+ "csp_systems_Sequence__Get_MetaData",
30425
+ "void",
30426
+ ["number", "number"],
30427
+ [_ptr, this.pointer],
30428
+ );
30429
+
30430
+ const _nPtr = getNativePointer(_ptr);
30431
+ return new Common.Map<string, string>(
30432
+ _nPtr,
30433
+ StringFactory,
30434
+ "String",
30435
+ StringFactory,
30436
+ "String",
30437
+ );
30438
+ }
30439
+
30440
+ set metaData(value: Common.Map<string, string>) {
30441
+ Module.ccall(
30442
+ "csp_systems_Sequence__Set_MetaData",
30443
+ "void",
30444
+ ["number", "number"],
30445
+ [this.pointer, value.pointer],
30446
+ );
30447
+ }
30246
30448
  }
30247
30449
  }
30248
30450
 
@@ -36491,6 +36693,9 @@ export namespace Multiplayer {
36491
36693
  /**
36492
36694
  * @description Gets the name of this external link component.
36493
36695
  */
36696
+ /** @deprecated
36697
+ Deprecated in favour of ComponentBase::GetComponentName()
36698
+ */
36494
36699
 
36495
36700
  getName(): string {
36496
36701
  let _result = Module.ccall(
@@ -36512,6 +36717,9 @@ export namespace Multiplayer {
36512
36717
  * @description Sets the name for this external link component.
36513
36718
  * @param value - - The new name to assign to this external link componenent.
36514
36719
  */
36720
+ /** @deprecated
36721
+ Deprecated in favour of ComponentBase::SetComponentName()
36722
+ */
36515
36723
 
36516
36724
  setName(value: string): void {
36517
36725
  Module.ccall(
@@ -36876,6 +37084,9 @@ export namespace Multiplayer {
36876
37084
  * @description Gets the name of this fiducial marker space component.
36877
37085
  * @return The name of this fiducial marker space component.
36878
37086
  */
37087
+ /** @deprecated
37088
+ Deprecated in favour of ComponentBase::GetComponentName()
37089
+ */
36879
37090
 
36880
37091
  getName(): string {
36881
37092
  let _result = Module.ccall(
@@ -36897,6 +37108,9 @@ export namespace Multiplayer {
36897
37108
  * @description Sets the name of this fiducial marker space component.
36898
37109
  * @param value - The name of this fiducial marker space component.
36899
37110
  */
37111
+ /** @deprecated
37112
+ Deprecated in favour of ComponentBase::SetComponentName()
37113
+ */
36900
37114
 
36901
37115
  setName(value: string): void {
36902
37116
  Module.ccall(
@@ -38197,6 +38411,9 @@ export namespace Multiplayer {
38197
38411
  * @description Gets the Name of the Hotspot.
38198
38412
  * @return The Name of the Hotspot.
38199
38413
  */
38414
+ /** @deprecated
38415
+ Deprecated in favour of ComponentBase::GetComponentName()
38416
+ */
38200
38417
 
38201
38418
  getName(): string {
38202
38419
  let _result = Module.ccall(
@@ -38218,6 +38435,9 @@ export namespace Multiplayer {
38218
38435
  * @description Sets the Name of this Hotspot.
38219
38436
  * @param value - The Name of this Hotspot.
38220
38437
  */
38438
+ /** @deprecated
38439
+ Deprecated in favour of ComponentBase::SetComponentName()
38440
+ */
38221
38441
 
38222
38442
  setName(value: string): void {
38223
38443
  Module.ccall(
@@ -38501,6 +38721,9 @@ export namespace Multiplayer {
38501
38721
  * @description Gets the name of this image space component.
38502
38722
  * @return The name of this image space component.
38503
38723
  */
38724
+ /** @deprecated
38725
+ Deprecated in favour of ComponentBase::GetComponentName()
38726
+ */
38504
38727
 
38505
38728
  getName(): string {
38506
38729
  let _result = Module.ccall(
@@ -38522,6 +38745,9 @@ export namespace Multiplayer {
38522
38745
  * @description Sets the name of this image space component.
38523
38746
  * @param value - The name of this image space component.
38524
38747
  */
38748
+ /** @deprecated
38749
+ Deprecated in favour of ComponentBase::SetComponentName()
38750
+ */
38525
38751
 
38526
38752
  setName(value: string): void {
38527
38753
  Module.ccall(
@@ -39740,6 +39966,9 @@ export namespace Multiplayer {
39740
39966
  * @description Get the name of the Reflection component.
39741
39967
  * @return Csp::common::string specifying the component name.
39742
39968
  */
39969
+ /** @deprecated
39970
+ Deprecated in favour of ComponentBase::GetComponentName()
39971
+ */
39743
39972
 
39744
39973
  getName(): string {
39745
39974
  let _result = Module.ccall(
@@ -39761,6 +39990,9 @@ export namespace Multiplayer {
39761
39990
  * @description Set the name for the Reflection component.
39762
39991
  * @param value - Name for the Reflection component.
39763
39992
  */
39993
+ /** @deprecated
39994
+ Deprecated in favour of ComponentBase::SetComponentName()
39995
+ */
39764
39996
 
39765
39997
  setName(value: string): void {
39766
39998
  Module.ccall(
@@ -41195,6 +41427,9 @@ export namespace Multiplayer {
41195
41427
  * @description Gets the name of this video player.
41196
41428
  * @return The name of this video player.
41197
41429
  */
41430
+ /** @deprecated
41431
+ Deprecated in favour of ComponentBase::GetComponentName()
41432
+ */
41198
41433
 
41199
41434
  getName(): string {
41200
41435
  let _result = Module.ccall(
@@ -41216,6 +41451,9 @@ export namespace Multiplayer {
41216
41451
  * @description Sets the name of this video player.
41217
41452
  * @param value - The name of this video player.
41218
41453
  */
41454
+ /** @deprecated
41455
+ Deprecated in favour of ComponentBase::SetComponentName()
41456
+ */
41219
41457
 
41220
41458
  setName(value: string): void {
41221
41459
  Module.ccall(
@@ -46096,6 +46334,426 @@ export namespace Systems {
46096
46334
  }
46097
46335
  }
46098
46336
 
46337
+ export namespace Systems {
46338
+ /**
46339
+ @ingroup HotspotSequence System
46340
+ * @description Data class used to contain information when attempting to get a Hot Spot Group.
46341
+ */
46342
+ export class HotspotGroupResult
46343
+ extends Systems.ResultBase
46344
+ implements INativeResource
46345
+ {
46346
+ /** @internal */
46347
+ constructor(pointer: NativePointer) {
46348
+ super(pointer);
46349
+ }
46350
+
46351
+ static fromResultBase(
46352
+ baseInstance: Systems.ResultBase,
46353
+ ): Systems.HotspotGroupResult {
46354
+ const nativeClassWrapper = baseInstance as unknown as NativeClassWrapper;
46355
+ return new Systems.HotspotGroupResult(
46356
+ new NativePointer(
46357
+ nativeClassWrapper.pointer,
46358
+ nativeClassWrapper.ownsPointer,
46359
+ ),
46360
+ );
46361
+ }
46362
+
46363
+ getHotspotGroup(): Systems.HotspotGroup {
46364
+ var _ret = Module._malloc(8);
46365
+
46366
+ Module.ccall(
46367
+ "csp_systems_HotspotGroupResult_GetHotspotGroupC_HotspotGroupRC",
46368
+ "void",
46369
+ ["number", "number"],
46370
+ [_ret, this.pointer],
46371
+ );
46372
+ var _nPtr = new Systems.HotspotGroup(getNativePointer(_ret));
46373
+ Module._free(_ret);
46374
+
46375
+ return _nPtr;
46376
+ }
46377
+
46378
+ delete(): void {
46379
+ if (this.ownsPointer && !this.disposed) {
46380
+ Module.ccall(
46381
+ "csp_systems_HotspotGroupResult_Dtor",
46382
+ "void",
46383
+ ["number"],
46384
+ [this.pointer],
46385
+ );
46386
+
46387
+ this.disposed = true;
46388
+ }
46389
+ }
46390
+ }
46391
+ }
46392
+
46393
+ export namespace Systems {
46394
+ /**
46395
+ @ingroup HotspotSequence System
46396
+ * @description Data class used to contain information when attempting to get a Hot Spot Group.
46397
+ */
46398
+ export class HotspotGroupsResult
46399
+ extends Systems.ResultBase
46400
+ implements INativeResource
46401
+ {
46402
+ /** @internal */
46403
+ constructor(pointer: NativePointer) {
46404
+ super(pointer);
46405
+ }
46406
+
46407
+ static fromResultBase(
46408
+ baseInstance: Systems.ResultBase,
46409
+ ): Systems.HotspotGroupsResult {
46410
+ const nativeClassWrapper = baseInstance as unknown as NativeClassWrapper;
46411
+ return new Systems.HotspotGroupsResult(
46412
+ new NativePointer(
46413
+ nativeClassWrapper.pointer,
46414
+ nativeClassWrapper.ownsPointer,
46415
+ ),
46416
+ );
46417
+ }
46418
+
46419
+ getHotspotGroups(): Common.Array<Systems.HotspotGroup> {
46420
+ var _ret = Module._malloc(8);
46421
+
46422
+ Module.ccall(
46423
+ "csp_systems_HotspotGroupsResult_GetHotspotGroupsC_ArrayRC",
46424
+ "void",
46425
+ ["number", "number"],
46426
+ [_ret, this.pointer],
46427
+ );
46428
+ var _nPtr = new Common.Array<Systems.HotspotGroup>(
46429
+ getNativePointer(_ret),
46430
+ csp_systems_HotspotGroupFactory,
46431
+ "csp_systems_HotspotGroup",
46432
+ );
46433
+ Module._free(_ret);
46434
+
46435
+ return _nPtr;
46436
+ }
46437
+
46438
+ delete(): void {
46439
+ if (this.ownsPointer && !this.disposed) {
46440
+ Module.ccall(
46441
+ "csp_systems_HotspotGroupsResult_Dtor",
46442
+ "void",
46443
+ ["number"],
46444
+ [this.pointer],
46445
+ );
46446
+
46447
+ this.disposed = true;
46448
+ }
46449
+ }
46450
+ }
46451
+ }
46452
+
46453
+ export namespace Systems {
46454
+ /**
46455
+ @ingroup HotspotSequenceSystem System
46456
+ * @description Public facing system that allows the management of groupings of hotspots in a space.
46457
+ */
46458
+ export class HotspotSequenceSystem
46459
+ extends Systems.SystemBase
46460
+ implements INativeResource
46461
+ {
46462
+ /** @internal */
46463
+ constructor(pointer: NativePointer) {
46464
+ super(pointer);
46465
+ }
46466
+
46467
+ static fromSystemBase(
46468
+ baseInstance: Systems.SystemBase,
46469
+ ): Systems.HotspotSequenceSystem {
46470
+ const nativeClassWrapper = baseInstance as unknown as NativeClassWrapper;
46471
+ return new Systems.HotspotSequenceSystem(
46472
+ new NativePointer(
46473
+ nativeClassWrapper.pointer,
46474
+ nativeClassWrapper.ownsPointer,
46475
+ ),
46476
+ );
46477
+ }
46478
+
46479
+ static create_sequenceSystem_spaceSystem(
46480
+ sequenceSystem: Systems.SequenceSystem,
46481
+ spaceSystem: Systems.SpaceSystem,
46482
+ ): HotspotSequenceSystem {
46483
+ var _ptr = Module._malloc(8);
46484
+ Module.ccall(
46485
+ "csp_systems_HotspotSequenceSystem_Ctor_SequenceSystemP_SpaceSystemP",
46486
+ "void",
46487
+ ["number", "number", "number"],
46488
+ [_ptr, sequenceSystem.pointer, spaceSystem.pointer],
46489
+ );
46490
+ var _nPtr = getNativePointer(_ptr);
46491
+
46492
+ return new HotspotSequenceSystem(_nPtr);
46493
+ }
46494
+
46495
+ /**
46496
+ * @description Create a Hotspot group
46497
+ * @param groupName - The unique grouping name
46498
+ * @param hotspotIds - Set of hotspot ids to add to the group
46499
+ * @param callback - Callback to call when a response is received
46500
+ */
46501
+
46502
+ async createHotspotGroup(
46503
+ arg1: string,
46504
+ hotspotIds: Common.Array<string>,
46505
+ ): Promise<Systems.HotspotGroupResult> {
46506
+ var _resolve;
46507
+
46508
+ var _promise = new Promise<Systems.HotspotGroupResult>((_r) => {
46509
+ _resolve = _r;
46510
+ });
46511
+
46512
+ var _callbackPtr: number;
46513
+ var _callback = (_stateObject__: number, result) => {
46514
+ var _resultPtr = getNativePointer(result);
46515
+ var _resultInstance = new Systems.HotspotGroupResult(_resultPtr);
46516
+
46517
+ if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
46518
+ return;
46519
+ }
46520
+
46521
+ _resolve(_resultInstance);
46522
+
46523
+ Module.removeFunction(_callbackPtr);
46524
+ };
46525
+
46526
+ _callbackPtr = Module.addFunction(_callback, "vii");
46527
+
46528
+ Module.ccall(
46529
+ "csp_systems_HotspotSequenceSystem_CreateHotspotGroup_void_StringRC_ArrayRC_HotspotGroupResultCallback",
46530
+ "void",
46531
+ ["number", "string", "number", "number", "number"],
46532
+ [this.pointer, arg1, hotspotIds.pointer, _callbackPtr, 0],
46533
+ );
46534
+
46535
+ return _promise;
46536
+ }
46537
+
46538
+ /**
46539
+ * @description Rename a Hotspot group
46540
+ * @param currentGroupName - The unique grouping name
46541
+ * @param newGroupName - The unique grouping name
46542
+ * @param callback - Callback to call when a response is received
46543
+ */
46544
+
46545
+ async renameHotspotGroup(
46546
+ groupName: string,
46547
+ newGroupName: string,
46548
+ ): Promise<Systems.HotspotGroupResult> {
46549
+ var _resolve;
46550
+
46551
+ var _promise = new Promise<Systems.HotspotGroupResult>((_r) => {
46552
+ _resolve = _r;
46553
+ });
46554
+
46555
+ var _callbackPtr: number;
46556
+ var _callback = (_stateObject__: number, result) => {
46557
+ var _resultPtr = getNativePointer(result);
46558
+ var _resultInstance = new Systems.HotspotGroupResult(_resultPtr);
46559
+
46560
+ if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
46561
+ return;
46562
+ }
46563
+
46564
+ _resolve(_resultInstance);
46565
+
46566
+ Module.removeFunction(_callbackPtr);
46567
+ };
46568
+
46569
+ _callbackPtr = Module.addFunction(_callback, "vii");
46570
+
46571
+ Module.ccall(
46572
+ "csp_systems_HotspotSequenceSystem_RenameHotspotGroup_void_StringRC_StringRC_HotspotGroupResultCallback",
46573
+ "void",
46574
+ ["number", "string", "string", "number", "number"],
46575
+ [this.pointer, groupName, newGroupName, _callbackPtr, 0],
46576
+ );
46577
+
46578
+ return _promise;
46579
+ }
46580
+
46581
+ /**
46582
+ * @description Update a Hotspot group
46583
+ * @param groupName - The unique grouping name
46584
+ * @param hotspotIds - Set of hotspot ids to replace
46585
+ * @param callback - Callback to call when a response is received
46586
+ */
46587
+
46588
+ async updateHotspotGroup(
46589
+ groupName: string,
46590
+ hotspotIds: Common.Array<string>,
46591
+ ): Promise<Systems.HotspotGroupResult> {
46592
+ var _resolve;
46593
+
46594
+ var _promise = new Promise<Systems.HotspotGroupResult>((_r) => {
46595
+ _resolve = _r;
46596
+ });
46597
+
46598
+ var _callbackPtr: number;
46599
+ var _callback = (_stateObject__: number, result) => {
46600
+ var _resultPtr = getNativePointer(result);
46601
+ var _resultInstance = new Systems.HotspotGroupResult(_resultPtr);
46602
+
46603
+ if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
46604
+ return;
46605
+ }
46606
+
46607
+ _resolve(_resultInstance);
46608
+
46609
+ Module.removeFunction(_callbackPtr);
46610
+ };
46611
+
46612
+ _callbackPtr = Module.addFunction(_callback, "vii");
46613
+
46614
+ Module.ccall(
46615
+ "csp_systems_HotspotSequenceSystem_UpdateHotspotGroup_void_StringRC_ArrayRC_HotspotGroupResultCallback",
46616
+ "void",
46617
+ ["number", "string", "number", "number", "number"],
46618
+ [this.pointer, groupName, hotspotIds.pointer, _callbackPtr, 0],
46619
+ );
46620
+
46621
+ return _promise;
46622
+ }
46623
+
46624
+ /**
46625
+ * @description Get a Hotspot group by name
46626
+ * @param groupName - The unique grouping name
46627
+ * @param callback - Callback to call when a response is received
46628
+ */
46629
+
46630
+ async getHotspotGroup(
46631
+ groupName: string,
46632
+ ): Promise<Systems.HotspotGroupResult> {
46633
+ var _resolve;
46634
+
46635
+ var _promise = new Promise<Systems.HotspotGroupResult>((_r) => {
46636
+ _resolve = _r;
46637
+ });
46638
+
46639
+ var _callbackPtr: number;
46640
+ var _callback = (_stateObject__: number, result) => {
46641
+ var _resultPtr = getNativePointer(result);
46642
+ var _resultInstance = new Systems.HotspotGroupResult(_resultPtr);
46643
+
46644
+ if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
46645
+ return;
46646
+ }
46647
+
46648
+ _resolve(_resultInstance);
46649
+
46650
+ Module.removeFunction(_callbackPtr);
46651
+ };
46652
+
46653
+ _callbackPtr = Module.addFunction(_callback, "vii");
46654
+
46655
+ Module.ccall(
46656
+ "csp_systems_HotspotSequenceSystem_GetHotspotGroup_void_StringRC_HotspotGroupResultCallback",
46657
+ "void",
46658
+ ["number", "string", "number", "number"],
46659
+ [this.pointer, groupName, _callbackPtr, 0],
46660
+ );
46661
+
46662
+ return _promise;
46663
+ }
46664
+
46665
+ /**
46666
+ * @description Get all Hotspot groups for the current space and logged in user.
46667
+ * @param callback - Callback to call when a response is received
46668
+ */
46669
+
46670
+ async getHotspotGroups(): Promise<Systems.HotspotGroupsResult> {
46671
+ var _resolve;
46672
+
46673
+ var _promise = new Promise<Systems.HotspotGroupsResult>((_r) => {
46674
+ _resolve = _r;
46675
+ });
46676
+
46677
+ var _callbackPtr: number;
46678
+ var _callback = (_stateObject__: number, result) => {
46679
+ var _resultPtr = getNativePointer(result);
46680
+ var _resultInstance = new Systems.HotspotGroupsResult(_resultPtr);
46681
+
46682
+ if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
46683
+ return;
46684
+ }
46685
+
46686
+ _resolve(_resultInstance);
46687
+
46688
+ Module.removeFunction(_callbackPtr);
46689
+ };
46690
+
46691
+ _callbackPtr = Module.addFunction(_callback, "vii");
46692
+
46693
+ Module.ccall(
46694
+ "csp_systems_HotspotSequenceSystem_GetHotspotGroups_void_HotspotGroupsResultCallback",
46695
+ "void",
46696
+ ["number", "number", "number"],
46697
+ [this.pointer, _callbackPtr, 0],
46698
+ );
46699
+
46700
+ return _promise;
46701
+ }
46702
+
46703
+ /**
46704
+ * @description Delete a Hotspot group by name
46705
+ * @param groupName - The unique grouping name
46706
+ * @param callback - Callback to call when a response is received
46707
+ */
46708
+
46709
+ async deleteHotspotGroup(groupName: string): Promise<Systems.NullResult> {
46710
+ var _resolve;
46711
+
46712
+ var _promise = new Promise<Systems.NullResult>((_r) => {
46713
+ _resolve = _r;
46714
+ });
46715
+
46716
+ var _callbackPtr: number;
46717
+ var _callback = (_stateObject__: number, result) => {
46718
+ var _resultPtr = getNativePointer(result);
46719
+ var _resultInstance = new Systems.NullResult(_resultPtr);
46720
+
46721
+ if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
46722
+ return;
46723
+ }
46724
+
46725
+ _resolve(_resultInstance);
46726
+
46727
+ Module.removeFunction(_callbackPtr);
46728
+ };
46729
+
46730
+ _callbackPtr = Module.addFunction(_callback, "vii");
46731
+
46732
+ Module.ccall(
46733
+ "csp_systems_HotspotSequenceSystem_DeleteHotspotGroup_void_StringRC_NullResultCallback",
46734
+ "void",
46735
+ ["number", "string", "number", "number"],
46736
+ [this.pointer, groupName, _callbackPtr, 0],
46737
+ );
46738
+
46739
+ return _promise;
46740
+ }
46741
+
46742
+ delete(): void {
46743
+ if (this.ownsPointer && !this.disposed) {
46744
+ Module.ccall(
46745
+ "csp_systems_HotspotSequenceSystem_Dtor",
46746
+ "void",
46747
+ ["number"],
46748
+ [this.pointer],
46749
+ );
46750
+
46751
+ this.disposed = true;
46752
+ }
46753
+ }
46754
+ }
46755
+ }
46756
+
46099
46757
  export namespace Systems {
46100
46758
  /**
46101
46759
  @ingroup CSPFoundation
@@ -47681,10 +48339,11 @@ export namespace Systems {
47681
48339
  /**
47682
48340
  * @description Creates a new sequence. If a sequence already exists with this key, it will overwrite the current one.
47683
48341
  * This call will fail if the user isn't a creator of the space.
47684
- * @param sequenceKey - The unique grouping name. The suggested convention is: Type:[Id]
47685
- * @param referenceType - The type of reference (GroupId, SpaceId etc.)
48342
+ * @param sequenceKey - The unique grouping name. Our naming convention is: Type:[SpaceId]:[GroupName]
48343
+ * @param referenceType - The type of reference (GroupId etc.)
47686
48344
  * @param referenceId - The id of the reference
47687
48345
  * @param items - An ordered array of members
48346
+ * @param metaData - Any additional data relating to the Sequence
47688
48347
  * @param callback - Callback to call when a response is received
47689
48348
  */
47690
48349
 
@@ -47693,6 +48352,7 @@ export namespace Systems {
47693
48352
  referenceType: string,
47694
48353
  referenceId: string,
47695
48354
  items: Common.Array<string>,
48355
+ metaData: Common.Map<string, string>,
47696
48356
  ): Promise<Systems.SequenceResult> {
47697
48357
  var _resolve;
47698
48358
 
@@ -47717,15 +48377,25 @@ export namespace Systems {
47717
48377
  _callbackPtr = Module.addFunction(_callback, "vii");
47718
48378
 
47719
48379
  Module.ccall(
47720
- "csp_systems_SequenceSystem_CreateSequence_void_StringRC_StringRC_StringRC_ArrayRC_SequenceResultCallback",
48380
+ "csp_systems_SequenceSystem_CreateSequence_void_StringRC_StringRC_StringRC_ArrayRC_MapRC_SequenceResultCallback",
47721
48381
  "void",
47722
- ["number", "string", "string", "string", "number", "number", "number"],
48382
+ [
48383
+ "number",
48384
+ "string",
48385
+ "string",
48386
+ "string",
48387
+ "number",
48388
+ "number",
48389
+ "number",
48390
+ "number",
48391
+ ],
47723
48392
  [
47724
48393
  this.pointer,
47725
48394
  sequenceKey,
47726
48395
  referenceType,
47727
48396
  referenceId,
47728
48397
  items.pointer,
48398
+ metaData.pointer,
47729
48399
  _callbackPtr,
47730
48400
  0,
47731
48401
  ],
@@ -47736,10 +48406,11 @@ export namespace Systems {
47736
48406
 
47737
48407
  /**
47738
48408
  * @description Updates an existing sequence. This call will fail if the user isn't a creator of the space.
47739
- * @param sequenceKey - The unique grouping name. The suggested convention is: Type:[Id]
47740
- * @param referenceType - The type of reference (GroupId, SpaceId etc.)
48409
+ * @param sequenceKey - The unique grouping name. Our naming convention is: Type:[SpaceId]:[GroupName]
48410
+ * @param referenceType - The type of reference (GroupId etc.)
47741
48411
  * @param referenceId - The id of the reference
47742
48412
  * @param items - An ordered array of members
48413
+ * @param metaData - Any additional data relating to the Sequence
47743
48414
  * @param callback - Callback to call when a response is received
47744
48415
  */
47745
48416
 
@@ -47748,6 +48419,7 @@ export namespace Systems {
47748
48419
  referenceType: string,
47749
48420
  referenceId: string,
47750
48421
  items: Common.Array<string>,
48422
+ metaData: Common.Map<string, string>,
47751
48423
  ): Promise<Systems.SequenceResult> {
47752
48424
  var _resolve;
47753
48425
 
@@ -47772,15 +48444,25 @@ export namespace Systems {
47772
48444
  _callbackPtr = Module.addFunction(_callback, "vii");
47773
48445
 
47774
48446
  Module.ccall(
47775
- "csp_systems_SequenceSystem_UpdateSequence_void_StringRC_StringRC_StringRC_ArrayRC_SequenceResultCallback",
48447
+ "csp_systems_SequenceSystem_UpdateSequence_void_StringRC_StringRC_StringRC_ArrayRC_MapRC_SequenceResultCallback",
47776
48448
  "void",
47777
- ["number", "string", "string", "string", "number", "number", "number"],
48449
+ [
48450
+ "number",
48451
+ "string",
48452
+ "string",
48453
+ "string",
48454
+ "number",
48455
+ "number",
48456
+ "number",
48457
+ "number",
48458
+ ],
47778
48459
  [
47779
48460
  this.pointer,
47780
48461
  sequenceKey,
47781
48462
  referenceType,
47782
48463
  referenceId,
47783
48464
  items.pointer,
48465
+ metaData.pointer,
47784
48466
  _callbackPtr,
47785
48467
  0,
47786
48468
  ],
@@ -47836,8 +48518,9 @@ export namespace Systems {
47836
48518
  * @description Finds sequences based on the given criteria
47837
48519
  * @param sequenceKeys - An array of sequence keys to search for
47838
48520
  * @param sequenceKeys - An optional regex string for searching keys
47839
- * @param referenceType - The type of reference (GroupId, SpaceId etc.). Must be used with ReferenceIds
48521
+ * @param referenceType - The type of reference (GroupId etc.). Must be used with ReferenceIds
47840
48522
  * @param referenceIds - The ids of the reference. Must be used with ReferenceType
48523
+ * @param metaData - Any additional data relating to the Sequence
47841
48524
  * @param callback - Callback to call when a response is received
47842
48525
  */
47843
48526
 
@@ -47846,6 +48529,7 @@ export namespace Systems {
47846
48529
  keyRegex: string | null,
47847
48530
  referenceType: string | null,
47848
48531
  referenceIds: Common.Array<string>,
48532
+ metaData: Common.Map<string, string>,
47849
48533
  ): Promise<Systems.SequencesResult> {
47850
48534
  var _resolve;
47851
48535
 
@@ -47870,15 +48554,25 @@ export namespace Systems {
47870
48554
  _callbackPtr = Module.addFunction(_callback, "vii");
47871
48555
 
47872
48556
  Module.ccall(
47873
- "csp_systems_SequenceSystem_GetSequencesByCriteria_void_ArrayRC_StringRC_StringRC_ArrayRC_SequencesResultCallback",
48557
+ "csp_systems_SequenceSystem_GetSequencesByCriteria_void_ArrayRC_StringRC_StringRC_ArrayRC_MapRC_SequencesResultCallback",
47874
48558
  "void",
47875
- ["number", "number", "string", "string", "number", "number", "number"],
48559
+ [
48560
+ "number",
48561
+ "number",
48562
+ "string",
48563
+ "string",
48564
+ "number",
48565
+ "number",
48566
+ "number",
48567
+ "number",
48568
+ ],
47876
48569
  [
47877
48570
  this.pointer,
47878
48571
  sequenceKeys.pointer,
47879
48572
  keyRegex,
47880
48573
  referenceType,
47881
48574
  referenceIds.pointer,
48575
+ metaData.pointer,
47882
48576
  _callbackPtr,
47883
48577
  0,
47884
48578
  ],
@@ -54366,6 +55060,24 @@ export namespace Common {
54366
55060
  return _inst;
54367
55061
  }
54368
55062
 
55063
+ static ofcsp_systems_HotspotGroup(): Array<Systems.HotspotGroup> {
55064
+ var _ret = Module._malloc(8);
55065
+ Module.ccall(
55066
+ "csp_common_Array_Ctor_csp_systems_HotspotGroup",
55067
+ "void",
55068
+ ["number"],
55069
+ [_ret],
55070
+ );
55071
+ var _inst = new Array<Systems.HotspotGroup>(
55072
+ getNativePointer(_ret),
55073
+ csp_systems_HotspotGroupFactory,
55074
+ "csp_systems_HotspotGroup",
55075
+ );
55076
+ Module._free(_ret);
55077
+
55078
+ return _inst;
55079
+ }
55080
+
54369
55081
  static ofcsp_systems_MaintenanceInfo(): Array<Systems.MaintenanceInfo> {
54370
55082
  var _ret = Module._malloc(8);
54371
55083
  Module.ccall(
@@ -55126,6 +55838,26 @@ export namespace Common {
55126
55838
  return _inst;
55127
55839
  }
55128
55840
 
55841
+ static ofcsp_systems_HotspotGroup_number(
55842
+ size: number,
55843
+ ): Array<Systems.HotspotGroup> {
55844
+ var _ret = Module._malloc(8);
55845
+ Module.ccall(
55846
+ "csp_common_Array_Conv_size_tC_csp_systems_HotspotGroup",
55847
+ "void",
55848
+ ["number", "number"],
55849
+ [_ret, size],
55850
+ );
55851
+ var _inst = new Array<Systems.HotspotGroup>(
55852
+ getNativePointer(_ret),
55853
+ csp_systems_HotspotGroupFactory,
55854
+ "csp_systems_HotspotGroup",
55855
+ );
55856
+ Module._free(_ret);
55857
+
55858
+ return _inst;
55859
+ }
55860
+
55129
55861
  static ofcsp_systems_MaintenanceInfo_number(
55130
55862
  size: number,
55131
55863
  ): Array<Systems.MaintenanceInfo> {