ServerAction¶
Отправляет http запрос.
Extends¶
Syntax¶
new ServerAction(parentView)
Properties¶
Для работы с данными свойствами используйте методы getProperty и setProperty.
Name | Type | Default | Description |
---|---|---|---|
origin* | String 1 |
– | Хост и порт |
path* | String 1 |
– | Строка пути (относительно хоста) |
data | Object 1 |
– | Данные запроса |
contentType | String |
‘application/x-www-form-urlencoded; charset=utf-8’ | Тип данных |
method | String |
‘GET’ | Метод запроса |
Url запроса определяется конкатинацией свойств origin и path.
* Обязательное свойство. 1 Шаблонизируемая величина
Parameters Templating¶
Зачастую при описании запроса возникает необходимость использовать изменяемые значения.
Для этого в ServerAction введены параметры. Вы можете задать значение
параметра с помощью метода setParam. А
затем использовать его в шаблонизируемых величинах, обозначив
<%[paramName]%>
.
Например, задан параметр userId, тогда в свойстве path можно обратится к нему следующим образом:
"/users?filter=eq(userId,<%userId%>)"
.
При отправке запроса вместо <%userId%> будет установлено соответсвующее значение параметра.
Метод execute¶
Если при вызове метода execute указан параметр callback, то вызов данного обработчика осуществляется с параметром value.
Name | Description |
---|---|
value.requestUrl | Url запроса |
value.method | Метод запроса |
value.contentType | Тип данных |
value.args | Данные запроса |
Methods¶
Name | Description |
---|---|
getParam | Возвращает значение параметра |
setParam | Устанавливает значение параметра |
ServerAction.metadata¶
Метаданные типа ServerAction.
Properties¶
Name | Type | Default | Description |
---|---|---|---|
Origin | String 1 |
– | Базовая часть url запроса |
Path* | String 1 |
– | Уточняющая часть url запроса |
Method | String |
‘GET’ | Метод запроса |
ContentType | String |
‘application/x-www-form-urlencoded; charset=utf-8’ | Тип данных |
Data | Object 1 |
– | Данные запроса |
Params | Object |
– | Параметры запроса |
OnSuccess | Script | – | Устанавливает обработчик успешного завершения действия |
OnError | Script | – | Устанавливает обработчик завершения действия с ошибкой |
* Обязательное свойство.
Examples¶
{
"ServerAction": {
"Method": "Get",
"Origin": "http://localhost:<%port%>",
"Path": "/documents/<%document%>",
"Data": {
"filter": "eq(_id,'<%_id%>')"
},
"Params": {
"port": "9900",
"document": "GetCompanyProfile988Response",
"_id": {
"Source": "MainDataSource",
"Property": "$._id"
}
},
"OnSuccess": "{ alert('onSuccess'); }",
"OnError": "{ alert('onError'); }"
}
}