Messages (wechat 1.8.0 API)

java.lang.Object
- me.hao0.wechat.core.Component
- - me.hao0.wechat.core.Messages

```
public final class Messages
extends Component
```
消息组件 Author: haolin Email: haolin.h0@gmail.com Date: 18/11/15

Since:

1.4.0

Field Summary
- Fields inherited from class me.hao0.wechat.core.Component
  wechat

Method Summary

Methods
Modifier and Type	Method and Description
`Boolean`	`deleteSend(Long id)` 删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
`void`	`deleteSend(Long id, Callback<Boolean> cb)` 删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
`Boolean`	`deleteSend(String accessToken, Long id)` 删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
`void`	`deleteSend(String accessToken, Long id, Callback<Boolean> cb)` 删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
`String`	`forward(RecvMessage recv)` 构建转发客服的XML消息(该消息自动转发给一个在线的客服)
`String`	`forward(RecvMessage recv, String kfAccount)` 构建转发客服的XML消息(指定一个在线的客服，若该客服不在线，消息将不再转发给其他在线客服)
`String`	`getSend(Long id)` 检查群发消息状态: 订阅号与服务号认证后均可用
`void`	`getSend(Long id, Callback<String> cb)` 检查群发消息状态: 订阅号与服务号认证后均可用
`String`	`getSend(String accessToken, Long id)` 检查群发消息状态: 订阅号与服务号认证后均可用
`void`	`getSend(String accessToken, Long id, Callback<String> cb)` 检查群发消息状态: 订阅号与服务号认证后均可用
`Boolean`	`previewSend(SendPreviewMessage msg)` 发送预览消息
`void`	`previewSend(SendPreviewMessage msg, Callback<Boolean> cb)` 发送预览消息
`Boolean`	`previewSend(String accessToken, SendPreviewMessage msg)` 发送预览消息
`void`	`previewSend(String accessToken, SendPreviewMessage msg, Callback<Boolean> cb)` 发送预览消息
`RecvMessage`	`receive(InputStream xml)` 接收微信服务器发来的XML消息
`RecvMessage`	`receive(String xml)` 接收微信服务器发来的XML消息
`String`	`respImage(RecvMessage recv, String mediaId)` 被动回复微信服务器图片消息
`String`	`respMusic(RecvMessage recv, String mediaId, String title, String desc, String url, String hqUrl)` 被动回复微信服务器音乐消息
`String`	`respNews(RecvMessage recv, List<Article> articles)` 被动回复微信服务器图文消息
`String`	`respText(RecvMessage recv, String content)` 被动回复微信服务器文本消息
`String`	`respVideo(RecvMessage recv, String mediaId, String title, String desc)` 被动回复微信服务器视频消息
`String`	`respVoice(RecvMessage recv, String mediaId)` 被动回复微信服务器语音消息
`Long`	`send(SendMessage msg)` 群发消息: 1.
`void`	`send(SendMessage msg, Callback<Long> cb)` 群发消息: 1.
`Long`	`send(String accessToken, SendMessage msg)` 群发消息: 1.
`void`	`send(String accessToken, SendMessage msg, Callback<Long> cb)` 群发消息: 1.
`Long`	`sendTemplate(String openId, String templateId, List<TemplateField> fields)` 向用户发送模版消息
`void`	`sendTemplate(String openId, String templateId, List<TemplateField> fields, Callback<Long> cb)` 向用户发送模版消息
`Long`	`sendTemplate(String openId, String templateId, List<TemplateField> fields, String link)` 向用户发送模版消息
`Long`	`sendTemplate(String accessToken, String openId, String templateId, List<TemplateField> fields)` 向用户发送模版消息
`void`	`sendTemplate(String openId, String templateId, String link, List<TemplateField> fields, Callback<Long> cb)` 向用户发送模版消息
`Long`	`sendTemplate(String accessToken, String openId, String templateId, String link, List<TemplateField> fields)` 向用户发送模版消息
`void`	`sendTemplate(String accessToken, String openId, String templateId, String link, List<TemplateField> fields, Callback<Long> cb)` 向用户发送模版消息

Methods inherited from class me.hao0.wechat.core.Component
doAsync, doGet, doPost, doPost, doUpload, doUpload, loadAccessToken

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - respText
```
public String respText(RecvMessage recv,
              String content)
```
    被动回复微信服务器文本消息
    
    Parameters:
    recv - 微信发来的XML消息
    content - 文本内容
    
    Returns:
    XML文本消息
  - respImage
```
public String respImage(RecvMessage recv,
               String mediaId)
```
    被动回复微信服务器图片消息
    
    Parameters:
    recv - 微信发来的XML消息
    mediaId - 通过素材管理接口上传多媒体文件，得到的id
    
    Returns:
    XML图片消息
  - respVoice
