MessageBuilder.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg;

import android.content.Context;
import android.net.Uri;
import android.text.TextUtils;

import com.netease.nimlib.BuildConfig;
import com.netease.nimlib.NimNosSceneKeyConstant;
import com.netease.nimlib.SDKCache;
import com.netease.nimlib.SDKCacheUI;
import com.netease.nimlib.biz.constant.IAuthService;
import com.netease.nimlib.migration.MessageConvert;
import com.netease.nimlib.notifier.support26.annotation.NonNull;
import com.netease.nimlib.sdk.msg.attachment.AudioAttachment;
import com.netease.nimlib.sdk.msg.attachment.FileAttachment;
import com.netease.nimlib.sdk.msg.attachment.ImageAttachment;
import com.netease.nimlib.sdk.msg.attachment.LocationAttachment;
import com.netease.nimlib.sdk.msg.attachment.MsgAttachment;
import com.netease.nimlib.sdk.msg.attachment.VideoAttachment;
import com.netease.nimlib.sdk.msg.constant.AttachStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgDirectionEnum;
import com.netease.nimlib.sdk.msg.constant.MsgStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;
import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import com.netease.nimlib.sdk.msg.model.CustomMessageConfig;
import com.netease.nimlib.sdk.msg.model.IMMessage;
import com.netease.nimlib.sdk.msg.model.MessageRobotInfo;
import com.netease.nimlib.sdk.robot.model.RobotAttachment;
import com.netease.nimlib.sdk.robot.model.RobotMsgType;
import com.netease.nimlib.sdk.util.UriUtils;
import com.netease.nimlib.session.IMMessageImpl;
import com.netease.nimlib.util.BitmapDecoder;
import com.netease.nimlib.util.StringUtil;
import com.netease.nimlib.util.TimeUtil;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

/**
 * 云信 IM 消息构造器，提供构建各类型消息的接口。
 */
public class MessageBuilder {

