Class DroppedAsset

Create an instance of Dropped Asset class with a given dropped asset id, url slug, and optional attributes and session credentials.

Example

const droppedAsset = await new DroppedAsset(topia, "1giFZb0sQ3X27L7uGyQX", "example", {
  attributes: { text: "My Dropped Asset" },
  credentials: { interactiveNonce: "exampleNonce", assetId: "droppedAssetId", visitorId: 1, urlSlug: "exampleWorld" }
});

Hierarchy (View Summary)

Asset
- DroppedAsset

Implements

DroppedAssetInterface

Data Objects

fetchDataObject

fetchDataObject(
    appPublicKey?: string,
    appJWT?: string,
    sharedAppPublicKey?: string,
    sharedAppJWT?: string,
): Promise<void | ResponseType>
Retrieves the data object for a dropped asset.
Parameters
- OptionalappPublicKey: string
- OptionalappJWT: string
- OptionalsharedAppPublicKey: string
- OptionalsharedAppJWT: string
Returns Promise<void | ResponseType>
Returns the data object or an error response.
Example
```
const dataObject = await droppedAsset.fetchDataObject();
```
Implementation of DroppedAssetInterface.fetchDataObject
- Defined in controllers/DroppedAsset.ts:219

incrementDataObjectValue

incrementDataObjectValue(
    path: string,
    amount: number,
    options?: {
        analytics?: AnalyticType[];
        appJWT?: string;
        appPublicKey?: string;
        lock?: { lockId: string; releaseLock?: boolean };
        sharedAppJWT?: string;
        sharedAppPublicKey?: string;
    },
): Promise<void | ResponseType>
Increments a specific value in the data object for a dropped asset by the amount specified. Must have valid interactive credentials from a visitor in the world.
Parameters
- path: string
- amount: number
- options: {
      analytics?: AnalyticType[];
      appJWT?: string;
      appPublicKey?: string;
      lock?: { lockId: string; releaseLock?: boolean };
      sharedAppJWT?: string;
      sharedAppPublicKey?: string;
  } = {}
Returns Promise<void | ResponseType>
Remarks
Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
Example
```
await droppedAsset.incrementDataObjectValue("key", 1);
```
Implementation of DroppedAssetInterface.incrementDataObjectValue
- Defined in controllers/DroppedAsset.ts:340

setDataObject

setDataObject(
    dataObject: object,
    options?: {
        analytics?: AnalyticType[];
        appJWT?: string;
        appPublicKey?: string;
        lock?: { lockId: string; releaseLock?: boolean };
        sharedAppJWT?: string;
        sharedAppPublicKey?: string;
    },
): Promise<void | ResponseType>
Sets the data object for a dropped asset and assigns the response data to the instance.
Parameters
- dataObject: object
- options: {
      analytics?: AnalyticType[];
      appJWT?: string;
      appPublicKey?: string;
      lock?: { lockId: string; releaseLock?: boolean };
      sharedAppJWT?: string;
      sharedAppPublicKey?: string;
  } = {}
Returns Promise<void | ResponseType>
Remarks
Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
Example
```
await droppedAsset.setDataObject(
  { resetCount: 0 },
  {
    analytics: [{ analyticName: "resets"} ],
    lock: { lockId: `${assetId}-${resetCount}-${new Date(Math.round(new Date().getTime() / 10000) * 10000)}` },
  },
);

const { resetCount } = droppedAsset.dataObject;
```
Implementation of DroppedAssetInterface.setDataObject
- Defined in controllers/DroppedAsset.ts:261

updateDataObject

updateDataObject(
    dataObject: object,
    options?: {
        analytics?: AnalyticType[];
        appJWT?: string;
        appPublicKey?: string;
        lock?: { lockId: string; releaseLock?: boolean };
        sharedAppJWT?: string;
        sharedAppPublicKey?: string;
    },
): Promise<void | ResponseType>
Updates the data object for a dropped asset and assigns the response data to the instance.
Parameters
- dataObject: object
- options: {
      analytics?: AnalyticType[];
      appJWT?: string;
      appPublicKey?: string;
      lock?: { lockId: string; releaseLock?: boolean };
      sharedAppJWT?: string;
      sharedAppPublicKey?: string;
  } = {}
