Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiInterface

Main API interface which shall contain all sub API objects.

Hierarchy

  • ApiInterface

Index

Properties

Readonly about

Readonly auth

Readonly dataset

Readonly image

Readonly legacyApi

legacyApi: IvionInterface

Readonly lib

Readonly license

Readonly mesh

Readonly mode

Readonly poi

Readonly routing

Readonly share

Readonly site

Readonly siteModel

Readonly transform

Readonly ui

Readonly view

Methods

isLicensed

  • isLicensed(): boolean
  • Checks whether the API feature is enabled for this instance. If not licensed the API can not be used and will throw errors if attempted. Therefore use this method to check first whether other API calls will work.

    Returns boolean

isPrivate

  • isPrivate(): Promise<boolean>
  • Whether private mode is on or not. If an instance is private, only logged in users will have access to data.

    Returns Promise<boolean>

Generated using TypeDoc