com.netease.nimlib.sdk.chatroom

Class ChatRoomMessageBuilder

java.lang.Object

com.netease.nimlib.sdk.chatroom.ChatRoomMessageBuilder

public class ChatRoomMessageBuilder
extends java.lang.Object

Chat room message constructor

Constructor Summary

Constructors

Constructor and Description
ChatRoomMessageBuilder()

Method Summary

Modifier and Type	Method and Description
static ChatRoomMessage	createChatRoomAudioMessage(java.lang.String roomId, java.io.File file, long duration) Create an audio message
static ChatRoomMessage	createChatRoomAudioMessage(java.lang.String roomId, java.io.File file, long duration, java.lang.String nosTokenSceneKey) Create an audio message and specify the NOS scene key for upload.
static ChatRoomMessage	createChatRoomCustomMessage(java.lang.String roomId, MsgAttachment attachment) Create a custom message
static ChatRoomMessage	createChatRoomCustomMessage(java.lang.String roomId, MsgAttachment attachment, java.lang.String nosTokenScene) Create a custom message with a specified NOS scene if any for upload
static ChatRoomMessage	createChatRoomFileMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName) Create a file message
static ChatRoomMessage	createChatRoomFileMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName, java.lang.String nosTokenSceneKey) Create a file message and specify the NOS scene key for upload
static ChatRoomMessage	createChatRoomImageMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName) Create an image message
static ChatRoomMessage	createChatRoomImageMessage(java.lang.String roomId, java.io.File file, java.lang.String displayName, java.lang.String nosTokenSceneKey) Create an image message and specify the NOS scene key for upload.
static ChatRoomMessage	createChatRoomLocationMessage(java.lang.String roomId, double lat, double lng, java.lang.String addr) Create a location message
static ChatRoomMessage	createChatRoomSpatialLocationTextMessage(java.lang.String roomId, java.lang.String text, java.lang.Double x, java.lang.Double y, java.lang.Double z) Create a text message
static ChatRoomMessage	createChatRoomTextMessage(java.lang.String roomId, java.lang.String text) Create a text message
static ChatRoomMessage	createChatRoomVideoMessage(java.lang.String roomId, java.io.File file, long duration, int width, int height, java.lang.String displayName) Create a video message
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) Create a video message and specify the NOS scene key for upload
static ChatRoomMessage	createEmptyChatRoomMessage(java.lang.String roomId, long time) Create an empty message with only the session ID and the time for query
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) Create a tip message

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatRoomMessageBuilder

public ChatRoomMessageBuilder()

Method Detail

createChatRoomTextMessage

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

Create a text message

Parameters:

roomId - chat room ID

text - text message

Returns:

ChatRoomMessage message object

createChatRoomCustomMessage

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

Create a custom message

Parameters:

roomId - chat room ID

attachment - message attachment

Returns:

ChatRoomMessage custom message object

createChatRoomCustomMessage

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

Create a custom message with a specified NOS scene if any for upload

Parameters:

roomId - chat room ID

attachment - message attachment

nosTokenScene - nos scene for upload

Returns:

ChatRoomMessage custom message object

createChatRoomImageMessage

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

Create an image message

Parameters:

roomId - chat room ID

file - Image file

displayName - The display name of an image file that can be different from the file name.

Returns:

ChatRoomMessage message object

createChatRoomImageMessage

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

Create an image message and specify the NOS scene key for upload.

Parameters:

roomId - chat room ID

file - Image file

displayName - The display name of an image file that can be different from the file name.

nosTokenSceneKey - The NOS scene key of an image used for upload. The default value is NimNosSceneKeyConstant#NIM_DEFAULT_IM.

Returns:

ChatRoomMessage message object

createChatRoomAudioMessage

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

Create an audio message

Parameters:

roomId - chat room ID

file - audio file

duration - duration of an audio file in milliseconds

Returns:

ChatRoomMessage message object

createChatRoomAudioMessage

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

Create an audio message and specify the NOS scene key for upload.

Parameters:

roomId - chat room ID

file - audio file

duration - The duration of an audio file. Unit: milliseconds

nosTokenSceneKey - The NOS scene key of an audio file used for upload. The default value is NimNosSceneKeyConstant#NIM_DEFAULT_IM.

Returns:

ChatRoomMessage message object

createChatRoomLocationMessage

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

Create a location message

Parameters:

roomId - chat room ID

lat - Latitude

lng - Longitude

addr - The location description

Returns:

ChatRoomMessage message object

createChatRoomVideoMessage

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

Create a video message

Parameters:

roomId - chat room ID

file - Video file

duration - Duration of a video file

width - Video width

height - Video height

displayName - The display name of the video file. The parameter can be empty.

Returns:

ChatRoomMessage message object

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)

Create a video message and specify the NOS scene key for upload

Parameters:

roomId - chat room ID

file - Video file

duration - Duration of a video file

width - Video width

height - Video height

displayName - The display name of the video file. The parameter can be empty.

nosTokenSceneKey - The NOS scene key of a video file used for upload. The default value is NimNosSceneKeyConstant#NIM_DEFAULT_IM.

Returns:

ChatRoomMessage message object

createChatRoomFileMessage

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

Create a file message

Parameters:

roomId - chat room ID

file - File

displayName - The display name of the file that can be different from the file name.

Returns:

ChatRoomMessage message object

createChatRoomFileMessage

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

Create a file message and specify the NOS scene key for upload

Parameters:

roomId - chat room ID

file - File

displayName - The display name of the file that can be different from the file name.

nosTokenSceneKey - The NOS scene key used for upload. The default value is NimNosSceneKeyConstant#NIM_DEFAULT_IM.

Returns:

ChatRoomMessage message object

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)

Create a text message

Parameters:

roomId - chat room ID

text - text message

x - x coordinate

y - y coordinate

z - z coordinate

Returns:

ChatRoomMessage message object

createTipMessage

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

Create a tip message

Parameters:

roomId - chat room ID

Returns:

ChatRoomMessage message object

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)

Parameters:

roomId - chat room ID

robotAccount - Bot account

text - The message text. In most cases, the display message contains the content plus @bot tag.

type - Bot message type. For more information, see RobotMsgType

content - The message content. If the message type is RobotMsgType.TEXT, the content must be specified.

target - If the message type is RobotMsgType.LINK, the target link that is redirected to must be specified.

params - If the message type is RobotMsgType.LINK, parameters must be specified.

Returns:

Bot message

createEmptyChatRoomMessage

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

Create an empty message with only the session ID and the time for query

Parameters:

time - The start time of a query

Returns:

Empty message