com.netease.nimlib.sdk.chatroom

类 ChatRoomMessageBuilder

java.lang.Object

com.netease.nimlib.sdk.chatroom.ChatRoomMessageBuilder

public class ChatRoomMessageBuilder
extends java.lang.Object

聊天室消息构造器

构造器概要

构造器

构造器和说明
ChatRoomMessageBuilder()

方法概要

限定符和类型	方法和说明
static ChatRoomMessage	createChatRoomAudioMessage(java.lang.String roomId, java.io.File file, long duration) 创建一条音频消息
static ChatRoomMessage	createChatRoomAudioMessage(java.lang.String roomId, java.io.File file, long duration, java.lang.String nosTokenSceneKey) 创建一条音频消息 并指定音频文件上传时使用的 nos scene
static ChatRoomMessage	createChatRoomCustomMessage(java.lang.String roomId, MsgAttachment attachment) 创建自定义消息
static ChatRoomMessage	createChatRoomCustomMessage(java.lang.String roomId, MsgAttachment attachment, java.lang.String nosTokenScene) 创建自定义消息 另外指定指定文件上传（如果有）时使用的 nos scene
static ChatRoomMessage	createChatRoomFileMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName) 创建一条文件消息
static ChatRoomMessage	createChatRoomFileMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName, java.lang.String nosTokenSceneKey) 创建一条文件消息 并指定文件上传时使用的 nos scene
static ChatRoomMessage	createChatRoomImageMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName) 创建一条图片消息
static ChatRoomMessage	createChatRoomImageMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName, java.lang.String nosTokenSceneKey) 创建一条图片消息 并指定图片上传时使用的 nos scene
static ChatRoomMessage	createChatRoomLocationMessage(java.lang.String roomId, double lat, double lng, java.lang.String addr) 创建一条地理位置信息
static ChatRoomMessage	createChatRoomSpatialLocationTextMessage(java.lang.String roomId, java.lang.String text, java.lang.Double x, java.lang.Double y, java.lang.Double z) 创建普通文本消息
static ChatRoomMessage	createChatRoomTextMessage(java.lang.String roomId, java.lang.String text) 创建普通文本消息
static ChatRoomMessage	createChatRoomVideoMessage(java.lang.String roomId, java.io.File file, long duration, int width, int height, java.lang.String displayName) 创建一条视频消息
static ChatRoomMessage	createChatRoomVideoMessage(java.lang.String roomId, java.io.File file, long duration, int width, int height, java.lang.String displayName, java.lang.String nosTokenSceneKey) 创建一条视频消息 并指定视频文件上传时使用的 nos scene
static ChatRoomMessage	createEmptyChatRoomMessage(java.lang.String roomId, long time) 创建一条空消息，仅设置了房间ID以及时间点，用于记录查询
static ChatRoomMessage	createRobotMessage(java.lang.String roomId, 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 ChatRoomMessage	createTipMessage(java.lang.String roomId) 创建一条提醒消息

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

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

构造器详细资料

ChatRoomMessageBuilder

public ChatRoomMessageBuilder()

方法详细资料

createChatRoomTextMessage

public static ChatRoomMessage createChatRoomTextMessage(java.lang.String roomId,
                                                        java.lang.String text)

创建普通文本消息

参数:

roomId - 聊天室ID

text - 文本消息内容

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomCustomMessage

public static ChatRoomMessage createChatRoomCustomMessage(java.lang.String roomId,
                                                          MsgAttachment attachment)

创建自定义消息

参数:

roomId - 聊天室ID

attachment - 消息附件对象

返回:

ChatRoomMessage 生成的自定义消息对象

createChatRoomCustomMessage

public static ChatRoomMessage createChatRoomCustomMessage(java.lang.String roomId,
                                                          MsgAttachment attachment,
                                                          java.lang.String nosTokenScene)

创建自定义消息 另外指定指定文件上传（如果有）时使用的 nos scene

参数:

roomId - 聊天室ID

attachment - 消息附件对象

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

返回:

ChatRoomMessage 生成的自定义消息对象

createChatRoomImageMessage

public static ChatRoomMessage createChatRoomImageMessage(java.lang.String roomId,
                                                         java.io.File file,
                                                         java.lang.String displayName)

创建一条图片消息

参数:

roomId - 聊天室ID

file - 图片文件

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomImageMessage

public static ChatRoomMessage createChatRoomImageMessage(java.lang.String roomId,
                                                         java.io.File file,
                                                         java.lang.String displayName,
                                                         java.lang.String nosTokenSceneKey)

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

参数:

roomId - 聊天室ID

file - 图片文件

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

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomAudioMessage

public static ChatRoomMessage createChatRoomAudioMessage(java.lang.String roomId,
                                                         java.io.File file,
                                                         long duration)

创建一条音频消息

参数:

roomId - 聊天室ID

file - 音频文件对象

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomAudioMessage

public static ChatRoomMessage createChatRoomAudioMessage(java.lang.String roomId,
                                                         java.io.File file,
                                                         long duration,
                                                         java.lang.String nosTokenSceneKey)

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

参数:

roomId - 聊天室ID

file - 音频文件对象

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

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomLocationMessage

public static ChatRoomMessage createChatRoomLocationMessage(java.lang.String roomId,
                                                            double lat,
                                                            double lng,
                                                            java.lang.String addr)

创建一条地理位置信息

参数:

roomId - 聊天室ID

lat - 维度

lng - 经度

addr - 地理位置描述信息

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomVideoMessage

public static ChatRoomMessage createChatRoomVideoMessage(java.lang.String roomId,
                                                         java.io.File file,
                                                         long duration,
                                                         int width,
                                                         int height,
                                                         java.lang.String displayName)

创建一条视频消息

参数:

roomId - 聊天室ID

file - 视频文件对象

duration - 视频文件持续时间

width - 视频宽度

height - 视频高度

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomVideoMessage

public static ChatRoomMessage createChatRoomVideoMessage(java.lang.String roomId,
                                                         java.io.File file,
                                                         long duration,
                                                         int width,
                                                         int height,
                                                         java.lang.String displayName,
                                                         java.lang.String nosTokenSceneKey)

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

参数:

roomId - 聊天室ID

file - 视频文件对象

duration - 视频文件持续时间

width - 视频宽度

height - 视频高度

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

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomFileMessage

public static ChatRoomMessage createChatRoomFileMessage(java.lang.String roomId,
                                                        java.io.File file,
                                                        java.lang.String displayName)

创建一条文件消息

参数:

roomId - 聊天室ID

file - 文件

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomFileMessage

public static ChatRoomMessage createChatRoomFileMessage(java.lang.String roomId,
                                                        java.io.File file,
                                                        java.lang.String displayName,
                                                        java.lang.String nosTokenSceneKey)

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

参数:

roomId - 聊天室ID

file - 文件

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

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

返回:

ChatRoomMessage 生成的聊天室消息对象

createChatRoomSpatialLocationTextMessage

public static ChatRoomMessage createChatRoomSpatialLocationTextMessage(java.lang.String roomId,
                                                                       java.lang.String text,
                                                                       java.lang.Double x,
                                                                       java.lang.Double y,
                                                                       java.lang.Double z)

创建普通文本消息

参数:

roomId - 聊天室ID

text - 文本消息内容

x - 坐标X

y - 坐标Y

z - 坐标Z

返回:

ChatRoomMessage 生成的聊天室消息对象

createTipMessage

public static ChatRoomMessage createTipMessage(java.lang.String roomId)

创建一条提醒消息

参数:

roomId - 聊天室ID

返回:

ChatRoomMessage 生成的聊天室消息对象

createRobotMessage

public static ChatRoomMessage createRobotMessage(java.lang.String roomId,
                                                 java.lang.String robotAccount,
                                                 java.lang.String text,
                                                 java.lang.String type,
                                                 java.lang.String content,
                                                 java.lang.String target,
                                                 java.lang.String params)

参数:

roomId - 聊天室ID

robotAccount - 机器人账号

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

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

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

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

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

返回:

机器人消息

createEmptyChatRoomMessage

public static ChatRoomMessage createEmptyChatRoomMessage(java.lang.String roomId,
                                                         long time)

创建一条空消息，仅设置了房间ID以及时间点，用于记录查询

参数:

time - 查询的时间起点信息

返回:

空消息