connected-spaces-platform.web 4.22.1 → 4.23.1

package/connectedspacesplatform.d.ts

@@ -4175,6 +4175,11 @@ export declare namespace Multiplayer {
          * It is highly advised not to call this function unless you know what you are doing.
          */
         retrieveAllEntities(): void;
+        /**
+         * @description Destroys the client's local view of all currently known entities.
+         * /// They still reside on the server, however they will not be accessible in the client application.
+         */
+        localDestroyAllEntities(): void;
         /**
          * @description Sets the selected state of an entity, if the operation is acceptable.
          * /// Criteria:
@@ -8467,6 +8472,23 @@ export declare namespace Systems {
         delete(): void;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup ECommerce System
+   * @description Data class used to contain information when attempting to get Arrays of Product Info.
+   */
+    class ProductInfoCollectionResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.ProductInfoCollectionResult;
+        /**
+         * @description Retrieves the Product Info Array being stored.
+         * @return Reference to the productinfos
+         */
+        getProducts(): Common.Array<Systems.ProductInfo>;
+        delete(): void;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup ECommerce System
@@ -8537,6 +8559,13 @@ export declare namespace Systems {
          * @param callback - Callback when asynchronous task finishes
          */
         getProductInformation(spaceId: string, productId: string): Promise<Systems.ProductInfoResult>;
+        /**
+         * @description Get product information from a shopify store within a space, by providing an array of VariantIds
+         * @param spaceId - Space id of product
+         * @param variantIds - Variant ids to search for
+         * @param callback - Callback containing collection of product info when asynchronous task finishes
+         */
+        getProductInfoCollectionByVariantIds(spaceId: string, variantIds: Common.Array<string>): Promise<Systems.ProductInfoCollectionResult>;
         /**
          * @description Get checkout information from a shopify store within a space
          * @param spaceId - Space id of the cart
@@ -9334,9 +9363,9 @@ export declare namespace Systems {
          */
         enterSpace(spaceId: string): Promise<Systems.NullResult>;
         /**
-         * @description Send exit current space event to EventSystem.
+         * @description Exits the space and deregisters from the space scope.
          */
-        exitSpace(): void;
+        exitSpace(): Promise<Systems.NullResult>;
         /**
          * @description Get whether user is currently in a space.
          * @return Result of whether they are in a Space.
@@ -9396,13 +9425,14 @@ export declare namespace Systems {
          * @description Retrieves basic space details for the spaces with the given attributes available to the logged in user.
          * Results pagination is supported through the use of ResultsSkip and ResultsMax.
          * @param isDiscoverable - `true` or `false` to filter by IsDiscoverable attribute value.
-         * @param isDiscoverable - `true` or `false` to filter by RequiresInvite attribute value.
+         * @param isArchived - `true` or `false` to filter by IsArchived attribute value.
+         * @param requiresInvite - `true` or `false` to filter by RequiresInvite attribute value.
          * @param resultsSkip - Number of result entries that will be skipped from the result. for no skip pass nullptr.
          * @param resultsMax - Maximum number of result entries to be retrieved. for all available result entries pass
          * nullptr.
          * @param callback - Callback when asynchronous task finishes
          */
-        getSpacesByAttributes(isDiscoverable: boolean | null, requiresInvite: boolean | null, resultsSkip: number | null, resultsMax: number | null): Promise<Systems.BasicSpacesResult>;
+        getSpacesByAttributes(isDiscoverable: boolean | null, isArchived: boolean | null, requiresInvite: boolean | null, resultsSkip: number | null, resultsMax: number | null): Promise<Systems.BasicSpacesResult>;
         /**
          * @description Retrieves space details corresponding to the provided Space IDs
          * @param requestedSpaceIDs - Array of space ids for which the space details will be retrieved
@@ -9934,7 +9964,7 @@ export declare namespace Systems {
          * @param refreshToken - Refresh token to be used for refreshing the authentication token
          * @param callback - Callback when asynchronous task finishes
          */
-        refreshSession(userId: string, refreshToken: string): Promise<Systems.LoginStateResult>;
+        loginWithRefreshToken(userId: string, refreshToken: string): Promise<Systems.LoginStateResult>;
         /**
          * @description Log in to Magnopus Connected Services as a guest.
          * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
@@ -9969,13 +9999,6 @@ export declare namespace Systems {
          * @param callback - Callback that contains the result of the magnopus connected services authentication operation
          */
         loginToThirdPartyAuthenticationProvider(thirdPartyToken: string, thirdPartyStateId: string, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
-        /**
-         * @description Log in to Magnopus Connected Services using the given one-time password/key.
-         * @param userId - The user id
-         * @param key - The one-time key to exchange
-         * @param callback - Callback to call when a response is received
-         */
-        exchangeKey(userId: string, key: string): Promise<Systems.LoginStateResult>;
         /**
          * @description Logout from Magnopus Connected Services.
          * @param callback - Callback to call when a response is received
@@ -10103,6 +10126,7 @@ export declare namespace Common {
         static ofcsp_systems_ProductVariantInfo(): Array<Systems.ProductVariantInfo>;
         static ofcsp_systems_ProductMediaInfo(): Array<Systems.ProductMediaInfo>;
         static ofcsp_systems_CartLine(): Array<Systems.CartLine>;
+        static ofcsp_systems_ProductInfo(): Array<Systems.ProductInfo>;
         static ofcsp_systems_TicketedEvent(): Array<Systems.TicketedEvent>;
         static ofcsp_systems_MaintenanceInfo(): Array<Systems.MaintenanceInfo>;
         static ofcsp_systems_FeatureLimitInfo(): Array<Systems.FeatureLimitInfo>;
@@ -10138,6 +10162,7 @@ export declare namespace Common {
         static ofcsp_systems_ProductVariantInfo_number(size: number): Array<Systems.ProductVariantInfo>;
         static ofcsp_systems_ProductMediaInfo_number(size: number): Array<Systems.ProductMediaInfo>;
         static ofcsp_systems_CartLine_number(size: number): Array<Systems.CartLine>;
+        static ofcsp_systems_ProductInfo_number(size: number): Array<Systems.ProductInfo>;
         static ofcsp_systems_TicketedEvent_number(size: number): Array<Systems.TicketedEvent>;
         static ofcsp_systems_MaintenanceInfo_number(size: number): Array<Systems.MaintenanceInfo>;
         static ofcsp_systems_FeatureLimitInfo_number(size: number): Array<Systems.FeatureLimitInfo>;

package/connectedspacesplatform.js

@@ -1123,6 +1123,11 @@ function csp_systems_ProductInfoResultFactory(nativePointer) {
 }
 ProxyClassFactories["csp_systems_ProductInfoResult"] =
     csp_systems_ProductInfoResultFactory;
+function csp_systems_ProductInfoCollectionResultFactory(nativePointer) {
+    return new Systems.ProductInfoCollectionResult(nativePointer);
+}
+ProxyClassFactories["csp_systems_ProductInfoCollectionResult"] =
+    csp_systems_ProductInfoCollectionResultFactory;
 function csp_systems_CheckoutInfoResultFactory(nativePointer) {
     return new Systems.CheckoutInfoResult(nativePointer);
 }
@@ -1449,6 +1454,11 @@ function csp_common_Array_csp_systems_CartLineFactory(nativePointer) {
 }
 ProxyClassFactories["csp_common_Array_csp_systems_CartLine"] =
     csp_common_Array_csp_systems_CartLineFactory;
+function csp_common_Array_csp_systems_ProductInfoFactory(nativePointer) {
+    return new Common.Array(nativePointer, csp_systems_ProductInfoFactory, "csp_systems_ProductInfo");
+}
+ProxyClassFactories["csp_common_Array_csp_systems_ProductInfo"] =
+    csp_common_Array_csp_systems_ProductInfoFactory;
 function csp_common_Array_csp_systems_TicketedEventFactory(nativePointer) {
     return new Common.Array(nativePointer, csp_systems_TicketedEventFactory, "csp_systems_TicketedEvent");
 }
@@ -10239,6 +10249,13 @@ export class CSPFoundation {
         retrieveAllEntities() {
             Module.ccall("csp_multiplayer_SpaceEntitySystem_RetrieveAllEntities_void", "void", ["number"], [this.pointer]);
         }
+        /**
+         * @description Destroys the client's local view of all currently known entities.
+         * /// They still reside on the server, however they will not be accessible in the client application.
+         */
+        localDestroyAllEntities() {
+            Module.ccall("csp_multiplayer_SpaceEntitySystem_LocalDestroyAllEntities_void", "void", ["number"], [this.pointer]);
+        }
         /**
          * @description Sets the selected state of an entity, if the operation is acceptable.
          * /// Criteria:
@@ -19550,6 +19567,40 @@ export class CSPFoundation {
     }
     Systems.ProductInfoResult = ProductInfoResult;
 })(Systems || (Systems = {}));
+(function (Systems) {
+    /**
+  @ingroup ECommerce System
+   * @description Data class used to contain information when attempting to get Arrays of Product Info.
+   */
+    class ProductInfoCollectionResult extends Systems.ResultBase {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        static fromResultBase(baseInstance) {
+            const nativeClassWrapper = baseInstance;
+            return new Systems.ProductInfoCollectionResult(new NativePointer(nativeClassWrapper.pointer, nativeClassWrapper.ownsPointer));
+        }
+        /**
+         * @description Retrieves the Product Info Array being stored.
+         * @return Reference to the productinfos
+         */
+        getProducts() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_systems_ProductInfoCollectionResult_GetProductsC_ArrayRC", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Common.Array(getNativePointer(_ret), csp_systems_ProductInfoFactory, "csp_systems_ProductInfo");
+            Module._free(_ret);
+            return _nPtr;
+        }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_systems_ProductInfoCollectionResult_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+    }
+    Systems.ProductInfoCollectionResult = ProductInfoCollectionResult;
+})(Systems || (Systems = {}));
 (function (Systems) {
     /**
   @ingroup ECommerce System
@@ -19710,6 +19761,31 @@ export class CSPFoundation {
             Module.ccall("csp_systems_ECommerceSystem_GetProductInformation_void_StringRC_StringRC_ProductInfoResultCallback", "void", ["number", "string", "string", "number", "number"], [this.pointer, spaceId, productId, _callbackPtr, 0]);
             return _promise;
         }
+        /**
+         * @description Get product information from a shopify store within a space, by providing an array of VariantIds
+         * @param spaceId - Space id of product
+         * @param variantIds - Variant ids to search for
+         * @param callback - Callback containing collection of product info when asynchronous task finishes
+         */
+        async getProductInfoCollectionByVariantIds(spaceId, variantIds) {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, result) => {
+                var _resultPtr = getNativePointer(result);
+                var _resultInstance = new Systems.ProductInfoCollectionResult(_resultPtr);
+                if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
+                    return;
+                }
+                _resolve(_resultInstance);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_systems_ECommerceSystem_GetProductInfoCollectionByVariantIds_void_StringRC_ArrayRC_ProductInfoCollectionResultCallback", "void", ["number", "string", "number", "number", "number"], [this.pointer, spaceId, variantIds.pointer, _callbackPtr, 0]);
+            return _promise;
+        }
         /**
          * @description Get checkout information from a shopify store within a space
          * @param spaceId - Space id of the cart
@@ -21855,10 +21931,26 @@ export class CSPFoundation {
             return _promise;
         }
         /**
-         * @description Send exit current space event to EventSystem.
+         * @description Exits the space and deregisters from the space scope.
          */
-        exitSpace() {
-            Module.ccall("csp_systems_SpaceSystem_ExitSpace_void", "void", ["number"], [this.pointer]);
+        async exitSpace() {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, result) => {
+                var _resultPtr = getNativePointer(result);
+                var _resultInstance = new Systems.NullResult(_resultPtr);
+                if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
+                    return;
+                }
+                _resolve(_resultInstance);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_systems_SpaceSystem_ExitSpace_void_NullResultCallback", "void", ["number", "number", "number"], [this.pointer, _callbackPtr, 0]);
+            return _promise;
         }
         /**
          * @description Get whether user is currently in a space.
@@ -22074,13 +22166,14 @@ export class CSPFoundation {
          * @description Retrieves basic space details for the spaces with the given attributes available to the logged in user.
          * Results pagination is supported through the use of ResultsSkip and ResultsMax.
          * @param isDiscoverable - `true` or `false` to filter by IsDiscoverable attribute value.
-         * @param isDiscoverable - `true` or `false` to filter by RequiresInvite attribute value.
+         * @param isArchived - `true` or `false` to filter by IsArchived attribute value.
+         * @param requiresInvite - `true` or `false` to filter by RequiresInvite attribute value.
          * @param resultsSkip - Number of result entries that will be skipped from the result. for no skip pass nullptr.
          * @param resultsMax - Maximum number of result entries to be retrieved. for all available result entries pass
          * nullptr.
          * @param callback - Callback when asynchronous task finishes
          */
-        async getSpacesByAttributes(isDiscoverable, requiresInvite, resultsSkip, resultsMax) {
+        async getSpacesByAttributes(isDiscoverable, isArchived, requiresInvite, resultsSkip, resultsMax) {
             var _resolve;
             var _promise = new Promise((_r) => {
                 _resolve = _r;
@@ -22101,6 +22194,11 @@ export class CSPFoundation {
                 isDiscoverablePointer = Module._malloc(4);
                 Module.setValue(isDiscoverablePointer, isDiscoverable ? 1 : 0, "i32");
             }
+            var isArchivedPointer = 0;
+            if (isArchived != null) {
+                isArchivedPointer = Module._malloc(4);
+                Module.setValue(isArchivedPointer, isArchived ? 1 : 0, "i32");
+            }
             var requiresInvitePointer = 0;
             if (requiresInvite != null) {
                 requiresInvitePointer = Module._malloc(4);
@@ -22116,10 +22214,11 @@ export class CSPFoundation {
                 resultsMaxPointer = Module._malloc(4);
                 Module.setValue(resultsMaxPointer, resultsMax, "i32");
             }
-            Module.ccall("csp_systems_SpaceSystem_GetSpacesByAttributes_void_boolRC_boolRC_intRC_intRC_BasicSpacesResultCallback", "void", [
+            Module.ccall("csp_systems_SpaceSystem_GetSpacesByAttributes_void_boolRC_boolRC_boolRC_intRC_intRC_BasicSpacesResultCallback", "void", [
                 "number",
                 "boolean",
                 "boolean",
+                "boolean",
                 "number",
                 "number",
                 "number",
@@ -22127,6 +22226,7 @@ export class CSPFoundation {
             ], [
                 this.pointer,
                 isDiscoverablePointer,
+                isArchivedPointer,
                 requiresInvitePointer,
                 resultsSkipPointer,
                 resultsMaxPointer,
@@ -22136,6 +22236,9 @@ export class CSPFoundation {
             if (isDiscoverablePointer) {
                 Module._free(isDiscoverablePointer);
             }
+            if (isArchivedPointer) {
+                Module._free(isArchivedPointer);
+            }
             if (requiresInvitePointer) {
                 Module._free(requiresInvitePointer);
             }
@@ -23852,7 +23955,7 @@ export class CSPFoundation {
          * @param refreshToken - Refresh token to be used for refreshing the authentication token
          * @param callback - Callback when asynchronous task finishes
          */
-        async refreshSession(userId, refreshToken) {
+        async loginWithRefreshToken(userId, refreshToken) {
             var _resolve;
             var _promise = new Promise((_r) => {
                 _resolve = _r;
@@ -23868,7 +23971,7 @@ export class CSPFoundation {
                 Module.removeFunction(_callbackPtr);
             };
             _callbackPtr = Module.addFunction(_callback, "vii");
-            Module.ccall("csp_systems_UserSystem_RefreshSession_void_StringRC_StringRC_LoginStateResultCallback", "void", ["number", "string", "string", "number", "number"], [this.pointer, userId, refreshToken, _callbackPtr, 0]);
+            Module.ccall("csp_systems_UserSystem_LoginWithRefreshToken_void_StringRC_StringRC_LoginStateResultCallback", "void", ["number", "string", "string", "number", "number"], [this.pointer, userId, refreshToken, _callbackPtr, 0]);
             return _promise;
         }
         /**
@@ -23988,31 +24091,6 @@ export class CSPFoundation {
             }
             return _promise;
         }
-        /**
-         * @description Log in to Magnopus Connected Services using the given one-time password/key.
-         * @param userId - The user id
-         * @param key - The one-time key to exchange
-         * @param callback - Callback to call when a response is received
-         */
-        async exchangeKey(userId, key) {
-            var _resolve;
-            var _promise = new Promise((_r) => {
-                _resolve = _r;
-            });
-            var _callbackPtr;
-            var _callback = (_stateObject__, result) => {
-                var _resultPtr = getNativePointer(result);
-                var _resultInstance = new Systems.LoginStateResult(_resultPtr);
-                if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
-                    return;
-                }
-                _resolve(_resultInstance);
-                Module.removeFunction(_callbackPtr);
-            };
-            _callbackPtr = Module.addFunction(_callback, "vii");
-            Module.ccall("csp_systems_UserSystem_ExchangeKey_void_StringRC_StringRC_LoginStateResultCallback", "void", ["number", "string", "string", "number", "number"], [this.pointer, userId, key, _callbackPtr, 0]);
-            return _promise;
-        }
         /**
          * @description Logout from Magnopus Connected Services.
          * @param callback - Callback to call when a response is received
@@ -24535,6 +24613,13 @@ export class CSPFoundation {
             Module._free(_ret);
             return _inst;
         }
+        static ofcsp_systems_ProductInfo() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_Array_Ctor_csp_systems_ProductInfo", "void", ["number"], [_ret]);
+            var _inst = new Array(getNativePointer(_ret), csp_systems_ProductInfoFactory, "csp_systems_ProductInfo");
+            Module._free(_ret);
+            return _inst;
+        }
         static ofcsp_systems_TicketedEvent() {
             var _ret = Module._malloc(8);
             Module.ccall("csp_common_Array_Ctor_csp_systems_TicketedEvent", "void", ["number"], [_ret]);
@@ -24780,6 +24865,13 @@ export class CSPFoundation {
             Module._free(_ret);
             return _inst;
         }
+        static ofcsp_systems_ProductInfo_number(size) {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_common_Array_Conv_size_tC_csp_systems_ProductInfo", "void", ["number", "number"], [_ret, size]);
+            var _inst = new Array(getNativePointer(_ret), csp_systems_ProductInfoFactory, "csp_systems_ProductInfo");
+            Module._free(_ret);
+            return _inst;
+        }
         static ofcsp_systems_TicketedEvent_number(size) {
             var _ret = Module._malloc(8);
             Module.ccall("csp_common_Array_Conv_size_tC_csp_systems_TicketedEvent", "void", ["number", "number"], [_ret, size]);