ACMsg (AbleCloud Java API)

java.lang.Object
- com.ablecloud.common.ACObject
- - com.ablecloud.common.ACMsg

```
public class ACMsg
extends ACObject
```

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ACK_MSG`
`static java.lang.String`	`ERR_MSG`
`static java.lang.String`	`JSON_PAYLOAD`
`static java.lang.String`	`MSG_ATTR_PREFIX`
`static java.lang.String`	`MSG_NAME_HEADER`
`static java.lang.String`	`OBJECT_PAYLOAD`
`static java.lang.String`	`STREAM_PAYLOAD`

构造器概要

构造器
构造器和说明

ACMsg()

构造器
构造器和说明
`ACMsg()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`closeStreamPayload()` 关闭流式负载。
`ACContext`	`getContext()` 获取交互上下文
`java.lang.String`	`getErr()`
`java.lang.Long`	`getErrCode()` 获取错误码
`java.lang.String`	`getErrDesc()`
`java.lang.String`	`getErrMsg()` 获取错误信息
`java.lang.String`	`getName()` 获取方法名
`byte[]`	`getPayload()` 获取二进制负载
`java.lang.String`	`getPayloadFormat()` 获取负载格式
`int`	`getPayloadSize()` 获取负载大小
`java.io.InputStream`	`getStreamPayload()` 获取流式负载
`java.lang.Object`	`getTag()`
`boolean`	`isErr()` 判断服务端响应的处理结果是否有错
`void`	`setAck()` 服务端处理成功后，调用该方法
`void`	`setContext(ACContext context)` 设置交互上下文
`void`	`setErr(long errCode, java.lang.String errMsg)` 设置错误信息。
`void`	`setName(java.lang.String name)` 设置请求方法名，服务端将根据该方法名进行处理
`void`	`setPayload(byte[] payload, java.lang.String format)` 设置二进制负载通过put/add方式设置的负载要么框架将其序列化为json，要么解析后作为url的参数传输。
`void`	`setStreamPayload(java.io.InputStream payload, int size)` 设置流式负载，主要用于较大的数据传输，如上传文件等。
`void`	`setTag(java.lang.Object tag)`

从类继承的方法 com.ablecloud.common.ACObject
add, changeKey, contains, delete, get, getBoolean, getByte, getDouble, getFloat, getInt, getKeys, getLong, getNullBoolean, getNullByte, getNullDouble, getNullFloat, getNullInt, getNullLong, getNullShort, getNullString, getObjectData, getShort, getString, hasObjectData, put, setObject, setObjectData, size, toString

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - OBJECT_PAYLOAD
```
public static final java.lang.String OBJECT_PAYLOAD
```
    另请参阅:
    
    常量字段值
  - JSON_PAYLOAD
```
public static final java.lang.String JSON_PAYLOAD
```
    另请参阅:
    
    常量字段值
  - STREAM_PAYLOAD
```
public static final java.lang.String STREAM_PAYLOAD
```
    另请参阅:
    
    常量字段值
  - MSG_NAME_HEADER
```
public static final java.lang.String MSG_NAME_HEADER
```
    另请参阅:
    
    常量字段值
  - ACK_MSG
```
public static final java.lang.String ACK_MSG
```
    另请参阅:
    
    常量字段值
  - ERR_MSG
```
public static final java.lang.String ERR_MSG
```
    另请参阅:
    
    常量字段值
  - MSG_ATTR_PREFIX
```
public static final java.lang.String MSG_ATTR_PREFIX
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - ACMsg
```
public ACMsg()
```
- 方法详细资料
  - getName
```
public java.lang.String getName()
```
    获取方法名
    
    返回:
  - setName
```
public void setName(java.lang.String name)
```
    设置请求方法名，服务端将根据该方法名进行处理
    
    参数:
    
    name - 方法名
  - getContext
```
public ACContext getContext()
```
    获取交互上下文
    
    返回:
  - setContext
```
public void setContext(ACContext context)
```
    设置交互上下文
    
    参数:
    
    context -
  - getPayloadFormat
```
public java.lang.String getPayloadFormat()
```
    获取负载格式
    
    返回:
  - getPayload
```
public byte[] getPayload()
```
    获取二进制负载
    
    返回:
  - getPayloadSize
```
public int getPayloadSize()
```
    获取负载大小
    
    返回:
  - setPayload
```
public void setPayload(byte[] payload,
                       java.lang.String format)
```
    设置二进制负载通过put/add方式设置的负载要么框架将其序列化为json，要么解析后作为url的参数传输。通过该函数可以设置额外的负载数据。
    
    参数:
    
    payload -
    
    format -
  - getStreamPayload
```
public java.io.InputStream getStreamPayload()
```
    获取流式负载
    
    返回:
  - closeStreamPayload
```
public void closeStreamPayload()
                        throws java.io.IOException
```
    关闭流式负载。通过getStreamPayload拿到流式负载后，需要显示的关闭。
    
    抛出:
    
    java.io.IOException
  - setStreamPayload
```
public void setStreamPayload(java.io.InputStream payload,
                             int size)
```
    设置流式负载，主要用于较大的数据传输，如上传文件等。
    
    参数:
    
    payload - 负载内容
    
    size - 负载大小
  - setErr
```
public void setErr(long errCode,
                   java.lang.String errMsg)
```
    设置错误信息。在服务端处理错误时，需要显示的调用该结果设置错误信息
    
    参数:
    
    errCode - 错误码
    
    errMsg - 错误信息
  - isErr
```
public boolean isErr()
```
    判断服务端响应的处理结果是否有错
    
    返回:
    
    true-处理有错，false-处理成功
  - getErrCode
```
public java.lang.Long getErrCode()
```
    获取错误码
    
    返回:
  - getErrMsg
```
public java.lang.String getErrMsg()
```
    获取错误信息
    
    返回:
  - getErrDesc
```
public java.lang.String getErrDesc()
```
  - getErr
```
public java.lang.String getErr()
```
  - setAck
```
public void setAck()
```
    服务端处理成功后，调用该方法
  - getTag
```
public java.lang.Object getTag()
```
  - setTag
```
public void setTag(java.lang.Object tag)
```

类 ACMsg

字段概要

构造器概要

方法概要

从类继承的方法 com.ablecloud.common.ACObject

从类继承的方法 java.lang.Object

字段详细资料

OBJECT_PAYLOAD

JSON_PAYLOAD

STREAM_PAYLOAD

MSG_NAME_HEADER

ACK_MSG

ERR_MSG

MSG_ATTR_PREFIX

构造器详细资料

ACMsg

方法详细资料

getName

setName

getContext

setContext

getPayloadFormat

getPayload

getPayloadSize

setPayload

getStreamPayload

closeStreamPayload

setStreamPayload

setErr

isErr

getErrCode

getErrMsg

getErrDesc

getErr

setAck

getTag

setTag