```
public String respVoice(RecvMessage recv,
               String mediaId)
```
    被动回复微信服务器语音消息
    
    Parameters:
    recv - 微信发来的XML消息
    mediaId - 通过素材管理接口上传多媒体文件，得到的id
    
    Returns:
    XML语音消息
  - respVideo
```
public String respVideo(RecvMessage recv,
               String mediaId,
               String title,
               String desc)
```
    被动回复微信服务器视频消息
    
    Parameters:
    recv - 微信发来的XML消息
    mediaId - 通过素材管理接口上传多媒体文件，得到的id
    title - 标题
    desc - 描述
    
    Returns:
    XML视频消息
  - respMusic
```
public String respMusic(RecvMessage recv,
               String mediaId,
               String title,
               String desc,
               String url,
               String hqUrl)
```
    被动回复微信服务器音乐消息
    
    Parameters:
    recv - 微信发来的XML消息
    mediaId - 通过素材管理接口上传多媒体文件，得到的id
    title - 标题
    desc - 描述
    url - 音乐链接
    hqUrl - 高质量音乐链接，WIFI环境优先使用该链接播放音乐
    
    Returns:
    XML音乐消息
  - respNews
```
public String respNews(RecvMessage recv,
              List<Article> articles)
```
    被动回复微信服务器图文消息
    
    Parameters:
    recv - 微信发来的XML消息
    articles - 图片消息对象列表，长度小于10
    
    Returns:
    XML图文消息
  - forward
```
public String forward(RecvMessage recv)
```
    构建转发客服的XML消息(该消息自动转发给一个在线的客服)
    
    Parameters:
    recv - 微信发来的XML消息
    
    Returns:
    转发客服的XML消息
  - forward
```
public String forward(RecvMessage recv,
             String kfAccount)
```
    构建转发客服的XML消息(指定一个在线的客服，若该客服不在线，消息将不再转发给其他在线客服)
    
    Parameters:
    recv - 微信发来的XML消息
    kfAccount - 客服帐号(包含域名)
    
    Returns:
    转发客服的XML消息
  - receive
```
public RecvMessage receive(String xml)
```
    接收微信服务器发来的XML消息
    
    Parameters:
    xml - xml字符串
    
    Returns:
    消息类，或抛WechatException
  - receive
```
public RecvMessage receive(InputStream xml)
```
    接收微信服务器发来的XML消息
    
    Parameters:
    xml - xml字符串
    
    Returns:
    消息类，或抛WechatException
  - sendTemplate
```
public Long sendTemplate(String openId,
                String templateId,
                List<TemplateField> fields)
```
    向用户发送模版消息
    
    Parameters:
    openId - 用户openId
    templateId - 模版ID
    fields - 字段列表
    
    Returns:
    消息ID，或抛WechatException
  - sendTemplate
```
public Long sendTemplate(String accessToken,
                String openId,
                String templateId,
                List<TemplateField> fields)
```
    向用户发送模版消息
    
    Parameters:
    accessToken - accessToken
    openId - 用户openId
    templateId - 模版ID
    fields - 字段列表
    
    Returns:
    消息ID，或抛WechatException
  - sendTemplate
```
public Long sendTemplate(String openId,
                String templateId,
                List<TemplateField> fields,
                String link)
```
    向用户发送模版消息
    
    Parameters:
    openId - 用户openId
    templateId - 模版ID
    fields - 字段列表
    link - 点击链接
    
    Returns:
    消息ID，或抛WechatException
  - sendTemplate
```
public void sendTemplate(String openId,
                String templateId,
                List<TemplateField> fields,
                Callback<Long> cb)
```
    向用户发送模版消息
    
    Parameters:
    openId - 用户openId
    templateId - 模版ID
    fields - 字段列表
    cb - 回调
  - sendTemplate
```
public void sendTemplate(String openId,
                String templateId,
                String link,
                List<TemplateField> fields,
                Callback<Long> cb)
```
    向用户发送模版消息
    
    Parameters:
    openId - 用户openId
    templateId - 模版ID
    link - 点击链接
    fields - 字段列表
    cb - 回调
  - sendTemplate
```
public void sendTemplate(String accessToken,
                String openId,
                String templateId,
                String link,
                List<TemplateField> fields,
                Callback<Long> cb)
```
    向用户发送模版消息
    
    Parameters:
    accessToken - accessToken
    openId - 用户openId
    templateId - 模版ID
    link - 点击链接
    fields - 字段列表
    cb - 回调
  - sendTemplate
```
public Long sendTemplate(String accessToken,
                String openId,
                String templateId,
                String link,
                List<TemplateField> fields)
```
    向用户发送模版消息
    
    Parameters:
    accessToken - accessToken
    openId - 用户openId
    templateId - 模版ID
    link - 点击链接
    fields - 字段列表
    
    Returns:
    消息ID，或抛WechatException
  - send