    /**
     * 创建一条文本消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>text</td>
     * <td>文本消息字符串，不得超过 5000 字符。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createTextMessage(String sessionId, SessionTypeEnum sessionType, String text) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.text.getValue());
        msg.setContent(text);
        return msg;
    }

    /**
     * 创建一条图片消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createImageMessage(String sessionId, SessionTypeEnum sessionType, File file) {
        return createImageMessage(sessionId, sessionType, file, null, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条图片消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>图片文件 URI 地址。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createImageMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri) {
        return createImageMessage(context,sessionId, sessionType, uri, null, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条图片消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>图片文件显示名称，可不同于文件名。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createImageMessage(String sessionId, SessionTypeEnum sessionType, File file, String displayName) {
        return createImageMessage(sessionId, sessionType, file, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条图片消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>图片文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>图片文件显示名称，可不同于文件名。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createImageMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri,String displayName) {
        return createImageMessage(context,sessionId, sessionType, uri, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条图片消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>图片文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createImageMessage(String sessionId, SessionTypeEnum sessionType, File file, String displayName, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.image.getValue());

        final ImageAttachment attachment = createImageAttachment(file, displayName, nosTokenSceneKey);
        msg.setAttachment(attachment);
        return msg;
    }

    /**
     * 创建一条图片消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>图片文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>图片文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createImageMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri, String displayName, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.image.getValue());
        final ImageAttachment attachment = createImageAttachment(context, uri, displayName, nosTokenSceneKey);
        msg.setAttachment(attachment);
        return msg;
    }

    /**
     * 创建一条语音消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>语音时长，单位为毫秒。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createAudioMessage(String sessionId, SessionTypeEnum sessionType, File file, long duration) {
        return createAudioMessage(sessionId, sessionType, file, duration, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条语音消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>音频文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>语音时长，单位为毫秒。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createAudioMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri, long duration) {
        return createAudioMessage(context,sessionId, sessionType, uri, duration, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条语音消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>语音时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createAudioMessage(String sessionId, SessionTypeEnum sessionType, File file, long duration, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.audio.getValue());
        if (duration > 0 && duration < 1000) {// 最低显示1秒
            duration = 1000;
        }
        final AudioAttachment attachment = createAudioAttachment(file, duration, nosTokenSceneKey);
        msg.setAttachment(attachment);
        return msg;
    }

    /**
     * 创建一条语音消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>音频文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>语音时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createAudioMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri, long duration, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.audio.getValue());
        if (duration > 0 && duration < 1000) {// 最低显示1秒
            duration = 1000;
        }
        final AudioAttachment attachment = createAudioAttachment(context, uri, duration, nosTokenSceneKey);
        msg.setAttachment(attachment);
        return msg;
    }

    /**
     * 创建一条地理位置消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>lat</td>
     * <td>位置纬度。</td>
     * </tr>
     * <tr>
     * <td>lng</td>
     * <td>位置经度。</td>
     * </tr>
     * <tr>
     * <td>addr</td>
     * <td>位置描述信息。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createLocationMessage(String sessionId, SessionTypeEnum sessionType, double lat, double lng, String addr) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.location.getValue());

        final LocationAttachment location = new LocationAttachment();
        location.setLatitude(lat);
        location.setLongitude(lng);
        location.setAddress(addr);
        msg.setAttachStatus(AttachStatusEnum.transferred);
        msg.setAttachment(location);

        return msg;
    }

    /**
     * 创建一条视频消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>视频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>width</td>
     * <td>视频宽度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>height</td>
     * <td>视频高度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>视频文件显示名称，可不同于文件名。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createVideoMessage(String sessionId, SessionTypeEnum sessionType, File file, long duration, int width, int height, String displayName) {
        return createVideoMessage(sessionId, sessionType, file, duration, width, height, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条视频消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>视频文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>视频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>width</td>
     * <td>视频宽度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>height</td>
     * <td>视频高度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>视频文件显示名称，可不同于文件名。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    @SuppressWarnings("java:S107")
    public static IMMessage createVideoMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri, long duration, int width, int height, String displayName) {
        return createVideoMessage(context,sessionId, sessionType, uri, duration, width, height, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条视频消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>视频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>width</td>
     * <td>视频宽度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>height</td>
     * <td>视频高度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>视频文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createVideoMessage(String sessionId, SessionTypeEnum sessionType, File file, long duration, int width, int height, String displayName, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.video.getValue());

        final VideoAttachment attachment = createVideoAttachment(file, duration, width, height, displayName, nosTokenSceneKey);
        msg.setAttachment(attachment);

        BitmapDecoder.extractThumbnail(file.getPath(), attachment.getThumbPathForSave());

        return msg;
    }

    /**
     * 创建一条视频消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>视频文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>视频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>width</td>
     * <td>视频宽度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>height</td>
     * <td>视频高度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>视频文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    @SuppressWarnings("java:S107")
    public static IMMessage createVideoMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri, long duration, int width, int height, String displayName, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.video.getValue());
        final VideoAttachment attachment = createVideoAttachment(context, uri, duration, width, height, displayName, nosTokenSceneKey);
        msg.setAttachment(attachment);

        BitmapDecoder.extractThumbnail(uri, attachment.getThumbPathForSave());

        return msg;
    }

    /**
     * 创建一条文件消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>文件显示名称，可不同于文件名。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createFileMessage(String sessionId, SessionTypeEnum sessionType, File file, String displayName) {
        return createFileMessage(sessionId, sessionType, file, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条文件消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>文件显示名称，可不同于文件名。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createFileMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri, String displayName) {
        return createFileMessage(context,sessionId, sessionType, uri, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条文件消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createFileMessage(String sessionId, SessionTypeEnum sessionType, File file, String displayName, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.file.getValue());

        final FileAttachment attachment = createFileAttachment(file, displayName, nosTokenSceneKey);
        msg.setAttachment(attachment);
        return msg;
    }

    /**
     * 创建一条文件消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createFileMessage(Context context,String sessionId, SessionTypeEnum sessionType, Uri uri, String displayName, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.file.getValue());
        final FileAttachment attachment = createFileAttachment(context, uri, displayName, nosTokenSceneKey);
        msg.setAttachment(attachment);
        return msg;
    }

    /**
     * 创建一条提醒消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createTipMessage(String sessionId, SessionTypeEnum sessionType) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.tip.getValue());

        return msg;
    }

    /**
     * 创建一条机器人普通文本消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>text</td>
     * <td>文本消息内容。</td>
     * </tr>
     * <tr>
     * <td>messageRobotInfo</td>
     * <td>{@link MessageRobotInfo}</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createRobotTextMessage(String sessionId, SessionTypeEnum sessionType, String text, MessageRobotInfo messageRobotInfo) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.text.getValue());
        msg.setContent(text);
        msg.setRobotInfo(messageRobotInfo);
        return msg;
    }

    /**
     * 创建一条机器人提醒消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>messageRobotInfo</td>
     * <td>{@link MessageRobotInfo}</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createRobotTipMessage(String sessionId, SessionTypeEnum sessionType, MessageRobotInfo messageRobotInfo) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.tip.getValue());
        msg.setRobotInfo(messageRobotInfo);
        return msg;
    }

    /**
     * 创建一条自定义消息。
     *
     * @par 使用前提：
     * <ul><li>已登录 IM。</li><li>已注册一个自定义消息解析器。详见[自定义消息收发](https://doc.yunxin.163.com/messaging/docs/DY3Mjg5NjE?platform=android#%E5%AE%9E%E7%8E%B0%E6%96%B9%E6%B3%95)。</li></ul>
     * @par 注意事项：
     * <ul><li>NIM SDK 不负责定义和解析自定义消息的具体内容，您需要自行完成解析。</li><li>SDK 会将自定义消息存入消息数据库，与内置消息一并展示在消息记录中。</li></ul>
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>attachment</td>
     * <td>MsgAttachment 对象。长度不得超过 5000 字符。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createCustomMessage(String sessionId, SessionTypeEnum sessionType, MsgAttachment attachment) {
        return createCustomMessage(sessionId, sessionType, null, attachment, null);
    }

    /**
     * 创建一条自定义消息。
     *
     * @par 使用前提：
     * <ul><li>已登录 IM。</li><li>已注册一个自定义消息解析器。详见[自定义消息收发](https://doc.yunxin.163.com/messaging/docs/DY3Mjg5NjE?platform=android#%E5%AE%9E%E7%8E%B0%E6%96%B9%E6%B3%95)。</li></ul>
     * @par 注意事项：
     * <ul><li>NIM SDK 不负责定义和解析自定义消息的具体内容，您需要自行完成解析。</li><li>SDK 会将自定义消息存入消息数据库，与内置消息一并展示在消息记录中。</li></ul>
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>content</td>
     * <td>消息简要描述，可用于推送及状态栏消息提醒的展示。创建成功后可通过 {@link IMMessage#getContent} 获取。</td>
     * </tr>
     * <tr>
     * <td>attachment</td>
     * <td>MsgAttachment 对象。长度不得超过 5000 字符。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createCustomMessage(String sessionId, SessionTypeEnum sessionType, String content, MsgAttachment attachment) {
        return createCustomMessage(sessionId, sessionType, content, attachment, null);
    }

    /**
     * 创建一条自定义消息。
     *
     * @par 使用前提：
     * <ul><li>已登录 IM。</li><li>已注册一个自定义消息解析器。详见[自定义消息收发](https://doc.yunxin.163.com/messaging/docs/DY3Mjg5NjE?platform=android#%E5%AE%9E%E7%8E%B0%E6%96%B9%E6%B3%95)。</li></ul>
     * @par 注意事项：
     * <ul><li>NIM SDK 不负责定义和解析自定义消息的具体内容，您需要自行完成解析。</li><li>SDK 会将自定义消息存入消息数据库，与内置消息一并展示在消息记录中。</li></ul>
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>content</td>
     * <td>消息简要描述，可用于推送及状态栏消息提醒的展示。创建成功后可通过 {@link IMMessage#getContent} 获取。</td>
     * </tr>
     * <tr>
     * <td>attachment</td>
     * <td>MsgAttachment 对象。长度不得超过 5000 字符。</td>
     * </tr>
     * <tr>
     * <td>config</td>
     * <td>自定义消息配置，详见 CustomMessageConfig。用于设定消息的声明周期，是否需要推送，是否需要计入未读数等。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createCustomMessage(String sessionId, SessionTypeEnum sessionType, String content, MsgAttachment attachment, CustomMessageConfig config) {
        return createCustomMessage(sessionId, sessionType, content, attachment, config, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条自定义消息。
     *
     * @par 使用前提：
     * <ul><li>已登录 IM。</li><li>已注册一个自定义消息解析器。详见[自定义消息收发](https://doc.yunxin.163.com/messaging/docs/DY3Mjg5NjE?platform=android#%E5%AE%9E%E7%8E%B0%E6%96%B9%E6%B3%95)。</li></ul>
     * @par 注意事项：
     * <ul><li>NIM SDK 不负责定义和解析自定义消息的具体内容，您需要自行完成解析。</li><li>SDK 会将自定义消息存入消息数据库，与内置消息一并展示在消息记录中。</li></ul>
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>content</td>
     * <td>消息简要描述，可用于推送及状态栏消息提醒的展示。创建成功后可通过 {@link IMMessage#getContent} 获取。</td>
     * </tr>
     * <tr>
     * <td>attachment</td>
     * <td>MsgAttachment 对象。长度不得超过 5000 字符。</td>
     * </tr>
     * <tr>
     * <td>config</td>
     * <td>自定义消息配置，详见 CustomMessageConfig。用于设定消息的声明周期，是否需要推送，是否需要计入未读数等。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createCustomMessage(String sessionId, SessionTypeEnum sessionType, String content, MsgAttachment attachment, CustomMessageConfig config, String nosTokenSceneKey) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.custom.getValue());
        msg.setContent(content);
        if (attachment != null && attachment instanceof FileAttachment) {
            ((FileAttachment) attachment).setNosTokenSceneKey(nosTokenSceneKey);
        }
        msg.setAttachment(attachment);
        msg.setConfig(config);
        return msg;
    }

    /**
     * 该方法不推荐使用，请使用 {@link MessageBuilder#createRobotTextMessage} 和 {@link MessageBuilder#createRobotTipMessage}。 
     */
    public static IMMessage createRobotMessage(String sessionId, SessionTypeEnum sessionType, String robotAccount, String text, String type, String content, String target, String params) {
        if (TextUtils.isEmpty(type) || TextUtils.isEmpty(robotAccount)) {
            throw new IllegalArgumentException("Invalid param, type and robot account should not be null");
        }

        if (type.equals(RobotMsgType.TEXT) && content == null) {
            throw new IllegalArgumentException("Invalid param, content should not be null");
        } else if (type.equals(RobotMsgType.LINK) && TextUtils.isEmpty(target)) {
            throw new IllegalArgumentException("Invalid param, target should not be null");
        }

        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.robot.getValue());

