com.netease.nimlib.sdk.msg

类 MessageBuilder

java.lang.Object

com.netease.nimlib.sdk.msg.MessageBuilder

public class MessageBuilder
extends java.lang.Object

云信IM消息构造器

构造器概要

构造器

构造器和说明
MessageBuilder()

方法概要

限定符和类型	方法和说明
static java.lang.String	convertMessageToJson(IMMessage msg) 通过IMMessage字符串生成Json字符串
static IMMessage	createAudioMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, long duration) 创建一条音频消息
static IMMessage	createAudioMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, long duration, java.lang.String nosTokenSceneKey) 创建一条音频消息 并指定音频文件上传时使用的 nos scene
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, MsgAttachment attachment) 创建一条APP自定义类型消息
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String content, MsgAttachment attachment) 创建一条APP自定义类型消息, 同时提供描述字段，可用于推送以及状态栏消息提醒的展示。
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String content, MsgAttachment attachment, CustomMessageConfig config) 创建一条APP自定义类型消息, 同时提供描述字段，可用于推送以及状态栏消息提醒的展示。
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String content, MsgAttachment attachment, CustomMessageConfig config, java.lang.String nosTokenSceneKey) 创建一条APP自定义类型消息, 同时提供描述字段，可用于推送以及状态栏消息提醒的展示。
static IMMessage	createEmptyMessage(java.lang.String sessionId, SessionTypeEnum sessionType, long time) 创建一条空消息，仅设置了聊天对象以及时间点，用于记录查询
static IMMessage	createFileMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, java.lang.String displayName) 创建一条文件消息
static IMMessage	createFileMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, java.lang.String displayName, java.lang.String nosTokenSceneKey) 创建一条文件消息 并指定文件上传时使用的 nos scene
static IMMessage	createForwardMessage(IMMessage message, java.lang.String sessionId, SessionTypeEnum sessionType) 创建一条待转发的消息
static java.lang.String	createForwardMessageListFileDetail(java.util.List<? extends IMMessage> messages) 创建多条待合并转发的消息
static IMMessage	createFromJson(java.lang.String json) 通过JSON字符串生成IMMessage
static IMMessage	createImageMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file) 创建一条图片消息, 显示名默认为null
static IMMessage	createImageMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, java.lang.String displayName) 创建一条图片消息
static IMMessage	createImageMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, java.lang.String displayName, java.lang.String nosTokenSceneKey) 创建一条图片消息 并指定图片上传时使用的 nos scene
static IMMessage	createLocationMessage(java.lang.String sessionId, SessionTypeEnum sessionType, double lat, double lng, java.lang.String addr) 创建一条地理位置信息
static IMMessage	createNrtcNetcallMessage(java.lang.String sessionId, SessionTypeEnum sessionType, MsgAttachment netCallAttachment) 创建一条通话记录消息
static IMMessage	createRobotMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String robotAccount, java.lang.String text, java.lang.String type, java.lang.String content, java.lang.String target, java.lang.String params)
static IMMessage	createTextMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String text) 创建一条普通文本消息
static IMMessage	createTipMessage(java.lang.String sessionId, SessionTypeEnum sessionType) 创建一条提醒消息
static IMMessage	createVideoMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, long duration, int width, int height, java.lang.String displayName) 创建一条视频消息
static IMMessage	createVideoMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, long duration, int width, int height, java.lang.String displayName, java.lang.String nosTokenSceneKey) 创建一条视频消息 并指定 视频文件上传使用的 nos scene

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

MessageBuilder

public MessageBuilder()

方法详细资料

createTextMessage

public static IMMessage createTextMessage(java.lang.String sessionId,
                                          SessionTypeEnum sessionType,
                                          java.lang.String text)

创建一条普通文本消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

text - 文本消息内容

返回:

IMMessage 生成的消息对象

createImageMessage

public static IMMessage createImageMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.io.File file)

创建一条图片消息, 显示名默认为null

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 图片文件

返回:

IMMessage 生成的消息对象

createImageMessage

public static IMMessage createImageMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.io.File file,
                                           java.lang.String displayName)

创建一条图片消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 图片文件

displayName - 图片文件的显示名，可不同于文件名

返回:

IMMessage 生成的消息对象

createImageMessage

public static IMMessage createImageMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.io.File file,
                                           java.lang.String displayName,
                                           java.lang.String nosTokenSceneKey)

创建一条图片消息 并指定图片上传时使用的 nos scene

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 图片文件

displayName - 图片文件的显示名，可不同于文件名

nosTokenSceneKey - 图片上传时使用的 nos scene ，默认为 NimNosSceneKeyConstant#NIM_DEFAULT_IM

返回:

IMMessage 生成的消息对象

createAudioMessage

public static IMMessage createAudioMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.io.File file,
                                           long duration)

创建一条音频消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 音频文件对象

duration - 音频文件持续时间，单位是ms

返回:

IMMessage 生成的消息对象

createAudioMessage

public static IMMessage createAudioMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.io.File file,
                                           long duration,
                                           java.lang.String nosTokenSceneKey)

创建一条音频消息 并指定音频文件上传时使用的 nos scene

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 音频文件对象

duration - 音频文件持续时间，单位是ms

nosTokenSceneKey - 音频文件上传时使用的 nos scene ，默认为 NimNosSceneKeyConstant#NIM_DEFAULT_IM

返回:

IMMessage 生成的消息对象

createLocationMessage

public static IMMessage createLocationMessage(java.lang.String sessionId,
                                              SessionTypeEnum sessionType,
                                              double lat,
                                              double lng,
                                              java.lang.String addr)

创建一条地理位置信息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

lat - 纬度

lng - 经度

addr - 地理位置描述信息

返回:

IMMessage 生成的消息对象

createVideoMessage

public static IMMessage createVideoMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.io.File file,
                                           long duration,
                                           int width,
                                           int height,
                                           java.lang.String displayName)

创建一条视频消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 视频文件对象

duration - 视频文件持续时间

width - 视频宽度

height - 视频高度

displayName - 视频文件显示名，可以为空

返回:

视频消息

createVideoMessage

public static IMMessage createVideoMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.io.File file,
                                           long duration,
                                           int width,
                                           int height,
                                           java.lang.String displayName,
                                           java.lang.String nosTokenSceneKey)

创建一条视频消息 并指定 视频文件上传使用的 nos scene

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 视频文件对象

duration - 视频文件持续时间

width - 视频宽度

height - 视频高度

displayName - 视频文件显示名，可以为空

nosTokenSceneKey - 视频文件上传时使用的 nos scene ，默认为 NimNosSceneKeyConstant#NIM_DEFAULT_IM

返回:

视频消息

createFileMessage

public static IMMessage createFileMessage(java.lang.String sessionId,
                                          SessionTypeEnum sessionType,
                                          java.io.File file,
                                          java.lang.String displayName)

创建一条文件消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 文件

displayName - 文件的显示名，可不同于文件名

返回:

IMMessage 生成的消息对象

createFileMessage

public static IMMessage createFileMessage(java.lang.String sessionId,
                                          SessionTypeEnum sessionType,
                                          java.io.File file,
                                          java.lang.String displayName,
                                          java.lang.String nosTokenSceneKey)

创建一条文件消息 并指定文件上传时使用的 nos scene

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

file - 文件

displayName - 文件的显示名，可不同于文件名

nosTokenSceneKey - 文件上传时使用的 nos scene ，默认为 NimNosSceneKeyConstant#NIM_DEFAULT_IM

返回:

IMMessage 生成的消息对象

createTipMessage

public static IMMessage createTipMessage(java.lang.String sessionId,
                                         SessionTypeEnum sessionType)

创建一条提醒消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

返回:

IMMessage 生成的消息对象

createCustomMessage

public static IMMessage createCustomMessage(java.lang.String sessionId,
                                            SessionTypeEnum sessionType,
                                            MsgAttachment attachment)

