SDK Reference
Metadata Read-only tenant settings, reference data, plans, roles, themes, languages, and feature settings.
Metadata methods are read-only helpers for dropdowns, tenant configuration, and
feature detection. Most records include a stable id or machine-readable value
when Linxio supplies one, plus tenant-specific fields.
Input countries() does not take parameters.
Returns dataLinxioCountry[] | null
optional Country records, usually including code and name.
errorLinxioError | null
optional Typed SDK error when countries cannot be loaded.
const countries = await linxio.metadata. countries (); if (countries.error) { throw countries.error; } Input roles() does not take parameters.
Returns dataLinxioRole[] | null
optional Role records, usually including id, name, and type when supplied.
errorLinxioError | null
optional Typed SDK error when roles cannot be loaded.
const roles = await linxio.metadata. roles (); if (roles.error) { throw roles.error; } const driverRole = roles.data. find (( role ) => role.name === "Driver" ); Input plans() does not take parameters.
Returns dataLinxioPlan[] | null
optional errorLinxioError | null
optional Typed SDK error when plans cannot be loaded.
const plans = await linxio.metadata. plans (); if (plans.error) { throw plans.error; } Input timezones() does not take parameters.
Returns dataLinxioTimezone[] | null
optional Timezone records, usually including name and offset when supplied.
errorLinxioError | null
optional Typed SDK error when timezones cannot be loaded.
const timezones = await linxio.metadata. timezones (); if (timezones.error) { throw timezones.error; } Input themes() does not take parameters.
Returns dataLinxioTheme[] | null
optional errorLinxioError | null
optional Typed SDK error when themes cannot be loaded.
const themes = await linxio.metadata. themes (); if (themes.error) { throw themes.error; } Input myTheme() does not take parameters.
Returns dataLinxioTheme | null
optional errorLinxioError | null
optional Typed SDK error when the current theme cannot be loaded.
const theme = await linxio.metadata. myTheme (); if (theme.error) { throw theme.error; } Input currentPlan() does not take parameters.
Returns dataLinxioCurrentPlan | null
optional Current plan details, enabled features, and permission flags when supplied.
errorLinxioError | null
optional Typed SDK error when current plan data cannot be loaded.
const plan = await linxio.metadata. currentPlan (); if (plan.error) { throw plan.error; } Input platformDomain() does not take parameters.
Returns dataLinxioPlatformDomain | null
optional Platform domain settings.
errorLinxioError | null
optional Typed SDK error when platform domain settings cannot be loaded.
const domain = await linxio.metadata. platformDomain (); if (domain.error) { throw domain.error; } Input languages() does not take parameters.
Returns dataLinxioLanguage[] | null
optional Language records, usually including code and name.
errorLinxioError | null
optional Typed SDK error when languages cannot be loaded.
const languages = await linxio.metadata. languages (); if (languages.error) { throw languages.error; } Input mapApiOptions() does not take parameters.
Returns dataLinxioMapApiOption[] | null
optional errorLinxioError | null
optional Typed SDK error when map options cannot be loaded.
const options = await linxio.metadata. mapApiOptions (); if (options.error) { throw options.error; } Input providers() does not take parameters.
Returns dataLinxioProviderSetting[] | null
optional Provider setting records.
errorLinxioError | null
optional Typed SDK error when provider settings cannot be loaded.
const providers = await linxio.metadata. providers (); if (providers.error) { throw providers.error; } Input digitalFormSettings() does not take parameters.
Returns dataLinxioDigitalFormSettings | null
optional Digital-form feature settings. Shape can vary by tenant.
errorLinxioError | null
optional Typed SDK error when settings cannot be loaded.
const settings = await linxio.metadata. digitalFormSettings (); if (settings.error) { throw settings.error; } Input ecoSpeedSettings() does not take parameters.
Returns dataLinxioEcoSpeedSettings | null
optional Eco-speed settings. Shape can vary by tenant.
errorLinxioError | null
optional Typed SDK error when settings cannot be loaded.
const settings = await linxio.metadata. ecoSpeedSettings (); if (settings.error) { throw settings.error; } Input excessiveIdlingSettings() does not take parameters.
Returns dataLinxioExcessiveIdlingSettings | null
optional Excessive-idling settings. Shape can vary by tenant.
errorLinxioError | null
optional Typed SDK error when settings cannot be loaded.
Excessive-idling settings const settings = await linxio.metadata. excessiveIdlingSettings (); if (settings.error) { throw settings.error; }