Returns Promise<void | ResponseType>
Remarks
Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
Example
```
await droppedAsset.updateDataObject({
  [`profiles.${profileId}.itemsCollectedByUser`]: { [dateKey]: { count: 1 }, total: 1 },
  [`profileMapper.${profileId}`]: username,
});

const { profiles } = droppedAsset.dataObject;
```
Implementation of DroppedAssetInterface.updateDataObject
- Defined in controllers/DroppedAsset.ts:303

Other

constructor

new DroppedAsset(
    topia: Topia,
    id: string,
    urlSlug: string,
    options?: DroppedAssetOptionalInterface,
): DroppedAsset
Parameters
- topia: Topia
- id: string
- urlSlug: string
- options: DroppedAssetOptionalInterface = ...
Returns DroppedAsset
Overrides Asset.constructor
- Defined in controllers/DroppedAsset.ts:46

credentials

credentials: undefined | InteractiveCredentials

`Optional`dataObject

dataObject?: null | object

`Optional` `Readonly`id

id?: string

`Optional`interactivePublicKey

interactivePublicKey?: null | string

`Optional`isInteractive

isInteractive?: null | boolean

`Optional`jwt

jwt?: string

position

position: { x: number; y: number }

requestOptions

requestOptions: object

`Optional`text

text?: null | string

topia

topia: Topia

urlSlug

urlSlug: string

addWebhook

addWebhook(
    __namedParameters: {
        dataObject: object;
        description: string;
        isUniqueOnly: boolean;
        shouldSetClickType?: boolean;
        shouldSetIsInteractive?: boolean;
        title: string;
        type: string;
        url: string;
    },
): Promise<void | AxiosResponse<any, any>>
Add a webhook to a dropped asset
Parameters
- __namedParameters: {
      dataObject: object;
      description: string;
      isUniqueOnly: boolean;
      shouldSetClickType?: boolean;
      shouldSetIsInteractive?: boolean;
      title: string;
      type: string;
      url: string;
  }
Returns Promise<void | AxiosResponse<any, any>>
Returns the new webhookId or an error.
Example
```
await droppedAsset.addWebhook({
  dataObject: {},
  description: "Webhook desc",
  enteredBy: "you",
  isUniqueOnly: false,
  title: "title",
  type: "type",
  url: "https://url.com",
});
```
Implementation of DroppedAssetInterface.addWebhook
- Defined in controllers/DroppedAsset.ts:824

deleteDroppedAsset

deleteDroppedAsset(): Promise<void | ResponseType>
Deletes the dropped asset (removes it from the world).

Returns Promise<void | ResponseType>
Example
```
await droppedAsset.deleteDroppedAsset();
```
Implementation of DroppedAssetInterface.deleteDroppedAsset
- Defined in controllers/DroppedAsset.ts:199

errorHandler

