ChatRoomMessageBuilder.java

浏览该文件的文档.

package com.netease.nimlib.sdk.chatroom;

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

import com.netease.nimlib.NimNosSceneKeyConstant;
import com.netease.nimlib.SDKCacheUI;
import com.netease.nimlib.chatroom.model.ChatRoomMessageImpl;
import com.netease.nimlib.report.utils.NtpTimeUtil;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomMessage;
import com.netease.nimlib.sdk.msg.MessageBuilder;
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.robot.model.RobotAttachment;
import com.netease.nimlib.sdk.robot.model.RobotMsgType;
import com.netease.nimlib.util.BitmapDecoder;
import com.netease.nimlib.util.StringUtil;
import com.netease.nimlib.util.TimeUtil;

import java.io.File;

/**
 * 聊天室消息构造器
 */
public class ChatRoomMessageBuilder {

    /**
     * 创建普通文本消息
     *
     * @param roomId 聊天室ID
     * @param text   文本消息内容
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomTextMessage(String roomId, String text) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.text.getValue());
        msg.setContent(text);

        return msg;
    }

    /**
     * 创建自定义消息
     *
     * @param roomId     聊天室ID
     * @param attachment 消息附件对象
     * @return ChatRoomMessage 生成的自定义消息对象
     */
    public static ChatRoomMessage createChatRoomCustomMessage(String roomId, MsgAttachment attachment) {
        return createChatRoomCustomMessage(roomId, attachment,  NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建自定义消息 另外指定指定文件上传（如果有）时使用的 nos scene
     *
     * @param roomId        聊天室ID
     * @param attachment    消息附件对象
     * @param nosTokenScene 文件上传（如果有）时使用的 nos scene
     * @return ChatRoomMessage 生成的自定义消息对象
     */
    public static ChatRoomMessage createChatRoomCustomMessage(String roomId, MsgAttachment attachment, String nosTokenScene) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.custom.getValue());
        if (attachment != null && attachment instanceof FileAttachment) {
            ((FileAttachment) attachment).setNosTokenSceneKey(nosTokenScene);
        }
        msg.setAttachment(attachment);

        return msg;
    }