```
public Long send(SendMessage msg)
```
    群发消息: 1. 分组群发:【订阅号与服务号认证后均可用】 2. 按OpenId列表发: 订阅号不可用，服务号认证后可用
    
    Parameters:
    msg - 消息
    
    Returns:
    消息ID，或抛WechatException
    See Also:
    SendMessageScope
  - send
```
public void send(SendMessage msg,
        Callback<Long> cb)
```
    群发消息: 1. 分组群发:【订阅号与服务号认证后均可用】 2. 按OpenId列表发: 订阅号不可用，服务号认证后可用
    
    Parameters:
    msg - 消息
    cb - 回调
    See Also:
    SendMessageScope
  - send
```
public void send(String accessToken,
        SendMessage msg,
        Callback<Long> cb)
```
    群发消息: 1. 分组群发:【订阅号与服务号认证后均可用】 2. 按OpenId列表发: 订阅号不可用，服务号认证后可用
    
    Parameters:
    accessToken - accessToken
    msg - 消息
    cb - 回调
    See Also:
    SendMessageScope
  - send
```
public Long send(String accessToken,
        SendMessage msg)
```
    群发消息: 1. 分组群发:【订阅号与服务号认证后均可用】 2. 按OpenId列表发: 订阅号不可用，服务号认证后可用
    
    Parameters:
    accessToken - accessToken
    msg - 消息
    
    Returns:
    消息ID，或抛WechatException
    See Also:
    SendMessageScope
  - previewSend
```
public Boolean previewSend(SendPreviewMessage msg)
```
    发送预览消息
    
    Parameters:
    msg - 预览消息
    
    Returns:
    发送成功返回true，或抛WechatException
  - previewSend
```
public void previewSend(SendPreviewMessage msg,
               Callback<Boolean> cb)
```
    发送预览消息
    
    Parameters:
    msg - 预览消息
    cb - 回调
  - previewSend
```
public void previewSend(String accessToken,
               SendPreviewMessage msg,
               Callback<Boolean> cb)
```
    发送预览消息
    
    Parameters:
    accessToken - accessToken
    msg - 预览消息
    cb - 回调
  - previewSend
```
public Boolean previewSend(String accessToken,
                  SendPreviewMessage msg)
```
    发送预览消息
    
    Parameters:
    accessToken - accessToken
    msg - 预览消息
    
    Returns:
    发送成功返回true，或抛WechatException
  - deleteSend
```
public Boolean deleteSend(Long id)
```
    删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
    
    Parameters:
    id - 群发消息ID
    
    Returns:
    删除成功，或抛WechatException
  - deleteSend
```
public void deleteSend(Long id,
              Callback<Boolean> cb)
```
    删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
    
    Parameters:
    id - 群发消息ID
    cb - 回调
  - deleteSend
```
public void deleteSend(String accessToken,
              Long id,
              Callback<Boolean> cb)
```
    删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
    
    Parameters:
    accessToken - acessToken
    id - 群发消息ID
    cb - 回调
  - deleteSend
```
public Boolean deleteSend(String accessToken,
                 Long id)
```
    删除群发消息: 订阅号与服务号认证后均可用: 1、只有已经发送成功的消息才能删除 2、删除消息是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 3、删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。 4、如果多次群发发送的是一个图文消息，那么删除其中一次群发，就会删除掉这个图文消息也，导致所有群发都失效
    
    Parameters:
    accessToken - acessToken
    id - 群发消息ID
    
    Returns:
    删除成功，或抛WechatException
  - getSend
```
public String getSend(Long id)
```
    检查群发消息状态: 订阅号与服务号认证后均可用
    
    Parameters:
    id - 群发消息ID
    
    Returns:
    群发消息状态，或抛WechatException
  - getSend
```
public void getSend(Long id,
           Callback<String> cb)
```
    检查群发消息状态: 订阅号与服务号认证后均可用
    
    Parameters:
    id - 群发消息ID
    cb - 回调
  - getSend
```
public void getSend(String accessToken,
           Long id,
           Callback<String> cb)
```
    检查群发消息状态: 订阅号与服务号认证后均可用
    
    Parameters:
    accessToken - acessToken
    id - 群发消息ID
    cb - 回调
  - getSend
```
public String getSend(String accessToken,
             Long id)
```
    检查群发消息状态: 订阅号与服务号认证后均可用
    
    Parameters:
    accessToken - acessToken
    id - 群发消息ID
    
    Returns:
    群发消息状态，或抛WechatException

Class Messages

Field Summary

Fields inherited from class me.hao0.wechat.core.Component

Method Summary

Methods inherited from class me.hao0.wechat.core.Component

Methods inherited from class java.lang.Object

Method Detail

respText

respImage

respVoice

respVideo

respMusic

respNews

forward

forward

receive

receive

sendTemplate

sendTemplate

sendTemplate

sendTemplate

sendTemplate

sendTemplate

sendTemplate

send

send

send

send

previewSend

previewSend

previewSend

previewSend

deleteSend

deleteSend

deleteSend

deleteSend

getSend

getSend

getSend

getSend