Class DroppedAsset

Summary

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

Usage

await new DroppedAsset(topia, "1giFZb0sQ3X27L7uGyQX", "example", {
  attributes: { text: "My Asset" },
  credentials: { apiKey: "exampleKey", interactiveNonce: "exampleNonce", visitorId: 1 }
});

Hierarchy

Asset
- DroppedAsset

Implements

DroppedAssetInterface

Constructors

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:41

Properties

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

`Optional` position

position?: {
x: number;
y: number;
}

Type declaration

x: number
y: number

requestOptions

requestOptions: object

`Optional` text

text?: null | string

topia

topia: Topia

urlSlug

urlSlug: string

Methods

addWebhook

addWebhook(__namedParameters: {
    dataObject: object;
    description: string;
    isUniqueOnly: boolean;
    shouldSetClickType?: boolean;
    shouldSetIsInteractive?: boolean;
    title: string;
    type: string;
    url: string;
}): Promise<void | AxiosResponse<any, any>>
Summary
Add a webhook to a dropped asset

Usage
```
await droppedAsset.addWebhook({
  dataObject: {},
  description: "Webhook desc",
  enteredBy: "you",
  isUniqueOnly: false,
  title: "title",
  type: "type",
  url: "https://url.com",
});
```
Parameters
- __namedParameters: {
      dataObject: object;
      description: string;
      isUniqueOnly: boolean;
      shouldSetClickType?: boolean;
      shouldSetIsInteractive?: boolean;
      title: string;
      type: string;
      url: string;
  }
  - dataObject: object
  - description: string
  - isUniqueOnly: boolean
  - Optional shouldSetClickType?: boolean
  - Optional shouldSetIsInteractive?: boolean
  - title: string
  - type: string
  - url: string
Returns Promise<void | AxiosResponse<any, any>>
Implementation of DroppedAssetInterface.addWebhook
- Defined in controllers/DroppedAsset.ts:528

deleteDroppedAsset

deleteDroppedAsset(): Promise<void | ResponseType>
Summary
Delete dropped asset.

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

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;
  }
  - Optional error?: unknown
  - Optional message?: string
  - Optional params?: object
  - Optional sdkMethod?: string
