Version 2 で CloudApi へ接続するためのクラスです。 使い方は継承元クラスの説明も参照。

const cloudApi = new mapray.cloud.CloudApiV2({
tokenType: CloudApi.TokenType.API_KEY,
userId: "...",
token: "...",
});

const datasets = await cloudApi.getDatasets();
// ...

Hierarchy (view full)

Constructors

Properties

basePath: string
version: string

Methods

  • 低レベルAPI。このクラスの別関数から呼び出される。

    Type Parameters

    • T

    Parameters

    • api: string
    • args: string[]
    • Optional query: Query
    • option: {} = {}

      Returns Promise<T>

      json

    • 低レベルAPI。このクラスの別関数から呼び出される。

      Parameters

      • method: string
      • url: string
      • Optional query: Query
      • Optional body: Body
      • option: RequestInit = {}

      Returns Promise<Response>

      json

    • 低レベルAPI。このクラスの別関数から呼び出される。

      Type Parameters

      • T

      Parameters

      • method: string
      • api: string
      • args: string[]
      • Optional query: Query
      • Optional body: Body
      • option: {} = {}

        Returns Promise<T>

        json

      • 低レベルAPI。このクラスの別関数から呼び出される。

        Type Parameters

        • T

        Parameters

        • api: string
        • args: string[]
        • Optional query: Query
        • option: {} = {}

          Returns Promise<T>

          json

        • 3Dデータセットのリストを取得します。 ページごとにデータセットリストを取得します。

          Parameters

          • page: number = 1

            取得する要素のページ番号

          • limit: number = 5

            1ページに含まれる要素数。最大100まで指定することができます。

          Returns Promise<Dataset3D[]>

          3Dデータセットの配列

        • データセットのリストを取得します。 ページごとにデータセットリストを取得します。

          Parameters

          • page: number = 1

            取得する要素のページ番号

          • limit: number = 5

            1ページに含まれる要素数。最大100まで指定することができます。

          Returns Promise<Dataset[]>

          データセットの配列

        • 点群データセットのリストを取得します。 ページごとにデータセットリストを取得します。

          Parameters

          • page: number = 1

            取得する要素のページ番号

          • limit: number = 5

            1ページに含まれる要素数。最大100まで指定することができます。

          Returns Promise<PointCloudDataset[]>

          点群データセットの配列

        • シーンのリストを取得します。 ページごとにシーンリストを取得します。

          *CloudApiV2でのみ対応しています。

          Parameters

          • page: number = 1

            取得する要素のページ番号

          • limit: number = 5

            1ページに含まれる要素数。最大100まで指定することができます。

          Returns Promise<mapray.cloud.Scene[]>

          シーンの配列

        • 低レベルAPI。このクラスの別関数から呼び出される。

          Type Parameters

          • T

          Parameters

          • api: string
          • args: string[]
          • Optional query: Query
          • Optional body: Body
          • option: {} = {}

            Returns Promise<T>

            json

          • 低レベルAPI。このクラスの別関数から呼び出される。

            Type Parameters

            • T

            Parameters

            • api: string
            • args: string[]
            • Optional query: Query
            • Optional body: Body
            • option: {} = {}

              Returns Promise<T>

              json

            • 低レベルAPI。このクラスの別関数から呼び出される。

              Type Parameters

              • T

              Parameters

              • api: string
              • args: string[]
              • Optional query: Query
              • Optional body: Body
              • option: {} = {}

                Returns Promise<T>

                json