From OpenSCADAWiki
Jump to: navigation, search

API користувацького програмування

Вхідна частина об'єкту модуля (SYS.Protocol.HTTP.{In})

  • bool setUser( string user ) — змінює користувача пов'язаного із ідентифікатором сеансу автентифікації.
    • user — користувач для зміни.
  • bool pgAccess(string URL) — перевіряє доступність сторінки, визначеної у URL.
    • URL — URL сторінки, що перевіряється.
  • string pgCreator(string cnt, string rcode = "", string httpattrs = "Content-Type: text/html;charset={SYS}", string htmlHeadEls = "", string forceTmplFile = "") — формує сторінку або ресурс із вмістом cnt, загорнутим у HTTP з результатом rcode, із додатковими атрибутами HTTP httpattrs, додатковим елементом заголовку HTML htmlHeadEls та використанням файлу шаблону forceTmplFile та для мови lang.
    • cnt — вміст сторінки або ресурсу (зображення, XML, CSS, JavaScript, ...);
    • rcode — результуючий код HTTP, на кшталт "200 OK"; порожнє значення вимикає додання HTTP заголовку;
    • httpattrs — додаткові атрибути HTTP, переважно це "Content-Type" із значенням по замовченню "text/html;charset={SYS}"; тільки для "Content-Type: text/html" буде здійснюватися загортання у внутрішній/сервісний, або визначений forceTmplFile, HTML-шаблон;
    • htmlHeadEls — додатковий тег заголовку HTML, переважно це META з "Refresh" для вказаного URL;
    • forceTmplFile — файл прямо визначеного шаблону для перекриття внутрішнього/сервісного або головної сторінки.