errorHandler(
    __namedParameters: {
        error?: unknown;
        message?: string;
        params?: object;
        sdkMethod?: string;
    },
): {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined
    | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
Parameters
- __namedParameters: { error?: unknown; message?: string; params?: object; sdkMethod?: string }
Returns {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
Inherited from Asset.errorHandler
- Defined in controllers/SDKController.ts:97

fetchAssetById

fetchAssetById(): Promise<object | ResponseType>
Retrieves platform asset details and assigns response data to the instance.

Returns Promise<object | ResponseType>
Returns the asset details or an error response.
Example
```
await asset.fetchAssetById();
const { assetName } = asset;
```
Implementation of DroppedAssetInterface.fetchAssetById
Inherited from Asset.fetchAssetById
- Defined in controllers/Asset.ts:45

fetchDroppedAssetAnalytics

fetchDroppedAssetAnalytics(
    __namedParameters: {
        dateValue: number;
        periodType: "week" | "month" | "quarter" | "year";
        year: number;
    },
): Promise<void | ResponseType>
Retrieve analytics for a dropped asset by day, week, month, quarter, or year
Parameters
- __namedParameters: {
      dateValue: number;
      periodType: "week" | "month" | "quarter" | "year";
      year: number;
  }
Returns Promise<void | ResponseType>
Returns the analytics data or an error.
Example
```
const analytics = await droppedAsset.fetchDroppedAssetAnalytics({
  periodType: "quarter",
  dateValue: 3,
  year: 2023,
});
```
- Defined in controllers/DroppedAsset.ts:920

fetchDroppedAssetById

fetchDroppedAssetById(): Promise<void | ResponseType>
Retrieves dropped asset details and assigns response data to the instance.

Returns Promise<void | ResponseType>
Example
```
await droppedAsset.fetchDroppedAssetById();
const { assetName } = droppedAsset;
```
Implementation of DroppedAssetInterface.fetchDroppedAssetById
- Defined in controllers/DroppedAsset.ts:69

flip

flip(): Promise<void | ResponseType>
Flip an dropped asset.

Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.flip(.5);
```
- Defined in controllers/DroppedAsset.ts:761

removeClickableLink

removeClickableLink(
__namedParameters: RemoveClickableLinkInterface,
): Promise<void | ResponseType>
Removes a clickable link from a dropped asset.
Parameters
- __namedParameters: RemoveClickableLinkInterface
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.removeClickableLink({ linkId: "link-id" });
```
Implementation of DroppedAssetInterface.removeClickableLink
- Defined in controllers/DroppedAsset.ts:534

setClickableLinkMulti

setClickableLinkMulti(
__namedParameters: SetClickableLinkMultiInterface,
): Promise<void | ResponseType>

Adds an array of links to an asset. Maximum is 20 links.

Parameters

__namedParameters: SetClickableLinkMultiInterface

Returns Promise<void | ResponseType>

Returns the updated dropped asset or an error.

Example

await droppedAsset.setClickableLinkMulti({
  clickableLinks: [
    {
      clickableLink: "https://example_one.com",
      clickableLinkTitle: "Example One Link",
      isForceLinkInIframe: true,
      isOpenLinkInDrawer: false,
    },
    {
      clickableLink: "https://example two.com",
      clickableLinkTitle: "Example Two Link",
      isForceLinkInIframe: false,
      isOpenLinkInDrawer: false,
    },
  ],
});

setInteractiveSettings

setInteractiveSettings(
    __namedParameters: {
        interactivePublicKey: string;
        isInteractive?: boolean;
    },
): Promise<void | ResponseType>
Set the interactive settings on a dropped asset
Parameters
- __namedParameters: { interactivePublicKey: string; isInteractive?: boolean }
Returns Promise<void | ResponseType>
Example
```
await droppedAsset.setInteractiveSettings({
  isInteractive: true,
  interactivePublicKey: "xyz"
});
```
Implementation of DroppedAssetInterface.setInteractiveSettings
- Defined in controllers/DroppedAsset.ts:882

topiaPublicApi

topiaPublicApi(): AxiosInstance
Returns AxiosInstance
Inherited from Asset.topiaPublicApi
- Defined in controllers/SDKController.ts:93

updateAsset

updateAsset(
    __namedParameters: {
        assetName: string;
        bottomLayerURL?: string;
        creatorTags: object;
        isPublic: boolean;
        shouldUploadImages?: boolean;
        tagJson: string;
        topLayerURL?: string;
    },
): Promise<void | ResponseType>
Updates platform asset details.
Parameters
- __namedParameters: {
      assetName: string;
      bottomLayerURL?: string;
      creatorTags: object;
      isPublic: boolean;
      shouldUploadImages?: boolean;
      tagJson: string;
      topLayerURL?: string;
  }
Returns Promise<void | ResponseType>
Example
```
await asset.updateAsset({
  assetName: "exampleAsset",
  bottomLayerURL: null,
  creatorTags: { "decorations": true },
  isPublic: true,
  shouldUploadImages: true,
  tagJson: "[{"label":"decorations","value":"decorations"}]",
  topLayerURL: "https://example.topLayerURL"
 });
const { assetName } = asset;
```
Inherited from Asset.updateAsset
- Defined in controllers/Asset.ts:72

updateBroadcast

updateBroadcast(
__namedParameters: UpdateBroadcastInterface,
): Promise<void | ResponseType>
Updates broadcast options for a dropped asset.
Parameters
- __namedParameters: UpdateBroadcastInterface
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateBroadcast({
  assetBroadcast: true,
  assetBroadcastAll: true,
  broadcasterEmail: "example@email.com"
});
```
Implementation of DroppedAssetInterface.updateBroadcast
- Defined in controllers/DroppedAsset.ts:381

updateClickableLinkMulti

updateClickableLinkMulti(
__namedParameters: UpdateClickableLinkMultiInterface,
): Promise<void | ResponseType>
Updates multiple clickable links for a dropped asset.
Parameters
- __namedParameters: UpdateClickableLinkMultiInterface
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Remarks
Pass in an 'existingLinkId' to edit an existing link.
Example
```
await droppedAsset.updateClickableLinkMulti({
  clickableLink: "https://example.com",
  clickableLinkTitle: "Example Link",
  isForceLinkInIframe: true,
  isOpenLinkInDrawer: false,
  existingLinkId: "abcd"
});
```
Implementation of DroppedAssetInterface.updateClickableLinkMulti
- Defined in controllers/DroppedAsset.ts:500

updateClickType

updateClickType(
__namedParameters: UpdateClickTypeInterface,
): Promise<void | ResponseType>
Updates click options for a dropped asset.
Parameters
- __namedParameters: UpdateClickTypeInterface
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateClickType({
  "clickType": "portal",
  "clickableLink": "https://topia.io",
  "clickableLinkTitle": "My awesome link!",
  "clickableDisplayTextDescription": "Description",
  "clickableDisplayTextHeadline": "Title",
  "position": {
    "x": 0,
    "y": 0
  },
  "portalName": "community"
});
```
Implementation of DroppedAssetInterface.updateClickType
- Defined in controllers/DroppedAsset.ts:415

updateCustomTextAsset

updateCustomTextAsset(
style: undefined | null | object,
text: undefined | null | string,
): Promise<void | ResponseType>
Updates text and style of a dropped asset.
Parameters
- style: undefined | null | object
- text: undefined | null | string
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
const style = {
  "textColor": "#abc123",
  "textFontFamily": "Arial",
  "textSize": 40,
  "textWeight": "normal",
  "textWidth": 200
};
await droppedAsset.updateCustomTextAsset(style, "hello world");
```
Implementation of DroppedAssetInterface.updateCustomTextAsset
- Defined in controllers/DroppedAsset.ts:562

updateDroppedAsset

updateDroppedAsset(
__namedParameters: UpdateDroppedAssetInterface,
): Promise<void | ResponseType>

Updates dropped asset details and assigns the response data to the instance. Requires Public Key to have the canUpdateDroppedAssets permission.

Parameters

__namedParameters: UpdateDroppedAssetInterface

Returns Promise<void | ResponseType>

Example

const payload = {
assetScale: 1,
clickType: "link",
clickableDisplayTextDescription: "Description",
clickableDisplayTextHeadline: "Headline",
clickableLink: "https://topia.io",
clickableLinkTitle: "Topia",
flipped: false,
isTextTopLayer: false,
layer0: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
layer1: "https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg",
position: { x: 0, y: 0 },
specialType: "webImage",
text: "My Asset",
textColor: "#000000",
textSize: 20,
textWeight: "normal",
textWidth: 200,
uniqueName: "example",
yOrderAdjust: 0,
}
await droppedAsset.updateDroppedAsset();
const { assetName } = droppedAsset;

updateLandmarkZone

updateLandmarkZone(
    __namedParameters: {
        isLandmarkZoneEnabled: boolean;
        landmarkZoneIsVisible?: boolean;
        landmarkZoneName?: string;
    },
): Promise<void | ResponseType>
Updates landmark zone options for a dropped asset.
Parameters
- __namedParameters: {
      isLandmarkZoneEnabled: boolean;
      landmarkZoneIsVisible?: boolean;
      landmarkZoneName?: string;
  }
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateLandmarkZone({
 isLandmarkZoneEnabled: true,
 landmarkZoneName: "Example",
 landmarkZoneIsVisible: true,
});
```
- Defined in controllers/DroppedAsset.ts:652

updateMediaType

updateMediaType(
__namedParameters: UpdateMediaTypeInterface,
): Promise<void | ResponseType>
Updates media options for a dropped asset.
Parameters
- __namedParameters: UpdateMediaTypeInterface
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateMediaType({
  "mediaType": "link",
  "mediaLink": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  "isVideo": true,
  "syncUserMedia": true,
  "audioSliderVolume: 30"
  "portalName": "community",
  "audioRadius": 0,
  "mediaName": "string"
});
```
Implementation of DroppedAssetInterface.updateMediaType
- Defined in controllers/DroppedAsset.ts:593

updateMuteZone

updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>
Updates mute zone options for a dropped asset.
Parameters
- isMutezone: boolean
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateMuteZone(true);
```
Implementation of DroppedAssetInterface.updateMuteZone
- Defined in controllers/DroppedAsset.ts:630

updatePosition

updatePosition(
    x: number,
    y: number,
    yOrderAdjust?: number,
): Promise<void | ResponseType>
Moves a dropped asset to specified coordinates.
Parameters
- x: number
- y: number
- OptionalyOrderAdjust: number
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updatePosition(100, 200, 100);
```
Implementation of DroppedAssetInterface.updatePosition
- Defined in controllers/DroppedAsset.ts:697

updatePrivateZone

updatePrivateZone(
__namedParameters: UpdatePrivateZoneInterface,
): Promise<void | ResponseType>
Updates private zone options for a dropped asset.
Parameters
- __namedParameters: UpdatePrivateZoneInterface
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updatePrivateZone({
  "isPrivateZone": false,
  "isPrivateZoneChatDisabled": true,
  "privateZoneUserCap": 10
});
```
Implementation of DroppedAssetInterface.updatePrivateZone
- Defined in controllers/DroppedAsset.ts:720

updateScale

updateScale(assetScale: number): Promise<void | ResponseType>
Updates the size of a dropped asset.
Parameters
- assetScale: number
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.assetScale(.5);
```
Implementation of DroppedAssetInterface.updateScale
- Defined in controllers/DroppedAsset.ts:743

updateUploadedMediaSelected

updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>
Change or remove media embedded in a dropped asset.
Parameters
- mediaId: string
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
```
Implementation of DroppedAssetInterface.updateUploadedMediaSelected
- Defined in controllers/DroppedAsset.ts:779

updateWebhookZone

updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>
Updates webhook zone options for a dropped asset.
Parameters
- isWebhookZoneEnabled: boolean
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateWebhookZone(true);
```
Implementation of DroppedAssetInterface.updateWebhookZone
- Defined in controllers/DroppedAsset.ts:679

updateWebImageLayers

updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType>
Change or remove top and bottom layers of a dropped asset.
Parameters
- bottom: string
- top: string
Returns Promise<void | ResponseType>
Returns the updated dropped asset or an error.
Example
```
await droppedAsset.updateWebImageLayers("","https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg");
```
Implementation of DroppedAssetInterface.updateWebImageLayers
- Defined in controllers/DroppedAsset.ts:797

Class DroppedAsset

Example

Hierarchy (View Summary)

Implements

Index

Data Objects

Other

Data Objects

fetchDataObject

Parameters

Returns Promise<void | ResponseType>

Example

incrementDataObjectValue

Parameters

Returns Promise<void | ResponseType>

Remarks

Example

setDataObject

Parameters

Returns Promise<void | ResponseType>

Remarks

Example

updateDataObject

Parameters

Returns Promise<void | ResponseType>

Remarks

Example

Other

constructor

Parameters

Returns DroppedAsset

credentials

OptionaldataObject

Optional Readonlyid

OptionalinteractivePublicKey

OptionalisInteractive

Optionaljwt

position

requestOptions

Optionaltext

topia

urlSlug

addWebhook

Parameters

Returns Promise<void | AxiosResponse<any, any>>

Example

deleteDroppedAsset

Returns Promise<void | ResponseType>

Example

errorHandler

Parameters

Returns { data: {}; message: string; method: string; params: object; sdkMethod: undefined | string; stack: string; stackTrace: Error; status: number; success: boolean; url: string;}

fetchAssetById

Returns Promise<object | ResponseType>

Example

fetchDroppedAssetAnalytics

Parameters

Returns Promise<void | ResponseType>

Example

fetchDroppedAssetById

Returns Promise<void | ResponseType>

Example

flip

Returns Promise<void | ResponseType>

Example

removeClickableLink

Parameters

Returns Promise<void | ResponseType>

Example

setClickableLinkMulti

Parameters

Returns Promise<void | ResponseType>

Example

setInteractiveSettings

Parameters

Returns Promise<void | ResponseType>

Example

topiaPublicApi

Returns AxiosInstance

updateAsset

`Optional`dataObject

`Optional` `Readonly`id

`Optional`interactivePublicKey

`Optional`isInteractive

`Optional`jwt

`Optional`text

Returns {
data: {};
message: string;
method: string;
params: object;
sdkMethod: undefined | string;
stack: string;
stackTrace: Error;
status: number;
success: boolean;
url: string;
}