Class DroppedAssetFactory

Example

const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);

Hierarchy (View Summary)

SDKController
- DroppedAssetFactory

Index

Constructors

constructor

new DroppedAssetFactory(topia: Topia): DroppedAssetFactory
Parameters
- topia: Topia
Returns DroppedAssetFactory
Overrides SDKController.constructor
- Defined in factories/DroppedAssetFactory.ts:14

Properties

credentials

credentials: undefined | InteractiveCredentials

`Optional`jwt

jwt?: string

requestOptions

requestOptions: object

topia

topia: Topia

Methods

create

create(
    id: string,
    urlSlug: string,
    options?: DroppedAssetOptionalInterface,
): DroppedAsset
Instantiate a new instance of DroppedAsset class.
Parameters
- id: string
- urlSlug: string
- Optionaloptions: DroppedAssetOptionalInterface
Returns DroppedAsset
Returns a new DroppedAsset object.
Example
```
const droppedAssetInstance = await DroppedAsset.create(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
```
- Defined in factories/DroppedAssetFactory.ts:28

drop

drop(
    asset: Asset,
    __namedParameters: {
        assetScale?: number;
        clickableDisplayTextDescription?: string;
        clickableDisplayTextHeadline?: string;
        clickableLink?: string;
        clickableLinkTitle?: string;
        clickType?: string;
        flipped?: boolean;
        interactivePublicKey?: string;
        isForceLinkInIframe?: boolean;
        isInteractive?: boolean;
        isOpenLinkInDrawer?: boolean;
        isTextTopLayer?: boolean;
        layer0?: string;
        layer1?: string;
        position: { x: number; y: number };
        sceneDropId?: string;
        text?: string;
        textColor?: string;
        textFontFamily?: string;
        textSize?: number;
        textWeight?: string;
        textWidth?: number;
        uniqueName?: string;
        urlSlug: string;
        yOrderAdjust?: number;
    },
): Promise<DroppedAsset>
Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
Parameters
- asset: Asset
- __namedParameters: {
      assetScale?: number;
      clickableDisplayTextDescription?: string;
      clickableDisplayTextHeadline?: string;
      clickableLink?: string;
      clickableLinkTitle?: string;
      clickType?: string;
      flipped?: boolean;
      interactivePublicKey?: string;
      isForceLinkInIframe?: boolean;
      isInteractive?: boolean;
      isOpenLinkInDrawer?: boolean;
      isTextTopLayer?: boolean;
      layer0?: string;
      layer1?: string;
      position: { x: number; y: number };
      sceneDropId?: string;
      text?: string;
      textColor?: string;
      textFontFamily?: string;
      textSize?: number;
      textWeight?: string;
      textWidth?: number;
      uniqueName?: string;
      urlSlug: string;
      yOrderAdjust?: number;
  }
Returns Promise<DroppedAsset>
Returns a new DroppedAsset object with all properties.
Example
```
const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
const droppedAssetInstance = await DroppedAsset.get(assetInstance, {
     assetScale: 1.5,
     flipped: true,
     layer0: "",
     layer1: "https://pathtoimage.png",
     interactivePublicKey,
     isInteractive: true,
     position: { x: 0, y: 0 },
     uniqueName: "exampleUniqueName",
     urlSlug,
   });
```
- Defined in factories/DroppedAssetFactory.ts:109

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 SDKController.errorHandler
- Defined in controllers/SDKController.ts:97

get

get(
    id: string,
    urlSlug: string,
    options?: DroppedAssetOptionalInterface,
): Promise<DroppedAsset>
Instantiate a new instance of DroppedAsset class and retrieve all properties.
Parameters
- id: string
- urlSlug: string
- Optionaloptions: DroppedAssetOptionalInterface
Returns Promise<DroppedAsset>
Returns a new DroppedAsset object with all properties.
Example
```
const droppedAssetInstance = await DroppedAsset.get(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
```
- Defined in factories/DroppedAssetFactory.ts:42

getWithUniqueName

getWithUniqueName(
    uniqueName: string,
    urlSlug: string,
    interactiveSecret: string,
    credentials: InteractiveCredentials,
): Promise<DroppedAsset>
Searches dropped assets within a world by a provide uniqueName. If a single match is found, a new instance of DroppedAsset class is returned all properties.
Parameters
- uniqueName: string
- urlSlug: string
- interactiveSecret: string
- credentials: InteractiveCredentials
Returns Promise<DroppedAsset>
Returns a new DroppedAsset object with all properties.
Remarks
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.
Example
```
const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, interactiveSecret, credentials);
```
- Defined in factories/DroppedAssetFactory.ts:61

topiaPublicApi

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

Class DroppedAssetFactory

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DroppedAssetFactory

Properties

credentials

Optionaljwt

requestOptions

topia

Methods

create

Parameters

Returns DroppedAsset

Example

drop

Parameters

Returns Promise<DroppedAsset>

Example

errorHandler

Parameters

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

get

Parameters

Returns Promise<DroppedAsset>

Example

getWithUniqueName

Parameters

Returns Promise<DroppedAsset>

Remarks

Example

topiaPublicApi

Returns AxiosInstance

Settings

On This Page

`Optional`jwt

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