Class PolyverseServiceAbstract

constructor

• new PolyverseService(): PolyverseService

• Returns PolyverseService

Static ReadonlydefaultAssetTypeFilter

Static ReadonlytokenCostCurrency

Static ReadonlytokenCurrency

StaticarticulateBackendURL

• articulateBackendURL(route, routeParams?): string

• Articulates a backend route using routeParams and queryParams.

  Parameters

  • route: string
  • OptionalrouteParams: {
        [key: string]: string | number | boolean;
    }

    • [key: string]: string | number | boolean

  Returns string

  Note

  The routeParams will substitue url encoded the key/value pairs with route templates. e.g. /user/:userID will substitute the :userID with the key userID

StaticauthenticatedFetch

• authenticatedFetch(url, isAuthOptional?): Promise<AsyncHTTPRequest>

• Performs an authenticated fetch. If the user is not authenticated, this API will throw.

  Parameters

  • url: string

    The url to fetch.
  • OptionalisAuthOptional: boolean

  Returns Promise<AsyncHTTPRequest>

  A promise for the fetch

  Throws

StaticauthenticatedPost

• authenticatedPost(url, ...requestBodies): Promise<AsyncHTTPRequest>

• Performs an authenticated post. If the user is not authenticated, this API will throw.

  Parameters

  • url: string

    The url to post.
  • Rest...requestBodies: HTTPRequestBody[]

  Returns Promise<AsyncHTTPRequest>

  A promise for the post

  Throws

StaticfetchAsset

• fetchAsset(libraryID, assetID): Promise<PolyverseAssetObject>

• Fetches the asset from the Polyverse backend.

  Parameters

  • libraryID: string

    The library ID to fetch the asset from.
  • assetID: string

    The asset ID to fetch.

  Returns Promise<PolyverseAssetObject>

  A promise for the asset object.

StaticfetchAssetList

• fetchAssetList(sortType, contentsLimit, contentsOffset, fetchType, fetchObjectID, categories, includeAssetTypeFilters, ignoreAssetTypeFilters?, includeCategories?, searchQuery?): Promise<PolyverseLibraryAssetContents>

• Fetches the asset list from the Polyverse backend. This API is used to fetch assets from the Polyverse backend. The assets can be fetched from the global library, user subscriptions, a channel or a library.

  Parameters

  • sortType: PolyverseAssetLibrarySortType

    The sort type to use.
  • contentsLimit: number

    The number of contents to fetch.
  • contentsOffset: number

    The offset to fetch the contents from.
  • fetchType:
        | "Global"
        | "Subscriptions"
        | "Channel"
        | "Library"

    The type of fetch to perform.
  • fetchObjectID: string

    The object ID to fetch the contents from.
  • categories: string[]

    The categories to fetch the assets from.
  • includeAssetTypeFilters: (
        | "Mesh"
        | "Material"
        | "Image"
        | "Json"
        | "Environment"
        | "Data"
        | "RSXDeployment"
        | "Audio"
        | "Video"
        | "InstaMATPackage")[]

    The asset type filters to include.
  • OptionalignoreAssetTypeFilters: (
        | "Mesh"
        | "Material"
        | "Image"
        | "Json"
        | "Environment"
        | "Data"
        | "RSXDeployment"
        | "Audio"
        | "Video"
        | "InstaMATPackage")[]

    The asset type filters to ignore.
  • OptionalincludeCategories: boolean

    Whether to include categories in the fetch.
  • OptionalsearchQuery: string

    The search query to use.

  Returns Promise<PolyverseLibraryAssetContents>

  A promise for the library asset contents.

  Note

  This is only used for channel and library fetch types.

StaticfetchPolytronObject

• fetchPolytronObject(identifier, objectID): Promise<PolytronObjectInfo>

• Fetches the Polytron Object from the Polyverse backend.

  Parameters

  • identifier: string

    The identifier of the object to fetch.
  • objectID: string

    The ID of the object to fetch.

  Returns Promise<PolytronObjectInfo>

  The PolytronTask object.

StaticfetchPolytronsFeatured

• fetchPolytronsFeatured(): Promise<PolytronFeaturedListResponse>

• Fetches the featured Polytron lists from the Polyverse backend.

  Returns Promise<PolytronFeaturedListResponse>

  The PolytronFeaturedListResponse object.

StaticfetchPolytronTask

• fetchPolytronTask(taskID): Promise<PolytronTask>

• Fetches the Polytron task status from the Polyverse backend.

  Parameters

  • taskID: string

    The task ID to fetch.

  Returns Promise<PolytronTask>

  The PolytronTask object.

StaticfetchPolytronTaskList

• fetchPolytronTaskList(query?): Promise<PolytronUserTasks>

• Fetches the Polytron task status from the Polyverse backend.

  Parameters

  • Optionalquery: string

  Returns Promise<PolytronUserTasks>

  The PolytronTask object.

StaticfetchUserConfiguration

• fetchUserConfiguration(): Promise<PolyverseAssetLibraryConfiguration>

• Fetches the user configuration from the Polyverse backend.

  Returns Promise<PolyverseAssetLibraryConfiguration>

  A promise for the asset object.

StaticfetchUserLibraries

• fetchUserLibraries(): Promise<PolyverseAssetLibrary[]>

• Fetches the user libraries with permission data from the Polyverse backend.

  Returns Promise<PolyverseAssetLibrary[]>

  A promise for the array of libraries.

StaticformatTokenCostInCurrency

• formatTokenCostInCurrency(tokenCost): string

• Formats the token cost in the current PolyverseService.tokenCurrency.

  Parameters

  • tokenCost: number

    The token cost to format.

  Returns string

  The formatted token cost.

StaticopenInBrowser

• openInBrowser(libraryID, assetID?): void

• Open the Polyverse library or asset in the browser.

  Parameters

  • libraryID: string

    The library ID to open.
  • OptionalassetID: string

    The optional asset ID to open.

  Returns void

StaticopenPolytronInBrowser

• openPolytronInBrowser(objectIdentifier, objectID): void

• Open the Polytron in the browser.

  Parameters

  • objectIdentifier: String

    The object identifier to open.
  • objectID: string

    The object ID to open.

  Returns void

StaticopenPolytronTaskInBrowser

• openPolytronTaskInBrowser(taskID): void

• Open the Polytron Task in the browser.

  Parameters

  • taskID: string

    The task ID to open.

  Returns void

StaticpostPolytronTaskRequest

• postPolytronTaskRequest(task, ...requestBodies): Promise<PolytronTask>

• Posts a Polytron task request to the Polyverse backend.

  Parameters

  • task: PolytronProcessingRequestObject

    The task to submit.
  • Rest...requestBodies: HTTPRequestBody[]

  Returns Promise<PolytronTask>

  The PolytronTask object.

StaticsearchPolytronCatalog

• searchPolytronCatalog(query): Promise<PolytronCatalogSearchResponse>

• Searches the Polytron catalog from the Polyverse backend.

  Parameters

  • query: string

    The query to search.

  Returns Promise<PolytronCatalogSearchResponse>

  The PolytronCatalogSearchResponse object.