io.uouo.wechat.api.model.WeChatMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wechat-api-uouo Show documentation
WeChat-API-UoUo
The newest version!
package io.uouo.wechat.api.model;

import io.uouo.wechat.api.enums.MsgType;
import io.uouo.wechat.utils.StringUtils;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 微信消息，封装了原始消息
 *
 * @author biezhi
 * @since 2018/1/20
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class WeChatMessage {

    /**
     * 微信原始消息
     */
    private Message raw;

    /**
     * mssage_id
     */
    private String id;

    /**
     * 文本内容
     */
    private String text;

    /**
     * 接收到的图片在本地的路径
     */
    private String imagePath;

    /**
     * 接收到的视频在本地的路径
     */
    private String videoPath;

    /**
     * 接收到的音频在本地的路径
     */
    private String voicePath;

    /**
     * 发送人 username
     */
    private String fromUserName;

    /**
     * 发送人昵称
     */
    private String fromNickName;

    /**
     * 发送人备注
     */
    private String fromRemarkName;

    /**
     * 我的UserName
     */
    private String mineUserName;

    /**
     * 我的微信昵称
     */
    private String mineNickName;

    /**
     * 接收人 username
     */
    private String toUserName;

    /**
     * 个人名片
     */
    private Recommend recommend;

    /**
     * 是否是位置信息
     */
    private boolean isLocation;

    /**
     * 是否是艾特我的消息
     */
    private boolean isAtMe;

    /**
     * 消息类型
     */
    private MsgType msgType;

    /**
     * 获取发送人姓名如果有备注则优先显示备注，否则显示昵称
     *
     *
     */
    public String getName() {
        return StringUtils.isEmpty(fromRemarkName) ? this.fromNickName : this.fromRemarkName;
    }

    /**
     * 是否是群聊消息
     *
     * @return 返回是否是群组消息
     */
    public boolean isGroup() {
        return fromUserName.contains("@@") || toUserName.contains("@@");
    }

}