    /**
     * 创建一条图片消息
     *
     * @param roomId      聊天室ID
     * @param file        图片文件
     * @param displayName 图片文件的显示名，可不同于文件名
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomImageMessage(String roomId, File file, String displayName) {
        return createChatRoomImageMessage(roomId, file, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条图片消息
     *
     * @param context     Context
     * @param roomId      聊天室ID
     * @param uri        图片uri
     * @param displayName 图片文件的显示名，可不同于文件名
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomImageMessage(Context context,String roomId, Uri uri, String displayName) {
        return createChatRoomImageMessage(context,roomId, uri, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }



    /**
     * 创建一条图片消息 并指定图片上传时使用的 nos scene
     *
     * @param roomId           聊天室ID
     * @param file             图片文件
     * @param displayName      图片文件的显示名，可不同于文件名
     * @param nosTokenSceneKey 图片上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomImageMessage(String roomId, File file, String displayName, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.image.getValue());

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

        return msg;
    }

    /**
     * 创建一条图片消息 并指定图片上传时使用的 nos scene
     *
     * @param roomId           聊天室ID
     * @param uri             图片文件uri
     * @param displayName      图片文件的显示名，可不同于文件名
     * @param nosTokenSceneKey 图片上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomImageMessage(Context context,String roomId, Uri uri, String displayName, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.image.getValue());
        final ImageAttachment attachment = MessageBuilder.createImageAttachment(context,uri,displayName,nosTokenSceneKey);
        msg.setAttachment(attachment);

        return msg;
    }


    /**
     * 创建一条音频消息
     *
     * @param roomId   聊天室ID
     * @param file     音频文件对象
     * @param duration 音频文件持续时间，单位是ms
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomAudioMessage(String roomId, File file, long duration) {
        return createChatRoomAudioMessage(roomId, file, duration, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条音频消息
     *
     * @param context  Context
     * @param roomId   聊天室ID
     * @param uri     音频文件uri
     * @param duration 音频文件持续时间，单位是ms
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomAudioMessage(Context context,String roomId, Uri uri, long duration) {
        return createChatRoomAudioMessage(context,roomId, uri, duration, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条音频消息 并指定音频文件上传时使用的 nos scene
     *
     * @param roomId           聊天室ID
     * @param file             音频文件对象
     * @param duration         音频文件持续时间，单位是ms
     * @param nosTokenSceneKey 音频文件上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomAudioMessage(String roomId, File file, long duration, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.audio.getValue());
        if (duration > 0 && duration < 1000) {
            duration = 1000; // 最低显示1秒
        }

        final AudioAttachment attachment = MessageBuilder.createAudioAttachment(file,duration,nosTokenSceneKey);
        msg.setAttachment(attachment);

        return msg;
    }

    /**
     * 创建一条音频消息 并指定音频文件上传时使用的 nos scene
     *
     * @param context          Context
     * @param roomId           聊天室ID
     * @param uri             音频文件uri
     * @param duration         音频文件持续时间，单位是ms
     * @param nosTokenSceneKey 音频文件上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomAudioMessage(Context context,String roomId, Uri uri, long duration, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.audio.getValue());
        if (duration > 0 && duration < 1000) {
            duration = 1000; // 最低显示1秒
        }
        final AudioAttachment attachment = MessageBuilder.createAudioAttachment(context,uri,duration,nosTokenSceneKey);
        msg.setAttachment(attachment);

        return msg;
    }

    /**
     * 创建一条地理位置信息
     *
     * @param roomId 聊天室ID
     * @param lat    维度
     * @param lng    经度
     * @param addr   地理位置描述信息
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomLocationMessage(String roomId, double lat, double lng, String addr) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        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;
    }

    /**
     * 创建一条视频消息
     *
     * @param roomId      聊天室ID
     * @param file        视频文件对象
     * @param duration    视频文件持续时间
     * @param width       视频宽度
     * @param height      视频高度
     * @param displayName 视频文件显示名，可以为空
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomVideoMessage(String roomId, File file, long duration, int width, int height, String displayName) {
        return createChatRoomVideoMessage(roomId, file, duration, width, height, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条视频消息
     *
     * @param context     Context
     * @param roomId      聊天室ID
     * @param uri        视频文件uri
     * @param duration    视频文件持续时间
     * @param width       视频宽度
     * @param height      视频高度
     * @param displayName 视频文件显示名，可以为空
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomVideoMessage(Context context,String roomId, Uri uri, long duration, int width, int height, String displayName) {
        return createChatRoomVideoMessage(context,roomId, uri, duration, width, height, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条视频消息 并指定视频文件上传时使用的 nos scene
     *
     * @param roomId           聊天室ID
     * @param file             视频文件对象
     * @param duration         视频文件持续时间
     * @param width            视频宽度
     * @param height           视频高度
     * @param displayName      视频文件显示名，可以为空
     * @param nosTokenSceneKey 视频文件上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomVideoMessage(String roomId, File file, long duration, int width, int height, String displayName, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.video.getValue());

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

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

        return msg;
    }

    /**
     * 创建一条视频消息 并指定视频文件上传时使用的 nos scene
     *
     * @param context          Context
     * @param roomId           聊天室ID
     * @param uri             视频文件uri
     * @param duration         视频文件持续时间
     * @param width            视频宽度
     * @param height           视频高度
     * @param displayName      视频文件显示名，可以为空
     * @param nosTokenSceneKey 视频文件上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    @SuppressWarnings("java:S107")
    public static ChatRoomMessage createChatRoomVideoMessage(Context context,String roomId, Uri uri, long duration, int width, int height, String displayName, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.video.getValue());

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

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

        return msg;
    }

    /**
     * 创建一条文件消息
     *
     * @param roomId      聊天室ID
     * @param file        文件
     * @param displayName 文件的显示名，可不同于文件名
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomFileMessage(String roomId, File file, String displayName) {
        return createChatRoomFileMessage(roomId, file, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
    }

    /**
     * 创建一条文件消息 并指定文件上传时使用的 nos scene
     *
     * @param context          Context
     * @param roomId           聊天室ID
     * @param uri             文件uri
     * @param displayName      文件的显示名，可不同于文件名
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomFileMessage(Context context,String roomId, Uri uri, String displayName) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.file.getValue());

        final FileAttachment attachment = MessageBuilder.createFileAttachment(context, uri, displayName, NimNosSceneKeyConstant.NIM_DEFAULT_IM);
        msg.setAttachment(attachment);
        return msg;
    }

    /**
     * 创建一条文件消息 并指定文件上传时使用的 nos scene
     *
     * @param roomId           聊天室ID
     * @param file             文件
     * @param displayName      文件的显示名，可不同于文件名
     * @param nosTokenSceneKey 文件上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomFileMessage(String roomId, File file, String displayName, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.file.getValue());

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

    /**
     * 创建一条文件消息 并指定文件上传时使用的 nos scene
     *
     * @param context          Context
     * @param roomId           聊天室ID
     * @param uri             文件uri
     * @param displayName      文件的显示名，可不同于文件名
     * @param nosTokenSceneKey 文件上传时使用的 nos scene ，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomFileMessage(Context context,String roomId, Uri uri, String displayName, String nosTokenSceneKey) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.file.getValue());

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

    /**
     * 创建普通文本消息
     *
     * @param roomId 聊天室ID
     * @param text   文本消息内容
     * @param x 坐标X
     * @param y 坐标Y
     * @param z 坐标Z
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createChatRoomSpatialLocationTextMessage(String roomId, String text,Double x,Double y,Double z) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.text.getValue());
        msg.setContent(text);
        msg.setLocX(x);
        msg.setLocY(y);
        msg.setLocZ(z);
        return msg;
    }

    /**
     * 创建一条提醒消息
     *
     * @param roomId 聊天室ID
     * @return ChatRoomMessage 生成的聊天室消息对象
     */
    public static ChatRoomMessage createTipMessage(String roomId) {
        ChatRoomMessageImpl msg = initSendMessage(roomId);
        msg.setMsgType(MsgTypeEnum.tip.getValue());

        return msg;
    }

