connected-spaces-platform.web 6.6.0 → 6.8.0

package/connectedspacesplatform.d.ts

@@ -379,8 +379,9 @@ export declare namespace Multiplayer {
         Hotspot = 26,
         CinematicCamera = 27,
         ScreenSharing = 28,
-        spare = 29,
-        values = 30,
+        AIChatbot = 29,
+        spare = 30,
+        values = 31,
         Delete = 56
     }
 }
@@ -476,6 +477,31 @@ export declare namespace Multiplayer {
         UserAgnostic = 1
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the list of properties that can be replicated for a AI chatbot component.
+     */
+    enum AIChatbotPropertyKeys {
+        Position = 0,
+        Voice = 1,
+        GuardrailAssetCollectionId = 2,
+        VisualState = 3,
+        Num = 4
+    }
+}
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the list of potential visual states that can be replicated for a AI chatbot component.
+     */
+    enum AIChatbotVisualState {
+        Waiting = 0,
+        Listening = 1,
+        Thinking = 2,
+        Speaking = 3,
+        Unknown = 4,
+        Num = 5
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the actions that can be performed on an animated model component.
@@ -3418,7 +3444,7 @@ export declare namespace Common {
         constructor(pointer: NativePointer);
         /**
          * @description A default ReplicatedValue will not have a valid type ("ReplicatedValueType::InvalidType"), and will have no internal value associated.
-         * /// Do not use this constructor unless you know what you are doing!
+         * This constuctor will create the value in an invalid state. Do not use unless you know what you are doing!
          */
         static create(): ReplicatedValue;
         /**
@@ -3458,36 +3484,32 @@ export declare namespace Common {
         static create_vector4Value(vector4Value: Common.Vector4): ReplicatedValue;
         /**
          * @description Construct a ReplicatedValue based on an csp::common::Map type with a string value as the key.
-         * @param inMapValue - Initial value.
-         */
-        static create_mapValue(mapValue: Common.Map<string, Common.ReplicatedValue>): ReplicatedValue;
-        /**
-         * @description Copy constructor
-         * @param other - The value to copy.
+         * @param inValue - Initial value.
          */
-        static create_other(other: Common.ReplicatedValue): ReplicatedValue;
+        static create_value(value: Common.Map<string, Common.ReplicatedValue>): ReplicatedValue;
         /**
          * @description Destroys the replicated value instance.
          */
         delete(): void;
         /**
-         * @description Assignment operator overload.
-         * @param inValue - Other replicated value to set this one to.
+         * @description Copy constructor
+         * @param other - The value to copy.
          */
+        static create_other(other: Common.ReplicatedValue): ReplicatedValue;
         /**
-         * @description Equality operator overload.
-         * @param replicatedValue - Other value to compare to.
+         * @description Copy assignment operator overload.
+         * @param inValue - Other replicated value to set from.
          */
         /**
-         * @description Non equality operator overload.
-         * @param replicatedValue - Other value to compare to.
+         * @description Move assignment operator overload.
+         * @param inValue - Other replicated value to move from.
          */
         /**
-         * @description Less than operator overload.
+         * @description Equality operator overload.
          * @param replicatedValue - Other value to compare to.
          */
         /**
-         * @description Greater than operator overload.
+         * @description Inequality operator overload.
          * @param replicatedValue - Other value to compare to.
          */
         /**
@@ -3502,8 +3524,7 @@ export declare namespace Common {
         setBool(value: boolean): void;
         /**
          * @description Get a bool value from this replicated value, will assert if not a bool type.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return bool
+         * @return Bool
          */
         getBool(): boolean;
         /**
@@ -3513,8 +3534,7 @@ export declare namespace Common {
         setFloat(value: number): void;
         /**
          * @description Get a float value from this replicated value, will assert if not a float type.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return float value
+         * @return Float value
          */
         getFloat(): number;
         /**
@@ -3524,15 +3544,13 @@ export declare namespace Common {
         setInt(value: bigint): void;
         /**
          * @description Get a int64 value from this replicated value, will assert if not a int64 type.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return int64 value
+         * @return Int64 value
          */
         getInt(): bigint;
         setString(value: string): void;
         /**
          * @description Get a csp::common::String& value from this replicated value, will assert if not a csp::common::String type.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return csp::common::String&
+         * @return Csp::common::string&
          */
         getString(): string;
         /**
@@ -3541,8 +3559,7 @@ export declare namespace Common {
         setVector2(value: Common.Vector2): void;
         /**
          * @description Get a csp::common::Vector2 value from this replicated value, will assert if not a csp::common::Vector2 type.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return csp::common::Vector2
+         * @return Csp::common::vector2
          */
         getVector2(): Common.Vector2;
         /**
@@ -3551,8 +3568,7 @@ export declare namespace Common {
         setVector3(value: Common.Vector3): void;
         /**
          * @description Get a csp::common::Vector3 value from this replicated value, will assert if not a csp::common::Vector3 type.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return csp::common::Vector3
+         * @return Csp::common::vector3
          */
         getVector3(): Common.Vector3;
         /**
@@ -3561,15 +3577,13 @@ export declare namespace Common {
         setVector4(value: Common.Vector4): void;
         /**
          * @description Get a csp::common::Vector4 value from this replicated value, will assert if not a csp::common::Vector4 type.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return csp::common::Vector4
+         * @return Csp::common::vector4
          */
         getVector4(): Common.Vector4;
         /**
          * @description Get a csp::common::Map value with a string value as the key.
          * This will assert if not a csp::common::Map type with a string value as the key.
-         * /// Use ReplicatedValue::GetReplicatedValueType to ensure type before accessing.
-         * /// @return csp::common::Map
+         * @return Csp::common::map
          */
         getStringMap(): Common.Map<string, Common.ReplicatedValue>;
         /**
@@ -4060,7 +4074,7 @@ export declare namespace Common {
          * @description Set a callback for handling a log. Can be used to debug Connected Spaces Platform within a client application.
          * @param inLogCallback - The callback to execute when a log occurs.
          */
-        setLogCallback(callback: (arg1: string) => void): void;
+        setLogCallback(callback: (arg1: Common.LogLevel, arg2: string) => void): void;
         /**
          * @description Set a callback for handling an event log. Can be used to debug Connected Spaces Platform within a client application.
          * @param inEventCallback - The callback to execute when an event log occurs.
@@ -5056,6 +5070,11 @@ export declare namespace Systems {
          * @return Pointer to the analyticssystem system class
          */
         getAnalyticsSystem(): Systems.AnalyticsSystem;
+        /**
+         * @description Retrieves external services proxy system.
+         * @return Pointer to the external services proxy system class.
+         */
+        getExternalServicesProxySystem(): Systems.ExternalServiceProxySystem;
         getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
         getEventBus(): Multiplayer.NetworkEventBus;
     }
@@ -5706,6 +5725,54 @@ export declare namespace Systems {
         set oAuthRedirectUrl(value: string);
     }
 }
