connected-spaces-platform.web 5.17.3 → 5.18.0

package/connectedspacesplatform.d.ts

@@ -84,6 +84,140 @@ export declare namespace Systems {
         UNITY = 2
     }
 }
+export declare namespace Web {
+    /**
+     * @description Enum which represents all possible HTTP responses.
+     */
+    enum EResponseCodes {
+        ResponseInit = 0,
+        ResponseContinue = 100,
+        ResponseSwitchingProtocols = 101,
+        ResponseProcessing = 102,
+        ResponseOK = 200,
+        ResponseCreated = 201,
+        ResponseAccepted = 202,
+        ResponseNonauthoritative = 203,
+        ResponseNoContent = 204,
+        ResponseResetContent = 205,
+        ResponsePartialContent = 206,
+        ResponseMultiStatus = 207,
+        ResponseAlreadyReported = 208,
+        ResponseImUsed = 226,
+        ResponseMultipleChoices = 300,
+        ResponseMovedPermanently = 301,
+        ResponseFound = 302,
+        ResponseSeeOther = 303,
+        ResponseNotModified = 304,
+        ResponseUseProxy = 305,
+        ResponseTemporaryRedirect = 307,
+        ResponsePermanentRedirect = 308,
+        ResponseBadRequest = 400,
+        ResponseUnauthorized = 401,
+        ResponsePaymentRequired = 402,
+        ResponseForbidden = 403,
+        ResponseNotFound = 404,
+        ResponseMethodNotAllowed = 405,
+        ResponseNotAcceptable = 406,
+        ResponseProxyAuthenticationRequired = 407,
+        ResponseRequestTimeout = 408,
+        ResponseConflict = 409,
+        ResponseGone = 410,
+        ResponseLengthRequired = 411,
+        ResponsePreconditionFailed = 412,
+        ResponseRequestEntityTooLarge = 413,
+        ResponseRequestUriTooLong = 414,
+        ResponseUnsupportedMediaType = 415,
+        ResponseRequestedRangeNotSatisfiable = 416,
+        ResponseExpectationFailed = 417,
+        ResponseImATeapot = 418,
+        ResponseEnchanceYourCalm = 420,
+        ResponseMisdirectedRequest = 421,
+        ResponseUnprocessableEntity = 422,
+        ResponseLocked = 423,
+        ResponseFailedDependency = 424,
+        ResponseUpgradeRequired = 426,
+        ResponsePreconditionRequired = 428,
+        ResponseTooManyRequests = 429,
+        ResponseRequestHeaderFieldsTooLarge = 431,
+        ResponseUnavailableForLegalReasons = 451,
+        ResponseInternalServerError = 500,
+        ResponseNotImplemented = 501,
+        ResponseBadGateway = 502,
+        ResponseServiceUnavailable = 503,
+        ResponseGatewayTimeout = 504,
+        ResponseVersionNotSupported = 505,
+        ResponseVariantAlsoNegotiates = 506,
+        ResponseInsufficientStorage = 507,
+        ResponseLoopDetected = 508,
+        ResponseNotExtended = 510,
+        ResponseNetworkAuthenticationRequired = 511
+    }
+}
+export declare namespace Multiplayer {
+    /**
+     * @description Enum used to indicate the failure state of a multiplayer request.
+     */
+    enum ErrorCode {
+        None = 0,
+        Unknown = 1,
+        NotConnected = 2,
+        AlreadyConnected = 3,
+        SpaceUserLimitExceeded = 4
+    }
+}
+export declare namespace Systems {
+    /**
+     * @description Code to indicate the result of a request.
+     * Request results should be checked for a success by clients before using any other accessors.
+     */
+    enum EResultCode {
+        Init = 0,
+        InProgress = 1,
+        Success = 2,
+        Failed = 3
+    }
+}
+export declare namespace Systems {
+    enum ERequestFailureReason {
+        Unknown = -1,
+        None = 0,
+        AddUserToSpaceDenied = 1,
+        UserSpaceAccessDenied = 2,
+        UserSpaceBannedAccessDenied = 3,
+        UserSpaceFullAccessDenied = 4,
+        UserSpaceInviteExpired = 5,
+        SpacePublicNameDuplicate = 6,
+        UserMaxSpaceLimitReached = 7,
+        UserAccountLocked = 8,
+        UserMissingPassword = 9,
+        UserUnverifiedEmail = 10,
+        UserBannedFromSpace = 11,
+        UserInvalidEmailDomain = 12,
+        UserInvalidThirdPartyAuth = 13,
+        UserAgeNotVerified = 14,
+        UserGuestLoginDisallowed = 15,
+        UserAgoraLimitReached = 16,
+        UserOpenAILimitReached = 17,
+        UserTicketedSpacesLimitReached = 18,
+        UserSpaceConcurrentUsersLimitReached = 19,
+        PrototypeReservedKeysNotAllowed = 20,
+        AssetInvalidFileContents = 21,
+        AssetInvalidFileType = 22,
+        AssetAudioVideoLimitReached = 23,
+        AssetObjectCaptureLimitReached = 24,
+        AssetTotalUploadSizeLimitReached = 25,
+        TicketUnknownNumber = 26,
+        TicketEmailMismatch = 27,
+        TicketVendorOAuthFailure = 28,
+        TicketOAuthTokenInvalid = 29,
+        TicketAlreadyApplied = 30,
+        ShopifyConnectionBroken = 31,
+        ShopifyInvalidStoreName = 32,
+        UserShopifyLimitReached = 33,
+        UserTokenRefreshFailed = 34,
+        InvalidSequenceKey = 35
+    }
+}
 export declare namespace Common {
     /**
      * @description enum for representing a type stored by a csp::common::Variant.
@@ -107,6 +241,19 @@ export declare namespace Common {
         OnlineSingleUser = 1
     }
 }
+export declare namespace Common {
+    enum LogLevel {
+        NoLogging = 0,
+        Fatal = 1,
+        Error = 2,
+        Warning = 3,
+        Display = 4,
+        Log = 5,
+        Verbose = 6,
+        VeryVerbose = 7,
+        All = 8
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Represents the type of component.
@@ -190,18 +337,6 @@ export declare namespace Multiplayer {
         Disconnected = 3
     }
 }
-export declare namespace Multiplayer {
-    /**
-     * @description Enum used to indicate the failure state of a multiplayer request.
-     */
-    enum ErrorCode {
-        None = 0,
-        Unknown = 1,
-        NotConnected = 2,
-        AlreadyConnected = 3,
-        SpaceUserLimitExceeded = 4
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Enum representing the type of a replicated value.
@@ -407,7 +542,9 @@ export declare namespace Multiplayer {
         AvatarPlayMode = 12,
         MovementDirection = 13,
         LocomotionModel = 14,
-        Num = 15
+        IsVisible = 15,
+        IsARVisible = 16,
+        Num = 17
     }
 }
 export declare namespace Multiplayer {
@@ -910,59 +1047,6 @@ export declare namespace Multiplayer {
         DeleteConversationAnnotation = 9
     }
 }
-export declare namespace Systems {
-    /**
-     * @description Code to indicate the result of a request.
-     * Request results should be checked for a success by clients before using any other accessors.
-     */
-    enum EResultCode {
-        Init = 0,
-        InProgress = 1,
-        Success = 2,
-        Failed = 3
-    }
-}
-export declare namespace Systems {
-    enum ERequestFailureReason {
-        Unknown = -1,
-        None = 0,
-        AddUserToSpaceDenied = 1,
-        UserSpaceAccessDenied = 2,
-        UserSpaceBannedAccessDenied = 3,
-        UserSpaceFullAccessDenied = 4,
-        UserSpaceInviteExpired = 5,
-        SpacePublicNameDuplicate = 6,
-        UserMaxSpaceLimitReached = 7,
-        UserAccountLocked = 8,
-        UserMissingPassword = 9,
-        UserUnverifiedEmail = 10,
-        UserBannedFromSpace = 11,
-        UserInvalidEmailDomain = 12,
-        UserInvalidThirdPartyAuth = 13,
-        UserAgeNotVerified = 14,
-        UserGuestLoginDisallowed = 15,
-        UserAgoraLimitReached = 16,
-        UserOpenAILimitReached = 17,
-        UserTicketedSpacesLimitReached = 18,
-        UserSpaceConcurrentUsersLimitReached = 19,
-        PrototypeReservedKeysNotAllowed = 20,
-        AssetInvalidFileContents = 21,
-        AssetInvalidFileType = 22,
-        AssetAudioVideoLimitReached = 23,
-        AssetObjectCaptureLimitReached = 24,
-        AssetTotalUploadSizeLimitReached = 25,
-        TicketUnknownNumber = 26,
-        TicketEmailMismatch = 27,
-        TicketVendorOAuthFailure = 28,
-        TicketOAuthTokenInvalid = 29,
-        TicketAlreadyApplied = 30,
-        ShopifyConnectionBroken = 31,
-        ShopifyInvalidStoreName = 32,
-        UserShopifyLimitReached = 33,
-        UserTokenRefreshFailed = 34,
-        InvalidSequenceKey = 35
-    }
-}
 export declare namespace Systems {
     /**
      * @description Asset type enum, defines the allowed and implemented types of assets.
@@ -1077,19 +1161,6 @@ export declare namespace Systems {
         Unknown = 2
     }
 }
-export declare namespace Systems {
-    enum LogLevel {
-        NoLogging = 0,
-        Fatal = 1,
-        Error = 2,
-        Warning = 3,
-        Display = 4,
-        Log = 5,
-        Verbose = 6,
-        VeryVerbose = 7,
-        All = 8
-    }
-}
 export declare namespace Systems {
     /**
   @ingroup Quota System
@@ -1190,75 +1261,6 @@ export declare namespace Systems {
         Invalid = 3
     }
 }
-export declare namespace Web {
-    /**
-     * @description Enum which represents all possible HTTP responses.
-     */
-    enum EResponseCodes {
-        ResponseInit = 0,
-        ResponseContinue = 100,
-        ResponseSwitchingProtocols = 101,
-        ResponseProcessing = 102,
-        ResponseOK = 200,
-        ResponseCreated = 201,
-        ResponseAccepted = 202,
-        ResponseNonauthoritative = 203,
-        ResponseNoContent = 204,
-        ResponseResetContent = 205,
-        ResponsePartialContent = 206,
-        ResponseMultiStatus = 207,
-        ResponseAlreadyReported = 208,
-        ResponseImUsed = 226,
-        ResponseMultipleChoices = 300,
-        ResponseMovedPermanently = 301,
-        ResponseFound = 302,
-        ResponseSeeOther = 303,
-        ResponseNotModified = 304,
-        ResponseUseProxy = 305,
-        ResponseTemporaryRedirect = 307,
-        ResponsePermanentRedirect = 308,
-        ResponseBadRequest = 400,
-        ResponseUnauthorized = 401,
-        ResponsePaymentRequired = 402,
-        ResponseForbidden = 403,
-        ResponseNotFound = 404,
-        ResponseMethodNotAllowed = 405,
-        ResponseNotAcceptable = 406,
-        ResponseProxyAuthenticationRequired = 407,
-        ResponseRequestTimeout = 408,
-        ResponseConflict = 409,
-        ResponseGone = 410,
-        ResponseLengthRequired = 411,
-        ResponsePreconditionFailed = 412,
-        ResponseRequestEntityTooLarge = 413,
-        ResponseRequestUriTooLong = 414,
-        ResponseUnsupportedMediaType = 415,
-        ResponseRequestedRangeNotSatisfiable = 416,
-        ResponseExpectationFailed = 417,
-        ResponseImATeapot = 418,
-        ResponseEnchanceYourCalm = 420,
-        ResponseMisdirectedRequest = 421,
-        ResponseUnprocessableEntity = 422,
-        ResponseLocked = 423,
-        ResponseFailedDependency = 424,
-        ResponseUpgradeRequired = 426,
-        ResponsePreconditionRequired = 428,
-        ResponseTooManyRequests = 429,
-        ResponseRequestHeaderFieldsTooLarge = 431,
-        ResponseUnavailableForLegalReasons = 451,
-        ResponseInternalServerError = 500,
-        ResponseNotImplemented = 501,
-        ResponseBadGateway = 502,
-        ResponseServiceUnavailable = 503,
-        ResponseGatewayTimeout = 504,
-        ResponseVersionNotSupported = 505,
-        ResponseVariantAlsoNegotiates = 506,
-        ResponseInsufficientStorage = 507,
-        ResponseLoopDetected = 508,
-        ResponseNotExtended = 510,
-        ResponseNetworkAuthenticationRequired = 511
-    }
-}
 export declare namespace Multiplayer {
     /**
      * @description Controls whether a component is enabled or disabled.
@@ -3613,6 +3615,75 @@ export declare namespace Common {
         processPendingEntityOperations(): void;
     }
 }
+export declare namespace Common {
+    /**
+     * @description A Connected Spaces Platform level Logger for debugging or printing to console, also handles logging to a file.
+     * Contains a callback system that allows clients to react to specific logs or events.
+     */
+    class LogSystem extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): LogSystem;
+        delete(): void;
+        /**
+         * @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;
+        /**
+         * @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.
+         */
+        setEventCallback(callback: (arg1: string) => void): void;
+        /**
+         * @description Set a callback for handling a begin marker event. Can be used to debug Connected Spaces Platform within a client application.
+         * @param inBeginCallback - The callback to execute when the marker begins.
+         */
+        setBeginMarkerCallback(callback: (arg1: string) => void): void;
+        /**
+         * @description Set a callback for handling an end marker event. Can be used to debug Connected Spaces Platform within a client application.
+         * @param inEndCallback - The callback to execute when the marker ends.
+         */
+        setEndMarkerCallback(callback: (arg1: number) => void): void;
+        /**
+         * @description Set the verbosity of logging for a system-wide level.
+         * @param inSystemLevel - The level to set the system logging to.
+         */
+        setSystemLevel(systemLevel: Common.LogLevel): void;
+        /**
+         * @description Retreive the log verbosity level.
+         */
+        getSystemLevel(): Common.LogLevel;
+        /**
+         * @description Check if we currently log a specified log verbosity level.
+         * @param level - The level to check.
+         */
+        loggingEnabled(level: Common.LogLevel): boolean;
+        /**
+         * @description Log a message at a specific verbosity level.
+         * @param level - The level to log this message at.
+         * @param inMessage - The message to be logged.
+         */
+        logMsg(level: Common.LogLevel, message: string): void;
+        /**
+         * @description Log an event.
+         * @param inEvent - The event to be logged.
+         */
+        logEvent(event: string): void;
+        /**
+         * @description Specify a 'Marker' event which can be used to communicate a certain process occurring, usually for debugging.
+         */
+        beginMarker(marker: string): void;
+        /**
+         * @description End a 'Marker' event.
+         */
+        endMarker(): void;
+        /**
+         * @description Clears all logging callbacks.
+         */
+        clearAllCallbacks(): void;
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description The base class for all components, provides mechanisms for dirtying properties and subscribing to events on property changes.
@@ -4339,13 +4410,14 @@ export declare namespace Multiplayer {
          * @description Creates a SpaceEntity with type Avatar, and relevant components and default states as specified.
          * @param inName - The name to give the new SpaceEntity.
          * @param inSpaceTransform - The initial transform to set the SpaceEntity to.
+         * @param isVisible - The initial visibility of the Avatar.
          * @param inState - The initial Avatar State to set.
          * @param inAvatarId - The Initial AvatarID to set.
          * @param inAvatarPlayMode - The Initial AvatarPlayMode to set.
          * @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, state: Multiplayer.AvatarState, avatarId: string, avatarPlayMode: Multiplayer.AvatarPlayMode): Promise<Multiplayer.SpaceEntity>;
+        createAvatar(name: string, 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.
@@ -4844,7 +4916,7 @@ export declare namespace Systems {
          * @description Retrieves the Log system.
          * @return Pointer to the log system class
          */
-        getLogSystem(): Systems.LogSystem;
+        getLogSystem(): Common.LogSystem;
         /**
          * @description Retrieves the Settings system.
          * @return Pointer to the settings system class
@@ -5608,73 +5680,6 @@ export declare namespace Systems {
         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.
-     * Contains a callback system that allows clients to react to specific logs or events.
-     */
-    class LogSystem extends NativeClassWrapper {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        /**
-         * @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;
-        /**
-         * @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.
-         */
-        setEventCallback(callback: (arg1: string) => void): void;
-        /**
-         * @description Set a callback for handling a begin marker event. Can be used to debug Connected Spaces Platform within a client application.
-         * @param inBeginCallback - The callback to execute when the marker begins.
-         */
-        setBeginMarkerCallback(callback: (arg1: string) => void): void;
-        /**
-         * @description Set a callback for handling an end marker event. Can be used to debug Connected Spaces Platform within a client application.
-         * @param inEndCallback - The callback to execute when the marker ends.
-         */
-        setEndMarkerCallback(callback: (arg1: number) => void): void;
-        /**
-         * @description Set the verbosity of logging for a system-wide level.
-         * @param inSystemLevel - The level to set the system logging to.
-         */
-        setSystemLevel(systemLevel: Systems.LogLevel): void;
-        /**
-         * @description Retreive the log verbosity level.
-         */
-        getSystemLevel(): Systems.LogLevel;
-        /**
-         * @description Check if we currently log a specified log verbosity level.
-         * @param level - The level to check.
-         */
-        loggingEnabled(level: Systems.LogLevel): boolean;
-        /**
-         * @description Log a message at a specific verbosity level.
-         * @param level - The level to log this message at.
-         * @param inMessage - The message to be logged.
-         */
-        logMsg(level: Systems.LogLevel, message: string): void;
-        /**
-         * @description Log an event.
-         * @param inEvent - The event to be logged.
-         */
-        logEvent(event: string): void;
-        /**
-         * @description Specify a 'Marker' event which can be used to communicate a certain process occurring, usually for debugging.
-         */
-        beginMarker(marker: string): void;
-        /**
-         * @description End a 'Marker' event.
-         */
-        endMarker(): void;
-        /**
-         * @description Clears all logging callbacks.
-         */
-        clearAllCallbacks(): void;
-    }
-}
 export declare namespace Systems {
     /**
      * @description Represents a single maintenance window, provides description of the event and a start and end timestamp
@@ -6557,7 +6562,7 @@ export declare namespace Multiplayer {
     /**
      * @description Data representation of an AvatarSpaceComponent.
      */
-    class AvatarSpaceComponent extends Multiplayer.ComponentBase implements INativeResource {
+    class AvatarSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
         static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.AvatarSpaceComponent;
@@ -6774,6 +6779,24 @@ export declare namespace Multiplayer {
          * @param value - The locomotion model used by this avatar component.
          */
         setLocomotionModel(value: Multiplayer.LocomotionModel): 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;
     }
 }