    /**
     * @param roomId       聊天室ID
     * @param robotAccount 机器人账号
     * @param text         消息显示的文案，一般基于content加上@机器人的标签作为消息显示的文案。
     * @param type         机器人消息类型，参考{@link com.netease.nimlib.sdk.robot.model.RobotMsgType}
     * @param content      消息内容，如果消息类型是{@link com.netease.nimlib.sdk.robot.model.RobotMsgType#TEXT}，必须传入说话内容
     * @param target       如果消息类型是{@link com.netease.nimlib.sdk.robot.model.RobotMsgType#LINK}, 必须传入跳转目标
     * @param params       如果消息类型是{@link com.netease.nimlib.sdk.robot.model.RobotMsgType#LINK}时，可能需要传入参数
     * @return 机器人消息
     */
    public static ChatRoomMessage createRobotMessage(String roomId, 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");
        }

        ChatRoomMessageImpl msg = initSendMessage(roomId);
        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;
    }

    /**
     * 创建一条空消息，仅设置了房间ID以及时间点，用于记录查询
     *
     * @param time 查询的时间起点信息
     * @return 空消息
     */
    public static ChatRoomMessage createEmptyChatRoomMessage(String roomId, long time) {
        ChatRoomMessageImpl msg = new ChatRoomMessageImpl();
        msg.setSessionId(roomId);
        msg.setSessionType(SessionTypeEnum.ChatRoom);
        msg.setTime(time);

        return msg;
    }

    private final static ChatRoomMessageImpl initSendMessage(String roomId) {
        ChatRoomMessageImpl msg = new ChatRoomMessageImpl();
        msg.setUuid(StringUtil.get32UUID());
        msg.setSessionId(roomId);
        msg.setFromAccount(SDKCacheUI.getChatRoomAccount());
        msg.setDirect(MsgDirectionEnum.Out);
        msg.setStatus(MsgStatusEnum.sending);
        msg.setSessionType(SessionTypeEnum.ChatRoom);
        msg.setTime(NtpTimeUtil.getServerNow());

        return msg;
    }
}