@rtsdk/topia 0.16.3 → 0.17.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +111 -7
- package/dist/index.d.ts +98 -8
- package/dist/index.js +112 -8
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -39804,7 +39804,14 @@ exports.DroppedAssetMediaType = void 0;
|
|
|
39804
39804
|
(function (DroppedAssetMediaType) {
|
|
39805
39805
|
DroppedAssetMediaType["NONE"] = "none";
|
|
39806
39806
|
DroppedAssetMediaType["LINK"] = "link";
|
|
39807
|
-
})(exports.DroppedAssetMediaType || (exports.DroppedAssetMediaType = {}));
|
|
39807
|
+
})(exports.DroppedAssetMediaType || (exports.DroppedAssetMediaType = {}));
|
|
39808
|
+
exports.DroppedAssetMediaVolumeRadius = void 0;
|
|
39809
|
+
(function (DroppedAssetMediaVolumeRadius) {
|
|
39810
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["CLOSE"] = 0] = "CLOSE";
|
|
39811
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["MEDIUM"] = 1] = "MEDIUM";
|
|
39812
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["FAR"] = 2] = "FAR";
|
|
39813
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["EVERYWHERE"] = 3] = "EVERYWHERE";
|
|
39814
|
+
})(exports.DroppedAssetMediaVolumeRadius || (exports.DroppedAssetMediaVolumeRadius = {}));
|
|
39808
39815
|
|
|
39809
39816
|
exports.WorldActivityType = void 0;
|
|
39810
39817
|
(function (WorldActivityType) {
|
|
@@ -39926,10 +39933,12 @@ class DroppedAsset extends Asset {
|
|
|
39926
39933
|
* const { assetName } = droppedAsset;
|
|
39927
39934
|
* ```
|
|
39928
39935
|
*/
|
|
39929
|
-
updateDroppedAsset({ assetScale, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, interactivePublicKey, layer0, layer1, position, specialType, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }) {
|
|
39936
|
+
updateDroppedAsset({ assetScale, audioRadius, audioSliderVolume, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, isVideo, interactivePublicKey, layer0, layer1, mediaLink, mediaName, mediaType, portalName, position, specialType, syncUserMedia, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }) {
|
|
39930
39937
|
return __awaiter(this, void 0, void 0, function* () {
|
|
39931
39938
|
const params = {
|
|
39932
39939
|
assetScale,
|
|
39940
|
+
audioRadius,
|
|
39941
|
+
audioSliderVolume,
|
|
39933
39942
|
clickType,
|
|
39934
39943
|
clickableLink,
|
|
39935
39944
|
clickableLinkTitle,
|
|
@@ -39938,11 +39947,17 @@ class DroppedAsset extends Asset {
|
|
|
39938
39947
|
flipped,
|
|
39939
39948
|
isInteractive,
|
|
39940
39949
|
isTextTopLayer,
|
|
39950
|
+
isVideo,
|
|
39941
39951
|
interactivePublicKey,
|
|
39942
39952
|
layer0,
|
|
39943
39953
|
layer1,
|
|
39954
|
+
mediaLink,
|
|
39955
|
+
mediaName,
|
|
39956
|
+
mediaType,
|
|
39957
|
+
portalName,
|
|
39944
39958
|
position,
|
|
39945
39959
|
specialType,
|
|
39960
|
+
syncUserMedia,
|
|
39946
39961
|
text,
|
|
39947
39962
|
textColor,
|
|
39948
39963
|
textSize,
|
|
@@ -40042,7 +40057,6 @@ class DroppedAsset extends Asset {
|
|
|
40042
40057
|
* });
|
|
40043
40058
|
* ```
|
|
40044
40059
|
*/
|
|
40045
|
-
// get dropped asset
|
|
40046
40060
|
updateDataObject(dataObject, options = {}) {
|
|
40047
40061
|
return __awaiter(this, void 0, void 0, function* () {
|
|
40048
40062
|
try {
|
|
@@ -40141,6 +40155,95 @@ class DroppedAsset extends Asset {
|
|
|
40141
40155
|
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickType" });
|
|
40142
40156
|
}
|
|
40143
40157
|
}
|
|
40158
|
+
/**
|
|
40159
|
+
* @summary
|
|
40160
|
+
* Adds an array of links to an asset. Maximum is 20 links.
|
|
40161
|
+
*
|
|
40162
|
+
* @usage
|
|
40163
|
+
* ```ts
|
|
40164
|
+
* await droppedAsset.setClickableLinkMulti({
|
|
40165
|
+
* clickableLinks: [
|
|
40166
|
+
* {
|
|
40167
|
+
* clickableLink: "https://example_one.com",
|
|
40168
|
+
* clickableLinkTitle: "Example One Link",
|
|
40169
|
+
* isForceLinkInIframe: true,
|
|
40170
|
+
* isOpenLinkInDrawer: false,
|
|
40171
|
+
* },
|
|
40172
|
+
* {
|
|
40173
|
+
* clickableLink: "https://example two.com",
|
|
40174
|
+
* clickableLinkTitle: "Example Two Link",
|
|
40175
|
+
* isForceLinkInIframe: false,
|
|
40176
|
+
* isOpenLinkInDrawer: false,
|
|
40177
|
+
* },
|
|
40178
|
+
* ],
|
|
40179
|
+
* });
|
|
40180
|
+
* ```
|
|
40181
|
+
*/
|
|
40182
|
+
setClickableLinkMulti({ clickableLinks }) {
|
|
40183
|
+
const params = {
|
|
40184
|
+
clickType: exports.DroppedAssetClickType.LINK,
|
|
40185
|
+
clickableLinks,
|
|
40186
|
+
};
|
|
40187
|
+
try {
|
|
40188
|
+
return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-clickable-link-multi");
|
|
40189
|
+
}
|
|
40190
|
+
catch (error) {
|
|
40191
|
+
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.setClickableLinkMulti" });
|
|
40192
|
+
}
|
|
40193
|
+
}
|
|
40194
|
+
/**
|
|
40195
|
+
* @summary
|
|
40196
|
+
* Updates multiple clickable links for a dropped asset.
|
|
40197
|
+
* Pass in an 'existingLinkId' to edit an existing link.
|
|
40198
|
+
*
|
|
40199
|
+
* @usage
|
|
40200
|
+
* ```ts
|
|
40201
|
+
* await droppedAsset.updateClickableLinkMulti({
|
|
40202
|
+
* clickableLink: "https://example.com",
|
|
40203
|
+
* clickableLinkTitle: "Example Link",
|
|
40204
|
+
* isForceLinkInIframe: true,
|
|
40205
|
+
* isOpenLinkInDrawer: false,
|
|
40206
|
+
* existingLinkId: "abcd"
|
|
40207
|
+
* });
|
|
40208
|
+
* ```
|
|
40209
|
+
*/
|
|
40210
|
+
updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }) {
|
|
40211
|
+
const params = {
|
|
40212
|
+
clickType: exports.DroppedAssetClickType.LINK,
|
|
40213
|
+
clickableLink,
|
|
40214
|
+
clickableLinkTitle,
|
|
40215
|
+
isForceLinkInIframe,
|
|
40216
|
+
isOpenLinkInDrawer,
|
|
40217
|
+
existingLinkId,
|
|
40218
|
+
linkSamlQueryParams,
|
|
40219
|
+
};
|
|
40220
|
+
try {
|
|
40221
|
+
return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "update-clickable-link-multi");
|
|
40222
|
+
}
|
|
40223
|
+
catch (error) {
|
|
40224
|
+
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickableLinkMulti" });
|
|
40225
|
+
}
|
|
40226
|
+
}
|
|
40227
|
+
/**
|
|
40228
|
+
* @summary
|
|
40229
|
+
* Removes a clickable link from a dropped asset.
|
|
40230
|
+
*
|
|
40231
|
+
* @usage
|
|
40232
|
+
* ```ts
|
|
40233
|
+
* await droppedAsset.removeClickableLink({ linkId: "link-id" });
|
|
40234
|
+
* ```
|
|
40235
|
+
*/
|
|
40236
|
+
removeClickableLink({ linkId }) {
|
|
40237
|
+
const params = {
|
|
40238
|
+
linkId,
|
|
40239
|
+
};
|
|
40240
|
+
try {
|
|
40241
|
+
return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "remove-clickable-link");
|
|
40242
|
+
}
|
|
40243
|
+
catch (error) {
|
|
40244
|
+
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.removeClickableLink" });
|
|
40245
|
+
}
|
|
40246
|
+
}
|
|
40144
40247
|
/**
|
|
40145
40248
|
* @summary
|
|
40146
40249
|
* Updates text and style of a dropped asset.
|
|
@@ -40910,8 +41013,7 @@ class World extends SDKController {
|
|
|
40910
41013
|
*
|
|
40911
41014
|
* @usage
|
|
40912
41015
|
* ```ts
|
|
40913
|
-
* await world.fetchDroppedAssetsWithUniqueName();
|
|
40914
|
-
* const assets = world.droppedAssets;
|
|
41016
|
+
* const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({u niqueName: "exampleUniqueName", isPartial: true });
|
|
40915
41017
|
* ```
|
|
40916
41018
|
*/
|
|
40917
41019
|
fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial = false, isReversed = false, }) {
|
|
@@ -40982,11 +41084,10 @@ class World extends SDKController {
|
|
|
40982
41084
|
*
|
|
40983
41085
|
* @usage
|
|
40984
41086
|
* ```ts
|
|
40985
|
-
* await world.fetchDroppedAssetsBySceneDropId({
|
|
41087
|
+
* const droppedAssets = await world.fetchDroppedAssetsBySceneDropId({
|
|
40986
41088
|
* sceneDropId: "sceneDropIdExample",
|
|
40987
41089
|
* uniqueName: "optionalUniqueNameExample",
|
|
40988
41090
|
* });
|
|
40989
|
-
* const assets = world.droppedAssets;
|
|
40990
41091
|
* ```
|
|
40991
41092
|
*/
|
|
40992
41093
|
fetchDroppedAssetsBySceneDropId({ sceneDropId, uniqueName, }) {
|
|
@@ -42699,6 +42800,9 @@ class DroppedAssetFactory extends SDKController {
|
|
|
42699
42800
|
* ```
|
|
42700
42801
|
* const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, interactiveSecret, credentials);
|
|
42701
42802
|
* ```
|
|
42803
|
+
*
|
|
42804
|
+
* @notes
|
|
42805
|
+
* This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with matching uniqueName for the given urlSlug.
|
|
42702
42806
|
*/
|
|
42703
42807
|
getWithUniqueName(uniqueName, urlSlug, interactiveSecret, credentials) {
|
|
42704
42808
|
return __awaiter(this, void 0, void 0, function* () {
|
package/dist/index.d.ts
CHANGED
|
@@ -59,6 +59,20 @@ declare enum DroppedAssetMediaType {
|
|
|
59
59
|
NONE = "none",
|
|
60
60
|
LINK = "link"
|
|
61
61
|
}
|
|
62
|
+
declare enum DroppedAssetMediaVolumeRadius {
|
|
63
|
+
CLOSE = 0,
|
|
64
|
+
MEDIUM = 1,
|
|
65
|
+
FAR = 2,
|
|
66
|
+
EVERYWHERE = 3
|
|
67
|
+
}
|
|
68
|
+
type DroppedAssetLinkType = {
|
|
69
|
+
clickableLink: string;
|
|
70
|
+
clickableLinkTitle?: string;
|
|
71
|
+
isForceLinkInIframe?: boolean;
|
|
72
|
+
isOpenLinkInDrawer?: boolean;
|
|
73
|
+
existingLinkId?: string;
|
|
74
|
+
linkSamlQueryParams?: string;
|
|
75
|
+
};
|
|
62
76
|
|
|
63
77
|
type InteractiveCredentials = {
|
|
64
78
|
apiKey?: string;
|
|
@@ -193,7 +207,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
|
|
|
193
207
|
* const { assetName } = droppedAsset;
|
|
194
208
|
* ```
|
|
195
209
|
*/
|
|
196
|
-
updateDroppedAsset({ assetScale, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, interactivePublicKey, layer0, layer1, position, specialType, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }: UpdateDroppedAssetInterface): Promise<void | ResponseType$1>;
|
|
210
|
+
updateDroppedAsset({ assetScale, audioRadius, audioSliderVolume, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, isVideo, interactivePublicKey, layer0, layer1, mediaLink, mediaName, mediaType, portalName, position, specialType, syncUserMedia, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }: UpdateDroppedAssetInterface): Promise<void | ResponseType$1>;
|
|
197
211
|
/**
|
|
198
212
|
* @summary
|
|
199
213
|
* Delete dropped asset.
|
|
@@ -319,6 +333,58 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
|
|
|
319
333
|
* ```
|
|
320
334
|
*/
|
|
321
335
|
updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType$1>;
|
|
336
|
+
/**
|
|
337
|
+
* @summary
|
|
338
|
+
* Adds an array of links to an asset. Maximum is 20 links.
|
|
339
|
+
*
|
|
340
|
+
* @usage
|
|
341
|
+
* ```ts
|
|
342
|
+
* await droppedAsset.setClickableLinkMulti({
|
|
343
|
+
* clickableLinks: [
|
|
344
|
+
* {
|
|
345
|
+
* clickableLink: "https://example_one.com",
|
|
346
|
+
* clickableLinkTitle: "Example One Link",
|
|
347
|
+
* isForceLinkInIframe: true,
|
|
348
|
+
* isOpenLinkInDrawer: false,
|
|
349
|
+
* },
|
|
350
|
+
* {
|
|
351
|
+
* clickableLink: "https://example two.com",
|
|
352
|
+
* clickableLinkTitle: "Example Two Link",
|
|
353
|
+
* isForceLinkInIframe: false,
|
|
354
|
+
* isOpenLinkInDrawer: false,
|
|
355
|
+
* },
|
|
356
|
+
* ],
|
|
357
|
+
* });
|
|
358
|
+
* ```
|
|
359
|
+
*/
|
|
360
|
+
setClickableLinkMulti({ clickableLinks }: SetClickableLinkMultiInterface): Promise<void | ResponseType$1>;
|
|
361
|
+
/**
|
|
362
|
+
* @summary
|
|
363
|
+
* Updates multiple clickable links for a dropped asset.
|
|
364
|
+
* Pass in an 'existingLinkId' to edit an existing link.
|
|
365
|
+
*
|
|
366
|
+
* @usage
|
|
367
|
+
* ```ts
|
|
368
|
+
* await droppedAsset.updateClickableLinkMulti({
|
|
369
|
+
* clickableLink: "https://example.com",
|
|
370
|
+
* clickableLinkTitle: "Example Link",
|
|
371
|
+
* isForceLinkInIframe: true,
|
|
372
|
+
* isOpenLinkInDrawer: false,
|
|
373
|
+
* existingLinkId: "abcd"
|
|
374
|
+
* });
|
|
375
|
+
* ```
|
|
376
|
+
*/
|
|
377
|
+
updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }: UpdateClickableLinkMultiInterface): Promise<void | ResponseType$1>;
|
|
378
|
+
/**
|
|
379
|
+
* @summary
|
|
380
|
+
* Removes a clickable link from a dropped asset.
|
|
381
|
+
*
|
|
382
|
+
* @usage
|
|
383
|
+
* ```ts
|
|
384
|
+
* await droppedAsset.removeClickableLink({ linkId: "link-id" });
|
|
385
|
+
* ```
|
|
386
|
+
*/
|
|
387
|
+
removeClickableLink({ linkId }: RemoveClickableLinkInterface): Promise<void | ResponseType$1>;
|
|
322
388
|
/**
|
|
323
389
|
* @summary
|
|
324
390
|
* Updates text and style of a dropped asset.
|
|
@@ -620,8 +686,7 @@ declare class World extends SDKController implements WorldInterface {
|
|
|
620
686
|
*
|
|
621
687
|
* @usage
|
|
622
688
|
* ```ts
|
|
623
|
-
* await world.fetchDroppedAssetsWithUniqueName();
|
|
624
|
-
* const assets = world.droppedAssets;
|
|
689
|
+
* const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({u niqueName: "exampleUniqueName", isPartial: true });
|
|
625
690
|
* ```
|
|
626
691
|
*/
|
|
627
692
|
fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial, isReversed, }: {
|
|
@@ -645,11 +710,10 @@ declare class World extends SDKController implements WorldInterface {
|
|
|
645
710
|
*
|
|
646
711
|
* @usage
|
|
647
712
|
* ```ts
|
|
648
|
-
* await world.fetchDroppedAssetsBySceneDropId({
|
|
713
|
+
* const droppedAssets = await world.fetchDroppedAssetsBySceneDropId({
|
|
649
714
|
* sceneDropId: "sceneDropIdExample",
|
|
650
715
|
* uniqueName: "optionalUniqueNameExample",
|
|
651
716
|
* });
|
|
652
|
-
* const assets = world.droppedAssets;
|
|
653
717
|
* ```
|
|
654
718
|
*/
|
|
655
719
|
fetchDroppedAssetsBySceneDropId({ sceneDropId, uniqueName, }: {
|
|
@@ -1686,7 +1750,7 @@ interface DroppedAssetInterface extends AssetInterface {
|
|
|
1686
1750
|
assetId?: string;
|
|
1687
1751
|
assetScale?: number | null;
|
|
1688
1752
|
assetPodium?: boolean | null;
|
|
1689
|
-
audioRadius?: number | null;
|
|
1753
|
+
audioRadius?: DroppedAssetMediaVolumeRadius | number | null;
|
|
1690
1754
|
assetBroadcastAll?: boolean | null;
|
|
1691
1755
|
assetPrivateConversation?: boolean | null;
|
|
1692
1756
|
assetPrivateZoneChannelDisabled?: boolean | null;
|
|
@@ -1694,6 +1758,7 @@ interface DroppedAssetInterface extends AssetInterface {
|
|
|
1694
1758
|
audioSliderVolume?: number | null;
|
|
1695
1759
|
bottomLayerURL?: string | null;
|
|
1696
1760
|
broadcasterEmail?: string | null;
|
|
1761
|
+
clickableLinks?: Array<DroppedAssetClickType> | null;
|
|
1697
1762
|
clickType?: string | null;
|
|
1698
1763
|
clickableLink?: string | null;
|
|
1699
1764
|
clickableLinkTitle?: string | null;
|
|
@@ -1765,6 +1830,8 @@ interface UpdateBroadcastInterface {
|
|
|
1765
1830
|
}
|
|
1766
1831
|
interface UpdateDroppedAssetInterface {
|
|
1767
1832
|
assetScale?: number;
|
|
1833
|
+
audioRadius?: DroppedAssetMediaVolumeRadius | number;
|
|
1834
|
+
audioSliderVolume?: number;
|
|
1768
1835
|
clickType?: DroppedAssetClickType;
|
|
1769
1836
|
clickableLink?: string;
|
|
1770
1837
|
clickableLinkTitle?: string;
|
|
@@ -1773,14 +1840,20 @@ interface UpdateDroppedAssetInterface {
|
|
|
1773
1840
|
flipped?: boolean;
|
|
1774
1841
|
isInteractive?: boolean;
|
|
1775
1842
|
isTextTopLayer?: boolean;
|
|
1843
|
+
isVideo?: boolean;
|
|
1776
1844
|
interactivePublicKey?: string;
|
|
1777
1845
|
layer0?: string;
|
|
1778
1846
|
layer1?: string;
|
|
1847
|
+
mediaLink?: string;
|
|
1848
|
+
mediaName?: string;
|
|
1849
|
+
mediaType?: DroppedAssetMediaType;
|
|
1779
1850
|
position?: {
|
|
1780
1851
|
x: number;
|
|
1781
1852
|
y: number;
|
|
1782
1853
|
};
|
|
1854
|
+
portalName?: string;
|
|
1783
1855
|
specialType?: string;
|
|
1856
|
+
syncUserMedia?: boolean;
|
|
1784
1857
|
text?: string | null;
|
|
1785
1858
|
textColor?: string | null;
|
|
1786
1859
|
textSize?: number | null;
|
|
@@ -1803,8 +1876,22 @@ interface UpdateClickTypeInterface {
|
|
|
1803
1876
|
y: number;
|
|
1804
1877
|
};
|
|
1805
1878
|
}
|
|
1879
|
+
interface SetClickableLinkMultiInterface {
|
|
1880
|
+
clickableLinks: DroppedAssetLinkType[];
|
|
1881
|
+
}
|
|
1882
|
+
interface UpdateClickableLinkMultiInterface {
|
|
1883
|
+
clickableLink: string;
|
|
1884
|
+
clickableLinkTitle?: string;
|
|
1885
|
+
isForceLinkInIframe?: boolean;
|
|
1886
|
+
isOpenLinkInDrawer?: boolean;
|
|
1887
|
+
existingLinkId?: string;
|
|
1888
|
+
linkSamlQueryParams?: string;
|
|
1889
|
+
}
|
|
1890
|
+
interface RemoveClickableLinkInterface {
|
|
1891
|
+
linkId: string;
|
|
1892
|
+
}
|
|
1806
1893
|
interface UpdateMediaTypeInterface {
|
|
1807
|
-
audioRadius: number;
|
|
1894
|
+
audioRadius: DroppedAssetMediaVolumeRadius | number;
|
|
1808
1895
|
audioSliderVolume: number;
|
|
1809
1896
|
isVideo: boolean;
|
|
1810
1897
|
mediaLink: string;
|
|
@@ -2470,6 +2557,9 @@ declare class DroppedAssetFactory extends SDKController {
|
|
|
2470
2557
|
* ```
|
|
2471
2558
|
* const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, interactiveSecret, credentials);
|
|
2472
2559
|
* ```
|
|
2560
|
+
*
|
|
2561
|
+
* @notes
|
|
2562
|
+
* This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with matching uniqueName for the given urlSlug.
|
|
2473
2563
|
*/
|
|
2474
2564
|
getWithUniqueName(uniqueName: string, urlSlug: string, interactiveSecret: string, credentials: InteractiveCredentials): Promise<DroppedAsset>;
|
|
2475
2565
|
/**
|
|
@@ -2707,4 +2797,4 @@ declare class WorldFactory extends SDKController {
|
|
|
2707
2797
|
}>;
|
|
2708
2798
|
}
|
|
2709
2799
|
|
|
2710
|
-
export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
|
|
2800
|
+
export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetLinkType, DroppedAssetMediaType, DroppedAssetMediaVolumeRadius, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, RemoveClickableLinkInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, SetClickableLinkMultiInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateClickableLinkMultiInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
|
package/dist/index.js
CHANGED
|
@@ -39802,7 +39802,14 @@ var DroppedAssetMediaType;
|
|
|
39802
39802
|
(function (DroppedAssetMediaType) {
|
|
39803
39803
|
DroppedAssetMediaType["NONE"] = "none";
|
|
39804
39804
|
DroppedAssetMediaType["LINK"] = "link";
|
|
39805
|
-
})(DroppedAssetMediaType || (DroppedAssetMediaType = {}));
|
|
39805
|
+
})(DroppedAssetMediaType || (DroppedAssetMediaType = {}));
|
|
39806
|
+
var DroppedAssetMediaVolumeRadius;
|
|
39807
|
+
(function (DroppedAssetMediaVolumeRadius) {
|
|
39808
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["CLOSE"] = 0] = "CLOSE";
|
|
39809
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["MEDIUM"] = 1] = "MEDIUM";
|
|
39810
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["FAR"] = 2] = "FAR";
|
|
39811
|
+
DroppedAssetMediaVolumeRadius[DroppedAssetMediaVolumeRadius["EVERYWHERE"] = 3] = "EVERYWHERE";
|
|
39812
|
+
})(DroppedAssetMediaVolumeRadius || (DroppedAssetMediaVolumeRadius = {}));
|
|
39806
39813
|
|
|
39807
39814
|
var WorldActivityType;
|
|
39808
39815
|
(function (WorldActivityType) {
|
|
@@ -39924,10 +39931,12 @@ class DroppedAsset extends Asset {
|
|
|
39924
39931
|
* const { assetName } = droppedAsset;
|
|
39925
39932
|
* ```
|
|
39926
39933
|
*/
|
|
39927
|
-
updateDroppedAsset({ assetScale, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, interactivePublicKey, layer0, layer1, position, specialType, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }) {
|
|
39934
|
+
updateDroppedAsset({ assetScale, audioRadius, audioSliderVolume, clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, flipped, isInteractive, isTextTopLayer, isVideo, interactivePublicKey, layer0, layer1, mediaLink, mediaName, mediaType, portalName, position, specialType, syncUserMedia, text, textColor, textSize, textWeight, textWidth, uniqueName, yOrderAdjust, }) {
|
|
39928
39935
|
return __awaiter(this, void 0, void 0, function* () {
|
|
39929
39936
|
const params = {
|
|
39930
39937
|
assetScale,
|
|
39938
|
+
audioRadius,
|
|
39939
|
+
audioSliderVolume,
|
|
39931
39940
|
clickType,
|
|
39932
39941
|
clickableLink,
|
|
39933
39942
|
clickableLinkTitle,
|
|
@@ -39936,11 +39945,17 @@ class DroppedAsset extends Asset {
|
|
|
39936
39945
|
flipped,
|
|
39937
39946
|
isInteractive,
|
|
39938
39947
|
isTextTopLayer,
|
|
39948
|
+
isVideo,
|
|
39939
39949
|
interactivePublicKey,
|
|
39940
39950
|
layer0,
|
|
39941
39951
|
layer1,
|
|
39952
|
+
mediaLink,
|
|
39953
|
+
mediaName,
|
|
39954
|
+
mediaType,
|
|
39955
|
+
portalName,
|
|
39942
39956
|
position,
|
|
39943
39957
|
specialType,
|
|
39958
|
+
syncUserMedia,
|
|
39944
39959
|
text,
|
|
39945
39960
|
textColor,
|
|
39946
39961
|
textSize,
|
|
@@ -40040,7 +40055,6 @@ class DroppedAsset extends Asset {
|
|
|
40040
40055
|
* });
|
|
40041
40056
|
* ```
|
|
40042
40057
|
*/
|
|
40043
|
-
// get dropped asset
|
|
40044
40058
|
updateDataObject(dataObject, options = {}) {
|
|
40045
40059
|
return __awaiter(this, void 0, void 0, function* () {
|
|
40046
40060
|
try {
|
|
@@ -40139,6 +40153,95 @@ class DroppedAsset extends Asset {
|
|
|
40139
40153
|
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickType" });
|
|
40140
40154
|
}
|
|
40141
40155
|
}
|
|
40156
|
+
/**
|
|
40157
|
+
* @summary
|
|
40158
|
+
* Adds an array of links to an asset. Maximum is 20 links.
|
|
40159
|
+
*
|
|
40160
|
+
* @usage
|
|
40161
|
+
* ```ts
|
|
40162
|
+
* await droppedAsset.setClickableLinkMulti({
|
|
40163
|
+
* clickableLinks: [
|
|
40164
|
+
* {
|
|
40165
|
+
* clickableLink: "https://example_one.com",
|
|
40166
|
+
* clickableLinkTitle: "Example One Link",
|
|
40167
|
+
* isForceLinkInIframe: true,
|
|
40168
|
+
* isOpenLinkInDrawer: false,
|
|
40169
|
+
* },
|
|
40170
|
+
* {
|
|
40171
|
+
* clickableLink: "https://example two.com",
|
|
40172
|
+
* clickableLinkTitle: "Example Two Link",
|
|
40173
|
+
* isForceLinkInIframe: false,
|
|
40174
|
+
* isOpenLinkInDrawer: false,
|
|
40175
|
+
* },
|
|
40176
|
+
* ],
|
|
40177
|
+
* });
|
|
40178
|
+
* ```
|
|
40179
|
+
*/
|
|
40180
|
+
setClickableLinkMulti({ clickableLinks }) {
|
|
40181
|
+
const params = {
|
|
40182
|
+
clickType: DroppedAssetClickType.LINK,
|
|
40183
|
+
clickableLinks,
|
|
40184
|
+
};
|
|
40185
|
+
try {
|
|
40186
|
+
return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "set-clickable-link-multi");
|
|
40187
|
+
}
|
|
40188
|
+
catch (error) {
|
|
40189
|
+
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.setClickableLinkMulti" });
|
|
40190
|
+
}
|
|
40191
|
+
}
|
|
40192
|
+
/**
|
|
40193
|
+
* @summary
|
|
40194
|
+
* Updates multiple clickable links for a dropped asset.
|
|
40195
|
+
* Pass in an 'existingLinkId' to edit an existing link.
|
|
40196
|
+
*
|
|
40197
|
+
* @usage
|
|
40198
|
+
* ```ts
|
|
40199
|
+
* await droppedAsset.updateClickableLinkMulti({
|
|
40200
|
+
* clickableLink: "https://example.com",
|
|
40201
|
+
* clickableLinkTitle: "Example Link",
|
|
40202
|
+
* isForceLinkInIframe: true,
|
|
40203
|
+
* isOpenLinkInDrawer: false,
|
|
40204
|
+
* existingLinkId: "abcd"
|
|
40205
|
+
* });
|
|
40206
|
+
* ```
|
|
40207
|
+
*/
|
|
40208
|
+
updateClickableLinkMulti({ clickableLink, clickableLinkTitle, isForceLinkInIframe, isOpenLinkInDrawer, existingLinkId, linkSamlQueryParams, }) {
|
|
40209
|
+
const params = {
|
|
40210
|
+
clickType: DroppedAssetClickType.LINK,
|
|
40211
|
+
clickableLink,
|
|
40212
|
+
clickableLinkTitle,
|
|
40213
|
+
isForceLinkInIframe,
|
|
40214
|
+
isOpenLinkInDrawer,
|
|
40215
|
+
existingLinkId,
|
|
40216
|
+
linkSamlQueryParams,
|
|
40217
|
+
};
|
|
40218
|
+
try {
|
|
40219
|
+
return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "update-clickable-link-multi");
|
|
40220
|
+
}
|
|
40221
|
+
catch (error) {
|
|
40222
|
+
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.updateClickableLinkMulti" });
|
|
40223
|
+
}
|
|
40224
|
+
}
|
|
40225
|
+
/**
|
|
40226
|
+
* @summary
|
|
40227
|
+
* Removes a clickable link from a dropped asset.
|
|
40228
|
+
*
|
|
40229
|
+
* @usage
|
|
40230
|
+
* ```ts
|
|
40231
|
+
* await droppedAsset.removeClickableLink({ linkId: "link-id" });
|
|
40232
|
+
* ```
|
|
40233
|
+
*/
|
|
40234
|
+
removeClickableLink({ linkId }) {
|
|
40235
|
+
const params = {
|
|
40236
|
+
linkId,
|
|
40237
|
+
};
|
|
40238
|
+
try {
|
|
40239
|
+
return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, params, "remove-clickable-link");
|
|
40240
|
+
}
|
|
40241
|
+
catch (error) {
|
|
40242
|
+
throw this.errorHandler({ error, params, sdkMethod: "DroppedAsset.removeClickableLink" });
|
|
40243
|
+
}
|
|
40244
|
+
}
|
|
40142
40245
|
/**
|
|
40143
40246
|
* @summary
|
|
40144
40247
|
* Updates text and style of a dropped asset.
|
|
@@ -40908,8 +41011,7 @@ class World extends SDKController {
|
|
|
40908
41011
|
*
|
|
40909
41012
|
* @usage
|
|
40910
41013
|
* ```ts
|
|
40911
|
-
* await world.fetchDroppedAssetsWithUniqueName();
|
|
40912
|
-
* const assets = world.droppedAssets;
|
|
41014
|
+
* const droppedAssets = await world.fetchDroppedAssetsWithUniqueName({u niqueName: "exampleUniqueName", isPartial: true });
|
|
40913
41015
|
* ```
|
|
40914
41016
|
*/
|
|
40915
41017
|
fetchDroppedAssetsWithUniqueName({ uniqueName, isPartial = false, isReversed = false, }) {
|
|
@@ -40980,11 +41082,10 @@ class World extends SDKController {
|
|
|
40980
41082
|
*
|
|
40981
41083
|
* @usage
|
|
40982
41084
|
* ```ts
|
|
40983
|
-
* await world.fetchDroppedAssetsBySceneDropId({
|
|
41085
|
+
* const droppedAssets = await world.fetchDroppedAssetsBySceneDropId({
|
|
40984
41086
|
* sceneDropId: "sceneDropIdExample",
|
|
40985
41087
|
* uniqueName: "optionalUniqueNameExample",
|
|
40986
41088
|
* });
|
|
40987
|
-
* const assets = world.droppedAssets;
|
|
40988
41089
|
* ```
|
|
40989
41090
|
*/
|
|
40990
41091
|
fetchDroppedAssetsBySceneDropId({ sceneDropId, uniqueName, }) {
|
|
@@ -42697,6 +42798,9 @@ class DroppedAssetFactory extends SDKController {
|
|
|
42697
42798
|
* ```
|
|
42698
42799
|
* const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, interactiveSecret, credentials);
|
|
42699
42800
|
* ```
|
|
42801
|
+
*
|
|
42802
|
+
* @notes
|
|
42803
|
+
* This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with matching uniqueName for the given urlSlug.
|
|
42700
42804
|
*/
|
|
42701
42805
|
getWithUniqueName(uniqueName, urlSlug, interactiveSecret, credentials) {
|
|
42702
42806
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -43055,4 +43159,4 @@ process.on("uncaughtException", function (err) {
|
|
|
43055
43159
|
process.exit(1);
|
|
43056
43160
|
});
|
|
43057
43161
|
|
|
43058
|
-
export { Asset, AssetFactory, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetMediaType, Ecosystem, EcosystemFactory, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, WebRTCConnector, WebRTCConnectorFactory, World, WorldActivity, WorldActivityFactory, WorldActivityType, WorldFactory };
|
|
43162
|
+
export { Asset, AssetFactory, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetMediaType, DroppedAssetMediaVolumeRadius, Ecosystem, EcosystemFactory, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, WebRTCConnector, WebRTCConnectorFactory, World, WorldActivity, WorldActivityFactory, WorldActivityType, WorldFactory };
|
package/package.json
CHANGED