connected-spaces-platform.web 6.26.0 → 6.28.0

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.
@@ -6523,6 +6523,12 @@ export declare namespace Common {
6523
6523
  set referenceId(value: string);
6524
6524
  get referenceType(): string;
6525
6525
  set referenceType(value: string);
6526
+ get references(): Common.Map<string, string>;
6527
+ set references(value: Common.Map<string, string>);
6528
+ get success(): boolean;
6529
+ set success(value: boolean);
6530
+ get statusReason(): string;
6531
+ set statusReason(value: string);
6526
6532
  }
6527
6533
  }
6528
6534
  export declare namespace Multiplayer {
@@ -10763,20 +10769,20 @@ export declare namespace Systems {
10763
10769
  getAssetCollectionByName(assetCollectionName: string): Promise<Systems.AssetCollectionResult>;
10764
10770
  /**
10765
10771
  * @description Retrieves asset collections based on the specified search criteria.
10772
+ * These parameters filter the search criteria using the intersection of the provided parameters.
10766
10773
  * Results pagination is supported through the use of ResultsSkipNumber and ResultsMaxNumber.
10767
- * @param space - Optional space to get asset collections associated with it
10768
- * @param assetCollectionParentId - Optional asset collection parent id to get asset collections associated with it
10769
- * @param assetCollectionType - Type of the asset collection
10770
- * @param assetCollectionTags - Optional array of strings representing asset collection tags
10771
- * @param assetCollectionNames - Optional array of strings representing asset
10772
- * collection names
10773
- * @param resultsSkipNumber - Optional param representing the number of result entries that will be skipped from the result. for no skip pass
10774
+ * @param assetCollectionIds - Search for asset collections with these ids.
10775
+ * @param parentId - Search for asset collections with this parent id.
10776
+ * @param names - Search for asset collections with these names.
10777
+ * @param types - Search for asset collections of these types.
10778
+ * @param tags - Search for asset collections with these user provided tags.
10779
+ * @param spaceIds - Search for asset collections associated with the provided spaces.
10780
+ * @param resultsSkipNumber - The number of result entries that will be skipped from the result. For no skip pass
10774
10781
  * nullptr.
10775
- * @param resultsMaxNumber - Optional param representing the maximum number of result entries to be retrieved. for all available result
10776
- * entries pass nullptr.
10777
- * @param callback - Callback when asynchronous task finishes
10782
+ * @param resultsMaxNumber - The maximum number of result entries to be retrieved. For all available results pass nullptr.
10783
+ * @param callback - Callback when asynchronous task finishes.
10778
10784
  */
10779
- findAssetCollections(ids: Common.Array<string> | null, parentId: string | null, names: Common.Array<string> | null, types: Common.Array<Systems.EAssetCollectionType> | null, tags: Common.Array<string> | null, spaceIds: Common.Array<string> | null, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Systems.AssetCollectionsResult>;
10785
+ findAssetCollections(assetCollectionIds: Common.Array<string> | null, parentId: string | null, names: Common.Array<string> | null, types: Common.Array<Systems.EAssetCollectionType> | null, tags: Common.Array<string> | null, spaceIds: Common.Array<string> | null, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Systems.AssetCollectionsResult>;
10780
10786
  /**
10781
10787
  * @description Updates the Metadata field of an Asset Collection
10782
10788
  * @param assetCollection - Asset collection to be updated
@@ -12845,11 +12851,14 @@ export declare namespace Systems {
12845
12851
  /**
12846
12852
  * @description Duplicate an existing space and assign it to the current user.
12847
12853
  * This is an asynchronous operation. If the user disconnects while waiting for the operation to complete it will continue unaffected. Please
12848
- * subcribe to the AsyncCallCompletedCallback via @ref SpaceSystem::SetAsyncCallCompletedCallback() to be notified when the duplication operation
12854
+ * subscribe to the AsyncCallCompletedCallback via @ref SpaceSystem::SetAsyncCallCompletedCallback() to be notified when the duplication operation
12849
12855
  * is complete. The AsyncCallCompletedEventData returned by the AsyncCallCompletedCallback will contain the following information:
12850
12856
  * - OperationName: "DuplicateSpaceAsync".
12851
- * - ReferenceId: Id of the newly duplicated Space.
12852
- * - ReferenceType: "GroupId".
12857
+ * - References: A String map containing the following key:value pairs:
12858
+ * - "OrignalSpaceId": Id of the original Space.
12859
+ * - "SpaceId": Id of the newly duplicated Space.
12860
+ * - Success: A boolean value indicating whether the duplication operation was successful.
12861
+ * - StatusReason: This will be an empty string if the operation was successful, but if the operation failed it will contain the failure status.
12853
12862
  * @param spaceId - Id of the space to duplicate.
12854
12863
  * @param newName - A unique name for the duplicated space.
12855
12864
  * @param newAttributes - Attributes to apply to the duplicated space.
@@ -13566,15 +13575,15 @@ export declare namespace Common {
13566
13575
  private TKeyTypeName;
13567
13576
  private TValueTypeFactory;
13568
13577
  private TValueTypeName;
13569
- static ofStringAndcsp_common_ReplicatedValue(): Map<string, Common.ReplicatedValue>;
13570
13578
  static ofStringAndString(): Map<string, string>;
13579
+ static ofStringAndcsp_common_ReplicatedValue(): Map<string, Common.ReplicatedValue>;
13571
13580
  static ofUInt32Andcsp_common_ReplicatedValue(): Map<number, Common.ReplicatedValue>;
13572
13581
  static ofUInt16Andcsp_multiplayer_ComponentBase(): Map<number, Multiplayer.ComponentBase>;
13573
13582
  static ofStringAndcsp_systems_Asset(): Map<string, Systems.Asset>;
13574
13583
  static ofStringAndcsp_common_Map_String_String(): Map<string, Common.Map<string, string>>;
13575
13584
  static ofStringAndcsp_common_Array_String(): Map<string, Common.Array<string>>;
13576
- static ofStringAndcsp_common_ReplicatedValue_Map(other: Common.Map<string, Common.ReplicatedValue>): Map<string, Common.ReplicatedValue>;
13577
13585
  static ofStringAndString_Map(other: Common.Map<string, string>): Map<string, string>;
13586
+ static ofStringAndcsp_common_ReplicatedValue_Map(other: Common.Map<string, Common.ReplicatedValue>): Map<string, Common.ReplicatedValue>;
13578
13587
  static ofUInt32Andcsp_common_ReplicatedValue_Map(other: Common.Map<number, Common.ReplicatedValue>): Map<number, Common.ReplicatedValue>;
13579
13588
  static ofUInt16Andcsp_multiplayer_ComponentBase_Map(other: Common.Map<number, Multiplayer.ComponentBase>): Map<number, Multiplayer.ComponentBase>;
13580
13589
  static ofStringAndcsp_systems_Asset_Map(other: Common.Map<string, Systems.Asset>): Map<string, Systems.Asset>;
@@ -2011,16 +2011,16 @@ function csp_common_List_csp_common_Vector3Factory(nativePointer) {
2011
2011
  }
2012
2012
  ProxyClassFactories["csp_common_List_csp_common_Vector3"] =
2013
2013
  csp_common_List_csp_common_Vector3Factory;
2014
- function csp_common_Map_String_csp_common_ReplicatedValueFactory(nativePointer) {
2015
- return new Common.Map(nativePointer, StringFactory, "String", csp_common_ReplicatedValueFactory, "csp_common_ReplicatedValue");
2016
- }
2017
- ProxyClassFactories["csp_common_Map_String_csp_common_ReplicatedValue"] =
2018
- csp_common_Map_String_csp_common_ReplicatedValueFactory;
2019
2014
  function csp_common_Map_String_StringFactory(nativePointer) {
2020
2015
  return new Common.Map(nativePointer, StringFactory, "String", StringFactory, "String");
2021
2016
  }
2022
2017
  ProxyClassFactories["csp_common_Map_String_String"] =
2023
2018
  csp_common_Map_String_StringFactory;
2019
+ function csp_common_Map_String_csp_common_ReplicatedValueFactory(nativePointer) {
2020
+ return new Common.Map(nativePointer, StringFactory, "String", csp_common_ReplicatedValueFactory, "csp_common_ReplicatedValue");
2021
+ }
2022
+ ProxyClassFactories["csp_common_Map_String_csp_common_ReplicatedValue"] =
2023
+ csp_common_Map_String_csp_common_ReplicatedValueFactory;
2024
2024
  function csp_common_Map_UInt32_csp_common_ReplicatedValueFactory(nativePointer) {
2025
2025
  return new Common.Map(nativePointer, NumberFactory, "UInt32", csp_common_ReplicatedValueFactory, "csp_common_ReplicatedValue");
2026
2026
  }
@@ -16576,6 +16576,29 @@ export class CSPFoundation {
16576
16576
  set referenceType(value) {
16577
16577
  Module.ccall("csp_common_AsyncCallCompletedEventData__Set_ReferenceType", "void", ["number", "string"], [this.pointer, value]);
16578
16578
  }
16579
+ get references() {
16580
+ const _ptr = Module._malloc(8);
16581
+ Module.ccall("csp_common_AsyncCallCompletedEventData__Get_References", "void", ["number", "number"], [_ptr, this.pointer]);
16582
+ const _nPtr = getNativePointer(_ptr);
16583
+ return new Common.Map(_nPtr, StringFactory, "String", StringFactory, "String");
16584
+ }
16585
+ set references(value) {
16586
+ Module.ccall("csp_common_AsyncCallCompletedEventData__Set_References", "void", ["number", "number"], [this.pointer, value.pointer]);
16587
+ }
16588
+ get success() {
16589
+ let _result = Module.ccall("csp_common_AsyncCallCompletedEventData__Get_Success", "boolean", ["number"], [this.pointer]);
16590
+ return _result;
16591
+ }
16592
+ set success(value) {
16593
+ Module.ccall("csp_common_AsyncCallCompletedEventData__Set_Success", "void", ["number", "boolean"], [this.pointer, value]);
16594
+ }
16595
+ get statusReason() {
16596
+ let _result = Module.ccall("csp_common_AsyncCallCompletedEventData__Get_StatusReason", "string", ["number"], [this.pointer]);
16597
+ return _result;
16598
+ }
16599
+ set statusReason(value) {
16600
+ Module.ccall("csp_common_AsyncCallCompletedEventData__Set_StatusReason", "void", ["number", "string"], [this.pointer, value]);
16601
+ }
16579
16602
  }
16580
16603
  Common.AsyncCallCompletedEventData = AsyncCallCompletedEventData;
16581
16604
  })(Common || (Common = {}));
@@ -24534,20 +24557,20 @@ export class CSPFoundation {
24534
24557
  }
24535
24558
  /**
24536
24559
  * @description Retrieves asset collections based on the specified search criteria.
24560
+ * These parameters filter the search criteria using the intersection of the provided parameters.
24537
24561
  * Results pagination is supported through the use of ResultsSkipNumber and ResultsMaxNumber.
24538
- * @param space - Optional space to get asset collections associated with it
24539
- * @param assetCollectionParentId - Optional asset collection parent id to get asset collections associated with it
24540
- * @param assetCollectionType - Type of the asset collection
24541
- * @param assetCollectionTags - Optional array of strings representing asset collection tags
24542
- * @param assetCollectionNames - Optional array of strings representing asset
24543
- * collection names
24544
- * @param resultsSkipNumber - Optional param representing the number of result entries that will be skipped from the result. for no skip pass
24562
+ * @param assetCollectionIds - Search for asset collections with these ids.
24563
+ * @param parentId - Search for asset collections with this parent id.
24564
+ * @param names - Search for asset collections with these names.
24565
+ * @param types - Search for asset collections of these types.
24566
+ * @param tags - Search for asset collections with these user provided tags.
24567
+ * @param spaceIds - Search for asset collections associated with the provided spaces.
24568
+ * @param resultsSkipNumber - The number of result entries that will be skipped from the result. For no skip pass
24545
24569
  * nullptr.
24546
- * @param resultsMaxNumber - Optional param representing the maximum number of result entries to be retrieved. for all available result
24547
- * entries pass nullptr.
24548
- * @param callback - Callback when asynchronous task finishes
24570
+ * @param resultsMaxNumber - The maximum number of result entries to be retrieved. For all available results pass nullptr.
24571
+ * @param callback - Callback when asynchronous task finishes.
24549
24572
  */
24550
- async findAssetCollections(ids, parentId, names, types, tags, spaceIds, resultsSkipNumber, resultsMaxNumber) {
24573
+ async findAssetCollections(assetCollectionIds, parentId, names, types, tags, spaceIds, resultsSkipNumber, resultsMaxNumber) {
24551
24574
  var _resolve;
24552
24575
  var _promise = new Promise((_r) => {
24553
24576
  _resolve = _r;
@@ -24587,7 +24610,7 @@ export class CSPFoundation {
24587
24610
  "number",
24588
24611
  ], [
24589
24612
  this.pointer,
24590
- ids != null ? ids.pointer : 0,
24613
+ assetCollectionIds != null ? assetCollectionIds.pointer : 0,
24591
24614
  parentId,
24592
24615
  names != null ? names.pointer : 0,
24593
24616
  types != null ? types.pointer : 0,
@@ -30440,11 +30463,14 @@ export class CSPFoundation {
30440
30463
  /**
30441
30464
  * @description Duplicate an existing space and assign it to the current user.
30442
30465
  * This is an asynchronous operation. If the user disconnects while waiting for the operation to complete it will continue unaffected. Please
30443
- * subcribe to the AsyncCallCompletedCallback via @ref SpaceSystem::SetAsyncCallCompletedCallback() to be notified when the duplication operation
30466
+ * subscribe to the AsyncCallCompletedCallback via @ref SpaceSystem::SetAsyncCallCompletedCallback() to be notified when the duplication operation
30444
30467
  * is complete. The AsyncCallCompletedEventData returned by the AsyncCallCompletedCallback will contain the following information:
30445
30468
  * - OperationName: "DuplicateSpaceAsync".
30446
- * - ReferenceId: Id of the newly duplicated Space.
30447
- * - ReferenceType: "GroupId".
30469
+ * - References: A String map containing the following key:value pairs:
30470
+ * - "OrignalSpaceId": Id of the original Space.
30471
+ * - "SpaceId": Id of the newly duplicated Space.
30472
+ * - Success: A boolean value indicating whether the duplication operation was successful.
30473
+ * - StatusReason: This will be an empty string if the operation was successful, but if the operation failed it will contain the failure status.
30448
30474
  * @param spaceId - Id of the space to duplicate.
30449
30475
  * @param newName - A unique name for the duplicated space.
30450
30476
  * @param newAttributes - Attributes to apply to the duplicated space.
@@ -33116,17 +33142,17 @@ export class CSPFoundation {
33116
33142
  this.TValueTypeFactory = TValueTypeFactory;
33117
33143
  this.TValueTypeName = TValueTypeName;
33118
33144
  }
33119
- static ofStringAndcsp_common_ReplicatedValue() {
33145
+ static ofStringAndString() {
33120
33146
  var _ret = Module._malloc(8);
33121
- Module.ccall("csp_common_Map_Ctor_String_csp_common_ReplicatedValue", "void", ["number"], [_ret]);
33122
- var _inst = new Map(getNativePointer(_ret), StringFactory, "String", csp_common_ReplicatedValueFactory, "csp_common_ReplicatedValue");
33147
+ Module.ccall("csp_common_Map_Ctor_String_String", "void", ["number"], [_ret]);
33148
+ var _inst = new Map(getNativePointer(_ret), StringFactory, "String", StringFactory, "String");
33123
33149
  Module._free(_ret);
33124
33150
  return _inst;
33125
33151
  }
33126
- static ofStringAndString() {
33152
+ static ofStringAndcsp_common_ReplicatedValue() {
33127
33153
  var _ret = Module._malloc(8);
33128
- Module.ccall("csp_common_Map_Ctor_String_String", "void", ["number"], [_ret]);
33129
- var _inst = new Map(getNativePointer(_ret), StringFactory, "String", StringFactory, "String");
33154
+ Module.ccall("csp_common_Map_Ctor_String_csp_common_ReplicatedValue", "void", ["number"], [_ret]);
33155
+ var _inst = new Map(getNativePointer(_ret), StringFactory, "String", csp_common_ReplicatedValueFactory, "csp_common_ReplicatedValue");
33130
33156
  Module._free(_ret);
33131
33157
  return _inst;
33132
33158
  }
@@ -33165,17 +33191,17 @@ export class CSPFoundation {
33165
33191
  Module._free(_ret);
33166
33192
  return _inst;
33167
33193
  }
33168
- static ofStringAndcsp_common_ReplicatedValue_Map(other) {
33194
+ static ofStringAndString_Map(other) {
33169
33195
  var _ret = Module._malloc(8);
33170
- Module.ccall("csp_common_Map_Ctor_MapRC_String_csp_common_ReplicatedValue", "void", ["number", "number"], [_ret, other.pointer]);
33171
- var _inst = new Map(getNativePointer(_ret), StringFactory, "String", csp_common_ReplicatedValueFactory, "csp_common_ReplicatedValue");
33196
+ Module.ccall("csp_common_Map_Ctor_MapRC_String_String", "void", ["number", "number"], [_ret, other.pointer]);
33197
+ var _inst = new Map(getNativePointer(_ret), StringFactory, "String", StringFactory, "String");
33172
33198
  Module._free(_ret);
33173
33199
  return _inst;
33174
33200
  }
33175
- static ofStringAndString_Map(other) {
33201
+ static ofStringAndcsp_common_ReplicatedValue_Map(other) {
33176
33202
  var _ret = Module._malloc(8);
33177
- Module.ccall("csp_common_Map_Ctor_MapRC_String_String", "void", ["number", "number"], [_ret, other.pointer]);
33178
- var _inst = new Map(getNativePointer(_ret), StringFactory, "String", StringFactory, "String");
33203
+ Module.ccall("csp_common_Map_Ctor_MapRC_String_csp_common_ReplicatedValue", "void", ["number", "number"], [_ret, other.pointer]);
33204
+ var _inst = new Map(getNativePointer(_ret), StringFactory, "String", csp_common_ReplicatedValueFactory, "csp_common_ReplicatedValue");
33179
33205
  Module._free(_ret);
33180
33206
  return _inst;
33181
33207
  }