connected-spaces-platform.web 5.19.0 → 5.20.0

package/connectedspacesplatform.d.ts

@@ -72,16 +72,17 @@ export declare class NativeRef {
     set value(value: number | bigint);
 }
 declare type ProxyClassFactory = (nativePointer: NativePointer) => NativeClassWrapper | number | string;
-export declare namespace Systems {
+export declare namespace Common {
     /**
-     * @description Enum for setting csp::systems::Asset third party platform type.
-     * NONE indicates that the asset will work on any platform.
-     * Any other value indicates it will only work with this platform.
+     * @description Enum which represents possible login states of a CSP client.
      */
-    enum EThirdPartyPlatform {
-        NONE = 0,
-        UNREAL = 1,
-        UNITY = 2
+    enum ELoginState {
+        LoginThirdPartyProviderDetailsRequested = 0,
+        LoginRequested = 1,
+        LoggedIn = 2,
+        LogoutRequested = 3,
+        LoggedOut = 4,
+        Error = 5
     }
 }
 export declare namespace Web {
@@ -165,6 +166,17 @@ export declare namespace Multiplayer {
         SpaceUserLimitExceeded = 4
     }
 }
+export declare namespace Systems {
+    /**
+     * @description Indicates special handling for any thirdparty platform
+     * NOTE: We may remove this soon, as it's deceptive implying these are the only platforms we support.
+     */
+    enum EThirdPartyPlatform {
+        NONE = 0,
+        UNREAL = 1,
+        UNITY = 2
+    }
+}
 export declare namespace Systems {
     /**
      * @description Code to indicate the result of a request.
@@ -337,6 +349,27 @@ export declare namespace Multiplayer {
         Disconnected = 3
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enum used to specify the SignalR method to invoke in the multiplayer connection.
+     */
+    enum MultiplayerHubMethod {
+        DELETE_OBJECTS = 0,
+        GENERATE_OBJECT_IDS = 1,
+        GET_CLIENT_ID = 2,
+        PAGE_SCOPED_OBJECTS = 3,
+        RESET_SCOPES = 4,
+        SEND_EVENT_MESSAGE = 5,
+        SEND_OBJECT_MESSAGE = 6,
+        SEND_OBJECT_NOT_FOUND = 7,
+        SEND_OBJECT_PATCH = 8,
+        SEND_OBJECT_PATCHES = 9,
+        SET_ALLOW_SELF_MESSAGING = 10,
+        SET_SCOPES = 11,
+        START_LISTENING = 12,
+        STOP_LISTENING = 13
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enum representing the type of a replicated value.
@@ -1237,16 +1270,6 @@ export declare namespace Systems {
         SPACE = 1
     }
 }
-export declare namespace Systems {
-    enum ELoginState {
-        LoginThirdPartyProviderDetailsRequested = 0,
-        LoginRequested = 1,
-        LoggedIn = 2,
-        LogoutRequested = 3,
-        LoggedOut = 4,
-        Error = 5
-    }
-}
 export declare namespace Systems {
     /**
      * @description FDN supported Authentication Providers, the ones that can be used are the ones above Num
@@ -1490,6 +1513,31 @@ export declare namespace Systems {
         setMimeType: (mimeType: string) => void;
     }
 }
+/**
+ * @description Represents definition for identifying and versioning an external service endpoint..
+ */
+export declare class ServiceDefinition extends NativeClassWrapper implements INativeResource {
+    /** @internal */
+    constructor(pointer: NativePointer);
+    static create(): ServiceDefinition;
+    static create_uRI_version(uRI: string, version: number): ServiceDefinition;
+    /**
+     * @description Gets the URI for the service endpoint.
+     * @return URI of the service endpoint.
+     */
+    getURI(): string;
+    /**
+     * @description Sets the URI for the service endpoint.
+     * @param inURI - URI for service endpoint.
+     */
+    setURI(uRI: string): void;
+    /**
+     * @description Gets the current version of the service endpoint.
+     * @return Representing the current version of the service endpoint.
+     */
+    getVersion(): number;
+    delete(): void;
+}
 /**
  * @description Holds supported endpoint uris used by Foundation.
  */
@@ -1498,20 +1546,20 @@ export declare class EndpointURIs extends NativeClassWrapper implements INativeR
     constructor(pointer: NativePointer);
     static create(): EndpointURIs;
     delete(): void;
-    get userServiceURI(): string;
-    set userServiceURI(value: string);
-    get prototypeServiceURI(): string;
-    set prototypeServiceURI(value: string);
-    get spatialDataServiceURI(): string;
-    set spatialDataServiceURI(value: string);
-    get multiplayerServiceURI(): string;
-    set multiplayerServiceURI(value: string);
-    get aggregationServiceURI(): string;
-    set aggregationServiceURI(value: string);
-    get trackingServiceURI(): string;
-    set trackingServiceURI(value: string);
-    get maintenanceWindowURI(): string;
-    set maintenanceWindowURI(value: string);
+    get userService(): ServiceDefinition;
+    set userService(value: ServiceDefinition);
+    get prototypeService(): ServiceDefinition;
+    set prototypeService(value: ServiceDefinition);
+    get spatialDataService(): ServiceDefinition;
+    set spatialDataService(value: ServiceDefinition);
+    get multiplayerService(): ServiceDefinition;
+    set multiplayerService(value: ServiceDefinition);
+    get aggregationService(): ServiceDefinition;
+    set aggregationService(value: ServiceDefinition);
+    get trackingService(): ServiceDefinition;
+    set trackingService(value: ServiceDefinition);
+    get maintenanceWindow(): ServiceDefinition;
+    set maintenanceWindow(value: ServiceDefinition);
 }
 /**
  * @description Holds client data used in requests for all Magnopus Serives.
@@ -1651,6 +1699,33 @@ export declare namespace Common {
         static dummy(): Common.CancellationToken;
     }
 }
+export declare namespace Common {
+    /**
+     * @description Data structure representing the user login state, including detection of access token expiry
+     */
+    class LoginState extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): LoginState;
+        delete(): void;
+        static create_otherState(otherState: Common.LoginState): LoginState;
+        /**
+         * @description Check if the access token for the login is expired.
+         * @return Is the token expired.
+         */
+        refreshNeeded(): boolean;
+        get state(): Common.ELoginState;
+        set state(value: Common.ELoginState);
+        get accessToken(): string;
+        set accessToken(value: string);
+        get refreshToken(): string;
+        set refreshToken(value: string);
+        get userId(): string;
+        set userId(value: string);
+        get deviceId(): string;
+        set deviceId(value: string);
+    }
+}
 export declare namespace Common {
     /**
      * @description Holds all valid mime types.
@@ -3493,6 +3568,27 @@ export declare namespace Common {
         set w(value: number);
     }
 }
+export declare namespace Common {
+    class InvalidInterfaceUseError extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create_msg(msg: string): InvalidInterfaceUseError;
+        delete(): void;
+        get msg(): string;
+        set msg(value: string);
+    }
+}
+export declare namespace Common {
+    class IJSScriptRunner extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        /**
+         * @description Virtual destructor.
+         */
+        delete(): void;
+        runScript(contextId: bigint, scriptText: string): boolean;
+    }
+}
 export declare namespace Common {
     class IRealtimeEngine extends NativeClassWrapper implements INativeResource {
         /** @internal */
@@ -4138,7 +4234,7 @@ export declare namespace Multiplayer {
         /**
          * @description Creates a SpaceEntity instance using the space entity system provided.
          */
-        static create_entitySystem_logSystem(entitySystem: Multiplayer.SpaceEntitySystem, logSystem: Common.LogSystem): SpaceEntity;
+        static create_entitySystem_scriptRunner_logSystem(entitySystem: Multiplayer.SpaceEntitySystem, scriptRunner: Common.IJSScriptRunner, logSystem: Common.LogSystem): SpaceEntity;
         /**
          * @description Destroys the SpaceEntity instance.
          */
@@ -4417,7 +4513,7 @@ export declare namespace Multiplayer {
          * @param callback - EntityCreatedCallback A callback that executes when the creation is complete,
          * which contains a pointer to the new SpaceEntity so that it can be used on the local client.
          */
-        createAvatar(name: string, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
+        createAvatar(name: string, loginState: Common.LoginState, spaceTransform: Multiplayer.SpaceTransform, isVisible: boolean, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
         /**
          * @description Creates a SpaceEntity of type Object, and relevant default values.
          * @param inName - The name to give the new SpaceEntity.
@@ -5756,37 +5852,6 @@ export declare namespace Systems {
         set period(value: Systems.PeriodEnum);
     }
 }
-export declare namespace Systems {
-    /**
-     * @description A JavaScript based scripting system that can be used to create advanced behaviours and interactions between entities in spaces.
-     */
-    class ScriptSystem extends NativeClassWrapper {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        /**
-         * @description Starts up the JavaScript runtime context.
-         */
-        initialise(): void;
-        /**
-         * @description Shuts down and deletes the JavaScript runtime context.
-         */
-        shutdown(): void;
-        /**
-         * @description Attempts to execute a script in a given context.
-         * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
-         * @param scriptText - The script to execute.
-         * @return A boolean representing success running the script.
-         */
-        runScript(contextId: bigint, scriptText: string): boolean;
-        /**
-         * @description Attempts to execute a script from a given file path in the given context.
-         * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
-         * @param scriptFilePath - The file path of the script to execute.
-         * @return A boolean representing success running the script.
-         */
-        runScriptFile(contextId: bigint, scriptFilePath: string): boolean;
-    }
-}
 export declare namespace Systems {
     /**
   @ingroup Sequence System
@@ -6102,33 +6167,6 @@ export declare namespace Systems {
         set w(value: number);
     }
 }
-export declare namespace Systems {
-    /**
-     * @description Data structure representing the user login state, including detection of access token expiry
-     */
-    class LoginState extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): LoginState;
-        delete(): void;
-        static create_otherState(otherState: Systems.LoginState): LoginState;
-        /**
-         * @description Check if the access token for the login is expired.
-         * @return Is the token expired.
-         */
-        refreshNeeded(): boolean;
-        get state(): Systems.ELoginState;
-        set state(value: Systems.ELoginState);
-        get accessToken(): string;
-        set accessToken(value: string);
-        get refreshToken(): string;
-        set refreshToken(value: string);
-        get userId(): string;
-        set userId(value: string);
-        get deviceId(): string;
-        set deviceId(value: string);
-    }
-}
 export declare namespace Systems {
     /**
      * @description Data for access and refresh tokens, and their expiry times.
@@ -10641,10 +10679,11 @@ export declare namespace Systems {
         /**
          * @description This will delete any groups which only contain this item
          * For any groups which contanin the given item and additional items, it will just update the group by removing the given item.
-         * @param itemName - An item to update all sequences containing.
+         * @param itemID - An item to update all sequences containing. Can be retrieved from a HotspotSpaceComponent via
+         * HotspotSpaceComponent::GetUniqueComponentId
          * @param callback - Callback to call when a response is received
          */
-        removeItemFromGroups(itemName: string): Promise<Systems.NullResult>;
+        removeItemFromGroups(itemID: string): Promise<Systems.NullResult>;
         /**
          * @description Sets a callback to be fired when a hotspot sequence is changed.
          * @param callback - Callback to receive data for the hotspot sequence that has been changed.
@@ -10855,6 +10894,38 @@ export declare namespace Systems {
         getTierFeaturesQuota(tierName: Systems.TierNames): Promise<Systems.FeaturesQuotaResult>;
     }
 }
+export declare namespace Systems {
+    /**
+     * @description A JavaScript based scripting system that can be used to create advanced behaviours and interactions between entities in spaces.
+     */
+    class ScriptSystem extends Common.IJSScriptRunner {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromIJSScriptRunner(baseInstance: Common.IJSScriptRunner): Systems.ScriptSystem;
+        /**
+         * @description Starts up the JavaScript runtime context.
+         */
+        initialise(): void;
+        /**
+         * @description Shuts down and deletes the JavaScript runtime context.
+         */
+        shutdown(): void;
+        /**
+         * @description Attempts to execute a script in a given context.
+         * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
+         * @param scriptText - The script to execute.
+         * @return A boolean representing success running the script.
+         */
+        runScript(contextId: bigint, scriptText: string): boolean;
+        /**
+         * @description Attempts to execute a script from a given file path in the given context.
+         * @param contextId - The context in which to run the script. If the provided context does not exist, the script run will fail.
+         * @param scriptFilePath - The file path of the script to execute.
+         * @return A boolean representing success running the script.
+         */
+        runScriptFile(contextId: bigint, scriptFilePath: string): boolean;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup Sequence System
@@ -11861,7 +11932,7 @@ export declare namespace Systems {
         /** @internal */
         constructor(pointer: NativePointer);
         static fromResultBase(baseInstance: Systems.ResultBase): Systems.LoginStateResult;
-        getLoginState(): Systems.LoginState;
+        getLoginState(): Common.LoginState;
         delete(): void;
     }
 }
@@ -11958,7 +12029,7 @@ export declare namespace Systems {
          * @description Get the current login state.
          * @return Current login state
          */
-        getLoginState(): Systems.LoginState;
+        getLoginState(): Common.LoginState;
         /**
          * @description Sets a callback that will get fired when the login token has changed as a result of logging in with credentials or with a token or
          * after the Connected Spaces Platform internal system has refreshed the session.