File

integration-libs/epd-visualization/core/connectors/scene/scene.adapter.ts

Index

Methods

Methods

Abstract getNodes
getNodes(sceneId: string, nodeIds?: string[], $expand?: string[], $filter?: string[], contentType?: string)

Used for invoking the EPD Visualization API for retrieving scene node information.

Parameters :
Name Type Optional Description
sceneId string No

The scene id to use as the sceneId path parameter.

nodeIds string[] Yes

An array of scene node ids to pass in id query parameters.

$expand string[] Yes

A set of strings to combine to form the $expand query parameter.

$filter string[] Yes

A set of strings to combine to form the $filter query parameter.

contentType string Yes

The contentType query parameter.

An Observable producing a NodesResponse which contains an array of objects describing scene nodes.

import { Observable } from 'rxjs';
import { NodesResponse } from './nodes-response';

export abstract class SceneAdapter {
  /**
   * Used for invoking the EPD Visualization API for retrieving scene node information.
   * @param sceneId The scene id to use as the sceneId path parameter.
   * @param nodeIds An array of scene node ids to pass in id query parameters.
   * @param $expand A set of strings to combine to form the $expand query parameter.
   * @param $filter A set of strings to combine to form the $filter query parameter.
   * @param contentType The contentType query parameter.
   * @returns An Observable producing a NodesResponse which contains an array of objects describing scene nodes.
   */
  abstract getNodes(
    sceneId: string,
    nodeIds?: string[],
    $expand?: string[],
    $filter?: string[],
    contentType?: string
  ): Observable<NodesResponse>;
}

result-matching ""

    No results matching ""