connected-spaces-platform.web 4.27.2 → 4.28.1

package/connectedspacesplatform.d.ts

@@ -128,7 +128,8 @@ export declare namespace Multiplayer {
         Fog = 21,
         ECommerce = 22,
         FiducialMarker = 23,
-        GaussianSplat = 24
+        GaussianSplat = 24,
+        Text = 25
     }
 }
 export declare namespace Multiplayer {
@@ -369,6 +370,13 @@ export declare namespace Multiplayer {
         Num = 15
     }
 }
+export declare namespace Multiplayer {
+    enum BillboardMode {
+        Off = 0,
+        Billboard = 1,
+        YawLockedBillboard = 2
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the list of properties that can be replicated for a button component.
@@ -570,16 +578,6 @@ export declare namespace Multiplayer {
         Num = 11
     }
 }
-export declare namespace Multiplayer {
-    /**
-     * @description The billboard mode supported by this image space component.
-     */
-    enum BillboardMode {
-        Off = 0,
-        Billboard = 1,
-        YawLockedBillboard = 2
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description The display mode supported by this image space component.
@@ -735,6 +733,26 @@ export declare namespace Multiplayer {
         Num = 10
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the list of properties that can be replicated for an text space component.
+     */
+    enum TextPropertyKeys {
+        Position = 0,
+        Rotation = 1,
+        Scale = 2,
+        Text = 3,
+        TextColor = 4,
+        BackgroundColor = 5,
+        IsBackgroundVisible = 6,
+        Width = 7,
+        Height = 8,
+        BillboardMode = 9,
+        IsVisible = 10,
+        IsARVisible = 11,
+        Num = 12
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the possible playback states for a video player.
@@ -3286,7 +3304,7 @@ export declare namespace Common {
          */
         static create_boolValue(boolValue: boolean): Variant;
         /**
-         * @description Construct a Variant based on a float type.
+         * @description Construct a Variant based on a double-precision float type.
          * @param inFloatValue - In value
          */
         static create_floatValue(floatValue: number): Variant;
@@ -3334,12 +3352,12 @@ export declare namespace Common {
          */
         getBool(): boolean;
         /**
-         * @description Sets internal variant type as a float.
+         * @description Sets internal variant type as a double-precision float.
          */
         setFloat(value: number): void;
         /**
-         * @description Gets internal variant type as a float.
-         * @return Float
+         * @description Gets internal variant type as a double-precision float.
+         * @return Double
          */
         getFloat(): number;
         /**
@@ -4856,6 +4874,8 @@ export declare namespace Systems {
         set isUnique(value: boolean);
         get version(): string;
         set version(value: string);
+        get organizationId(): string;
+        set organizationId(value: string);
     }
 }
 export declare namespace Systems {
@@ -4969,6 +4989,8 @@ export declare namespace Systems {
         set options(value: Common.Array<Systems.VariantOptionInfo>);
         get unitPrice(): Systems.CurrencyInfo;
         set unitPrice(value: Systems.CurrencyInfo);
+        get availableStock(): number;
+        set availableStock(value: number);
     }
 }
 export declare namespace Systems {
@@ -5301,8 +5323,6 @@ export declare namespace Systems {
         set createdBy(value: string);
         get name(): string;
         set name(value: string);
-        get description(): string;
-        set description(value: string);
         get members(): Common.Array<Systems.OrganizationRoleInfo>;
         set members(value: Common.Array<Systems.OrganizationRoleInfo>);
         get spaceCount(): number;
@@ -7986,6 +8006,146 @@ export declare namespace Multiplayer {
         delete(): void;
     }
 }
+export declare namespace Multiplayer {
+    /**
+  @ingroup TextSpaceComponent
+   * @description Data representation of an TextSpaceComponent.
+   */
+    class TextSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.TextSpaceComponent;
+        /**
+         * @description Constructs the text space component, and associates it with the specified Parent space entity.
+         * @param parent - The Space entity that owns this component.
+         */
+        static create_parent(parent: Multiplayer.SpaceEntity): TextSpaceComponent;
+        /**
+         * @description Gets the text  this text component refers to.
+         * @return The text this text component refers to.
+         */
+        getText(): string;
+        /**
+         * @description Sets the text this text component refers to.
+         * @param value - The text this text component refers to.
+         */
+        setText(value: string): void;
+        /**
+         * @description Gets the text color.
+         * @return The text color, expected to be in RGB color space, with each value normalised between 0...1.
+         */
+        getTextColor(): Common.Vector3;
+        /**
+         * @description Sets the text color.
+         * @param value - The text color, expected to be in RGB color space, with each value normalised between 0...1.
+         */
+        setTextColor(value: Common.Vector3): void;
+        /**
+         * @description Gets the background color that should be globally applied text associated with this component.
+         * @return The background color, expected to be in RGB color space, with each value normalised between 0...1.
+         */
+        getBackgroundColor(): Common.Vector3;
+        /**
+         * @description Sets the background color.
+         * @param value - The background color, expected to be in RGB color space, with each value normalised between 0...1.
+         */
+        setBackgroundColor(value: Common.Vector3): void;
+        /**
+         * @description Sets the background visibility.
+         * @param value - The background visibility.
+         */
+        getIsBackgroundVisible(): boolean;
+        /**
+         * @description Sets the background visibility.
+         * @param value - The background visibility.
+         */
+        setIsBackgroundVisible(value: boolean): void;
+        /**
+         * @description Sets the Text Width.
+         * @param value - The Text Width.
+         */
+        getWidth(): number;
+        /**
+         * @description Sets the Text Width.
+         * @param value - The Text Width.
+         */
+        setWidth(value: number): void;
+        /**
+         * @description Sets the Text Height.
+         * @param value - The Text Height.
+         */
+        getHeight(): number;
+        /**
+         * @description Sets the Text Height.
+         * @param value - The Text Height.
+         */
+        setHeight(value: number): void;
+        /**
+         * \addtogroup ITransformComponent
+        @{
+        @copydoc IPositionComponent::GetPosition()
+         */
+        getPosition(): Common.Vector3;
+        /**
+        @copydoc IPositionComponent::SetPosition()
+         */
+        setPosition(value: Common.Vector3): void;
+        /**
+        @copydoc IRotationComponent::GetRotation()
+         */
+        getRotation(): Common.Vector4;
+        /**
+        @copydoc IRotationComponent::SetRotation()
+         */
+        setRotation(value: Common.Vector4): void;
+        /**
+        @copydoc IScaleComponent::GetScale()
+         */
+        getScale(): Common.Vector3;
+        /**
+        @copydoc IScaleComponent::SetScale()
+         */
+        setScale(value: Common.Vector3): void;
+        /**
+        @copydoc ITransformComponent::GetTransform()
+         */
+        getTransform(): Multiplayer.SpaceTransform;
+        /**
+        @copydoc ITransformComonent::SetTransform()
+         */
+        setTransform(value: Multiplayer.SpaceTransform): void;
+        /**
+        @}
+         * @description Gets the billboard mode used by this text component.
+         * @return The billboard mode used by this text component.
+         */
+        getBillboardMode(): Multiplayer.BillboardMode;
+        /**
+         * @description Sets the billboard mode used by this text component.
+         * @param billboardMode - The billboard mode used by this text component.
+         */
+        setBillboardMode(billboardMode: Multiplayer.BillboardMode): void;
+        /**
+         * \addtogroup IVisibleComponent
+        @{
+        @copydoc IVisibleComponent::GetIsVisible()
+         */
+        getIsVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVisible()
+         */
+        setIsVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsARVisible()
+         */
+        getIsARVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsARVisible()
+         */
+        setIsARVisible(value: boolean): void;
+        delete(): void;
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup VideoPlayerSpaceComponent
@@ -9171,6 +9331,49 @@ export declare namespace Systems {
          * @param callback - The callback to execute.
          */
         setMemberJoinedOrganizationCallback(callback: (arg1: string) => void): void;
+        /**
+         * @description Create a new Organization.
+         * Only a User with tenant admin permissions can create an Organization.
+         * If the user does not have the required permissions their call will be rejected.
+         * @param organizationOwnerId - Id of the Organization owner.
+         * @param organizationName - The Organization name
+         * @param callback - Callback when asynchronous task finishes.
+         */
+        createOrganization(organizationOwnerId: string, organizationName: string): Promise<Systems.OrganizationResult>;
+        /**
+         * @description Retrieves Organization info for the specified Organization.
+         * If this request is made by a User with an Owner or Admin Organization role, the resultant Organization object will contain an array of
+         * OrganizationRoleInfo objects for each Organization member. If the request is made by a User who does not have the Owner or Admin role, the
+         * resultant Organization object will contain an array with a single OrganizationRoleInfo object which represents them.
+         * @param organizationId - Id of the Organization to retrieve information on. If no Id is specified,
+         * the Id of the Organization the user is currently authenticated against will be used.
+         * @param callback - Callback when asynchronous task finishes.
+         */
+        getOrganization(organizationId: string | null): Promise<Systems.OrganizationResult>;
+        /**
+         * @description Get the Id of the Organization the user is authenticated against.
+         * @return The Id of the Organization the User belongs to.
+         */
+        getCurrentOrganizationId(): string;
+        /**
+         * @description Updates the name and/or the description of the specified Organization.
+         * Only a User with an Organization Owner role can update an Organization. If the user does not have the required Organization role
+         * their call will be rejected.
+         * @param organizationId - Id of the Organization to update. If no Id is specified,
+         * the Id of the Organization the user is currently authenticated against will be used.
+         * @param name - The new Organization name
+         * @param callback - Callback when asynchronous task finishes.
+         */
+        updateOrganization(organizationId: string | null, name: string): Promise<Systems.OrganizationResult>;
+        /**
+         * @description Deactivates the specified Organization.
+         * This call performs a soft-delete of the Organization and will allow for Organization reactivation in the future.
+         * Only A User with owner-level permissions can deactivate an Organization. If the user does not have the required role their call will be
+         * rejected.
+         * @param organizationId - Id of the Organization to deactivate.
+         * @param callback - Callback when asynchronous task finishes.
+         */
+        deactivateOrganization(organizationId: string): Promise<Systems.NullResult>;
         /**
          * @description Invites a given email to the User's Organization.
          * Only a User with an Admin or Owner Organization role can invite people to the organization. If the User does not have the required role their
@@ -9565,6 +9768,8 @@ export declare namespace Systems {
         set moderatorIds(value: Common.Array<string>);
         get bannedUserIds(): Common.Array<string>;
         set bannedUserIds(value: Common.Array<string>);
+        get organizationId(): string;
+        set organizationId(value: string);
     }
 }
 export declare namespace Systems {