Returns {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
- 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:82

fetchAssetById

fetchAssetById(): Promise<object | ResponseType>
Summary
Retrieves platform asset details.

Usage
```
await asset.fetchAssetById();
const { assetName } = asset;
```
Returns Promise<object | ResponseType>
Implementation of DroppedAssetInterface.fetchAssetById

Inherited from Asset.fetchAssetById
- Defined in controllers/Asset.ts:53

fetchDataObject

fetchDataObject(): Promise<void | ResponseType>
Summary
Retrieves the data object for a dropped asset.

Usage
```
const dataObject = await droppedAsset.fetchDataObject();
```
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.fetchDataObject
- Defined in controllers/DroppedAsset.ts:104

fetchDroppedAssetAnalytics

fetchDroppedAssetAnalytics(__namedParameters: {
    dateValue: number;
    periodType: "week" | "month" | "quarter" | "year";
    year: number;
}): Promise<void | ResponseType>
Summary
Retrieve analytics for a dropped asset by day, week, month, quarter, or year

Usage
```
const analytics = await droppedAsset.fetchDroppedAssetAnalytics({
  periodType: "quarter",
  dateValue: 3,
  year: 2023,
});
```
Parameters
- __namedParameters: {
      dateValue: number;
      periodType: "week" | "month" | "quarter" | "year";
      year: number;
  }
  - dateValue: number
  - periodType: "week" | "month" | "quarter" | "year"
  - year: number
Returns Promise<void | ResponseType>
- Defined in controllers/DroppedAsset.ts:625

fetchDroppedAssetById

fetchDroppedAssetById(): Promise<void | ResponseType>
Summary
Retrieves dropped asset details.

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

flip

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

Usage
```
await droppedAsset.flip(.5);
```
Returns Promise<void | ResponseType>
- Defined in controllers/DroppedAsset.ts:468

incrementDataObjectValue

incrementDataObjectValue(path: string, amount: number, options?: {
    analytics?: string[];
    lock?: {
        lockId: string;
        releaseLock?: boolean;
    };
}): Promise<void | ResponseType>
Summary
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.

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

Usage
```
await droppedAsset.incrementDataObjectValue(
  "path": "key",
  "amount": 1,
);
```
Parameters
- path: string
- amount: number
- options: {
      analytics?: string[];
      lock?: {
          lockId: string;
          releaseLock?: boolean;
      };
  } = {}
  - Optional analytics?: string[]
  - Optional lock?: {
    lockId: string;
    releaseLock?: boolean;
    }
    - lockId: string
    - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.incrementDataObjectValue
- Defined in controllers/DroppedAsset.ts:194

setDataObject

setDataObject(dataObject: object, options?: {
    analytics?: string[];
    lock?: {
        lockId: string;
        releaseLock?: boolean;
    };
}): Promise<void | ResponseType>
Summary
Sets the data object for a dropped asset.

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

Usage
```
await droppedAsset.setDataObject({
  "exampleKey": "exampleValue",
});
```
Parameters
- dataObject: object
- options: {
      analytics?: string[];
      lock?: {
          lockId: string;
          releaseLock?: boolean;
      };
  } = {}
  - Optional analytics?: string[]
  - Optional lock?: {
    lockId: string;
    releaseLock?: boolean;
    }
    - lockId: string
    - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.setDataObject
- Defined in controllers/DroppedAsset.ts:130

setInteractiveSettings

setInteractiveSettings(__namedParameters: {
interactivePublicKey: string;
isInteractive?: boolean;
}): Promise<void | ResponseType>
Summary
Set the interactive settings on a dropped asset

Usage
```
await droppedAsset.setInteractiveSettings({
  isInteractive: true,
  interactivePublicKey: "xyz"
});
```
Parameters
- __namedParameters: {
  interactivePublicKey: string;
  isInteractive?: boolean;
  }
  - interactivePublicKey: string
  - Optional isInteractive?: boolean
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.setInteractiveSettings
- Defined in controllers/DroppedAsset.ts:587

topiaPublicApi

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

updateBroadcast

updateBroadcast(__namedParameters: UpdateBroadcastInterface): Promise<void | ResponseType>
Summary
Updates broadcast options for a dropped asset.

Usage
```
await droppedAsset.updateBroadcast({
  assetBroadcast: true,
  assetBroadcastAll: true,
  broadcasterEmail: "example@email.com"
});
```
Parameters
- __namedParameters: UpdateBroadcastInterface
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateBroadcast
- Defined in controllers/DroppedAsset.ts:229

updateClickType

updateClickType(__namedParameters: UpdateClickTypeInterface): Promise<void | ResponseType>

Summary

Updates click options for a dropped asset.

Usage

await droppedAsset.updateClickType({
  "clickType": "portal",
  "clickableLink": "https://topia.io",
  "clickableLinkTitle": "My awesome link!",
  "clickableDisplayTextDescription": "Description",
  "clickableDisplayTextHeadline": "Title",
  "position": {
    "x": 0,
    "y": 0
  },
  "portalName": "community"
});

Parameters

__namedParameters: UpdateClickTypeInterface

Returns Promise<void | ResponseType>

updateCustomTextAsset

updateCustomTextAsset(style: undefined | null | object, text: undefined | null | string): Promise<void | ResponseType>
Summary
Updates text and style of a dropped asset.

Usage
```
const style = {
  "textColor": "#abc123",
  "textFontFamily": "Arial",
  "textSize": 40,
  "textWeight": "normal",
  "textWidth": 200
};
await droppedAsset.updateCustomTextAsset(style, "hello world");
```
Parameters
- style: undefined | null | object
- text: undefined | null | string
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateCustomTextAsset
- Defined in controllers/DroppedAsset.ts:307

updateDataObject

updateDataObject(dataObject: object, options?: {
    analytics?: string[];
    lock?: {
        lockId: string;
        releaseLock?: boolean;
    };
}): Promise<void | ResponseType>
Summary
Updates the data object for a dropped asset.

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

Usage
```
await droppedAsset.updateDataObject({
  "exampleKey": "exampleValue",
});
```
Parameters
- dataObject: object
- options: {
      analytics?: string[];
      lock?: {
          lockId: string;
          releaseLock?: boolean;
      };
  } = {}
  - Optional analytics?: string[]
  - Optional lock?: {
    lockId: string;
    releaseLock?: boolean;
    }
    - lockId: string
    - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateDataObject
- Defined in controllers/DroppedAsset.ts:162

updateMediaType

updateMediaType(__namedParameters: UpdateMediaTypeInterface): Promise<void | ResponseType>

Summary

Updates media options for a dropped asset.

Usage

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"
});

Parameters

__namedParameters: UpdateMediaTypeInterface

Returns Promise<void | ResponseType>

updateMuteZone

updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>
Summary
Updates mute zone options for a dropped asset.

Usage
```
await droppedAsset.updateMuteZone(true);
```
Parameters
- isMutezone: boolean
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateMuteZone
- Defined in controllers/DroppedAsset.ts:373

updatePosition

updatePosition(x: number, y: number, yOrderAdjust?: number): Promise<void | ResponseType>
Summary
Moves a dropped asset to specified coordinates.

Usage
```
await droppedAsset.updatePosition(100,200);
```
Parameters
- x: number
- y: number
- Optional yOrderAdjust: number
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updatePosition
- Defined in controllers/DroppedAsset.ts:407

updatePrivateZone