+export declare namespace Systems {
+    /**
+     * *******************************************************************************************************************
+     * @description Data structure used when making invocations of the external service proxy.
+     */
+    class ExternalServicesOperationParams extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): ExternalServicesOperationParams;
+        delete(): void;
+        get serviceName(): string;
+        set serviceName(value: string);
+        get operationName(): string;
+        set operationName(value: string);
+        get setHelp(): boolean;
+        set setHelp(value: boolean);
+        get parameters(): Common.Map<string, string>;
+        set parameters(value: Common.Map<string, string>);
+    }
+}
+export declare namespace Systems {
+    /**
+     * *******************************************************************************************************************
+     * @description Specialised data structure that can be used to retrieve an Agora user token via the proxy service.
+     */
+    class AgoraUserTokenParams extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): AgoraUserTokenParams;
+        delete(): void;
+        get agoraUserId(): string;
+        set agoraUserId(value: string);
+        get channelName(): string;
+        set channelName(value: string);
+        get referenceId(): string;
+        set referenceId(value: string);
+        get lifespan(): number;
+        set lifespan(value: number);
+        get readOnly(): boolean;
+        set readOnly(value: boolean);
+        get shareAudio(): boolean;
+        set shareAudio(value: boolean);
+        get shareVideo(): boolean;
+        set shareVideo(value: boolean);
+        get shareScreen(): boolean;
+        set shareScreen(value: boolean);
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup HotspotSequence System
@@ -6114,52 +6181,6 @@ export declare namespace Systems {
         set refreshExpiryTime(value: string);
     }
 }
