connected-spaces-platform.web 4.18.0 → 4.19.0

package/connectedspacesplatform.d.ts

@@ -4021,6 +4021,12 @@ export declare namespace Multiplayer {
          * /// @return True if deselection occurred. False if not.
          */
         deselect(): boolean;
+        /**
+         * @description Checks if the entity can be modified.
+         * Specifically whether the local client already owns the entity or can take ownership of the entity.
+         * @return True if the entity can be modified, False if not.
+         */
+        isModifiable(): boolean;
     }
 }
 export declare namespace Multiplayer {
@@ -4648,7 +4654,6 @@ export declare namespace Systems {
     class AnalyticsSystem extends NativeClassWrapper {
         /** @internal */
         constructor(pointer: NativePointer);
-        static create(): AnalyticsSystem;
         /**
          * @description Send an event
          * @param event - AnalyticsEvent
@@ -4823,8 +4828,8 @@ export declare namespace Systems {
         set pointOfInterestId(value: string);
         get parentId(): string;
         set parentId(value: string);
-        get spaceIds(): Common.Array<string>;
-        set spaceIds(value: Common.Array<string>);
+        get spaceId(): string;
+        set spaceId(value: string);
         get createdBy(): string;
         set createdBy(value: string);
         get createdAt(): string;
@@ -5646,10 +5651,10 @@ export declare namespace Systems {
         delete(): void;
         get agoraUserId(): string;
         set agoraUserId(value: string);
-        get lifespan(): number;
-        set lifespan(value: number);
         get channelName(): string;
         set channelName(value: string);
+        get lifespan(): number;
+        set lifespan(value: number);
         get readOnly(): boolean;
         set readOnly(value: boolean);
         get shareAudio(): boolean;
@@ -8304,6 +8309,16 @@ export declare namespace Systems {
          * @param callback - Callback when asynchronous task finishes
          */
         deleteAssetCollection(assetCollection: Systems.AssetCollection): Promise<Systems.NullResult>;
+        /**
+         * @description Copies an array of asset collections to another space. Note that all source asset collections must belong to the same space.
+         * @param sourceAssetCollections - The array of asset collections to copy. They must all belong to the same
+         * space.
+         * @param destSpaceId - The unique identifier of the space to copy these asset collections to.
+         * @param copyAsync - Whether to instruct the services to perform the copy of the asset collections
+         * asynchronously.
+         * @param callback - Callback when asynchronous task finishes
+         */
+        copyAssetCollectionsToSpace(sourceAssetCollections: Common.Array<Systems.AssetCollection>, destSpaceId: string, copyAsync: boolean): Promise<Systems.AssetCollectionsResult>;
         /**
          * @description Finds an asset collection by its Id.
          * @param assetCollectionId - Asset collection to delete
@@ -8316,12 +8331,6 @@ export declare namespace Systems {
          * @param callback - Callback when asynchronous task finishes
          */
         getAssetCollectionByName(assetCollectionName: string): Promise<Systems.AssetCollectionResult>;
-        /**
-         * @description Finds a collection of asset collections by their Ids.
-         * @param assetCollectionIds - An array of ids to search for
-         * @param callback - Callback when asynchronous task finishes
-         */
-        getAssetCollectionsByIds(assetCollectionIds: Common.Array<string>): Promise<Systems.AssetCollectionsResult>;
         /**
          * @description Retrieves asset collections based on the specified search criteria.
          * Results pagination is supported through the use of ResultsSkipNumber and ResultsMaxNumber.
@@ -8337,7 +8346,7 @@ export declare namespace Systems {
          * entries pass nullptr.
          * @param callback - Callback when asynchronous task finishes
          */
-        getAssetCollectionsByCriteria(spaceId: string | null, assetCollectionParentId: string | null, assetCollectionType: Systems.EAssetCollectionType | null, assetCollectionTags: Common.Array<string> | null, assetCollectionNames: Common.Array<string> | null, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Systems.AssetCollectionsResult>;
+        findAssetCollections(ids: Common.Array<string> | null, parentId: string | null, names: Common.Array<string> | null, types: Common.Array<Systems.EAssetCollectionType> | null, tags: Common.Array<string> | null, spaceIds: Common.Array<string> | null, resultsSkipNumber: number | null, resultsMaxNumber: number | null): Promise<Systems.AssetCollectionsResult>;
         /**
          * @description Updates the Metadata field of an Asset Collection
          * @param assetCollection - Asset collection to be updated
@@ -8547,7 +8556,6 @@ export declare namespace Systems {
         /** @internal */
         constructor(pointer: NativePointer);
         static fromSystemBase(baseInstance: Systems.SystemBase): Systems.ECommerceSystem;
-        static create(): ECommerceSystem;
         /**
          * @description Get product information from a shopify store within a space
          * @param spaceId - Space id of product
@@ -9036,24 +9044,24 @@ export declare namespace Systems {
          * @param inValue - Boolean reflecting desired state to store in magnopus connected services.
          * @param callback - Callback when asynchronous task finishes.
          */
-        setNDAStatus(userId: string, value: boolean): Promise<Systems.NullResult>;
+        setNDAStatus(value: boolean): Promise<Systems.NullResult>;
         /**
          * @description Get a boolean indicating whether the current user has completed a non-disclosure agreement.
          * @param callback - Callback to call when a response is received.
          */
-        getNDAStatus(userId: string): Promise<Systems.BooleanResult>;
+        getNDAStatus(): Promise<Systems.BooleanResult>;
         /**
          * @description Opt in or out to receiving a newsletter for the current user.
          * NullResultCallback. Returns status of the update task, no payload expected.
          * @param inValue - Boolean reflecting desired state to store in magnopus connected services
          * @param callback - Callback when asynchronous task finishes
          */
-        setNewsletterStatus(userId: string, value: boolean): Promise<Systems.NullResult>;
+        setNewsletterStatus(value: boolean): Promise<Systems.NullResult>;
         /**
          * @description Get a boolean indicating whether the current user has opted into receiving a newsletter.
          * @param callback - Callback to call when a response is received.
          */
-        getNewsletterStatus(userId: string): Promise<Systems.BooleanResult>;
+        getNewsletterStatus(): Promise<Systems.BooleanResult>;
         /**
          * @description Add a Space to the current user's list of recently visited Spaces
          * Supplying a SpaceID will store as the most recent space, manages the list order and storing to Magnopus Connected Services.
@@ -9061,18 +9069,18 @@ export declare namespace Systems {
          * @param inSpaceID - SpaceID of most recent space entered
          * @param callback - Callback when asynchronous task finishes
          */
-        addRecentlyVisitedSpace(userId: string, spaceID: string): Promise<Systems.NullResult>;
+        addRecentlyVisitedSpace(spaceID: string): Promise<Systems.NullResult>;
         /**
          * @description Get an array of the most recently visited Spaces for the current user.
          * Returns an csp::common::Array of csp::common::Strings ordered from most to least recent spaces up to a maximum of 10 entries.
          * @param callback - Callback to call when a response is received.
          */
-        getRecentlyVisitedSpaces(userId: string): Promise<Systems.StringArrayResult>;
+        getRecentlyVisitedSpaces(): Promise<Systems.StringArrayResult>;
         /**
          * @description Clear the list of recently-visited spaces for the current user.
          * @param callback - Callback when asynchronous task finishes.
          */
-        clearRecentlyVisitedSpaces(userId: string): Promise<Systems.NullResult>;
+        clearRecentlyVisitedSpaces(): Promise<Systems.NullResult>;
         /**
          * @description Block a space for the current user.
          * The client is expected to implement the actual space filtering functionality as this function only adds the provided space to a list and will
@@ -9080,60 +9088,55 @@ export declare namespace Systems {
          * @param inSpaceID - SpaceID of most space to block
          * @param callback - Callback when asynchronous task finishes
          */
-        addBlockedSpace(userId: string, spaceID: string): Promise<Systems.NullResult>;
+        addBlockedSpace(spaceID: string): Promise<Systems.NullResult>;
         /**
          * @description Unblock a space for the current user.
          * @param inSpaceID - SpaceID of most space to block
          * @param callback - Callback when asynchronous task finishes
          */
-        removeBlockedSpace(userId: string, spaceID: string): Promise<Systems.NullResult>;
+        removeBlockedSpace(spaceID: string): Promise<Systems.NullResult>;
         /**
          * @description Get a list of Spaces that were blocked by the current user.
          * Returns an csp::common::Array of csp::common::Strings ordered from most to least recent blocked spaces.
          * @param callback - Callback to call when a response is received.
          */
-        getBlockedSpaces(userId: string): Promise<Systems.StringArrayResult>;
+        getBlockedSpaces(): Promise<Systems.StringArrayResult>;
         /**
          * @description Clear the list of blocked Spaces for the current user.
          * @param callback - Callback when asynchronous task finishes.
          */
-        clearBlockedSpaces(userId: string): Promise<Systems.NullResult>;
+        clearBlockedSpaces(): Promise<Systems.NullResult>;
         /**
          * @description Updates the Portrait Avatar image or adds one if it didn't have it previously using FileAssetDataSource
-         * @param userId - UserId of Avatar Portrait
          * @param newAvatarPortrait - New Portrait Avatar information
          * @param callback - Callback when asynchronous task finishes
          */
-        updateAvatarPortrait(userId: string, newAvatarPortrait: Systems.FileAssetDataSource): Promise<Systems.NullResult>;
+        updateAvatarPortrait(newAvatarPortrait: Systems.FileAssetDataSource): Promise<Systems.NullResult>;
         /**
          * @description Retrieves the Avatar Portrait information associated with the space
          * If the user of the Avatar portrait associated with it the result callback will be successful, the HTTP res code will be ResponseNotFound
          * and the Uri field inside the UriResult will be empty
-         * @param userId - UserId of Avatar Portrait
          * @param callback - Callback when asynchronous task finishes
          */
-        getAvatarPortrait(userId: string): Promise<Systems.UriResult>;
+        getAvatarPortrait(): Promise<Systems.UriResult>;
         /**
          * @description Updates the Avatar Portrait image or adds one if it didn't have it previously using BufferAssetDataSource
-         * @param userId - UserId of Avatar Portrait
          * @param newAvatarPortrait - New Avatar Portrait information
          * @param callback - Callback when asynchronous task finishes
          */
-        updateAvatarPortraitWithBuffer(userId: string, newAvatarPortrait: Systems.BufferAssetDataSource): Promise<Systems.NullResult>;
+        updateAvatarPortraitWithBuffer(newAvatarPortrait: Systems.BufferAssetDataSource): Promise<Systems.NullResult>;
         /**
          * @description Sets the avatar type and identifier for a user.
-         * @param inUserId - The ID of the user to set avatar info for.
          * @param inType - The type of avatar (predefined, Ready Player Me, or custom).
          * @param inIdentifier - A value used to identify or locate the avatar. Differs depending on the value of InType.
          * @param callback - Callback to call when task finishes.
          */
-        setAvatarInfo(userId: string, type: Systems.AvatarType, identifier: Common.Variant): Promise<Systems.NullResult>;
+        setAvatarInfo(type: Systems.AvatarType, identifier: Common.Variant): Promise<Systems.NullResult>;
         /**
          * @description Retrieves the avatar type and identifier for a user.
-         * @param inUserId - The ID of the user to get avatar info for.
          * @param callback - Callback to call when task finishes.
          */
-        getAvatarInfo(userId: string): Promise<Systems.AvatarInfoResult>;
+        getAvatarInfo(): Promise<Systems.AvatarInfoResult>;
     }
 }
 export declare namespace Systems {
@@ -9835,83 +9838,19 @@ export declare namespace Systems {
         delete(): void;
     }
 }
-export declare namespace Systems {
-    /**
-     * @description Result structure for a logout state request.
-     */
-    class LogoutResult extends Systems.NullResult implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromNullResult(baseInstance: Systems.NullResult): Systems.LogoutResult;
-        delete(): void;
-    }
-}
 export declare namespace Systems {
     /**
   @ingroup User System
    * @description @brief Data class used to contain information when the login token has changed
    */
-    class LoginTokenReceived extends Systems.ResultBase implements INativeResource {
+    class LoginTokenInfoResult extends Systems.ResultBase implements INativeResource {
         /** @internal */
         constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Systems.LoginTokenReceived;
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.LoginTokenInfoResult;
         getLoginTokenInfo(): Systems.LoginTokenInfo;
         delete(): void;
     }
 }
-export declare namespace Systems {
-    /**
-  @ingroup User System
-   * @description @brief Data class used to contain information when a ping response is received
-   */
-    class PingResponseReceived extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Systems.PingResponseReceived;
-        delete(): void;
-    }
-}
-export declare namespace Systems {
-    /**
-  @ingroup User System
-   * @description @brief Data class used to contain information requesting a user token
-   */
-    class AgoraUserTokenResult extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Systems.AgoraUserTokenResult;
-        getUserToken(): string;
-        delete(): void;
-    }
-}
-export declare namespace Systems {
-    /**
-     * @description Result url for a tier checkout session request
-     */
-    class CheckoutSessionUrlResult extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Systems.CheckoutSessionUrlResult;
-        static create(): CheckoutSessionUrlResult;
-        static create_arg1(arg1: number): CheckoutSessionUrlResult;
-        getUrl(): string;
-        delete(): void;
-    }
-}
-export declare namespace Systems {
-    /**
-     * @description Result url for a user customer portal request
-     */
-    class CustomerPortalUrlResult extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Systems.CustomerPortalUrlResult;
-        static create(): CustomerPortalUrlResult;
-        static create_arg1(arg1: number): CustomerPortalUrlResult;
-        getUrl(): string;
-        delete(): void;
-    }
-}
 export declare namespace Systems {
     /**
      * @description Data structure for a full user profile, which incudes user email, roles, and data for creation and update history.
@@ -10001,7 +9940,7 @@ export declare namespace Systems {
          * For C#: register a callback to the OnNewLoginTokenReceived event
          * @param callback - Callback that gets called as described above
          */
-        setNewLoginTokenReceivedCallback(callback: (result: Systems.LoginTokenReceived) => void): void;
+        setNewLoginTokenReceivedCallback(callback: (result: Systems.LoginTokenInfoResult) => void): void;
         /**
          * @description Log in to Magnopus Connected Services services using a username-password or email-password combination.
          * @param userName - Csp::common::string
@@ -10064,7 +10003,7 @@ export declare namespace Systems {
          * @description Logout from Magnopus Connected Services.
          * @param callback - Callback to call when a response is received
          */
-        logout(): Promise<Systems.LogoutResult>;
+        logout(): Promise<Systems.NullResult>;
         /**
          * @description Creates a new user profile.
          * @param userName - User name associated with the new profile
@@ -10138,13 +10077,13 @@ export declare namespace Systems {
          * @description Ping Magnopus Connected Services
          * @param callback - Callback to call when a response is received
          */
-        ping(): Promise<Systems.PingResponseReceived>;
+        ping(): Promise<Systems.NullResult>;
         /**
          * @description Retrieve User token from Agora
          * @param params - Params to configure the User token
          * @param callback - Callback to call when a response is received
          */
-        getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.AgoraUserTokenResult>;
+        getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.StringResult>;
         /**
          * @description Re-send user verification email
          * @param inEmail - User's email address
@@ -10157,13 +10096,13 @@ export declare namespace Systems {
          * @param userId - The id of the user associated with the customer portal
          * @param callback - Callback that contains the customer portal url of the user
          */
-        getCustomerPortalUrl(userId: string): Promise<Systems.CustomerPortalUrlResult>;
+        getCustomerPortalUrl(userId: string): Promise<Systems.StringResult>;
         /**
          * @description Get the checkout session Url for a user from Stripe
          * @param tier - The tier of the checkout session needed
          * @param callback - Callback that contains the checkout session url of the tier
          */
-        getCheckoutSessionUrl(tier: Systems.TierNames): Promise<Systems.CheckoutSessionUrlResult>;
+        getCheckoutSessionUrl(tier: Systems.TierNames): Promise<Systems.StringResult>;
     }
 }
 export declare namespace Common {
@@ -10180,6 +10119,7 @@ export declare namespace Common {
         static ofcsp_systems_EAssetPlatform(): Array<Systems.EAssetPlatform>;
         static ofcsp_systems_Asset(): Array<Systems.Asset>;
         static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
+        static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
         static ofcsp_systems_EAssetType(): Array<Systems.EAssetType>;
         static ofcsp_systems_LODAsset(): Array<Systems.LODAsset>;
         static ofcsp_systems_VariantOptionInfo(): Array<Systems.VariantOptionInfo>;
@@ -10214,6 +10154,7 @@ export declare namespace Common {
         static ofcsp_systems_EAssetPlatform_number(size: number): Array<Systems.EAssetPlatform>;
         static ofcsp_systems_Asset_number(size: number): Array<Systems.Asset>;
         static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
+        static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;
         static ofcsp_systems_EAssetType_number(size: number): Array<Systems.EAssetType>;
         static ofcsp_systems_LODAsset_number(size: number): Array<Systems.LODAsset>;
         static ofcsp_systems_VariantOptionInfo_number(size: number): Array<Systems.VariantOptionInfo>;