Vue_AppGlobals

object

localestringrequired

localeShortstringrequired

localeWithDashesstringrequired

timeConfigobject | nullrequired

apiCsrfstring | nullrequired

dashboardPropsVue_DashboardGlobals | nullrequired

Show child attributes

One of

instanceNamestringrequired

homeUrlstringrequired

logoutUrlstringrequired

versionstringrequired

isDockerbooleanrequired

platformstringrequired

showChartsbooleanrequired

showAlbumArtbooleanrequired

supportedLocalesobjectrequired

Show child attributes

[key: string]string

analyticsLevelAnalyticsLevelallno_ipnonerequired

userVue_UserGlobals | nullrequired

Show child attributes

One of

idintegerrequired

displayNamestring | nullrequired

permissionsApi_Admin_RolePermissionsrequired

Show child attributes

globalArray<GlobalPermissions>administer allview administrationview system logsadminister settingsadminister api keysadminister stationsadminister custom fieldsadminister backupsadminister storage locationsrequired

stationArray<Api_Admin_RoleStationPermission>required

Show child attributes

idintegerrequired

The station ID.

permissionsArray<StationPermissions>administer allview station managementview station reportsview station logsmanage station profilemanage station broadcastingmanage station streamersmanage station mountsmanage station remotesmanage station mediadelete station mediamanage station automationmanage station web hooksmanage station podcastsrequired

notificationsArray<Api_ToastNotification>required

Show child attributes

messagestringrequired

titlestring | nullrequired

variantFlashLevelssuccesswarningdangerinforequired

componentPropsArray<{}> | nullrequired

Example

{
  "locale": "string",
  "localeShort": "string",
  "localeWithDashes": "string",
  "timeConfig": {},
  "apiCsrf": "string",
  "dashboardProps": {
    "instanceName": "string",
    "homeUrl": "string",
    "logoutUrl": "string",
    "version": "string",
    "isDocker": true,
    "platform": "string",
    "showCharts": true,
    "showAlbumArt": true,
    "supportedLocales": {},
    "analyticsLevel": "all"
  },
  "user": {
    "id": 0,
    "displayName": "string",
    "permissions": {
      "global": [
        "administer all"
      ],
      "station": [
        {
          "id": 0,
          "permissions": [
            "administer all"
          ]
        }
      ]
    }
  },
  "notifications": [
    {
      "message": "string",
      "title": "string",
      "variant": "success"
    }
  ],
  "componentProps": []
}

Docs by Sourcey