-export declare namespace Systems {
-    /**
-     * @description Data structure for an Agora user token, giving userID, referenceID, channel name and settings regarding sharing of audio/video/screenshare.
-     */
-    class AgoraUserTokenParams extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): AgoraUserTokenParams;
-        delete(): void;
-        get agoraUserId(): string;
-        set agoraUserId(value: string);
-        get channelName(): string;
-        set channelName(value: string);
-        get referenceId(): string;
-        set referenceId(value: string);
-        get lifespan(): number;
-        set lifespan(value: number);
-        get readOnly(): boolean;
-        set readOnly(value: boolean);
-        get shareAudio(): boolean;
-        set shareAudio(value: boolean);
-        get shareVideo(): boolean;
-        set shareVideo(value: boolean);
-        get shareScreen(): boolean;
-        set shareScreen(value: boolean);
-    }
-}
-export declare namespace Systems {
-    /**
-     * @description Data structure for a custom service proxy posting, giving service name, operation name, set help and parameters
-     */
-    class TokenInfoParams extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): TokenInfoParams;
-        delete(): void;
-        get serviceName(): string;
-        set serviceName(value: string);
-        get operationName(): string;
-        set operationName(value: string);
-        get setHelp(): boolean;
-        set setHelp(value: boolean);
-        get parameters(): Common.Map<string, string>;
-        set parameters(value: Common.Map<string, string>);
-    }
-}
 export declare namespace Systems {
     /**
      * @description Data structure for overrides to the default token options
@@ -6630,6 +6651,55 @@ export declare namespace Multiplayer {
         delete(): void;
     }
 }
+export declare namespace Multiplayer {
+    class AIChatbotSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IPositionComponent, INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.AIChatbotSpaceComponent;
+        static create_logSystem_parent(logSystem: Common.LogSystem, parent: Multiplayer.SpaceEntity): AIChatbotSpaceComponent;
+        /**
+         * @description Gets the voice name of the TTS model associated with this AI chatbot.
+         * @return The name of the TTS voice associated with this AI chatbot.
+         */
+        getVoice(): string;
+        /**
+         * @description Sets the voice name of the TTS model associated with this AI chatbot.
+         * @param value - The name of the TTS voice associated with this AI chatbot.
+         */
+        setVoice(value: string): void;
+        /**
+         * @description Gets the ID of the guardrail asset associated with this AI chatbot.
+         * @return The ID of the guardrail asset collection associated with this AI chatbot.
+         */
+        getGuardrailAssetCollectionId(): string;
+        /**
+         * @description Sets the ID of the guardrail asset associated with this AI chatbot.
+         * @param value - The ID of the guardrail asset collection associated with this AI chatbot.
+         */
+        setGuardrailAssetCollectionId(value: string): void;
+        /**
+         * @description Retrieves the visual state of the AI chatbot for this component.
+         * @return The visual state of the AI chatbot.
+         */
+        getVisualState(): Multiplayer.AIChatbotVisualState;
+        /**
+         * @description Sets the visual state of the AI chatbot for this component.
+         * @param value - The visual state of the AI chatbot.
+         */
+        setVisualState(value: Multiplayer.AIChatbotVisualState): void;
+        /**
+         * \addtogroup IPositionComponent
+        @{
+        @copydoc IPositionComponent::GetPosition()
+         */
+        getPosition(): Common.Vector3;
+        /**
+        @copydoc IPositionComponent::SetPosition()
+         */
+        setPosition(value: Common.Vector3): void;
+        delete(): void;
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup AnimatedModelSpaceComponent
@@ -8257,7 +8327,7 @@ export declare namespace Multiplayer {
          */
         getFogMode(): Multiplayer.FogMode;
         /**
-         * @description Sets the type of fog currently to be used by this fog component.
+         * @description Sets the type of fog to be used by this fog component.
          * @param value - The modality of fog to be used by this component.
          */
         setFogMode(value: Multiplayer.FogMode): void;
@@ -8297,88 +8367,81 @@ export declare namespace Multiplayer {
         setTransform(value: Multiplayer.SpaceTransform): void;
         /**
         @}
-         * @description Get start sistance
-         * Note: Distance from camera that the fog will start.
-         * Note: 0 = this property has no effect.
-         * @return Current start distance
+         * @description Gets start distance.
+         * NOTE: Distance from camera that the fog will start. 0 = this property has no effect.
+         * @return Current start distance.
          */
         getStartDistance(): number;
         /**
-         * @description Set Current start distance
-         * Note: Distance from camera that the fog will start.
-         * Note: 0 = this property has no effect.
-         * @param value - Current start distance
+         * @description Sets start distance.
+         * NOTE: Distance from camera that the fog will start. 0 = this property has no effect.
+         * @param value - Start distance.
          */
         setStartDistance(value: number): void;
         /**
-         * @description Get Current end distance
-         * Note: objects passed this distance will not be affected by fog.
-         * Note: 0 = this property has no effect.
-         * @return Current end distance
+         * @description Gets end distance.
+         * NOTE: Objects passed this distance will not be affected by fog. 0 = this property has no effect.
+         * @return Current end distance.
          */
         getEndDistance(): number;
         /**
-         * @description Set Current end distance
-         * Note: objects passed this distance will not be affected by fog.
-         * Note: 0 = this property has no effect.
-         * @param value - Current end distance
+         * @description Sets end distance.
+         * NOTE: Objects passed this distance will not be affected by fog. 0 = this property has no effect.
+         * @param value - End distance.
          */
         setEndDistance(value: number): void;
         /**
-         * @description Get fog color
-         * @return Current fog color
+         * @description Gets fog color.
+         * @return Current fog color.
          */
         getColor(): Common.Vector3;
         /**
-         * @description Set Current fog color
-         * @param value - Current fog color
+         * @description Sets fog color.
+         * @param value - Fog color.
          */
         setColor(value: Common.Vector3): void;
         /**
-         * @description Get Global density factor
-         * Note: Global density factor
-         * @return Current Global density factor
+         * @description Gets global density factor.
+         * @return Current global density factor.
          */
         getDensity(): number;
         /**
-         * @description Set Global density factor
-         * Note: Global density factor
-         * @param value - Global density factor
+         * @description Sets global density factor.
+         * @param value - Global density factor.
          */
         setDensity(value: number): void;
         /**
-         * @description Get Height density factor
-         * Note: Height density factor, controls how the density increases and height decreases. Smaller values make the visible transition larger.
-         * @return Current Height density factor
+         * @description Gets Height density factor.
+         * NOTE: Controls how the density increases and height decreases. Smaller values make the visible transition larger.
+         * @return Current height density factor.
          */
         getHeightFalloff(): number;
         /**
-         * @description Set Height density factor
-         * Note: Height density factor, controls how the density increases and height decreases. Smaller values make the visible transition larger.
-         * @param value - Height density factor
+         * @description Sets Height density factor.
+         * NOTE: Controls how the density increases and height decreases. Smaller values make the visible transition larger.
+         * @param value - Height density factor.
          */
         setHeightFalloff(value: number): void;
         /**
-         * @description Get Maximum opacity of the Fog.
-         * Maximum opacity of the Fog.
-         * Note: 1 = fog becomes fully opaque at a distance and replaces the scene colour completely.
-         * Note: 0 = fog colour will have no impact.
-         * @return Current Maximum opacity of the Fog
+         * @description Gets maximum opacity of the fog.
+         * NOTE: 1 = fog becomes fully opaque at a distance and replaces the scene colour completely. 0 = fog colour will have no impact.
+         * @return Current maximum opacity.
          */
         getMaxOpacity(): number;
         /**
-         * @description Set Maximum opacity of the Fog.
-         * @param value - Maximum opacity of the Fog.
+         * @description Sets maximum opacity of the fog.
+         * NOTE: 1 = fog becomes fully opaque at a distance and replaces the scene colour completely. 0 = fog colour will have no impact.
+         * @param value - Maximum opacity of the fog.
          */
         setMaxOpacity(value: number): void;
         /**
-         * @description Get Is Fog Volumetric.
-         * @param value - Fog Volumetric Flag
+         * @description Gets IsFogVolumetric.
+         * @return Current fog volumetric flag.
          */
         getIsVolumetric(): boolean;
         /**
-         * @description Set Is Fog Volumetric
-         * @param value - Is Fog Volumetric Flag
+         * @description Sets IsFogVolumetric.
+         * @param value - Fog Volumetric Flag.
          */
         setIsVolumetric(value: boolean): void;
         /**
@@ -10396,6 +10459,18 @@ export declare namespace Systems {
         delete(): void;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Asset System
+   * @description Data class used to process and represent information relating to copied asset collections.
+   */
+    class AssetCollectionsCopyResult extends Systems.AssetCollectionsResult implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromAssetCollectionsResult(baseInstance: Systems.AssetCollectionsResult): Systems.AssetCollectionsCopyResult;
+        delete(): void;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup Asset System
@@ -11220,6 +11295,58 @@ export declare namespace Systems {
         getIsSpaceTicketed(spaceId: string): Promise<Systems.SpaceIsTicketedResult>;
     }
 }
+export declare namespace Systems {
+    /**
+     * @description Data class used to contain information relating to invocations via the external service proxy system.
+     */
+    class ExternalServiceInvocationResult extends Systems.StringResult implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromStringResult(baseInstance: Systems.StringResult): Systems.ExternalServiceInvocationResult;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+     * @description A specialisation of the result data class that handles respnses from the external service proxy system.
+     */
+    class GetAgoraTokenResult extends Systems.ExternalServiceInvocationResult implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromExternalServiceInvocationResult(baseInstance: Systems.ExternalServiceInvocationResult): Systems.GetAgoraTokenResult;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+   * *******************************************************************************************************************
+  @ingroup External Service Proxy System
+   * @description Public facing system that allows client applications to interact with
+   * backend services acting as a proxy for some other set of services.
+   * /// In situations where a CSP client application needs secure access to some other set of third-party
+   * services (like AI, VOIP, ECommerce etc), this system can be particularly helpful,
+   * as it enables services that CSP interfaces with to own the responsibility of distributing secure tokens to those platforms.
+   */
+    class ExternalServiceProxySystem extends Systems.SystemBase {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromSystemBase(baseInstance: Systems.SystemBase): Systems.ExternalServiceProxySystem;
+        /**
+         * @description Generic function which will make a post request to the services proxy endpoint to trigger some specified operation of specified
+         * service. The nature of the operation and what is returned is entirely dependent on the service and operation name provided.
+         * @param params - Params to specify service, operation, set help and parameters.
+         * @param callback - Callback to call when a response is received.
+         */
+        invokeOperation(params: Systems.ExternalServicesOperationParams): Promise<Systems.StringResult>;
+        /**
+         * @description Specialised utility function which executes a post call to the external services proxy, specifically to retrieve Agora user token
+         * credentials. A good example for how client applications may wish to use PostServiceProxy.
+         * @param params - Params to configure the User token.
+         * @param callback - Callback to call when a response is received.
+         */
+        getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.StringResult>;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup GraphQL System
@@ -12933,18 +13060,6 @@ export declare namespace Systems {
          * @param callback - Callback to call when a response is received
          */
         ping(): Promise<Systems.NullResult>;
-        /**
-         * @description Retrieve User token from Agora
-         * @param params - Params to configure the User token
-         * @param callback - Callback to call when a response is received
-         */
-        getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.StringResult>;
-        /**
-         * @description Post Service Proxy to perform specified operation of specified service
-         * @param params - Params to specify service, operation, set help and parameters
-         * @param callback - Callback to call when a response is received
-         */
-        postServiceProxy(params: Systems.TokenInfoParams): Promise<Systems.StringResult>;
         /**
          * @description Re-send user verification email
          * @param inEmail - User's email address