Commit 6caca176 authored by Valentin Skripnikov's avatar Valentin Skripnikov

-

parent b5d37bf3
...@@ -8,17 +8,20 @@ AS.FORMS.ApiUtils ...@@ -8,17 +8,20 @@ AS.FORMS.ApiUtils
Утилиты для работы с REST API Synergy Утилиты для работы с REST API Synergy
.. note:: При использовании данных методов адрес и порт Synergy, а также
параметры авторизации определяются при подключении проигрывателя форм.
Методы являются оберткой над `jQuery.ajax() <http://api.jquery.com/jquery.ajax/>`_
и обладают всеми его свойствами.
.. js:function:: simpleAsyncGet(urlPart[, callback[, dataType[, data[, errorHandler]]]]) .. js:function:: simpleAsyncGet(urlPart[, callback[, dataType[, data[, errorHandler]]]])
Выполнить GET запрос по указанному URL REST API. Выполнить GET запрос по указанному URL REST API.
Хост и порт Synergy прописываются при подключении проигрывателя форм.
Является оберткой над `jQuery.ajax() <http://api.jquery.com/jquery.ajax/>`_, поэтому обладает всеми его свойствами.
:param string urlPart: Часть URL метода REST API, без ``http://host:port/Synergy/``, :param string urlPart: Часть URL метода REST API, без ``http://host:port/Synergy/``,
например ``rest/api/registry/create_doc?registryCode=someregistry`` например ``rest/api/registry/create_doc?registryCode=someregistry``
:param function callback: Функция, которая будет вызвана в случае успешного выполнения запроса. :param function callback: Функция, которая будет вызвана в случае успешного выполнения запроса.
В данную функцию передается один параметр - ответ на запрос. В данную функцию передается один параметр - ответ на запрос.
:param string dataType: Тип данных ответа на запрос. :param string dataType: ``default:'json'`` Тип данных ответа на запрос.
Может принимать значения: ``"xml"``, ``"html"``, ``"script"``, ``"json"``, ``"jsonp"``, ``"text"``. Может принимать значения: ``"xml"``, ``"html"``, ``"script"``, ``"json"``, ``"jsonp"``, ``"text"``.
Если не передавать параметр, то будет использоваться дефолтное значение ``"json"``. Если не передавать параметр, то будет использоваться дефолтное значение ``"json"``.
:param object data: Данные запроса. Могут быть строкой, объектом или массивом. :param object data: Данные запроса. Могут быть строкой, объектом или массивом.
...@@ -35,7 +38,20 @@ AS.FORMS.ApiUtils ...@@ -35,7 +38,20 @@ AS.FORMS.ApiUtils
В данную функцию передается один параметр - ответ на запрос. В данную функцию передается один параметр - ответ на запрос.
:param string dataType: ``default:'json'`` Тип данных ответа на запрос. :param string dataType: ``default:'json'`` Тип данных ответа на запрос.
Может принимать значения: ``"xml"``, ``"html"``, ``"script"``, ``"json"``, ``"jsonp"``, ``"text"``. Может принимать значения: ``"xml"``, ``"html"``, ``"script"``, ``"json"``, ``"jsonp"``, ``"text"``.
:param object data: Данные запроса. Могут быть строкой, объектом или массивом. :param object data: Данные запроса. Должны соответствовать параметру ``contentType``
Конвертируются в строку запроса и добавляются к URL.
:param string contentType: ``default:'application/x-www-form-urlencoded; charset=UTF-8'`` Тип данных запроса. :param string contentType: ``default:'application/x-www-form-urlencoded; charset=UTF-8'`` Тип данных запроса.
:param function errorHandler: Функция, которая будет вызвана в случае неуспешного выполнения запроса. :param function errorHandler: Функция, которая будет вызвана в случае неуспешного выполнения запроса.
AS.FORMS.ASFDataUtils
~~~~~~~~~~~~~~~~~~~~~
.. js:class:: AS.FORMS.ASFDataUtils
Утилиты для работы с asfData и asfDefinition
.. js:function:: getBaseAsfData(asfProperty[, blockNumber[, value[, key]]])
Получить базовый объект данных компонента. Получив таким образом объект,
можно добавить к нему собственные свойства.
:param object asfProperty: Определение компонента :js:data:`AS.FORMS.Model.asfProperty`
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment