Skip to content

Function: getBuildingInfo()

ts
function getBuildingInfo(buildingId): Promise<BuildingInfo>;

Read static building metadata by building ID.

Returns the iframe's snapshot for buildingId: name, the building's own entity id, and floor levels. Useful for populating directory UIs (floor count, building name) without navigating into the building.

The iframe source is the bulk map data fetched at property-load time, so the result is effectively static for a given property session.

Parameters

ParameterTypeDescription
buildingIdnumberNumeric building ID (from the Mapsted Hub or CMS). Must be number, not string.

Returns

Promise<BuildingInfo>

Throws

MAPSTED-1012 when buildingId is null / undefined.

Throws

MAPSTED-1013 when buildingId is not a number.

Throws

MAPSTED-1086 (building not found) when the iframe reports the id is unknown.

Throws

MAPSTED-1090 when the API is not READY.