Interface: MapVxRequestContext

Optional context sent with every request to public-api.mapvx.com. Used by totems and directory apps to identify the deployment (totem ID, QR origin, institution, etc.). Values are sent as request headers (X-MapVx-* and mvx-product) when the request target host matches the MapVX API host used by the SDK Requester.

Example


// Totem app
initializeSDK(token, {
  mapvxRequestContext: {
    baseUrl: "https://myapp.com/totem",
    totemId: "totem-floor-1",
    parentPlace: "building-123",
    institutionId: "inst-1",
    institutionName: "Main Mall",
    fullUrl: "https://myapp.com/totem/floor-1",
    mvxProduct: "totems",
  },
})
 
// Directory / QR app
initializeSDK(token, {
  mapvxRequestContext: {
    baseUrl: "https://myapp.com/dir",
    originId: "qr-origin-123",
    institutionId: "inst-1",
    parentPlace: "building-123",
    institutionName: "Main Mall",
    fullUrl: "https://myapp.com/dir/place/456",
    mvxProduct: "directory",
  },
})

Properties

baseUrl?


optional baseUrl: string;

Base URL of the app (e.g. totem or directory base).

fullUrl?


optional fullUrl: string;

Full URL of the current page or screen.

institutionId?


optional institutionId: string;

Institution identifier (directorio).

institutionName?


optional institutionName: string;

Human-readable institution name.

mvxProduct?


optional mvxProduct: string;

Product identifier (e.g. totems, directory, demo). Sent as the mvx-product request header when set.

originId?


optional originId: string;

Origin identifier, e.g. QR code id (directory apps).

parentPlace?


optional parentPlace: string;

Parent place ID (directorio or totem).

totemId?


optional totemId: string;

Totem identifier (totem apps).