connected-spaces-platform.web 4.29.1 → 4.31.0

package/connectedspacesplatform.d.ts

@@ -157,6 +157,13 @@ export declare namespace Multiplayer {
         Invalid = 3
     }
 }
+export declare namespace Multiplayer {
+    enum ESequenceUpdateType {
+        Create = 0,
+        Update = 1,
+        Delete = 2
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enum used to specify the current state of the multiplayer connection.
@@ -560,12 +567,6 @@ export declare namespace Multiplayer {
         Num = 10
     }
 }
-export declare namespace Multiplayer {
-    enum HotspotType {
-        TeleportHotspot = 0,
-        SpawnHotspot = 1
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the list of properties that can be replicated for an Hotspot space component.
@@ -574,10 +575,11 @@ export declare namespace Multiplayer {
         Position = 0,
         Rotation = 1,
         Name = 2,
-        HotspotType = 3,
-        IsVisible = 4,
-        IsARVisible = 5,
-        Num = 6
+        IsTeleportPoint = 3,
+        IsSpawnPoint = 4,
+        IsVisible = 5,
+        IsARVisible = 6,
+        Num = 7
     }
 }
 export declare namespace Multiplayer {
@@ -1046,7 +1048,8 @@ export declare namespace Systems {
 }
 export declare namespace Systems {
     enum EPointOfInterestType {
-        DEFAULT = 0
+        DEFAULT = 0,
+        SPACE = 1
     }
 }
 export declare namespace Systems {
@@ -3613,6 +3616,20 @@ export declare namespace Multiplayer {
         set userId(value: string);
     }
 }
+export declare namespace Multiplayer {
+    class SequenceChangedParams extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): SequenceChangedParams;
+        delete(): void;
+        get updateType(): Multiplayer.ESequenceUpdateType;
+        set updateType(value: Multiplayer.ESequenceUpdateType);
+        get key(): string;
+        set key(value: string);
+        get newKey(): string;
+        set newKey(value: string);
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup Multiplayer
@@ -3668,6 +3685,11 @@ export declare namespace Multiplayer {
          * @param callback - Callback to receive data for the user permissions that has been changed.
          */
         setUserPermissionsChangedCallback(callback: (arg1: Multiplayer.UserPermissionsParams) => void): void;
+        /**
+         * @description Sets a callback for a sequence changed event.
+         * @param callback - Callback to receive data for the sequence that has been changed.
+         */
+        setSequenceChangedCallback(callback: (arg1: Multiplayer.SequenceChangedParams) => void): void;
         /**
          * @description Registers a callback to listen for the named event.
          * @param eventName - The identifying name for the event to listen for.
@@ -4637,6 +4659,11 @@ export declare namespace Systems {
          * @return Pointer to the organization system class
          */
         getOrganizationSystem(): Systems.OrganizationSystem;
+        /**
+         * @description Retrieves the Sequence system.
+         * @return Pointer to the sequence system class
+         */
+        getSequenceSystem(): Systems.SequenceSystem;
         getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
         getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
     }
@@ -5441,6 +5468,26 @@ export declare namespace Systems {
         runScriptFile(contextId: bigint, scriptFilePath: string): boolean;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Sequence System
+   * @description A basic class abstraction for a sequence, including key, and reference variables, and items.
+   */
+    class Sequence extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): Sequence;
+        delete(): void;
+        get key(): string;
+        set key(value: string);
+        get referenceType(): string;
+        set referenceType(value: string);
+        get referenceId(): string;
+        set referenceId(value: string);
+        get items(): Common.Array<string>;
+        set items(value: Common.Array<string>);
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup Settings System
@@ -5687,6 +5734,8 @@ export declare namespace Systems {
         set location(value: Systems.GeoLocation);
         get assetCollectionId(): string;
         set assetCollectionId(value: string);
+        get spaceId(): string;
+        set spaceId(value: string);
     }
 }
 export declare namespace Systems {
@@ -7403,14 +7452,23 @@ export declare namespace Multiplayer {
          */
         setName(value: string): void;
         /**
-         * @description Gets the HotspotType of this Hotspot.
+         * @description Gets the IsTeleportPoint of this Hotspot.
          */
-        getHotspotType(): Multiplayer.HotspotType;
+        getIsTeleportPoint(): boolean;
         /**
-         * @description Sets the HotspotType of this Hotspot.
-         * @param value - The Type of the Hotspot.
+         * @description Sets this Hotspot to be a teleport point.
+         * @param inValue - The teleport point state flag value.
          */
-        setHotspotType(value: Multiplayer.HotspotType): void;
+        setIsTeleportPoint(value: boolean): void;
+        /**
+         * @description Gets the IsSpawnPoint of this Hotspot.
+         */
+        getIsSpawnPoint(): boolean;
+        /**
+         * @description Sets this Hotspot to be a spawn point.
+         * @param inValue - The spawn point state flag value.
+         */
+        setIsSpawnPoint(value: boolean): void;
         /**
          * @description Gets a unique identifier for this component in the hierarchy.
          * NOTE: This does not give a complete hierarchy path, only the entityId of the parent for the component.
@@ -9671,6 +9729,90 @@ export declare namespace Systems {
         getTierFeaturesQuota(tierName: Systems.TierNames): Promise<Systems.FeaturesQuotaResult>;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Sequence System
+   * @description Result structure for a sequence result
+   */
+    class SequenceResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.SequenceResult;
+        getSequence(): Systems.Sequence;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Sequence System
+   * @description Data class used to contain information when attempting to get an array of sequences.
+   */
+    class SequencesResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.SequencesResult;
+        getSequences(): Common.Array<Systems.Sequence>;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Sequence System
+   * @description Public facing system that allows the management of groupings of items in a space.
+   */
+    class SequenceSystem extends Systems.SystemBase {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromSystemBase(baseInstance: Systems.SystemBase): Systems.SequenceSystem;
+        /**
+         * @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 referenceId - The id of the reference
+         * @param items - An ordered array of members
+         * @param callback - Callback to call when a response is received
+         */
+        createSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<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 referenceId - The id of the reference
+         * @param items - An ordered array of members
+         * @param callback - Callback to call when a response is received
+         */
+        updateSequence(sequenceKey: string, referenceType: string, referenceId: string, items: Common.Array<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
+         * @param newSequenceKey - The new sequence key name
+         * @param callback - Callback to call when a response is received
+         */
+        renameSequence(oldSequenceKey: string, newSequenceKey: string): Promise<Systems.SequenceResult>;
+        /**
+         * @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 referenceIds - The ids of the reference. Must be used with ReferenceType
+         * @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>;
+        /**
+         * @description Gets a sequence by it's key
+         * @param sequenceKey - The unique grouping name
+         * @param callback - Callback to call when a response is received
+         */
+        getSequence(sequenceKey: string): Promise<Systems.SequenceResult>;
+        /**
+         * @description Deletes the given sequences. This call will fail if the user isn't a creator of the space
+         * @param sequenceKeys - An array of sequence keys to delete
+         * @param callback - Callback to call when a response is received
+         */
+        deleteSequences(sequenceKeys: Common.Array<string>): Promise<Systems.NullResult>;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup Settings System
@@ -10500,12 +10642,13 @@ export declare namespace Systems {
          */
         deletePOI(pOI: Systems.PointOfInterest): Promise<Systems.NullResult>;
         /**
-         * @description Retrieves an array with all the Points of Interest that are located inside the circular area defined by the parameters
-         * @param originLocation - Latitude and longitude coordinates of the circular area origin
-         * @param areaRadius - Radius of the circular area origin
-         * @param callback - Callback when asynchronous task finishes
+         * @description Retrieves an array with all the Points of Interest that are located inside the circular area defined by the parameters..
+         * @param originLocation - The latitude and longitude coordinates of origin of the search location.
+         * @param areaRadius - The Radius of the circular area to search around the provided origin.
+         * @param type - The type of POI to search for. If none is specified, all types will be included in the returned set.
+         * @param callback - Callback when asynchronous task finishes.
          */
-        getPOIsInArea(originLocation: Systems.GeoLocation, areaRadius: number): Promise<Systems.POICollectionResult>;
+        getPOIsInArea(originLocation: Systems.GeoLocation, areaRadius: number, type: Systems.EPointOfInterestType | null): Promise<Systems.POICollectionResult>;
     }
 }
 export declare namespace Systems {
@@ -10742,12 +10885,16 @@ export declare namespace Systems {
          * @param callback - Callback to call when a response is received
          */
         getProfileByUserId(userId: string): Promise<Systems.ProfileResult>;
+        /** @deprecated
+                Deprecated in favour of GetBasicProfilesByUserId
+        */
+        getProfilesByUserId(userIds: Common.Array<string>): Promise<Systems.BasicProfilesResult>;
         /**
          * @description Get a list of minimal profiles (avatarId, personalityType, userName, and platform) by user IDs.
          * @param inUserIds - An array of user ids to search for users by
          * @param callback - Callback to call when a response is received
          */
-        getProfilesByUserId(userIds: Common.Array<string>): Promise<Systems.BasicProfilesResult>;
+        getBasicProfilesByUserId(userIds: Common.Array<string>): Promise<Systems.BasicProfilesResult>;
         /**
          * @description Ping Magnopus Connected Services
          * @param callback - Callback to call when a response is received
@@ -10811,6 +10958,7 @@ export declare namespace Common {
         static ofcsp_systems_FeatureLimitInfo(): Array<Systems.FeatureLimitInfo>;
         static ofcsp_systems_FeatureQuotaInfo(): Array<Systems.FeatureQuotaInfo>;
         static ofcsp_systems_TierFeatures(): Array<Systems.TierFeatures>;
+        static ofcsp_systems_Sequence(): Array<Systems.Sequence>;
         static ofcsp_systems_Site(): Array<Systems.Site>;
         static ofcsp_systems_GeoLocation(): Array<Systems.GeoLocation>;
         static ofcsp_systems_Space(): Array<Systems.Space>;
@@ -10851,6 +10999,7 @@ export declare namespace Common {
         static ofcsp_systems_FeatureLimitInfo_number(size: number): Array<Systems.FeatureLimitInfo>;
         static ofcsp_systems_FeatureQuotaInfo_number(size: number): Array<Systems.FeatureQuotaInfo>;
         static ofcsp_systems_TierFeatures_number(size: number): Array<Systems.TierFeatures>;
+        static ofcsp_systems_Sequence_number(size: number): Array<Systems.Sequence>;
         static ofcsp_systems_Site_number(size: number): Array<Systems.Site>;
         static ofcsp_systems_GeoLocation_number(size: number): Array<Systems.GeoLocation>;
         static ofcsp_systems_Space_number(size: number): Array<Systems.Space>;