connected-spaces-platform.web 5.21.0 → 5.22.0

package/connectedspacesplatform.d.ts

@@ -1514,7 +1514,7 @@ export declare namespace Systems {
     }
 }
 /**
- * @description Represents definition for identifying and versioning an external service endpoint..
+ * @description Represents definition for identifying and versioning an external service endpoint.
  */
 export declare class ServiceDefinition extends NativeClassWrapper implements INativeResource {
     /** @internal */
@@ -4181,25 +4181,21 @@ export declare namespace Multiplayer {
         sendNetworkEventToClient(eventName: string, args: Common.Array<Common.ReplicatedValue>, targetClientId: bigint): Promise<Multiplayer.ErrorCode>;
         /**
          * @description Register interest in a network event, such that the NetworkEventBus will call the provided callback when it arrives
-         * @param registration - Registration information, containing a ReceiverID and an EventName.
-         * @param callback - Callback to invoke when specified event is received.
-         * @return True if the registration was successful, false otherwise, such as in the case where Registration was not-unique, or the callback was
-         * null.
+         * @param registration - Registration information, containing a ReceiverID and an EventName. Will fail to register if
+         * identical callback registration already registered.
+         * @param callback - Callback to invoke when specified event is received. Will fail to register if null.
          */
-        listenNetworkEvent(registration: Multiplayer.NetworkEventRegistration, callback: (networkEventData: Common.NetworkEventData) => void): boolean;
+        listenNetworkEvent(registration: Multiplayer.NetworkEventRegistration, callback: (networkEventData: Common.NetworkEventData) => void): void;
         /**
          * @description Deregister interest in a network event
          * @param registration - Registration information of already registered event, containing a ReceiverID and an EventName.
-         * @return True if the deregistration was successful, false otherwise, such as in the case where Registration was not found
          */
-        stopListenNetworkEvent(registration: Multiplayer.NetworkEventRegistration): boolean;
+        stopListenNetworkEvent(registration: Multiplayer.NetworkEventRegistration): void;
         /**
          * @description Deregister interest in all network events registered to a particular EventReceiverId
          * @param eventReceiverId - EventReceiverId to deregister.
-         * @return True if the deregistration was successful, false otherwise, such as if no events were found to deregister under the provided
-         * EventReceiverId.
          */
-        stopListenAllNetworkEvents(eventReceiverId: string): boolean;
+        stopListenAllNetworkEvents(eventReceiverId: string): void;
         /**
          * @description Get an array of all interests currently registered to the NetworkEventBus
          * @return Csp::common::array&lt;csp::multiplayer::networkeventregistration&gt; a container of all currently registered registrations.
@@ -4972,6 +4968,58 @@ export declare namespace Systems {
         set sequences(value: Common.Array<Systems.Sequence>);
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Stores the version and deprecation information for a service
+   */
+    class VersionMetadata extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): VersionMetadata;
+        delete(): void;
+        get version(): string;
+        set version(value: string);
+        get deprecationDatetime(): string;
+        set deprecationDatetime(value: string);
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Stores information about a service, including available versions
+   */
+    class ServiceStatus extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): ServiceStatus;
+        delete(): void;
+        get reverseProxy(): string;
+        set reverseProxy(value: string);
+        get name(): string;
+        set name(value: string);
+        get apiVersions(): Common.Array<Systems.VersionMetadata>;
+        set apiVersions(value: Common.Array<Systems.VersionMetadata>);
+        get currentApiVersion(): string;
+        set currentApiVersion(value: string);
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Store information about the current service deployment
+   */
+    class ServicesDeploymentStatus extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): ServicesDeploymentStatus;
+        delete(): void;
+        get version(): string;
+        set version(value: string);
+        get services(): Common.Array<Systems.ServiceStatus>;
+        set services(value: Common.Array<Systems.ServiceStatus>);
+    }
+}
 export declare namespace Systems {
     /**
      * @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient or NetworkEventBus instance in the constructor
@@ -9499,6 +9547,23 @@ export declare namespace Multiplayer {
         delete(): void;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Status System
+   * @description Data class used to contain information when a Response is received from the Status Server
+   */
+    class ServicesDeploymentStatusResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.ServicesDeploymentStatusResult;
+        /**
+         * @description Will return services deployment status for the latest available deployment from the server
+         * @return The latest services deployment status
+         */
+        getLatestServicesDeploymentStatus(): Systems.ServicesDeploymentStatus;
+        delete(): void;
+    }
+}
 export declare namespace Systems {
     /**
      * @description A result handler that is used to notify a user of an error.
@@ -12343,6 +12408,8 @@ export declare namespace Common {
         static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
         static ofcsp_systems_Asset(): Array<Systems.Asset>;
         static ofcsp_systems_Sequence(): Array<Systems.Sequence>;
+        static ofcsp_systems_VersionMetadata(): Array<Systems.VersionMetadata>;
+        static ofcsp_systems_ServiceStatus(): Array<Systems.ServiceStatus>;
         static ofString(): Array<string>;
         static ofcsp_systems_EAssetPlatform(): Array<Systems.EAssetPlatform>;
         static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
@@ -12386,6 +12453,8 @@ export declare namespace Common {
         static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
         static ofcsp_systems_Asset_number(size: number): Array<Systems.Asset>;
         static ofcsp_systems_Sequence_number(size: number): Array<Systems.Sequence>;
+        static ofcsp_systems_VersionMetadata_number(size: number): Array<Systems.VersionMetadata>;
+        static ofcsp_systems_ServiceStatus_number(size: number): Array<Systems.ServiceStatus>;
         static ofString_number(size: number): Array<string>;
         static ofcsp_systems_EAssetPlatform_number(size: number): Array<Systems.EAssetPlatform>;
         static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;

package/connectedspacesplatform.js

@@ -827,6 +827,21 @@ function csp_systems_CSPSceneDataFactory(nativePointer) {
 }
 ProxyClassFactories["csp_systems_CSPSceneData"] =
     csp_systems_CSPSceneDataFactory;
+function csp_systems_VersionMetadataFactory(nativePointer) {
+    return new Systems.VersionMetadata(nativePointer);
+}
+ProxyClassFactories["csp_systems_VersionMetadata"] =
+    csp_systems_VersionMetadataFactory;
+function csp_systems_ServiceStatusFactory(nativePointer) {
+    return new Systems.ServiceStatus(nativePointer);
+}
+ProxyClassFactories["csp_systems_ServiceStatus"] =
+    csp_systems_ServiceStatusFactory;
+function csp_systems_ServicesDeploymentStatusFactory(nativePointer) {
+    return new Systems.ServicesDeploymentStatus(nativePointer);
+}
+ProxyClassFactories["csp_systems_ServicesDeploymentStatus"] =
+    csp_systems_ServicesDeploymentStatusFactory;
 function csp_systems_SystemBaseFactory(nativePointer) {
     return new Systems.SystemBase(nativePointer);
 }
@@ -1229,6 +1244,11 @@ function csp_multiplayer_AnnotationThumbnailCollectionResultFactory(nativePointe
 }
 ProxyClassFactories["csp_multiplayer_AnnotationThumbnailCollectionResult"] =
     csp_multiplayer_AnnotationThumbnailCollectionResultFactory;
+function csp_systems_ServicesDeploymentStatusResultFactory(nativePointer) {
+    return new Systems.ServicesDeploymentStatusResult(nativePointer);
+}
+ProxyClassFactories["csp_systems_ServicesDeploymentStatusResult"] =
+    csp_systems_ServicesDeploymentStatusResultFactory;
 function csp_systems_NullResultFactory(nativePointer) {
     return new Systems.NullResult(nativePointer);
 }
@@ -1671,6 +1691,16 @@ function csp_common_Array_csp_systems_SequenceFactory(nativePointer) {
 }
 ProxyClassFactories["csp_common_Array_csp_systems_Sequence"] =
     csp_common_Array_csp_systems_SequenceFactory;
+function csp_common_Array_csp_systems_VersionMetadataFactory(nativePointer) {
+    return new Common.Array(nativePointer, csp_systems_VersionMetadataFactory, "csp_systems_VersionMetadata");
+}
+ProxyClassFactories["csp_common_Array_csp_systems_VersionMetadata"] =
+    csp_common_Array_csp_systems_VersionMetadataFactory;
+function csp_common_Array_csp_systems_ServiceStatusFactory(nativePointer) {
+    return new Common.Array(nativePointer, csp_systems_ServiceStatusFactory, "csp_systems_ServiceStatus");
+}
+ProxyClassFactories["csp_common_Array_csp_systems_ServiceStatus"] =
+    csp_common_Array_csp_systems_ServiceStatusFactory;
 function csp_common_Array_StringFactory(nativePointer) {
     return new Common.Array(nativePointer, StringFactory, "String");
 }
@@ -3187,7 +3217,7 @@ export var Systems;
     })(EThirdPartyAuthenticationProviders = Systems.EThirdPartyAuthenticationProviders || (Systems.EThirdPartyAuthenticationProviders = {}));
 })(Systems || (Systems = {}));
 /**
- * @description Represents definition for identifying and versioning an external service endpoint..
+ * @description Represents definition for identifying and versioning an external service endpoint.
  */
 export class ServiceDefinition extends NativeClassWrapper {
     /** @internal */
@@ -10884,38 +10914,31 @@ export class CSPFoundation {
         }
         /**
          * @description Register interest in a network event, such that the NetworkEventBus will call the provided callback when it arrives
-         * @param registration - Registration information, containing a ReceiverID and an EventName.
-         * @param callback - Callback to invoke when specified event is received.
-         * @return True if the registration was successful, false otherwise, such as in the case where Registration was not-unique, or the callback was
-         * null.
+         * @param registration - Registration information, containing a ReceiverID and an EventName. Will fail to register if
+         * identical callback registration already registered.
+         * @param callback - Callback to invoke when specified event is received. Will fail to register if null.
          */
         listenNetworkEvent(registration, callback) {
             var _callback = (_stateObject__, networkEventData) => {
                 var _networkEventData = new Common.NetworkEventData(getNativePointer(networkEventData));
                 callback(_networkEventData);
             };
-            var callbackPtr = Module.addFunction(_callback, "iii");
-            let _result = Module.ccall("csp_multiplayer_NetworkEventBus_ListenNetworkEvent_bool_NetworkEventRegistration_NetworkEventCallback", "boolean", ["number", "number", "number"], [this.pointer, registration.pointer, callbackPtr]);
-            return _result;
+            var callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_multiplayer_NetworkEventBus_ListenNetworkEvent_void_NetworkEventRegistration_NetworkEventCallback", "void", ["number", "number", "number"], [this.pointer, registration.pointer, callbackPtr]);
         }
         /**
          * @description Deregister interest in a network event
          * @param registration - Registration information of already registered event, containing a ReceiverID and an EventName.
-         * @return True if the deregistration was successful, false otherwise, such as in the case where Registration was not found
          */
         stopListenNetworkEvent(registration) {
-            let _result = Module.ccall("csp_multiplayer_NetworkEventBus_StopListenNetworkEvent_bool_NetworkEventRegistration", "boolean", ["number", "number"], [this.pointer, registration.pointer]);
-            return _result;
+            Module.ccall("csp_multiplayer_NetworkEventBus_StopListenNetworkEvent_void_NetworkEventRegistration", "void", ["number", "number"], [this.pointer, registration.pointer]);
         }
         /**
          * @description Deregister interest in all network events registered to a particular EventReceiverId
          * @param eventReceiverId - EventReceiverId to deregister.
-         * @return True if the deregistration was successful, false otherwise, such as if no events were found to deregister under the provided
-         * EventReceiverId.
          */
         stopListenAllNetworkEvents(eventReceiverId) {
-            let _result = Module.ccall("csp_multiplayer_NetworkEventBus_StopListenAllNetworkEvents_bool_StringRC", "boolean", ["number", "string"], [this.pointer, eventReceiverId]);
-            return _result;
+            Module.ccall("csp_multiplayer_NetworkEventBus_StopListenAllNetworkEvents_void_StringRC", "void", ["number", "string"], [this.pointer, eventReceiverId]);
         }
         /**
          * @description Get an array of all interests currently registered to the NetworkEventBus
@@ -12501,6 +12524,141 @@ export class CSPFoundation {
     }
     Systems.CSPSceneData = CSPSceneData;
 })(Systems || (Systems = {}));
+(function (Systems) {
+    /**
+  @ingroup Status System
+   * @description Stores the version and deprecation information for a service
+   */
+    class VersionMetadata extends NativeClassWrapper {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        static create() {
+            var _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_VersionMetadata_Ctor", "void", ["number"], [_ptr]);
+            var _nPtr = getNativePointer(_ptr);
+            return new VersionMetadata(_nPtr);
+        }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_systems_VersionMetadata_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+        get version() {
+            let _result = Module.ccall("csp_systems_VersionMetadata__Get_Version", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set version(value) {
+            Module.ccall("csp_systems_VersionMetadata__Set_Version", "void", ["number", "string"], [this.pointer, value]);
+        }
+        get deprecationDatetime() {
+            let _result = Module.ccall("csp_systems_VersionMetadata__Get_DeprecationDatetime", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set deprecationDatetime(value) {
+            Module.ccall("csp_systems_VersionMetadata__Set_DeprecationDatetime", "void", ["number", "string"], [this.pointer, value]);
+        }
+    }
+    Systems.VersionMetadata = VersionMetadata;
+})(Systems || (Systems = {}));
+(function (Systems) {
+    /**
+  @ingroup Status System
+   * @description Stores information about a service, including available versions
+   */
+    class ServiceStatus extends NativeClassWrapper {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        static create() {
+            var _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_ServiceStatus_Ctor", "void", ["number"], [_ptr]);
+            var _nPtr = getNativePointer(_ptr);
+            return new ServiceStatus(_nPtr);
+        }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_systems_ServiceStatus_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+        get reverseProxy() {
+            let _result = Module.ccall("csp_systems_ServiceStatus__Get_ReverseProxy", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set reverseProxy(value) {
+            Module.ccall("csp_systems_ServiceStatus__Set_ReverseProxy", "void", ["number", "string"], [this.pointer, value]);
+        }
+        get name() {
+            let _result = Module.ccall("csp_systems_ServiceStatus__Get_Name", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set name(value) {
+            Module.ccall("csp_systems_ServiceStatus__Set_Name", "void", ["number", "string"], [this.pointer, value]);
+        }
+        get apiVersions() {
+            const _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_ServiceStatus__Get_ApiVersions", "void", ["number", "number"], [_ptr, this.pointer]);
+            const _nPtr = getNativePointer(_ptr);
+            return new Common.Array(_nPtr, csp_systems_VersionMetadataFactory, "csp_systems_VersionMetadata");
+        }
+        set apiVersions(value) {
+            Module.ccall("csp_systems_ServiceStatus__Set_ApiVersions", "void", ["number", "number"], [this.pointer, value.pointer]);
+        }
+        get currentApiVersion() {
+            let _result = Module.ccall("csp_systems_ServiceStatus__Get_CurrentApiVersion", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set currentApiVersion(value) {
+            Module.ccall("csp_systems_ServiceStatus__Set_CurrentApiVersion", "void", ["number", "string"], [this.pointer, value]);
+        }
+    }
+    Systems.ServiceStatus = ServiceStatus;
+})(Systems || (Systems = {}));
+(function (Systems) {
+    /**
+  @ingroup Status System
+   * @description Store information about the current service deployment
+   */
+    class ServicesDeploymentStatus extends NativeClassWrapper {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        static create() {
+            var _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_ServicesDeploymentStatus_Ctor", "void", ["number"], [_ptr]);
+            var _nPtr = getNativePointer(_ptr);
+            return new ServicesDeploymentStatus(_nPtr);
+        }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_systems_ServicesDeploymentStatus_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+        get version() {
+            let _result = Module.ccall("csp_systems_ServicesDeploymentStatus__Get_Version", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set version(value) {
+            Module.ccall("csp_systems_ServicesDeploymentStatus__Set_Version", "void", ["number", "string"], [this.pointer, value]);
+        }
+        get services() {
+            const _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_ServicesDeploymentStatus__Get_Services", "void", ["number", "number"], [_ptr, this.pointer]);
+            const _nPtr = getNativePointer(_ptr);
+            return new Common.Array(_nPtr, csp_systems_ServiceStatusFactory, "csp_systems_ServiceStatus");
+        }
+        set services(value) {
+            Module.ccall("csp_systems_ServicesDeploymentStatus__Set_Services", "void", ["number", "number"], [this.pointer, value.pointer]);
+        }
+    }
+    Systems.ServicesDeploymentStatus = ServicesDeploymentStatus;
+})(Systems || (Systems = {}));
 (function (Systems) {
     /**
      * @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient or NetworkEventBus instance in the constructor
@@ -21709,6 +21867,40 @@ export class CSPFoundation {
     }
     Multiplayer.AnnotationThumbnailCollectionResult = AnnotationThumbnailCollectionResult;
 })(Multiplayer || (Multiplayer = {}));
+(function (Systems) {
+    /**
+  @ingroup Status System
+   * @description Data class used to contain information when a Response is received from the Status Server
+   */
+    class ServicesDeploymentStatusResult extends Systems.ResultBase {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        static fromResultBase(baseInstance) {
+            const nativeClassWrapper = baseInstance;
+            return new Systems.ServicesDeploymentStatusResult(new NativePointer(nativeClassWrapper.pointer, nativeClassWrapper.ownsPointer));
+        }
+        /**
+         * @description Will return services deployment status for the latest available deployment from the server
+         * @return The latest services deployment status
+         */
+        getLatestServicesDeploymentStatus() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_systems_ServicesDeploymentStatusResult_GetLatestServicesDeploymentStatusC_ServicesDeploymentStatusRC", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Systems.ServicesDeploymentStatus(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_systems_ServicesDeploymentStatusResult_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+    }
+    Systems.ServicesDeploymentStatusResult = ServicesDeploymentStatusResult;
+})(Systems || (Systems = {}));
 (function (Systems) {
     /**
      * @description A result handler that is used to notify a user of an error.
@@ -29824,6 +30016,20 @@ export class CSPFoundation {
             Module._free(_ret);
             return _inst;
         }
+        static ofcsp_systems_VersionMetadata() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_Array_Ctor_csp_systems_VersionMetadata", "void", ["number"], [_ret]);
+            var _inst = new Array(getNativePointer(_ret), csp_systems_VersionMetadataFactory, "csp_systems_VersionMetadata");
+            Module._free(_ret);
+            return _inst;
+        }
+        static ofcsp_systems_ServiceStatus() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_Array_Ctor_csp_systems_ServiceStatus", "void", ["number"], [_ret]);
+            var _inst = new Array(getNativePointer(_ret), csp_systems_ServiceStatusFactory, "csp_systems_ServiceStatus");
+            Module._free(_ret);
+            return _inst;
+        }
         static ofString() {
             var _ret = Module._malloc(8);
             Module.ccall("csp_common_Array_Ctor_String", "void", ["number"], [_ret]);
@@ -30125,6 +30331,20 @@ export class CSPFoundation {
             Module._free(_ret);
             return _inst;
         }
+        static ofcsp_systems_VersionMetadata_number(size) {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_Array_Conv_size_tC_csp_systems_VersionMetadata", "void", ["number", "number"], [_ret, size]);
+            var _inst = new Array(getNativePointer(_ret), csp_systems_VersionMetadataFactory, "csp_systems_VersionMetadata");
+            Module._free(_ret);
+            return _inst;
+        }
+        static ofcsp_systems_ServiceStatus_number(size) {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_Array_Conv_size_tC_csp_systems_ServiceStatus", "void", ["number", "number"], [_ret, size]);
+            var _inst = new Array(getNativePointer(_ret), csp_systems_ServiceStatusFactory, "csp_systems_ServiceStatus");
+            Module._free(_ret);
+            return _inst;
+        }
         static ofString_number(size) {
             var _ret = Module._malloc(8);
             Module.ccall("csp_common_Array_Conv_size_tC_String", "void", ["number", "number"], [_ret, size]);