Interface ApiInterface

Main API interface which shall contain all sub API objects.

interface ApiInterface {
    about: AboutApiInterface;
    auth: AuthApiInterface;
    dataset: DatasetApiInterface;
    image: ImageApiInterface;
    legacyApi: IvionInterface;
    lib: ThirdPartyLibraryInterface;
    license: LicenseApiInterface;
    mesh: MeshApiInterface;
    mode: ModeApiInterface;
    poi: PoiApiInterface;
    publishing: PublishingApiInterface;
    routing: RouteApiInterface;
    share: ShareApiInterface;
    site: SiteApiInterface;
    siteModel: SiteModelApiInterface;
    transform: TransformApiInterface;
    ui: UiApiInterface;
    view: ViewApiInterface;
    isLicensed(): boolean;
    isPrivate(): Promise<boolean>;
}

Index

Properties

about auth dataset image legacyApi lib license mesh mode poi publishing routing share site siteModel transform ui view

Methods

isLicensed isPrivate

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`mode

mode: ModeApiInterface

`Readonly`poi

poi: PoiApiInterface

`Readonly`publishing

publishing: PublishingApiInterface

`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>