Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiInterface

Main API interface which shall contain all sub API objects.

Hierarchy

  • ApiInterface

Index

Properties

Methods

Properties

Readonly about

about: AboutApiInterface

Readonly auth

auth: AuthApiInterface

Readonly dataset

dataset: DatasetApiInterface

Readonly image

image: ImageApiInterface

Readonly legacyApi

legacyApi: IvionInterface

Readonly lib

lib: ThirdPartyLibraryInterface

Readonly license

license: LicenseApiInterface

Readonly mesh

mesh: MeshApiInterface

Readonly poi

poi: PoiApiInterface

Readonly routing

routing: RouteApiInterface

Readonly share

share: ShareApiInterface

Readonly site

site: SiteApiInterface

Readonly siteModel

siteModel: SiteModelApiInterface

Readonly transform

transform: TransformApiInterface

Readonly ui

ui: UiApiInterface

Readonly view

view: ViewApiInterface

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