构建 RESTClient 类的新实例。
全称 | mx.rpc.RESTClient |
命名空间 | mx.rpc |
类 | RESTClient |
继承层次结构 | RESTClient |
源文件 | ~\mx\scripts\rpc\RESTClient.js |
JavaScript 代码 |
var client = new mx.rpc.RESTClient();
var appSuiteID = "abcd123";
var appSuite = { id: "abcd123", name: "应用套件1", owner: "admin" };
client.post(
"/appsuites/create",
JSON.stringify({ "appSuite": appSuite }), // 将 appSuite 先转换为 JSON 字符串,然后作为 POST 参数传递到服务端
function(p_context) // 回调函数
{
if (p_context.successful)
{
alert(p_context.resultValue);
}
else
{
alert("REST 服务调用失败,请参考: " + p_context.resultHint);
}
} // End of callback function
); // End of client.post |
名称 | 说明 |
RESTClient() | 构建 RESTClient 类的新实例。 |
名称 | 说明 |
get(p_path, [p_data], [p_callback]) | 使用 HTTP GET 方法,以异步方式进行 REST 服务调用。 |
getSync(p_path, [p_data]) | 使用 HTTP GET 方法,以同步方式进行 REST 服务调用,并返回服务端的响应结果,通常是一个字符串或一个 JSON 对象。 |
post(p_path, [p_data], [p_callback]) | 使用 HTTP POST 方法,以异步方式进行 REST 服务调用。 |
put(p_path, [p_data], [p_callback]) | 使用 HTTP PUT 方法,以异步方式进行 REST 服务调用。 |
remove(p_path, [p_data], [p_callback]) | 说明:由于 delete 是 JavaScript 关键字,所以该方法名称改为 remove。 使用 HTTP DELETE 方法,以异步方式进行 REST 服务调用。 |
send(p_path, p_method, [p_data], [p_async], [p_callback]) | 以异步或同步方式进行 REST 服务调用。当确定使用 HTTP 方法时,建议直接使用 get 和 post 等方法。 |
sendSync(p_path, p_method, [p_data]) | 以同步方式进行 REST 服务调用,并返回服务端的响应结果,通常是一个字符串或一个 JSON 对象。当确定使用 HTTP 方法时,建议直接使用 getSync 和 postSync 等方法。 |
setBaseUrl(p_baseUrl) | 设置 baseUrl 字段的值。 |
名称 | 说明 |
async | 获取或设置一个布尔值,表示请求是否使用同步。 |
baseUrl | 获取 RESTClient 的基 URL。通常以“~”开头,表示相对于网站的根路径,并以“/”结尾;如“~/rest/is/”;如果以“~/../”开头,表示相对于模块的根路径,并以“/”结尾。 如果设置了基 URL,则所有方法中传递的 path 都会以该 URL 为相对路径。如根路径是“~/rest/is/”,调用 send 方法时使用“appsuites/create”为 p_path 参数,则最终路径会被自动拼合为“~/rest/is/appsuites/create”。 如果设置 baseUrl 为 null,则在调用 send、get、post 等方法时,p_path 参数必须为完整的 URL 路径,如“~/rest/is/appsuites/create”。 |
mode | 获取或者设置服务请求的模式。
该参数常见值包括:
|
timeout | 获取或设置一个数字,表示超时时间,以毫秒为单位。 |
该参数常见值包括: