V2NIMMessageCreator.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message;
 
import android.text.TextUtils;
import com.netease.nimlib.SDKCacheUI;
import com.netease.nimlib.report.utils.NtpTimeUtil;
import com.netease.nimlib.sdk.msg.constant.MsgDirectionEnum;
import com.netease.nimlib.sdk.msg.constant.MsgStatusEnum;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageType;
import com.netease.nimlib.sdk.v2.message.model.V2NIMMessageCallDuration;
import com.netease.nimlib.sdk.v2.storage.V2NIMStorageSceneConfig;
import com.netease.nimlib.util.StringUtil;
import com.netease.nimlib.v2.message.impl.V2NIMMessageImpl;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageAttachmentImpl;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageAudioAttachmentImpl.V2NIMMessageAudioAttachmentBuilder;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageCallAttachmentImpl;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageFileAttachmentImpl.V2NIMMessageFileAttachmentBuilder;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageImageAttachmentImpl.V2NIMMessageImageAttachmentBuilder;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageLocationAttachmentImpl;
import com.netease.nimlib.v2.message.impl.attachment.V2NIMMessageVideoAttachmentImpl.V2NIMMessageVideoAttachmentBuilder;
import java.util.List;
 
public class V2NIMMessageCreator {
 
    private static final String TAG = "V2NIMMessageCreator";
 
    private static V2NIMMessageImpl createV2Message(V2NIMMessageType messageType) {
        V2NIMMessageImpl message = new V2NIMMessageImpl();
        message.setMessageClientId(StringUtil.get32UUID());
        message.setMessageType(messageType);
        message.setCreateTime(NtpTimeUtil.getServerNow());
        return message;
    }
 
    /**
     * 构造文本消息
     *
     * @param text 需要发送的文本内容
     * @return V2NIMMessage
     */
    public static V2NIMMessage createTextMessage(String text) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_TEXT);
        message.setText(text);
        return message;
    }
 
    /**
     * 构造图片消息
     *
     * @param imagePath 图片文件地址
     * @param name 文件显示名称
     * @param sceneName 文件存储场景名
     * @param width 图片文件宽度
     * @param height 图片文件高度
     * @return V2NIMMessage
     */
    public static V2NIMMessage createImageMessage(String imagePath, String name, String sceneName, Integer width, Integer height) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_IMAGE);
 
        V2NIMMessageImageAttachmentBuilder builder = V2NIMMessageImageAttachmentBuilder.builder();
        if (!TextUtils.isEmpty(imagePath)) {
            builder.withPath(imagePath);
        }
        if (!TextUtils.isEmpty(name)) {
            builder.withName(name);
        }
        if (!TextUtils.isEmpty(sceneName)) {
            builder.withSceneName(sceneName);
        } else {
            builder.withSceneName(V2NIMStorageSceneConfig.DEFAULT_IM.getSceneName());
        }
        if (width != null) {
            builder.withWidth(width);
        }
        if (height != null) {
            builder.withHeight(height);
        }
        message.setAttachment(builder.build());
 
        return message;
    }
 
    /**
     * 构造语音消息
     *
     * @param audioPath 视频文件地址
     * @param name 视频文件显示名称
     * @param sceneName 文件存储场景名
     *      自定义场景使用之前， 需要先调用V2NIMStorageService.addCustomStorageScene新增自定义场景值
     *      传空默认使用：V2NIMStorageSceneConfig.DEFAULT_IM
     * @param duration 语音文件播放长度
     * @return V2NIMMessage
     */
    public static V2NIMMessage createAudioMessage(String audioPath, String name, String sceneName, Integer duration) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_AUDIO);
 
        V2NIMMessageAudioAttachmentBuilder builder = V2NIMMessageAudioAttachmentBuilder.builder();
        if (!TextUtils.isEmpty(audioPath)) {
            builder.withPath(audioPath);
        }
        if (!TextUtils.isEmpty(name)) {
            builder.withName(name);
        }
        if (!TextUtils.isEmpty(sceneName)) {
            builder.withSceneName(sceneName);
        } else {
            builder.withSceneName(V2NIMStorageSceneConfig.DEFAULT_IM.getSceneName());
        }
        if (duration != null) {
            builder.withDuration(duration);
        }
        message.setAttachment(builder.build());
 
        return message;
    }
 
    /**
     * 构造视频消息
     *
     * @param videoPath 视频文件地址
     * @param name 视频文件显示名称
     * @param sceneName 文件存储场景名
     *      自定义场景使用之前， 需要先调用V2NIMStorageService.addCustomStorageScene新增自定义场景值
     *      传空默认使用：V2NIMStorageSceneConfig.DEFAULT_IM
     * @param duration 视频文件播放长度
     * @param width 视频文件宽度
     * @param height 视频文件高度
     * @return V2NIMMessage
     */
    public static V2NIMMessage createVideoMessage(String videoPath, String name, String sceneName, Integer duration, Integer width, Integer height) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_VIDEO);
 
        V2NIMMessageVideoAttachmentBuilder builder = V2NIMMessageVideoAttachmentBuilder.builder();
        if (!TextUtils.isEmpty(videoPath)) {
            builder.withPath(videoPath);
        }
        if (!TextUtils.isEmpty(name)) {
            builder.withName(name);
        }
        if (!TextUtils.isEmpty(sceneName)) {
            builder.withSceneName(sceneName);
        } else {
            builder.withSceneName(V2NIMStorageSceneConfig.DEFAULT_IM.getSceneName());
        }
        if (duration != null) {
            builder.withDuration(duration);
        }
        if (width != null) {
            builder.withWidth(width);
        }
        if (height != null) {
            builder.withHeight(height);
        }
        message.setAttachment(builder.build());
 
        return message;
    }
 
    /**
     * 构造文件消息
     *
     * @param filePath 文件地址
     * @param name 文件显示名称
     * @param sceneName 场景名
     *      自定义场景使用之前， 需要先调用V2NIMStorageService.addCustomStorageScene新增自定义场景值
     *      传空默认使用：V2NIMStorageSceneConfig.DEFAULT_IM
     * @return V2NIMMessage
     */
    public static V2NIMMessage createFileMessage(String filePath, String name, String sceneName) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_FILE);
 
        V2NIMMessageFileAttachmentBuilder builder = V2NIMMessageFileAttachmentBuilder.builder();
        if (!TextUtils.isEmpty(filePath)) {
            builder.withPath(filePath);
        }
        if (!TextUtils.isEmpty(name)) {
            builder.withName(name);
        }
        if (!TextUtils.isEmpty(sceneName)) {
            builder.withSceneName(sceneName);
        } else {
            builder.withSceneName(V2NIMStorageSceneConfig.DEFAULT_IM.getSceneName());
        }
        message.setAttachment(builder.build());
 
        return message;
    }
 
    /**
     * 构造地理位置消息
     *
     * @param latitude 纬度
     * @param longitude 经度
     * @param address 详细位置信息
     * @return V2NIMMessage
     */
    public static V2NIMMessage createLocationMessage(double latitude, double longitude, String address) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_LOCATION);
 
        V2NIMMessageLocationAttachmentImpl locationAttachment = new V2NIMMessageLocationAttachmentImpl(latitude, longitude, address);
        message.setAttachment(locationAttachment);
 
        return message;
    }
 
    /**
     * 构造自定义消息消息
     *
     * @param text 需要发送的文本内容
     * @param rawAttachment 需要发送的附件
     * @return V2NIMMessage
     */
    public static V2NIMMessage createCustomMessage(String text, String rawAttachment) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_CUSTOM);
        message.setText(text);
        message.setAttachment(new V2NIMMessageAttachmentImpl(rawAttachment));
        return message;
    }
 
    /**
     * 构造转发消息，消息内容与原消息一样
     * 转发消息类型不能为：V2NIM_MESSAGE_TYPE_NOTIFICATION，V2NIM_MESSAGE_TYPE_ROBOT，V2NIM_MESSAGE_TYPE_TIP，V2NIM_MESSAGE_TYPE_AVCHAT
     * 转发的消息消息必须为发送成功的消息
     *
     * @param message 需要转发的消息体
     * @return V2NIMMessage
     */
    public static V2NIMMessage createForwardMessage(V2NIMMessage message) {
        if (!(message instanceof V2NIMMessageImpl)) {
            return null;
        }
 
        if (message.getMessageType() == V2NIMMessageType.V2NIM_MESSAGE_TYPE_NOTIFICATION
                || message.getMessageType() == V2NIMMessageType.V2NIM_MESSAGE_TYPE_ROBOT
                || message.getMessageType() == V2NIMMessageType.V2NIM_MESSAGE_TYPE_TIPS
                || message.getMessageType() == V2NIMMessageType.V2NIM_MESSAGE_TYPE_AVCHAT) {
            return null;
        }
 
//        if (((V2NIMMessageImpl) message).getServerIdV1() <= 0) {
//            NimLog.w(TAG, "invalid serverId:" + ((V2NIMMessageImpl) message).getServerIdV1());
//            return null;
//        }
 
        V2NIMMessageImpl deepClone = ((V2NIMMessageImpl) message).deepClone();
        if (deepClone == null) {
            return null;
        }
 
        V2NIMMessageImpl forward = createV2Message(deepClone.getMessageType());
        forward.setSenderId(SDKCacheUI.getAccount());
        forward.setDirect(MsgDirectionEnum.Out);
        forward.setStatus(MsgStatusEnum.sending);
        forward.setText(deepClone.getText());
        forward.setServerExtension(deepClone.getServerExtension());
        forward.setLocalExtension(deepClone.getLocalExtension());
        forward.setSubType(deepClone.getSubType());
        forward.setAttachment(deepClone.getAttachment());
 
 
        return forward;
    }
 
    /**
     * 构造提示消息
     *
     * @param text 提示内容
     * @return V2NIMMessage
     */
    public static V2NIMMessage createTipsMessage(String text) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_TIPS);
        message.setText(text);
        return message;
    }
 
    /**
     * 构造话单消息
     * @param type 话单类型， 业务自定义，内容不校验
     *             建议：
     *             音频：1
     *             视频：2
     * @param channelId 话单频道ID， 内容不校验
     * @param status 通话状态，业务自定义状态， 内容不校验
     *                  建议：
     *                  通话完成：1
     *                  通话取消：2
     *                  通话拒绝：3
     *                  超时未接听：4
     *                  对方忙： 5
     * @param durations 通话成员时长列表， 内容不校验
     * @param text 话单描述
     * @return V2NIMMessage
     */
    public static V2NIMMessage createCallMessage(int type, String channelId, int status, List<V2NIMMessageCallDuration> durations, String text) {
        V2NIMMessageImpl message = createV2Message(V2NIMMessageType.V2NIM_MESSAGE_TYPE_CALL);
        message.setText(text);
        V2NIMMessageCallAttachmentImpl callAttachment = new V2NIMMessageCallAttachmentImpl(type, channelId, status, durations);
        message.setAttachment(callAttachment);
        return message;
    }
}