connected-spaces-platform.web 6.9.0 → 6.10.0

package/connectedspacesplatform.d.ts

@@ -72,6 +72,9 @@ export declare class NativeRef {
     set value(value: number | bigint);
 }
 declare type ProxyClassFactory = (nativePointer: NativePointer) => NativeClassWrapper | number | string;
+export declare enum EFeatureFlag {
+    Invalid = 0
+}
 export declare namespace Common {
     /**
      * @description Enum specifying the type of change that occured to an asset.
@@ -1100,6 +1103,17 @@ export declare namespace Multiplayer {
         Num = 3
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the type of stereo the video player supports.
+     */
+    enum StereoVideoType {
+        None = 0,
+        SideBySide = 1,
+        TopBottom = 2,
+        Num = 3
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the list of properties that can be replicated for a video player component.
@@ -1126,7 +1140,8 @@ export declare namespace Multiplayer {
         MeshComponentId = 18,
         IsEnabled = 19,
         IsVirtualVisible = 20,
-        Num = 21
+        StereoVideoType = 21,
+        Num = 22
     }
 }
 export declare namespace Multiplayer {
@@ -1283,7 +1298,8 @@ export declare namespace Systems {
         OpenAI = 6,
         Shopify = 7,
         TicketedSpace = 8,
-        Invalid = 9
+        GoogleGenAI = 9,
+        Invalid = 10
     }
 }
 export declare namespace Systems {
@@ -1623,6 +1639,18 @@ export declare namespace Systems {
         setMimeType: (mimeType: string) => void;
     }
 }
+export declare class FeatureFlag extends NativeClassWrapper implements INativeResource {
+    /** @internal */
+    constructor(pointer: NativePointer);
+    static create(): FeatureFlag;
+    static create_type_isEnabled(type: EFeatureFlag, isEnabled: boolean): FeatureFlag;
+    getDescription(): string;
+    delete(): void;
+    get type(): EFeatureFlag;
+    set type(value: EFeatureFlag);
+    get enabled(): boolean;
+    set enabled(value: boolean);
+}
 /**
  * @description Represents definition for identifying and versioning an external service endpoint.
  */
@@ -1704,9 +1732,12 @@ export declare class CSPFoundation {
      * @param tenant - Tenant for Magnopus Services. Data is not shared between tenants so clients using separate tenants
      * cannot interact with each other.
      * @param clientUserAgentHeader - The Client Info data
+     * @param featureFlagOverrides - Optional list of feature flags whose default
+     * enabled state is to be overriden. The FeatureFlag.Description property can be ignored when passing in feature flags here as this is defined by
+     * the developer who creates the flag.
      * @return True for successful initialisation.
      */
-    static initialise(endpointRootURI: string, tenant: string, clientUserAgentHeader: ClientUserAgent): boolean;
+    static initialise(endpointRootURI: string, tenant: string, clientUserAgentHeader: ClientUserAgent, featureFlagOverrides: Common.Array<FeatureFlag>): boolean;
     /**
      * @description This should be used at the end of the application lifecycle.
      * Clears event queues and destroys foundation systems.
@@ -1774,6 +1805,23 @@ export declare class CSPFoundation {
      * @return Const csp::common::string&
      */
     static getTenant(): string;
+    /**
+     * @description Checks if a given feature flag is enabled.
+     * @param flag - The feature flag to check
+     * @return True if the feature flag is enabled, false otherwise
+     */
+    static isFeatureEnabled(flag: EFeatureFlag): boolean;
+    /**
+     * @description Returns an array of feature flags.
+     * @return An array of the defined feature flags
+     */
+    static getFeatureFlags(): Common.Array<FeatureFlag>;
+    /**
+     * @description Get the description of a feature flag.
+     * @param flag - The feature flag whose description is to be retrieved
+     * @return The description of the feature flag
+     */
+    static getFeatureFlagDescription(flag: EFeatureFlag): string;
 }
 export declare namespace Common {
     /**
@@ -4940,9 +4988,13 @@ export declare namespace Systems {
 }
 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
-     * of each System.
-     */
+   * @description Base class for all Connected Spaces Platform Systems, which enforces passing of a WebClient or NetworkEventBus instance in the constructor
+   * of each System.
+  @invariant EventBusPtr can never be null. The NetworkEventBus is owned by the MultiplayerConnection and persists for it's lifetime. It is passed
+   * to each system (which derive from SystemBase) by reference to their ctor. This ref is dereferenced before being passed to the SystemBase ctor.
+  @invariant LogSystem can never be null. The LogSystem is owned by the SystemsManager and persists for it's lifetime. It is passed to
+   * each system (which derive from SystemBase) by reference to their ctor. This ref is dereferenced before being passed to the SystemBase ctor.
+   */
     class SystemBase extends NativeClassWrapper {
         /** @internal */
         constructor(pointer: NativePointer);
@@ -4953,10 +5005,6 @@ export declare namespace Systems {
          * @description Registers the system to listen for the default event.
          */
         registerSystemCallback(): void;
-        /**
-         * @description Deregisters the system from listening for the default event.
-         */
-        deregisterSystemCallback(): void;
     }
 }
 export declare namespace Systems {
@@ -6316,6 +6364,21 @@ export declare namespace Common {
         set hotspotData(value: Common.HotspotSequenceChangedNetworkEventData);
     }
 }
+export declare namespace Common {
+    class AsyncCallCompletedEventData extends Common.NetworkEventData implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromNetworkEventData(baseInstance: Common.NetworkEventData): Common.AsyncCallCompletedEventData;
+        static create(): AsyncCallCompletedEventData;
+        delete(): void;
+        get operationName(): string;
+        set operationName(value: string);
+        get referenceId(): string;
+        set referenceId(value: string);
+        get referenceType(): string;
+        set referenceType(value: string);
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Class for creating and managing objects in an offline context.
@@ -9912,6 +9975,16 @@ export declare namespace Multiplayer {
          * @param value - The type of video source used by this component.
          */
         setVideoPlayerSourceType(value: Multiplayer.VideoPlayerSourceType): void;
+        /**
+         * @description Gets the type of stereo the video of this component uses.
+         * @return The type of stereo used by this video.
+         */
+        getStereoVideoType(): Multiplayer.StereoVideoType;
+        /**
+         * @description Sets the type of stereo the video of this component uses.
+         * @param value - The type of stereo used by this video.
+         */
+        setStereoVideoType(value: Multiplayer.StereoVideoType): void;
         /**
          * \addtogroup IVisibleComponent
         @{
@@ -10716,10 +10789,6 @@ export declare namespace Systems {
          * @description Registers the system to listen for the named event.
          */
         registerSystemCallback(): void;
-        /**
-         * @description Deregisters the system from listening for the named event.
-         */
-        deregisterSystemCallback(): void;
     }
 }
 export declare namespace Systems {
@@ -11473,10 +11542,6 @@ export declare namespace Systems {
          * @description Registers the system to listen for the named event.
          */
         registerSystemCallback(): void;
-        /**
-         * @description Deregisters the system from listening for the named event.
-         */
-        deregisterSystemCallback(): void;
     }
 }
 export declare namespace Systems {
@@ -11815,10 +11880,6 @@ export declare namespace Systems {
          * @description Registers the system to listen for the named event.
          */
         registerSystemCallback(): void;
-        /**
-         * @description Deregisters the system from listening for the named event.
-         */
-        deregisterSystemCallback(): void;
     }
 }
 export declare namespace Systems {
@@ -12515,16 +12576,44 @@ export declare namespace Systems {
          */
         deleteSpaceGeoLocation(spaceId: string): Promise<Systems.NullResult>;
         /**
-         * @description Duplicate an existing space and assign it to the current user
+         * @description Duplicate an existing space and assign it to the current user.
+         * This is a synchronous operation and can have a high execution time for complex spaces. If the user disconnects while waiting for the operation
+         * to complete, the duplicate space request will be cancelled.
+         * \deprecated Use DuplicateSpaceAsync() instead. This method performs a synchronous duplication of a Space which can timeout and fail for
+         * complex Spaces or if the backend services are under excessive load.
          * @param spaceId - Id of the space to duplicate.
          * @param newName - A unique name for the duplicated space.
          * @param newAttributes - Attributes to apply to the duplicated space.
-         * @param memberGroupIds - An optional array of group (space) IDs to copy users from.
+         * @param memberGroupIds - An optional array of group (space) IDs. Members of these groups will be added
+         * to the duplicated space with the same roles.
          * @param shallowCopy - If true, the duplicated space will reference the assets of the original space. Otherwise, all assets will be
          * duplicated.
-         * @param callback - Callback when asynchronous task finishes
+         * @param callback - Callback when asynchronous task finishes.
          */
         duplicateSpace(spaceId: string, newName: string, newAttributes: Systems.SpaceAttributes, memberGroupIds: Common.Array<string> | null, shallowCopy: boolean): Promise<Systems.SpaceResult>;
+        /**
+         * @description Duplicate an existing space and assign it to the current user.
+         * This is an asynchronous operation. If the user disconnects while waiting for the operation to complete it will continue unaffected. Please
+         * subcribe to the AsyncCallCompletedCallback via @ref SpaceSystem::SetAsyncCallCompletedCallback() to be notified when the duplication operation
+         * is complete. The AsyncCallCompletedEventData returned by the AsyncCallCompletedCallback will contain the following information:
+         * - OperationName: "DuplicateSpaceAsync".
+         * - ReferenceId: Id of the newly duplicated Space.
+         * - ReferenceType: "GroupId".
+         * @param spaceId - Id of the space to duplicate.
+         * @param newName - A unique name for the duplicated space.
+         * @param newAttributes - Attributes to apply to the duplicated space.
+         * @param memberGroupIds - An optional array of group (space) IDs. Members of these groups will be added
+         * to the duplicated space with the same roles.
+         * @param shallowCopy - If true, the duplicated space will reference the assets of the original space. Otherwise, all assets will be
+         * duplicated.
+         * @param callback - Callback when asynchronous task is successfully received by the backend services.
+         */
+        duplicateSpaceAsync(spaceId: string, newName: string, newAttributes: Systems.SpaceAttributes, memberGroupIds: Common.Array<string> | null, shallowCopy: boolean): Promise<Systems.NullResult>;
+        /**
+         * @description Sets a callback for the async call completed event. Triggered when an async call to DuplicateSpace is completed.
+         * @param callback - Callback to receive data concerning the Space duplication.
+         */
+        setAsyncCallCompletedCallback(callback: (arg1: Common.AsyncCallCompletedEventData) => void): void;
     }
 }
 export declare namespace Systems {
@@ -13078,10 +13167,6 @@ export declare namespace Systems {
          * @description Registers the system to listen for the named event.
          */
         registerSystemCallback(): void;
-        /**
-         * @description Deregisters the system from listening for the named event.
-         */
-        deregisterSystemCallback(): void;
     }
 }
 export declare namespace Common {
@@ -13091,6 +13176,7 @@ export declare namespace Common {
         private TTypeFactory;
         private TTypeName;
         static ofcsp_multiplayer_ComponentUpdateInfo(): Array<Multiplayer.ComponentUpdateInfo>;
+        static ofcsp_FeatureFlag(): Array<FeatureFlag>;
         static ofcsp_common_ReplicatedValue(): Array<Common.ReplicatedValue>;
         static ofcsp_systems_SpaceUserRole(): Array<Systems.SpaceUserRole>;
         static ofcsp_multiplayer_NetworkEventRegistration(): Array<Multiplayer.NetworkEventRegistration>;
@@ -13135,6 +13221,7 @@ export declare namespace Common {
         static ofcsp_common_Map_String_String(): Array<Common.Map<string, string>>;
         static ofcsp_common_Array_String(): Array<Common.Array<string>>;
         static ofcsp_multiplayer_ComponentUpdateInfo_number(size: number): Array<Multiplayer.ComponentUpdateInfo>;
+        static ofcsp_FeatureFlag_number(size: number): Array<FeatureFlag>;
         static ofcsp_common_ReplicatedValue_number(size: number): Array<Common.ReplicatedValue>;
         static ofcsp_systems_SpaceUserRole_number(size: number): Array<Systems.SpaceUserRole>;
         static ofcsp_multiplayer_NetworkEventRegistration_number(size: number): Array<Multiplayer.NetworkEventRegistration>;