        // build attachment
        RobotAttachment robotAttachment = new RobotAttachment();
        robotAttachment.initSend(robotAccount, type, content, target, params);
        msg.setAttachment(robotAttachment);
        msg.setContent(text); // 文案显示用,便于全文检索等

        return msg;
    }

    /**
     * 创建一条通话记录消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>netCallAttachment</td>
     * <td>通话记录附件对象，详见 MsgAttachment。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createNrtcNetcallMessage(String sessionId, SessionTypeEnum sessionType, MsgAttachment netCallAttachment) {
        IMMessageImpl msg = initSendMessage(sessionId, sessionType);
        msg.setMsgType(MsgTypeEnum.nrtc_netcall.getValue());
        msg.setAttachment(netCallAttachment);
        return msg;
    }

    /**
     * 创建一条空消息。
     *
     *该方法仅设置聊天对象以及时间点，用于历史消息查询。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>time</td>
     * <td>历史消息查询的起始时间 Unix 时间戳（毫秒）。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createEmptyMessage(String sessionId, SessionTypeEnum sessionType, long time) {
        IMMessageImpl msg = new IMMessageImpl();
        msg.setSessionId(sessionId);
        msg.setSessionType(sessionType);
        msg.setTime(time);
        return msg;
    }

    /**
     * 创建一条待转发消息。
     *
     * @par 使用前提：
     * 已登录 IM 并实现消息发送和接收。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>message</td>
     * <td>已创建的 {@link IMMessage} 对象。</td>
     * </tr>
     * <tr>
     * <td>sessionId</td>
     * <td>会话 ID，根据会话类型（sessionType）判断：<ul><li>如果是单聊，则 sessionId 为用户的云信 IM 帐号（即 accid）</li><li>如果是群聊，则 sessionId 为群组 ID</li></ul></td>
     * </tr>
     * <tr>
     * <td>sessionType</td>
     * <td>会话类型，详见 SessionTypeEnum。</td>
     * </tr>
     * <tr>
     * <td>time</td>
     * <td>历史消息查询的起始时间 Unix 时间戳（毫秒）。</td>
     * </tr>
     * </table>
     * @return
     * 待转发的 {@link IMMessage} 对象。
     *
     */
    public static IMMessage createForwardMessage(IMMessage message, String sessionId, SessionTypeEnum sessionType) {
        if (message.getMsgType() == MsgTypeEnum.notification || message.getMsgType() == MsgTypeEnum.avchat || message.getMsgType() == MsgTypeEnum.robot) {
            return null;
        }
        IMMessageImpl forward = ((IMMessageImpl) message).deepClone();
        if (forward != null) {
            forward.setSessionId(sessionId);
            forward.setSessionType(sessionType);
            forward.setUuid(StringUtil.get32UUID());
            forward.setFromAccount(SDKCacheUI.getAccount());
            forward.setDirect(MsgDirectionEnum.Out);
            forward.setStatus(MsgStatusEnum.sending);
            forward.setTime(TimeUtil.currentTimeMillis());
            forward.setServerId(0L);
            forward.setMessageId(0L);
            // clear team msg ack
            forward.setMsgAck(false);
            forward.setHasSendAck(false);
            forward.setTeamMsgAckCount(0);
            forward.setTeamMsgUnAckCount(0);

            // 接收到消息，但是附件没有下载成功的情况。不会再次上传附件，所以要将附件的发送状态直接改为def
            final MsgAttachment attachment = forward.getAttachment();
            if (attachment != null && attachment instanceof FileAttachment) {
                final FileAttachment media = (FileAttachment) attachment;
                if (!TextUtils.isEmpty(media.getUrl())) {
                    forward.setAttachStatus(AttachStatusEnum.def);
                }
            }
        }

        return forward;
    }

    private static IMMessageImpl initSendMessage(String toId, SessionTypeEnum sessionType) {
        IMMessageImpl msg = new IMMessageImpl();

        msg.setUuid(StringUtil.get32UUID());
        msg.setSessionId(toId);
        msg.setFromAccount(SDKCacheUI.getAccount());
        msg.setDirect(MsgDirectionEnum.Out);
        msg.setStatus(MsgStatusEnum.sending);
        msg.setSessionType(sessionType);
        msg.setTime(TimeUtil.currentTimeMillis());

        return msg;
    }

    /**
     * 创建多条待合并转发的消息。
     *
     * @par 使用前提：
     * 已登录 IM 并实现消息发送和接收。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>message</td>
     * <td>已创建的 {@link IMMessage} 列表。</td>
     * </tr>
     * </table>
     * @return
     * 待转发的多条消息字符串。
     *
     */
    public static String createForwardMessageListFileDetail(List<? extends IMMessage> messages) {
        if (messages == null || messages.isEmpty()) {
            return "";
        }
        final String sessionId = messages.get(0).getSessionId();
        if (sessionId==null) {
            return "";
        }
        List<IMMessage> msgList = new ArrayList<>(messages.size());
        for (IMMessage msg : messages) {
            // 不是来自同一会话，不添加
            if (!sessionId.equals(msg.getSessionId())){
                continue;
            }
            // 不是可以转发的类型，不添加
            if (msg.getMsgType() == MsgTypeEnum.notification || msg.getMsgType() == MsgTypeEnum.avchat || msg.getMsgType() == MsgTypeEnum.robot) {
                continue;
            }
            msgList.add(msg);
        }
        return buildHeader(0, msgList.size()) + "\n" + buildBody(msgList);
    }

    /**
     * 序列化文件的头部，占一行
     *
     * @param version       文件格式版本
     * @param message_count 消息数目
     * @return 头部字符串
     */
    private static String buildHeader(int version, int message_count) {
        JSONObject obj = new JSONObject();
        try {
            obj.put("version", version);
            //终端类型：Android
            obj.put("terminal", IAuthService.ClientType.Android);
            obj.put("sdk_version", BuildConfig.VERSION_NAME);
            obj.put("app_version", BuildConfig.VERSION_CODE);
            obj.put("message_count", message_count);
        } catch (JSONException e) {
            e.printStackTrace();
        }
        return obj.toString();
    }

    /**
     * 把需要进行上传的数据 按照约定的“数据字段字典”转换后的json格式字符串，每条记录一行，存储在文本文件中，并从第二行开始存储(因为第一行存的是head信息)
     *
     * @param msgList 要合并的消息列表
     * @return 合并后的字符串
     */
    private static String buildBody(@NonNull List<IMMessage> msgList) {
        String enter = "\n";
        if (msgList.isEmpty()) {
            return "";
        }
        StringBuilder stringBuilder = new StringBuilder();
        for (IMMessage msg : msgList) {
            stringBuilder.append(enter).append(MessageConvert.convertMessageToJson(msg, SDKCacheUI.getAccount()));
        }
        return stringBuilder.substring(enter.length());
    }


    /**
     * 创建一条 JSON 消息。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>json</td>
     * <td>JSON 格式的字符串。</td>
     * </tr>
     * </table>
     * @return
     * {@link IMMessage} 对象。
     *
     */
    public static IMMessage createFromJson(String json){
        if (TextUtils.isEmpty(json)) {
            return null;
        }
        return MessageConvert.convertJsonToMessage(json, SDKCacheUI.getAccount());
    }

    /**
     * 将 IMMessage 对象转换成 JSON 格式的字符串。
     *
     * @par 使用前提：
     * 已调用 createXXMessage 创建一条消息，并返回 {@link IMMessage} 对象。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>msg</td>
     * <td>{@link IMMessage} 消息体。</td>
     * </tr>
     * </table>
     * @return
     * 转换后的 JSON 字符串。
     *
     */
    public static String convertMessageToJson(IMMessage msg) {
        if (msg == null) {
            return null;
        }
        return MessageConvert.convertMessageToJson(msg, SDKCacheUI.getAccount());
    }

    /**
     * 创建图片附件，用于上传图片文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>图片文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * ImageAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static ImageAttachment createImageAttachment(File file, String displayName, String nosTokenSceneKey) {
        final ImageAttachment attachment = new ImageAttachment();
        attachment.setPath(file.getPath());
        attachment.setSize(file.length());
        int[] dimension = BitmapDecoder.decodeBound(file);
        attachment.setWidth(dimension[0]);
        attachment.setHeight(dimension[1]);
        attachment.setDisplayName(displayName);
        attachment.setExtension(StringUtil.getExtension(file.getName()));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }

    /**
     * 创建图片附件，用于上传图片文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>图片文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>图片文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>图片文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * ImageAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static ImageAttachment createImageAttachment(Context context, Uri uri, String displayName, String nosTokenSceneKey) {
        final ImageAttachment attachment = new ImageAttachment();
        attachment.setUri(uri);
        attachment.setSize(UriUtils.getFileSizeFromUri(context, uri));
        int[] dimension = BitmapDecoder.decodeBound(context, uri);
        attachment.setWidth(dimension[0]);
        attachment.setHeight(dimension[1]);
        attachment.setDisplayName(displayName);
        attachment.setExtension(UriUtils.getFileExtensionFromUri(context, uri));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }

    /**
     * 创建音频附件。用于上传音频文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>音频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>音频文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * AudioAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static AudioAttachment createAudioAttachment(File file, long duration, String nosTokenSceneKey) {
        final AudioAttachment attachment = new AudioAttachment();
        attachment.setPath(file.getPath());
        attachment.setSize(file.length());
        attachment.setDuration(duration);// ms
        attachment.setExtension(StringUtil.getExtension(file.getName()));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }

    /**
     * 创建音频附件。用于上传音频文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>音频文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>音频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>音频文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * AudioAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static AudioAttachment createAudioAttachment(Context context, Uri uri, long duration, String nosTokenSceneKey) {
        final AudioAttachment attachment = new AudioAttachment();
        attachment.setUri(uri);
        attachment.setSize(UriUtils.getFileSizeFromUri(context, uri));
        attachment.setDuration(duration);// ms
        attachment.setExtension(UriUtils.getFileExtensionFromUri(context, uri));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }

    /**
     * 创建视频附件。用于上传视频文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>视频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>width</td>
     * <td>视频宽度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>height</td>
     * <td>视频高度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>视频文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>视频文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * VideoAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static VideoAttachment createVideoAttachment(File file, long duration, int width, int height, String displayName, String nosTokenSceneKey) {
        final VideoAttachment attachment = new VideoAttachment();
        attachment.setPath(file.getPath());
        attachment.setSize(file.length());
        attachment.setDuration(duration);
        attachment.setWidth(width);
        attachment.setHeight(height);
        attachment.setDisplayName(displayName);
        attachment.setExtension(StringUtil.getExtension(file.getName()));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }

    /**
     * 创建视频附件。用于上传视频文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>视频文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>duration</td>
     * <td>视频文件时长，单位为毫秒。</td>
     * </tr>
     * <tr>
     * <td>width</td>
     * <td>视频宽度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>height</td>
     * <td>视频高度，单位为像素。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>视频文件显示名称，可不同于文件名。</td>
     * </tr>     
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>视频文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * VideoAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static VideoAttachment createVideoAttachment(Context context, Uri uri, long duration, int width, int height, String displayName,
        String nosTokenSceneKey) {
        final VideoAttachment attachment = new VideoAttachment();
        attachment.setUri(uri);
        attachment.setSize(UriUtils.getFileSizeFromUri(context, uri));
        attachment.setDuration(duration);
        attachment.setWidth(width);
        attachment.setHeight(height);
        attachment.setDisplayName(displayName);
        attachment.setExtension(UriUtils.getFileExtensionFromUri(context, uri));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }

    /**
     * 创建文件附件。用于上传文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>file</td>
     * <td>Android File 对象。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * FileAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static FileAttachment createFileAttachment(File file, String displayName, String nosTokenSceneKey) {
        final FileAttachment attachment = new FileAttachment();
        attachment.setPath(file.getPath());
        attachment.setSize(file.length());
        attachment.setDisplayName(displayName);
        attachment.setExtension(StringUtil.getExtension(file.getName()));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }

    /**
     * 创建文件附件。用于上传文件。
     *
     * @par 使用前提：
     * 已登录 IM。
     * @par 参数说明：
     * <table>
     * <tr>
     * <th>参数名称</th>
     * <th>描述</th>
     * </tr>
     * <tr>
     * <td>context</td>
     * <td>Android Context 对象。</td>
     * </tr>
     * <tr>
     * <td>uri</td>
     * <td>文件 URI 地址。</td>
     * </tr>
     * <tr>
     * <td>displayName</td>
     * <td>文件显示名称，可不同于文件名。</td>
     * </tr>
     * <tr>
     * <td>nosTokenSceneKey</td>
     * <td>文件上传时使用的 NOS Scene Key，详见 NimNosSceneKeyConstant。</td>
     * </tr>
     * </table>
     * @return
     * FileAttachment 对象。
     *
     */
    @androidx.annotation.NonNull
    public static FileAttachment createFileAttachment(Context context, Uri uri, String displayName, String nosTokenSceneKey) {
        final FileAttachment attachment = new FileAttachment();
        attachment.setUri(uri);
        attachment.setSize(UriUtils.getFileSizeFromUri(context, uri));
        attachment.setDisplayName(displayName);
        attachment.setExtension(UriUtils.getFileExtensionFromUri(context, uri));
        attachment.setNosTokenSceneKey(nosTokenSceneKey);
        return attachment;
    }
}