connected-spaces-platform.web 4.31.0 → 5.0.1

package/connectedspacesplatform.d.ts

@@ -261,7 +261,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for an animated model component.
      */
     enum AnimatedModelPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         ExternalResourceAssetId = 1,
         ExternalResourceAssetCollectionId = 2,
         Position = 3,
@@ -390,7 +390,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for a button component.
      */
     enum ButtonPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         LabelText = 1,
         IconAssetId = 2,
         AssetCollectionId = 3,
@@ -489,7 +489,7 @@ export declare namespace Multiplayer {
      * @description The list of properties defined within an external link component.
      */
     enum ExternalLinkPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         LinkUrl = 1,
         Position = 2,
         Rotation = 3,
@@ -506,7 +506,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for a fiducial marker space component.
      */
     enum FiducialMarkerPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         MarkerAssetId = 1,
         AssetCollectionId = 2,
         Position = 3,
@@ -554,7 +554,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for a Gaussian Splat component.
      */
     enum GaussianSplatPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         ExternalResourceAssetId = 1,
         ExternalResourceAssetCollectionId = 2,
         Position = 3,
@@ -574,7 +574,7 @@ export declare namespace Multiplayer {
     enum HotspotPropertyKeys {
         Position = 0,
         Rotation = 1,
-        Name = 2,
+        Name_DEPRECATED = 2,
         IsTeleportPoint = 3,
         IsSpawnPoint = 4,
         IsVisible = 5,
@@ -587,7 +587,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for an image space component.
      */
     enum ImagePropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         ImageAssetId = 1,
         AssetCollectionId = 2,
         Position = 3,
@@ -648,7 +648,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for a light component.
      */
     enum LightPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         LightType = 1,
         Color = 2,
         Intensity = 3,
@@ -688,7 +688,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for a reflection component.
      */
     enum ReflectionPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         ReflectionAssetId = 1,
         AssetCollectionId = 2,
         Position = 3,
@@ -743,7 +743,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for a static model component.
      */
     enum StaticModelPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         ExternalResourceAssetId = 1,
         ExternalResourceAssetCollectionId = 2,
         Position = 3,
@@ -813,7 +813,7 @@ export declare namespace Multiplayer {
      * @description Enumerates the list of properties that can be replicated for a video player component.
      */
     enum VideoPlayerPropertyKeys {
-        Name = 0,
+        Name_DEPRECATED = 0,
         VideoAssetId = 1,
         VideoAssetURL = 2,
         AssetCollectionId = 3,
@@ -3559,6 +3559,15 @@ export declare namespace Multiplayer {
          * @param inActionParams - Parameters for the action that will be passed to the action handler callback.
          */
         invokeAction(action: string, actionParams: string): void;
+        /**
+         * @description Gets the name of the component.
+         */
+        getComponentName(): string;
+        /**
+         * @description Sets the name for the component.
+         * @param value - - The new name to assign to the componenent.
+         */
+        setComponentName(value: string): void;
     }
 }
 export declare namespace Multiplayer {
@@ -4664,6 +4673,11 @@ export declare namespace Systems {
          * @return Pointer to the sequence system class
          */
         getSequenceSystem(): Systems.SequenceSystem;
+        /**
+         * @description Retrieves the HotspotSequenceSystem system.
+         * @return Pointer to the hotspotsequencesystem system class
+         */
+        getHotspotSequenceSystem(): Systems.HotspotSequenceSystem;
         getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
         getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
     }
@@ -5217,6 +5231,22 @@ export declare namespace Systems {
         set oAuthRedirectUrl(value: string);
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup HotspotSequence System
+   * @description A basic class abstraction for a Hot Spot Group, including name, and items within the group.
+   */
+    class HotspotGroup extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): HotspotGroup;
+        delete(): void;
+        get name(): string;
+        set name(value: string);
+        get items(): Common.Array<string>;
+        set items(value: Common.Array<string>);
+    }
+}
 export declare namespace Systems {
     /**
      * @description A Connected Spaces Platform level Logger for debugging or printing to console, also handles logging to a file.
@@ -5486,6 +5516,8 @@ export declare namespace Systems {
         set referenceId(value: string);
         get items(): Common.Array<string>;
         set items(value: Common.Array<string>);
+        get metaData(): Common.Map<string, string>;
+        set metaData(value: Common.Map<string, string>);
     }
 }
 export declare namespace Systems {
@@ -6933,11 +6965,17 @@ export declare namespace Multiplayer {
         /**
          * @description Gets the name of this external link component.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::GetComponentName()
+        */
         getName(): string;
         /**
          * @description Sets the name for this external link component.
          * @param value - - The new name to assign to this external link componenent.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::SetComponentName()
+        */
         setName(value: string): void;
         /**
          * @description Gets the URL address to which this external link component redirects the user on trigger.
@@ -7042,11 +7080,17 @@ export declare namespace Multiplayer {
          * @description Gets the name of this fiducial marker space component.
          * @return The name of this fiducial marker space component.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::GetComponentName()
+        */
         getName(): string;
         /**
          * @description Sets the name of this fiducial marker space component.
          * @param value - The name of this fiducial marker space component.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::SetComponentName()
+        */
         setName(value: string): void;
         /**
          * @description Gets the ID of the image asset this image component refers to.
@@ -7445,11 +7489,17 @@ export declare namespace Multiplayer {
          * @description Gets the Name of the Hotspot.
          * @return The Name of the Hotspot.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::GetComponentName()
+        */
         getName(): string;
         /**
          * @description Sets the Name of this Hotspot.
          * @param value - The Name of this Hotspot.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::SetComponentName()
+        */
         setName(value: string): void;
         /**
          * @description Gets the IsTeleportPoint of this Hotspot.
@@ -7536,11 +7586,17 @@ export declare namespace Multiplayer {
          * @description Gets the name of this image space component.
          * @return The name of this image space component.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::GetComponentName()
+        */
         getName(): string;
         /**
          * @description Sets the name of this image space component.
          * @param value - The name of this image space component.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::SetComponentName()
+        */
         setName(value: string): void;
         /**
          * @description Gets the ID of the image asset this image component refers to.
@@ -7902,11 +7958,17 @@ export declare namespace Multiplayer {
          * @description Get the name of the Reflection component.
          * @return Csp::common::string specifying the component name.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::GetComponentName()
+        */
         getName(): string;
         /**
          * @description Set the name for the Reflection component.
          * @param value - Name for the Reflection component.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::SetComponentName()
+        */
         setName(value: string): void;
         /**
          * @description Get the Asset Id for the Reflection texture asset.
@@ -8327,11 +8389,17 @@ export declare namespace Multiplayer {
          * @description Gets the name of this video player.
          * @return The name of this video player.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::GetComponentName()
+        */
         getName(): string;
         /**
          * @description Sets the name of this video player.
          * @param value - The name of this video player.
          */
+        /** @deprecated
+                Deprecated in favour of ComponentBase::SetComponentName()
+        */
         setName(value: string): void;
         /**
          * @description Gets the ID of the video asset associated with this video player.
@@ -9394,6 +9462,83 @@ export declare namespace Systems {
         runQuery(queryText: string): Promise<Systems.GraphQLResult>;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup HotspotSequence System
+   * @description Data class used to contain information when attempting to get a Hot Spot Group.
+   */
+    class HotspotGroupResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.HotspotGroupResult;
+        getHotspotGroup(): Systems.HotspotGroup;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup HotspotSequence System
+   * @description Data class used to contain information when attempting to get a Hot Spot Group.
+   */
+    class HotspotGroupsResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.HotspotGroupsResult;
+        getHotspotGroups(): Common.Array<Systems.HotspotGroup>;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup HotspotSequenceSystem System
+   * @description Public facing system that allows the management of groupings of hotspots in a space.
+   */
+    class HotspotSequenceSystem extends Systems.SystemBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromSystemBase(baseInstance: Systems.SystemBase): Systems.HotspotSequenceSystem;
+        static create_sequenceSystem_spaceSystem(sequenceSystem: Systems.SequenceSystem, spaceSystem: Systems.SpaceSystem): HotspotSequenceSystem;
+        /**
+         * @description Create a Hotspot group
+         * @param groupName - The unique grouping name
+         * @param hotspotIds - Set of hotspot ids to add to the group
+         * @param callback - Callback to call when a response is received
+         */
+        createHotspotGroup(arg1: string, hotspotIds: Common.Array<string>): Promise<Systems.HotspotGroupResult>;
+        /**
+         * @description Rename a Hotspot group
+         * @param currentGroupName - The unique grouping name
+         * @param newGroupName - The unique grouping name
+         * @param callback - Callback to call when a response is received
+         */
+        renameHotspotGroup(groupName: string, newGroupName: string): Promise<Systems.HotspotGroupResult>;
+        /**
+         * @description Update a Hotspot group
+         * @param groupName - The unique grouping name
+         * @param hotspotIds - Set of hotspot ids to replace
+         * @param callback - Callback to call when a response is received
+         */
+        updateHotspotGroup(groupName: string, hotspotIds: Common.Array<string>): Promise<Systems.HotspotGroupResult>;
+        /**
+         * @description Get a Hotspot group by name
+         * @param groupName - The unique grouping name
+         * @param callback - Callback to call when a response is received
+         */
+        getHotspotGroup(groupName: string): Promise<Systems.HotspotGroupResult>;
+        /**
+         * @description Get all Hotspot groups for the current space and logged in user.
+         * @param callback - Callback to call when a response is received
+         */
+        getHotspotGroups(): Promise<Systems.HotspotGroupsResult>;
+        /**
+         * @description Delete a Hotspot group by name
+         * @param groupName - The unique grouping name
+         * @param callback - Callback to call when a response is received
+         */
+        deleteHotspotGroup(groupName: string): Promise<Systems.NullResult>;
+        delete(): void;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup CSPFoundation
@@ -9767,22 +9912,24 @@ export declare namespace Systems {
         /**
          * @description Creates a new sequence. If a sequence already exists with this key, it will overwrite the current one.
          * This call will fail if the user isn't a creator of the space.
-         * @param sequenceKey - The unique grouping name. The suggested convention is: Type:[Id]
-         * @param referenceType - The type of reference (GroupId, SpaceId etc.)
+         * @param sequenceKey - The unique grouping name. Our naming convention is: Type:[SpaceId]:[GroupName]
+         * @param referenceType - The type of reference (GroupId etc.)
          * @param referenceId - The id of the reference
          * @param items - An ordered array of members
+         * @param metaData - Any additional data relating to the Sequence
          * @param callback - Callback to call when a response is received
          */
-        createSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<string>): Promise<Systems.SequenceResult>;
+        createSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<string>, metaData: Common.Map<string, string>): Promise<Systems.SequenceResult>;
         /**
          * @description Updates an existing sequence. This call will fail if the user isn't a creator of the space.
-         * @param sequenceKey - The unique grouping name. The suggested convention is: Type:[Id]
-         * @param referenceType - The type of reference (GroupId, SpaceId etc.)
+         * @param sequenceKey - The unique grouping name. Our naming convention is: Type:[SpaceId]:[GroupName]
+         * @param referenceType - The type of reference (GroupId etc.)
          * @param referenceId - The id of the reference
          * @param items - An ordered array of members
+         * @param metaData - Any additional data relating to the Sequence
          * @param callback - Callback to call when a response is received
          */
-        updateSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<string>): Promise<Systems.SequenceResult>;
+        updateSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<string>, metaData: Common.Map<string, string>): Promise<Systems.SequenceResult>;
         /**
          * @description Renames a given sequence. This call will fail if the user isn't a creator of the space.
          * @param oldSequenceKey - The current sequence key name
@@ -9794,11 +9941,12 @@ export declare namespace Systems {
          * @description Finds sequences based on the given criteria
          * @param sequenceKeys - An array of sequence keys to search for
          * @param sequenceKeys - An optional regex string for searching keys
-         * @param referenceType - The type of reference (GroupId, SpaceId etc.). Must be used with ReferenceIds
+         * @param referenceType - The type of reference (GroupId etc.). Must be used with ReferenceIds
          * @param referenceIds - The ids of the reference. Must be used with ReferenceType
+         * @param metaData - Any additional data relating to the Sequence
          * @param callback - Callback to call when a response is received
          */
-        getSequencesByCriteria(sequenceKeys: Common.Array<string>, keyRegex: string | null, referenceType: string | null, referenceIds: Common.Array<string>): Promise<Systems.SequencesResult>;
+        getSequencesByCriteria(sequenceKeys: Common.Array<string>, keyRegex: string | null, referenceType: string | null, referenceIds: Common.Array<string>, metaData: Common.Map<string, string>): Promise<Systems.SequencesResult>;
         /**
          * @description Gets a sequence by it's key
          * @param sequenceKey - The unique grouping name
@@ -10951,6 +11099,7 @@ export declare namespace Common {
         static ofcsp_systems_ProductInfo(): Array<Systems.ProductInfo>;
         static ofcsp_systems_ShopifyStoreInfo(): Array<Systems.ShopifyStoreInfo>;
         static ofcsp_systems_TicketedEvent(): Array<Systems.TicketedEvent>;
+        static ofcsp_systems_HotspotGroup(): Array<Systems.HotspotGroup>;
         static ofcsp_systems_MaintenanceInfo(): Array<Systems.MaintenanceInfo>;
         static ofcsp_systems_EOrganizationRole(): Array<Systems.EOrganizationRole>;
         static ofcsp_systems_InviteOrganizationRoleInfo(): Array<Systems.InviteOrganizationRoleInfo>;
@@ -10992,6 +11141,7 @@ export declare namespace Common {
         static ofcsp_systems_ProductInfo_number(size: number): Array<Systems.ProductInfo>;
         static ofcsp_systems_ShopifyStoreInfo_number(size: number): Array<Systems.ShopifyStoreInfo>;
         static ofcsp_systems_TicketedEvent_number(size: number): Array<Systems.TicketedEvent>;
+        static ofcsp_systems_HotspotGroup_number(size: number): Array<Systems.HotspotGroup>;
         static ofcsp_systems_MaintenanceInfo_number(size: number): Array<Systems.MaintenanceInfo>;
         static ofcsp_systems_EOrganizationRole_number(size: number): Array<Systems.EOrganizationRole>;
         static ofcsp_systems_InviteOrganizationRoleInfo_number(size: number): Array<Systems.InviteOrganizationRoleInfo>;