From OpenSCADAWiki
Jump to: navigation, search
 
Line 6: Line 6:
 
* ''bool pgAccess(string URL)'' — перевіряє доступність сторінки, визначеної у ''URL''.
 
* ''bool pgAccess(string URL)'' — перевіряє доступність сторінки, визначеної у ''URL''.
 
** ''URL'' — URL сторінки, що перевіряється.
 
** ''URL'' — URL сторінки, що перевіряється.
* ''string pgCreator(string cnt, string rcode = "200 OK", string httpattrs = "Content-Type: text/html;charset={SYS}", string htmlHeadEls = "", string forceTmplFile = "")'' — формує сторінку або ресурс із вмістом ''cnt'', загорнутим у HTTP з результатом ''rcode'', із додатковими атрибутами HTTP ''httpattrs'', додатковим елементом заголовку HTML ''htmlHeadEls'' та використанням файлу шаблону ''forceTmplFile'' та для мови ''lang''.
+
* ''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, ...);
 
** ''cnt'' — вміст сторінки або ресурсу (зображення, XML, CSS, JavaScript, ...);
 
** ''rcode'' — результуючий код HTTP, на кшталт "200 OK"; порожнє значення вимикає додання HTTP заголовку;
 
** ''rcode'' — результуючий код HTTP, на кшталт "200 OK"; порожнє значення вимикає додання HTTP заголовку;

Latest revision as of 18:03, 7 October 2024

Information about message (contribute)
This message has no documentation. If you know where or how this message is used, you can help other translators by adding documentation to this message.
Message definition (Modules/HTTP)
== User programming API ==
<section begin=API />
'''Input part of the module object (SYS.Protocol.HTTP.{In})'''
* ''bool setUser( string user )'' — changes the user linked to the authentication session ID.
** ''user'' — user to change.
* ''bool pgAccess(string URL)'' — checks for accessing the page, pointed by the ''URL''.
** ''URL'' — URL of the checking page.
* ''string pgCreator(string cnt, string rcode = "", string httpattrs = "Content-Type: text/html;charset={SYS}", string htmlHeadEls = "", string forceTmplFile = "" )'' — forms for a page or a resource from the content ''cnt'', wrapped to HTTP with the result ''rcode'', with HTTP additional attributes ''httpattrs'', HTML additional head's element ''htmlHeadEls'', forced to template file ''forceTmplFile''.
** ''cnt'' — content of the page or the resource (images, XML, CSS, JavaScript, ...) ;
** ''rcode'' — HTTP result code, like to "200 OK"; empty value there disables addition of the HTTP header;
** ''httpattrs'' — additional HTTP-attributes, mostly this is "Content-Type" which by default sets to "text/html;charset={SYS}"; only for "Content-Type: text/html" will be wrapped to internal/service or force ''forceTmplFile'' HTML-template;
** ''htmlHeadEls'' — additional HTML-header's tag, it's mostly META with "Refresh" to the specified URL;
** ''forceTmplFile'' — force template file to override the internal/service or the main-page template.
<section end=API />
Translation== API користувацького програмування ==
<section begin=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'' — файл прямо визначеного шаблону для перекриття внутрішнього/сервісного або головної сторінки.
<section end=API />

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 — файл прямо визначеного шаблону для перекриття внутрішнього/сервісного або головної сторінки.