创建一条APP自定义类型消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

attachment - 消息附件对象

返回:

自定义消息

createCustomMessage

public static IMMessage createCustomMessage(java.lang.String sessionId,
                                            SessionTypeEnum sessionType,
                                            java.lang.String content,
                                            MsgAttachment attachment)

创建一条APP自定义类型消息, 同时提供描述字段，可用于推送以及状态栏消息提醒的展示。

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

content - 消息简要描述，可通过IMMessage#getContent()获取，主要用户推送展示。

attachment - 消息附件对象

返回:

自定义消息

createCustomMessage

public static IMMessage createCustomMessage(java.lang.String sessionId,
                                            SessionTypeEnum sessionType,
                                            java.lang.String content,
                                            MsgAttachment attachment,
                                            CustomMessageConfig config)

创建一条APP自定义类型消息, 同时提供描述字段，可用于推送以及状态栏消息提醒的展示。

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

content - 消息简要描述，可通过IMMessage#getContent()获取，主要用于用户推送展示。

attachment - 消息附件对象

config - 自定义消息配置

返回:

自定义消息

createCustomMessage

public static IMMessage createCustomMessage(java.lang.String sessionId,
                                            SessionTypeEnum sessionType,
                                            java.lang.String content,
                                            MsgAttachment attachment,
                                            CustomMessageConfig config,
                                            java.lang.String nosTokenSceneKey)

创建一条APP自定义类型消息, 同时提供描述字段，可用于推送以及状态栏消息提醒的展示。另外指定文件上传（如果有）时使用的 nos scene

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

content - 消息简要描述，可通过IMMessage#getContent()获取，主要用于用户推送展示。

attachment - 消息附件对象

config - 自定义消息配置

nosTokenSceneKey - 文件上传（如果有）时使用的 nos scene

返回:

自定义消息

createRobotMessage

public static IMMessage createRobotMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           java.lang.String robotAccount,
                                           java.lang.String text,
                                           java.lang.String type,
                                           java.lang.String content,
                                           java.lang.String target,
                                           java.lang.String params)

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

robotAccount - 机器人账号

text - 消息显示的文案，一般基于content加上@机器人的标签作为消息显示的文案。

type - 机器人消息类型，参考RobotMsgType

content - 消息内容，如果消息类型是RobotMsgType.TEXT，必须传入说话内容

target - 如果消息类型是RobotMsgType.LINK, 必须传入跳转目标

params - 如果消息类型是RobotMsgType.LINK时，可能需要传入参数

返回:

机器人消息

createNrtcNetcallMessage

public static IMMessage createNrtcNetcallMessage(java.lang.String sessionId,
                                                 SessionTypeEnum sessionType,
                                                 MsgAttachment netCallAttachment)

创建一条通话记录消息

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

netCallAttachment - 通话记录附件对象

返回:

通话记录消息

createEmptyMessage

public static IMMessage createEmptyMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           long time)

创建一条空消息，仅设置了聊天对象以及时间点，用于记录查询

参数:

sessionId - 聊天对象ID

sessionType - 会话类型

time - 查询的时间起点信息

返回:

空消息

createForwardMessage

public static IMMessage createForwardMessage(IMMessage message,
                                             java.lang.String sessionId,
                                             SessionTypeEnum sessionType)

创建一条待转发的消息

参数:

message - 要转发的消息

sessionId - 聊天对象ID

sessionType - 会话类型

返回:

待转发的消息

createForwardMessageListFileDetail

public static java.lang.String createForwardMessageListFileDetail(java.util.List<? extends IMMessage> messages)

创建多条待合并转发的消息

参数:

messages - 要转发的消息

返回:

待转发的消息

createFromJson

public static IMMessage createFromJson(java.lang.String json)

通过JSON字符串生成IMMessage

参数:

json - 数据源

返回:

消息

convertMessageToJson

public static java.lang.String convertMessageToJson(IMMessage msg)

通过IMMessage字符串生成Json字符串

参数:

msg - 消息体

返回:

json字符串