APIConnectResponse类说明
路径
com.roma.apic.livedata.provider.v1.APIConnectResponse
说明
在execute函数中返回此类对象,可以指定调用函数API接口返回的HTTP状态码、返回头和body体。
使用示例
1 2 3 4 |
importClass(com.roma.apic.livedata.provider.v1.APIConnectResponse); function execute(data) { return new APIConnectResponse(401, {"X-Type":"Demo"}, "unauthorized", false); } |
此时,调用Function API返回的HTTP状态码为401,响应头中包含了"X-Type: Demo",且响应body为"unauthorized"
构造器详情
- public APIConnectResponse(Integer statusCode)
构造一个APIConnectResponse
参数:statusCode表示响应状态码
- public APIConnectResponse(Integer statusCode, Map<String,String> headers)
构造一个APIConnectResponse
参数:statusCode表示响应状态码,headers表示响应请求头
- public APIConnectResponse(Integer statusCode, Map<String,String> headers, Object body)
构造一个APIConnectResponse
参数:statusCode表示响应状态码,headers表示响应请求头,body表示响应body体
- public APIConnectResponse(Integer statusCode, Map<String,String> headers, String body, Boolean base64Encoded)
构造一个APIConnectResponse
参数:statusCode表示响应状态码,headers表示响应请求头,body表示响应body体,base64Encoded表示传入的body是否已经base64编码
方法列表
返回类型 |
方法和说明 |
---|---|
Object |
getBody() 获取响应的返回体 |
Map<String,String> |
获取响应的返回头 |
Integer |
获取响应返回码 |
Boolean |
获取body是否已经base64编码 |
void |
setBase64Encoded(Boolean base64Encoded) 设置body是否已经base64编码 |
void |
setBody(Object body) 设置响应的body体 |
void |
setHeaders(Map<String,String> headers) 设置响应的返回头 |
void |
setStatusCode(Integer statusCode) 设置响应的返回码 |
方法详情
- public Object getBody()
获取响应的返回体
返回信息
返回响应返回体对象
- public Map<String,String> getHeaders()
获取响应的返回头
返回信息
返回请求头的Map集合
- public Integer getStatusCode()
获取响应返回码
返回信息
返回响应返回码
- public Boolean isBase64Encoded()
获取body是否已经base64编码
返回信息
- true:已经进行base64编码
- false:没有进行base64编码
- public void setBase64Encoded(Boolean base64Encoded)
设置body是否已经base64编码
输入参数
base64Encoded:取值为true表示已经base64编码,取值为false表示没有base64编码
- public void setBody(Object body)
设置响应的body体
输入参数
body:body体对象
- public void setHeaders(Map<String,String> headers)
设置响应的返回头
输入参数
headers:返回头的map集合
- public void setStatusCode(Integer statusCode)
设置响应返回码
输入参数
statusCode:返回码