Updated documentation

2025-08-14 18:54:07 +02:00
parent 9129d8b064
commit e9f1d05f4f
2 changed files with 2 additions and 57 deletions

@@ -1,61 +1,6 @@
# ModuleServerAPI # ModuleServerAPI
Class representing the ModuleServerAPI. The ModuleServerAPI is the powerful server-side foundation that brings your Getiyo modules to life. Every module you create relies on this API to handle the complex orchestration between users, data, and the Getiyo platform itself. [Click here to view the introductions.](./ModuleServerAPIIntroduction)
<!--
## Overview
Libs
* [libs](./ModuleServerAPI#libs)
Communication
* [on](./ModuleServerAPI#on)
* [broadcast](./ModuleServerAPI#broadcast)
Clients
* [getClients](./ModuleServerAPI#getclients)
* [getClient](./ModuleServerAPI#getclient)
* [hasClient](./ModuleServerAPI#hasclient)
* [onNewClient](./ModuleServerAPI#onnewclient)
Events
* [onModulePropertyUpdate](./ModuleServerAPI#onmodulepropertyupdate)
* [onReferencePropertyUpdate](./ModuleServerAPI#onreferencepropertyupdate)
* [onSceneChange](./ModuleServerAPI#onscenechange)
* [onFileUpload](./ModuleServerAPI#onfileupload)
* [onTrigger](./ModuleServerAPI#ontrigger)
* [onInit](./ModuleServerAPI#oninit-deprecated) **Deprecated**
Properties
* [getReferenceProperties](./ModuleServerAPI#getreferenceproperties)
* [getReferenceProperty](./ModuleServerAPI#getreferenceproperty)
* [hasReferenceProperty](./ModuleServerAPI#hasreferenceproperty)
* [getModuleProperties](./ModuleServerAPI#getmoduleproperties)
* [getModuleProperty](./ModuleServerAPI#getmoduleproperty)
* [hasModuleProperty](./ModuleServerAPI#hasmoduleproperty)
* [getLastState](./ModuleServerAPI#setlaststate)
* [setLastState](./ModuleServerAPI#setlaststate)
Files
* [readJSON](./ModuleServerAPI#readjson)
* [writeJSON](./ModuleServerAPI#writejson)
* [writeFile](./ModuleServerAPI#writefile)
* [fileExists](./ModuleServerAPI#fileexists)
* [addHost](./ModuleServerAPI#addhost)
* [removeHost](./ModuleServerAPI#removehost)
* [hasHost](./ModuleServerAPI#hashost)
* [hostFile](./ModuleServerAPI#hostfile-deprecated) **Deprecated**
* [removeHostFile](./ModuleServerAPI#removehostfile-deprecated) **Deprecated**
* [hasHostFile](./ModuleServerAPI#hashostfile-deprecated) **Deprecated**
Conditions
* [finishServerCondition](./ModuleServerAPI#finishservercondition)
* [forceClientCondition](./ModuleServerAPI#forceclientcondition)
Environment
* [getModuleID](./ModuleServerAPI.md#getmoduleid)
* [getScenes](./ModuleServerAPI#getscenes)
* [getResolution](./ModuleServerAPI#getresolution) **Deprecated** -->
## Sub Classes ## Sub Classes

@@ -1,6 +1,6 @@
# ModuleServerAPI - Introduction # ModuleServerAPI - Introduction
Welcome to the **ModuleServerAPI** the powerful server-side foundation that brings your Getiyo modules to life. Every module you create relies on this API to handle the complex orchestration between users, data, and the Getiyo platform itself. The ModuleServerAPI is the powerful server-side foundation that brings your Getiyo modules to life. Every module you create relies on this API to handle the complex orchestration between users, data, and the Getiyo platform itself.
## What is the ModuleServerAPI? ## What is the ModuleServerAPI?