com.netease.nimlib.sdk.msg

Class MessageBuilder

java.lang.Object

com.netease.nimlib.sdk.msg.MessageBuilder

public class MessageBuilder
extends java.lang.Object

Message builder

Constructor Summary

Constructors

Constructor and Description
MessageBuilder()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	convertMessageToJson(IMMessage msg) Convert IMMessages into JSON file
static IMMessage	createAudioMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, long duration) Create an audio message
static IMMessage	createAudioMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, long duration, java.lang.String nosTokenSceneKey) Create an audio message and specify the NOS scene key for upload.
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, MsgAttachment attachment) Create a custom message
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String content, MsgAttachment attachment) Create a custom message with a description field used for push or alert on the status bar.
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String content, MsgAttachment attachment, CustomMessageConfig config) Create a custom message with a description field used for push or alert on the status bar.
static IMMessage	createCustomMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String content, MsgAttachment attachment, CustomMessageConfig config, java.lang.String nosTokenSceneKey) Create a custom message with a description field used for push or alert on the status bar.
static IMMessage	createEmptyMessage(java.lang.String sessionId, SessionTypeEnum sessionType, long time) Create an empty message with only the session and the time for query
static IMMessage	createFileMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, java.lang.String displayName) Create a file message
static IMMessage	createFileMessage(java.lang.String sessionId, SessionTypeEnum sessionType, 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 IMMessage	createForwardMessage(IMMessage message, java.lang.String sessionId, SessionTypeEnum sessionType) Create a message to be forwarded
static java.lang.String	createForwardMessageListFileDetail(java.util.List<? extends IMMessage> messages) Create messages to be forwarded
static IMMessage	createFromJson(java.lang.String json) Create IMMessages from JSON strings
static IMMessage	createImageMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file) Create an image message.
static IMMessage	createImageMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, java.lang.String displayName) Create an image message
static IMMessage	createImageMessage(java.lang.String sessionId, SessionTypeEnum sessionType, 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 IMMessage	createLocationMessage(java.lang.String sessionId, SessionTypeEnum sessionType, double lat, double lng, java.lang.String addr) Create a location message
static IMMessage	createNrtcNetcallMessage(java.lang.String sessionId, SessionTypeEnum sessionType, MsgAttachment netCallAttachment) Create a call message
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) Create a text message
static IMMessage	createTipMessage(java.lang.String sessionId, SessionTypeEnum sessionType) Create a tip message
static IMMessage	createVideoMessage(java.lang.String sessionId, SessionTypeEnum sessionType, java.io.File file, long duration, int width, int height, java.lang.String displayName) Create a video message
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) Create a video message and specify the NOS scene key for upload

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageBuilder

public MessageBuilder()

Method Detail

createTextMessage

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

Create a text message

Parameters:

sessionId - Session ID

sessionType - Session type

text - message content

Returns:

IMMessage The message object

createImageMessage

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

Create an image message. The default name is null.

Parameters:

sessionId - Session ID

sessionType - Session type

file - Image file

Returns:

IMMessage The message object

createImageMessage

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

Create an image message

Parameters:

sessionId - Session ID

sessionType - Session type

file - Image file

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

Returns:

IMMessage The message object

createImageMessage

public static IMMessage createImageMessage(java.lang.String sessionId,
                                           SessionTypeEnum sessionType,
                                           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:

sessionId - Session ID

sessionType - Session type

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:

IMMessage The message object

createAudioMessage

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

Create an audio message

Parameters:

sessionId - Session ID

sessionType - Session type

file - audio file

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

Returns:

IMMessage The message object

createAudioMessage

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

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

Parameters:

sessionId - Session ID

sessionType - Session type

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:

IMMessage The message object

createLocationMessage

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

Create a location message

Parameters:

sessionId - Session ID

sessionType - Session type

lat - Latitude

lng - Longitude

addr - The location description

Returns:

IMMessage The message object

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)

Create a video message

Parameters:

sessionId - Session ID

sessionType - Session type

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:

Video messages

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)

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

Parameters:

sessionId - Session ID

sessionType - Session type

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:

Video messages

createFileMessage

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

Create a file message

Parameters:

sessionId - Session ID

sessionType - Session type

file - File

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

Returns:

IMMessage The message object

createFileMessage

public static IMMessage createFileMessage(java.lang.String sessionId,
                                          SessionTypeEnum sessionType,
                                          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:

sessionId - Session ID

sessionType - Session type

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:

IMMessage The message object

createTipMessage

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

Create a tip message

Parameters:

sessionId - Session ID

sessionType - Session type

Returns:

IMMessage The message object

createCustomMessage

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

Create a custom message

Parameters:

sessionId - Session ID

sessionType - Session type

attachment - Attachment of a message

Returns:

Custom message

createCustomMessage

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

Create a custom message with a description field used for push or alert on the status bar.

Parameters:

sessionId - Session ID

sessionType - Session type

content - Message description that can be obtained by calling IMMessage#getContent(). The description of the message will be displayed for push services.

attachment - Attachment of a message

Returns:

Custom message

createCustomMessage

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

Create a custom message with a description field used for push or alert on the status bar.

Parameters:

sessionId - Session ID

sessionType - Session type

content - Message description that can be obtained by calling IMMessage#getContent(). The description of the message will be displayed for push services.

attachment - Attachment of a message

config - The configuration of a custom message

Returns:

Custom message

createCustomMessage

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

Create a custom message with a description field used for push or alert on the status bar. Specify the NOS scene key for upload if any.

Parameters:

sessionId - Session ID

sessionType - Session type

content - Message description that can be obtained by calling IMMessage#getContent(). The description of the message will be displayed for push services.

attachment - Attachment of a message

config - The configuration of a custom message

nosTokenSceneKey - The NOS scene key for upload if any

Returns:

Custom message

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)

Parameters:

sessionId - Session ID

sessionType - Session type

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

createNrtcNetcallMessage

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

Create a call message

Parameters:

sessionId - The session ID

sessionType - The session type

netCallAttachment - The call attachment object

Returns:

Call message

createEmptyMessage

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

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

Parameters:

sessionId - Session ID

sessionType - Session type

time - The start time of query

Returns:

Empty message

createForwardMessage

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

Create a message to be forwarded

Parameters:

message - The message

sessionId - Session ID

sessionType - Session type

Returns:

message to be forwarded

createForwardMessageListFileDetail

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

Create messages to be forwarded

Parameters:

messages - The messages to be forwarded

Returns:

messages to be forwarded

createFromJson

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

Create IMMessages from JSON strings

Parameters:

json - Data source

Returns:

Message

convertMessageToJson

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

Convert IMMessages into JSON file

Parameters:

msg - Message body

Returns:

JSON string