Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
819 lines (560 sloc) 10.1 KB

Holographics API

These are the current services and methods present in the API with examples. This document is auto-generated every release.

Fonts

REST

GET /api/fonts/ - ()

Websocket

getFonts ()

SDK Examples

Example for: get

Holographics.fonts.get().then((response) => {
  console.log(response)
})

Log

REST

GET /api/log/ - (data)

Websocket

getLog (data)

SDK Examples

Example for: get

Holographics.log.get({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Status

REST

GET /api/status/ - ()

Websocket

getStatus ()

SDK Examples

Example for: get

Holographics.status.get().then((response) => {
  console.log(response)
})

State

REST

GET /api/state/ - ()

PUT /api/state/ - (data)

PATCH /api/state/ - (data)

DELETE /api/state/ - ()

Websocket

getState ()

updateState (data)

patchState (data)

removeState ()

SDK Examples

Example for: get

Holographics.state.get().then((response) => {
  console.log(response)
})

Example for: update

Holographics.state.update({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: patch

Holographics.state.patch({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: remove

Holographics.state.remove().then((response) => {
  console.log(response)
})

Style

REST

GET /api/style/ - (data)

Websocket

getStyle (data)

SDK Examples

Example for: get

Holographics.style.get({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Themes

REST

GET /api/themes/ - ()

GET /api/themes/:id - (id)

PUT /api/themes/:id - (id,data)

DELETE /api/themes/:id - (id)

POST /api/themes/validate - (data)

GET /api/themes/reset - ()

Websocket

findThemes ()

getTheme (id)

updateTheme (id,data)

removeTheme (id)

validateTheme (data)

resetThemes ()

SDK Examples

Example for: find

Holographics.themes.find().then((response) => {
  console.log(response)
})

Example for: get

Holographics.themes.get({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

Example for: update

Holographics.themes.update({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: remove

Holographics.themes.remove({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

Example for: validate

Holographics.themes.validate({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: reset

Holographics.themes.reset().then((response) => {
  console.log(response)
})

Palettes

REST

GET /api/palettes/ - ()

POST /api/palettes/ - (data)

GET /api/palettes/:id - (id)

PUT /api/palettes/:id - (id,data)

PATCH /api/palettes/:id - (id,data)

DELETE /api/palettes/:id - (id)

Websocket

findPalettes ()

createPalette (data)

getPalette (id)

updatePalette (id,data)

patchPalette (id,data)

removePalette (id)

SDK Examples

Example for: find

Holographics.palettes.find().then((response) => {
  console.log(response)
})

Example for: create

Holographics.palettes.create({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: get

Holographics.palettes.get({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

Example for: update

Holographics.palettes.update({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: patch

Holographics.palettes.patch({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: remove

Holographics.palettes.remove({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

MediaFiles

REST

GET /api/mediafiles/ - ()

Websocket

getMediaFiles ()

SDK Examples

Example for: get

Holographics.mediafiles.get().then((response) => {
  console.log(response)
})

Widgets

REST

GET /api/widgets/ - ()

POST /api/widgets/ - (data)

GET /api/widgets/:id - (id)

PUT /api/widgets/:id - (id,data)

PATCH /api/widgets/:id - (id,data)

DELETE /api/widgets/:id - (id)

PUT /api/widgets/:id/toggle - (id,data)

Websocket

findWidgets ()

createWidget (data)

getWidget (id)

updateWidget (id,data)

patchWidget (id,data)

removeWidget (id)

toggleWidget (id,data)

SDK Examples

Example for: find

Holographics.widgets.find().then((response) => {
  console.log(response)
})

Example for: create

Holographics.widgets.create({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: get

Holographics.widgets.get({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

Example for: update

Holographics.widgets.update({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: patch

Holographics.widgets.patch({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: remove

Holographics.widgets.remove({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

Example for: toggle

Holographics.widgets.toggle({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Entries

REST

GET /api/entries/ - (data)

POST /api/entries/ - (data)

GET /api/entries/:id - (id)

PUT /api/entries/:id - (id,data)

PATCH /api/entries/:id - (id,data)

DELETE /api/entries/:id - (id)

Websocket

findEntries (data)

createEntry (data)

getEntry (id)

updateEntry (id,data)

patchEntry (id,data)

removeEntry (id)

SDK Examples

Example for: find

Holographics.entries.find({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: create

Holographics.entries.create({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: get

Holographics.entries.get({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

Example for: update

Holographics.entries.update({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: patch

Holographics.entries.patch({
  id: 'resource id'
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: remove

Holographics.entries.remove({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})

WidgetModules

REST

GET /api/widgetmodules/ - ()

GET /api/widgetmodules/refresh - ()

GET /api/widgetmodules/reset - ()

Websocket

getWidgetModules ()

refreshWidgetModules ()

resetWidgetModules ()

SDK Examples

Example for: get

Holographics.widgetmodules.get().then((response) => {
  console.log(response)
})

Example for: refresh

Holographics.widgetmodules.refresh().then((response) => {
  console.log(response)
})

Example for: reset

Holographics.widgetmodules.reset().then((response) => {
  console.log(response)
})

Settings

REST

GET /api/settings/ - ()

PATCH /api/settings/ - (data)

Websocket

getSettings ()

patchSettings (data)

SDK Examples

Example for: get

Holographics.settings.get().then((response) => {
  console.log(response)
})

Example for: patch

Holographics.settings.patch({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Update

REST

GET /api/update/ - ()

GET /api/update/download - ()

GET /api/update/cancelDownload - ()

GET /api/update/install - ()

Websocket

getUpdate ()

downloadUpdate ()

cancelDownloadUpdate ()

installUpdate ()

SDK Examples

Example for: get

Holographics.update.get().then((response) => {
  console.log(response)
})

Example for: download

Holographics.update.download().then((response) => {
  console.log(response)
})

Example for: cancelDownload

Holographics.update.cancelDownload().then((response) => {
  console.log(response)
})

Example for: install

Holographics.update.install().then((response) => {
  console.log(response)
})

License

REST

GET /api/license/ - ()

PATCH /api/license/ - (data)

DELETE /api/license/ - ()

GET /api/license/validate - ()

Websocket

getLicense ()

patchLicense (data)

removeLicense ()

validateLicense ()

SDK Examples

Example for: get

Holographics.license.get().then((response) => {
  console.log(response)
})

Example for: patch

Holographics.license.patch({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: remove

Holographics.license.remove().then((response) => {
  console.log(response)
})

Example for: validate

Holographics.license.validate().then((response) => {
  console.log(response)
})

Machines

REST

POST /api/machines/ - (data)

DELETE /api/machines/:id - (id)

Websocket

createMachine (data)

removeMachine (id)

SDK Examples

Example for: create

Holographics.machines.create({
  data: {
    resource: 'data'
  }
}).then((response) => {
  console.log(response)
})

Example for: remove

Holographics.machines.remove({
  id: 'resource id'
}).then((response) => {
  console.log(response)
})
You can’t perform that action at this time.