updatePrivateZone(__namedParameters: UpdatePrivateZoneInterface): Promise<void | ResponseType>
Summary
Updates private zone options for a dropped asset.

Usage
```
await droppedAsset.updatePrivateZone({
  "isPrivateZone": false,
  "isPrivateZoneChatDisabled": true,
  "privateZoneUserCap": 10
});
```
Parameters
- __namedParameters: UpdatePrivateZoneInterface
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updatePrivateZone
- Defined in controllers/DroppedAsset.ts:429

updateScale

updateScale(assetScale: number): Promise<void | ResponseType>
Summary
Updates the size of a dropped asset.

Usage
```
await droppedAsset.assetScale(.5);
```
Parameters
- assetScale: number
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateScale
- Defined in controllers/DroppedAsset.ts:451

updateUploadedMediaSelected

updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>
Summary
Change or remove media embedded in a dropped asset.

Usage
```
await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
```
Parameters
- mediaId: string
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateUploadedMediaSelected
- Defined in controllers/DroppedAsset.ts:485

updateWebImageLayers

updateWebImageLayers(bottom: string, top: string): Promise<void | ResponseType>
Summary
Change or remove top and bottom layers of a dropped asset.

Usage
```
await droppedAsset.updateWebImageLayers("","https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg");
```
Parameters
- bottom: string
- top: string
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateWebImageLayers
- Defined in controllers/DroppedAsset.ts:502

updateWebhookZone

updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>
Summary
Updates webhook zone options for a dropped asset.

Usage
```
await droppedAsset.updateWebhookZone(true);
```
Parameters
- isWebhookZoneEnabled: boolean
Returns Promise<void | ResponseType>
Implementation of DroppedAssetInterface.updateWebhookZone
- Defined in controllers/DroppedAsset.ts:390

Class DroppedAsset

Summary

Usage

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

topia: Topia

id: string

urlSlug: string

options: DroppedAssetOptionalInterface = ...

Returns DroppedAsset

Properties

credentials

Optional dataObject

Optional Readonly id

Optional interactivePublicKey

Optional isInteractive

Optional jwt

Optional position

Type declaration

x: number

y: number

requestOptions

Optional text

topia

urlSlug

Methods

addWebhook

Summary

Usage

Parameters

__namedParameters: { dataObject: object; description: string; isUniqueOnly: boolean; shouldSetClickType?: boolean; shouldSetIsInteractive?: boolean; title: string; type: string; url: string; }

dataObject: object

description: string

isUniqueOnly: boolean

Optional shouldSetClickType?: boolean

Optional shouldSetIsInteractive?: boolean

title: string

type: string

url: string

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

deleteDroppedAsset

Summary

Usage

Returns Promise<void | ResponseType>

errorHandler

Parameters

__namedParameters: { error?: unknown; message?: string; params?: object; sdkMethod?: string; }

Optional error?: unknown

Optional message?: string

Optional params?: object

Optional sdkMethod?: string

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

data: {}

message: string

method: string

params: object

sdkMethod: undefined | string

stack: string

stackTrace: Error

status: number

success: boolean

url: string

fetchAssetById

Summary

Usage

Returns Promise<object | ResponseType>

fetchDataObject

Summary

Usage

Returns Promise<void | ResponseType>

fetchDroppedAssetAnalytics

Summary

Usage

`Optional` dataObject

`Optional` `Readonly` id

`Optional` interactivePublicKey

`Optional` isInteractive

`Optional` jwt

`Optional` position

`Optional` text

__namedParameters: {
dataObject: object;
description: string;
isUniqueOnly: boolean;
shouldSetClickType?: boolean;
shouldSetIsInteractive?: boolean;
title: string;
type: string;
url: string;
}

`Optional` shouldSetClickType?: boolean

`Optional` shouldSetIsInteractive?: boolean

__namedParameters: {
error?: unknown;
message?: string;
params?: object;
sdkMethod?: string;
}

`Optional` error?: unknown

`Optional` message?: string

`Optional` params?: object

`Optional` sdkMethod?: string

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

__namedParameters: {
dateValue: number;
periodType: "week" | "month" | "quarter" | "year";
year: number;
}

options: {
analytics?: string[];
lock?: {
lockId: string;
releaseLock?: boolean;
};
} = {}

`Optional` analytics?: string[]

`Optional` lock?: {
lockId: string;
releaseLock?: boolean;
}

`Optional` releaseLock?: boolean

options: {
analytics?: string[];
lock?: {
lockId: string;
releaseLock?: boolean;
};
} = {}

`Optional` analytics?: string[]

`Optional` lock?: {
lockId: string;
releaseLock?: boolean;
}

`Optional` releaseLock?: boolean

__namedParameters: {
interactivePublicKey: string;
isInteractive?: boolean;
}

`Optional` isInteractive?: boolean