NIMSDK-AOS  9.15.0
静态 Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.msg.MessageBuilder类 参考

云信 IM 消息构造器,提供构建各类型消息的接口。 更多...

静态 Public 成员函数

static IMMessage createTextMessage (String sessionId, SessionTypeEnum sessionType, String text)
 创建一条文本消息。 更多...
 
static IMMessage createImageMessage (String sessionId, SessionTypeEnum sessionType, File file)
 创建一条图片消息。 更多...
 
static IMMessage createImageMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri)
 创建一条图片消息。 更多...
 
static IMMessage createImageMessage (String sessionId, SessionTypeEnum sessionType, File file, String displayName)
 创建一条图片消息。 更多...
 
static IMMessage createImageMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, String displayName)
 创建一条图片消息。 更多...
 
static IMMessage createImageMessage (String sessionId, SessionTypeEnum sessionType, File file, String displayName, String nosTokenSceneKey)
 创建一条图片消息。 更多...
 
static IMMessage createImageMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, String displayName, String nosTokenSceneKey)
 创建一条图片消息。 更多...
 
static IMMessage createAudioMessage (String sessionId, SessionTypeEnum sessionType, File file, long duration)
 创建一条语音消息。 更多...
 
static IMMessage createAudioMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, long duration)
 创建一条语音消息。 更多...
 
static IMMessage createAudioMessage (String sessionId, SessionTypeEnum sessionType, File file, long duration, String nosTokenSceneKey)
 创建一条语音消息。 更多...
 
static IMMessage createAudioMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, long duration, String nosTokenSceneKey)
 创建一条语音消息。 更多...
 
static IMMessage createLocationMessage (String sessionId, SessionTypeEnum sessionType, double lat, double lng, String addr)
 创建一条地理位置消息。 更多...
 
static IMMessage createVideoMessage (String sessionId, SessionTypeEnum sessionType, File file, long duration, int width, int height, String displayName)
 创建一条视频消息。 更多...
 
static IMMessage createVideoMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, long duration, int width, int height, String displayName)
 创建一条视频消息。 更多...
 
static IMMessage createVideoMessage (String sessionId, SessionTypeEnum sessionType, File file, long duration, int width, int height, String displayName, String nosTokenSceneKey)
 创建一条视频消息。 更多...
 
static IMMessage createVideoMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, long duration, int width, int height, String displayName, String nosTokenSceneKey)
 创建一条视频消息。 更多...
 
static IMMessage createFileMessage (String sessionId, SessionTypeEnum sessionType, File file, String displayName)
 创建一条文件消息。 更多...
 
static IMMessage createFileMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, String displayName)
 创建一条文件消息。 更多...
 
static IMMessage createFileMessage (String sessionId, SessionTypeEnum sessionType, File file, String displayName, String nosTokenSceneKey)
 创建一条文件消息。 更多...
 
static IMMessage createFileMessage (Context context, String sessionId, SessionTypeEnum sessionType, Uri uri, String displayName, String nosTokenSceneKey)
 创建一条文件消息。 更多...
 
static IMMessage createTipMessage (String sessionId, SessionTypeEnum sessionType)
 创建一条提醒消息。 更多...
 
static IMMessage createRobotTextMessage (String sessionId, SessionTypeEnum sessionType, String text, MessageRobotInfo messageRobotInfo)
 创建一条机器人普通文本消息。 更多...
 
static IMMessage createRobotTipMessage (String sessionId, SessionTypeEnum sessionType, MessageRobotInfo messageRobotInfo)
 创建一条机器人提醒消息。 更多...
 
static IMMessage createCustomMessage (String sessionId, SessionTypeEnum sessionType, MsgAttachment attachment)
 创建一条自定义消息。 更多...
 
static IMMessage createCustomMessage (String sessionId, SessionTypeEnum sessionType, String content, MsgAttachment attachment)
 创建一条自定义消息。 更多...
 
static IMMessage createCustomMessage (String sessionId, SessionTypeEnum sessionType, String content, MsgAttachment attachment, CustomMessageConfig config)
 创建一条自定义消息。 更多...
 
static IMMessage createCustomMessage (String sessionId, SessionTypeEnum sessionType, String content, MsgAttachment attachment, CustomMessageConfig config, String nosTokenSceneKey)
 创建一条自定义消息。 更多...
 
static IMMessage createRobotMessage (String sessionId, SessionTypeEnum sessionType, String robotAccount, String text, String type, String content, String target, String params)
 该方法不推荐使用,请使用 MessageBuilder#createRobotTextMessageMessageBuilder#createRobotTipMessage更多...
 
static IMMessage createNrtcNetcallMessage (String sessionId, SessionTypeEnum sessionType, MsgAttachment netCallAttachment)
 创建一条通话记录消息。 更多...
 
static IMMessage createEmptyMessage (String sessionId, SessionTypeEnum sessionType, long time)
 创建一条空消息。 更多...
 
static IMMessage createForwardMessage (IMMessage message, String sessionId, SessionTypeEnum sessionType)
 创建一条待转发消息。 更多...
 
static String createForwardMessageListFileDetail (List<? extends IMMessage > messages)
 创建多条待合并转发的消息。 更多...
 
static IMMessage createFromJson (String json)
 创建一条 JSON 消息。 更多...
 
static String convertMessageToJson (IMMessage msg)
 将 IMMessage 对象转换成 JSON 格式的字符串。 更多...
 
.annotation.NonNull static ImageAttachment createImageAttachment (File file, String displayName, String nosTokenSceneKey)
 创建图片附件,用于上传图片文件。 更多...
 
.annotation.NonNull static ImageAttachment createImageAttachment (Context context, Uri uri, String displayName, String nosTokenSceneKey)
 创建图片附件,用于上传图片文件。 更多...
 
.annotation.NonNull static AudioAttachment createAudioAttachment (File file, long duration, String nosTokenSceneKey)
 创建音频附件。用于上传音频文件。 更多...
 
.annotation.NonNull static AudioAttachment createAudioAttachment (Context context, Uri uri, long duration, String nosTokenSceneKey)
 创建音频附件。用于上传音频文件。 更多...
 
.annotation.NonNull static VideoAttachment createVideoAttachment (File file, long duration, int width, int height, String displayName, String nosTokenSceneKey)
 创建视频附件。用于上传视频文件。 更多...
 
.annotation.NonNull static VideoAttachment createVideoAttachment (Context context, Uri uri, long duration, int width, int height, String displayName, String nosTokenSceneKey)
 创建视频附件。用于上传视频文件。 更多...
 
.annotation.NonNull static FileAttachment createFileAttachment (File file, String displayName, String nosTokenSceneKey)
 创建文件附件。用于上传文件。 更多...
 
.annotation.NonNull static FileAttachment createFileAttachment (Context context, Uri uri, String displayName, String nosTokenSceneKey)
 创建文件附件。用于上传文件。 更多...
 

详细描述

云信 IM 消息构造器,提供构建各类型消息的接口。

在文件 MessageBuilder.java45 行定义.

成员函数说明

◆ convertMessageToJson()

static String com.netease.nimlib.sdk.msg.MessageBuilder.convertMessageToJson ( IMMessage  msg)
static

将 IMMessage 对象转换成 JSON 格式的字符串。

使用前提:
已调用 createXXMessage 创建一条消息,并返回 IMMessage 对象。
参数说明:
参数名称 描述
msg IMMessage 消息体。
返回
转换后的 JSON 字符串。

在文件 MessageBuilder.java1517 行定义.

◆ createAudioAttachment() [1/2]

.annotation.NonNull static AudioAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createAudioAttachment ( File  file,
long  duration,
String  nosTokenSceneKey 
)
static

创建音频附件。用于上传音频文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
file Android File 对象。
duration 音频文件时长,单位为毫秒。
nosTokenSceneKey 音频文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
AudioAttachment 对象。

在文件 MessageBuilder.java1641 行定义.

◆ createAudioAttachment() [2/2]

.annotation.NonNull static AudioAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createAudioAttachment ( Context  context,
Uri  uri,
long  duration,
String  nosTokenSceneKey 
)
static

创建音频附件。用于上传音频文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
uri 音频文件 URI 地址。
duration 音频文件时长,单位为毫秒。
nosTokenSceneKey 音频文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
AudioAttachment 对象。

在文件 MessageBuilder.java1684 行定义.

◆ createAudioMessage() [1/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createAudioMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
long  duration 
)
static

创建一条语音消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
duration 语音时长,单位为毫秒。
返回
IMMessage 对象。

在文件 MessageBuilder.java351 行定义.

◆ createAudioMessage() [2/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createAudioMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
long  duration 
)
static

创建一条语音消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 音频文件 URI 地址。
duration 语音时长,单位为毫秒。
返回
IMMessage 对象。

在文件 MessageBuilder.java391 行定义.

◆ createAudioMessage() [3/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createAudioMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
long  duration,
String  nosTokenSceneKey 
)
static

创建一条语音消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
duration 语音时长,单位为毫秒。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java431 行定义.

◆ createAudioMessage() [4/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createAudioMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
long  duration,
String  nosTokenSceneKey 
)
static

创建一条语音消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 音频文件 URI 地址。
duration 语音时长,单位为毫秒。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java482 行定义.

◆ createCustomMessage() [1/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createCustomMessage ( String  sessionId,
SessionTypeEnum  sessionType,
MsgAttachment  attachment 
)
static

创建一条自定义消息。

使用前提:
注意事项:
  • NIM SDK 不负责定义和解析自定义消息的具体内容,您需要自行完成解析。
  • SDK 会将自定义消息存入消息数据库,与内置消息一并展示在消息记录中。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
attachment MsgAttachment 对象。长度不得超过 5000 字符。
返回
IMMessage 对象。

在文件 MessageBuilder.java1069 行定义.

◆ createCustomMessage() [2/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createCustomMessage ( String  sessionId,
SessionTypeEnum  sessionType,
String  content,
MsgAttachment  attachment 
)
static

创建一条自定义消息。

使用前提:
注意事项:
  • NIM SDK 不负责定义和解析自定义消息的具体内容,您需要自行完成解析。
  • SDK 会将自定义消息存入消息数据库,与内置消息一并展示在消息记录中。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
content 消息简要描述,可用于推送及状态栏消息提醒的展示。创建成功后可通过 IMMessage#getContent 获取。
attachment MsgAttachment 对象。长度不得超过 5000 字符。
返回
IMMessage 对象。

在文件 MessageBuilder.java1107 行定义.

◆ createCustomMessage() [3/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createCustomMessage ( String  sessionId,
SessionTypeEnum  sessionType,
String  content,
MsgAttachment  attachment,
CustomMessageConfig  config 
)
static

创建一条自定义消息。

使用前提:
注意事项:
  • NIM SDK 不负责定义和解析自定义消息的具体内容,您需要自行完成解析。
  • SDK 会将自定义消息存入消息数据库,与内置消息一并展示在消息记录中。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
content 消息简要描述,可用于推送及状态栏消息提醒的展示。创建成功后可通过 IMMessage#getContent 获取。
attachment MsgAttachment 对象。长度不得超过 5000 字符。
config 自定义消息配置,详见 CustomMessageConfig。用于设定消息的声明周期,是否需要推送,是否需要计入未读数等。
返回
IMMessage 对象。

在文件 MessageBuilder.java1149 行定义.

◆ createCustomMessage() [4/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createCustomMessage ( String  sessionId,
SessionTypeEnum  sessionType,
String  content,
MsgAttachment  attachment,
CustomMessageConfig  config,
String  nosTokenSceneKey 
)
static

创建一条自定义消息。

使用前提:
注意事项:
  • NIM SDK 不负责定义和解析自定义消息的具体内容,您需要自行完成解析。
  • SDK 会将自定义消息存入消息数据库,与内置消息一并展示在消息记录中。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
content 消息简要描述,可用于推送及状态栏消息提醒的展示。创建成功后可通过 IMMessage#getContent 获取。
attachment MsgAttachment 对象。长度不得超过 5000 字符。
config 自定义消息配置,详见 CustomMessageConfig。用于设定消息的声明周期,是否需要推送,是否需要计入未读数等。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java1195 行定义.

◆ createEmptyMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createEmptyMessage ( String  sessionId,
SessionTypeEnum  sessionType,
long  time 
)
static

创建一条空消息。

该方法仅设置聊天对象以及时间点,用于历史消息查询。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
time 历史消息查询的起始时间 Unix 时间戳(毫秒)。
返回
IMMessage 对象。

在文件 MessageBuilder.java1298 行定义.

◆ createFileAttachment() [1/2]

.annotation.NonNull static FileAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createFileAttachment ( File  file,
String  displayName,
String  nosTokenSceneKey 
)
static

创建文件附件。用于上传文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
file Android File 对象。
displayName 文件显示名称,可不同于文件名。
nosTokenSceneKey 文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
FileAttachment 对象。

在文件 MessageBuilder.java1836 行定义.

◆ createFileAttachment() [2/2]

.annotation.NonNull static FileAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createFileAttachment ( Context  context,
Uri  uri,
String  displayName,
String  nosTokenSceneKey 
)
static

创建文件附件。用于上传文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
uri 文件 URI 地址。
displayName 文件显示名称,可不同于文件名。
nosTokenSceneKey 文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
FileAttachment 对象。

在文件 MessageBuilder.java1879 行定义.

◆ createFileMessage() [1/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createFileMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
String  displayName 
)
static

创建一条文件消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
displayName 文件显示名称,可不同于文件名。
返回
IMMessage 对象。

在文件 MessageBuilder.java800 行定义.

◆ createFileMessage() [2/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createFileMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
String  displayName 
)
static

创建一条文件消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 文件 URI 地址。
displayName 文件显示名称,可不同于文件名。
返回
IMMessage 对象。

在文件 MessageBuilder.java836 行定义.

◆ createFileMessage() [3/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createFileMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
String  displayName,
String  nosTokenSceneKey 
)
static

创建一条文件消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
displayName 文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java876 行定义.

◆ createFileMessage() [4/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createFileMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
String  displayName,
String  nosTokenSceneKey 
)
static

创建一条文件消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 文件 URI 地址。
displayName 文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java925 行定义.

◆ createForwardMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createForwardMessage ( IMMessage  message,
String  sessionId,
SessionTypeEnum  sessionType 
)
static

创建一条待转发消息。

使用前提:
已登录 IM 并实现消息发送和接收。
参数说明:
参数名称 描述
message 已创建的 IMMessage 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
time 历史消息查询的起始时间 Unix 时间戳(毫秒)。
返回
待转发的 IMMessage 对象。

在文件 MessageBuilder.java1338 行定义.

◆ createForwardMessageListFileDetail()

static String com.netease.nimlib.sdk.msg.MessageBuilder.createForwardMessageListFileDetail ( List<? extends IMMessage messages)
static

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

使用前提:
已登录 IM 并实现消息发送和接收。
参数说明:
参数名称 描述
message 已创建的 IMMessage 列表。
返回
待转发的多条消息字符串。

在文件 MessageBuilder.java1406 行定义.

◆ createFromJson()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createFromJson ( String  json)
static

创建一条 JSON 消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
json JSON 格式的字符串。
返回
IMMessage 对象。

在文件 MessageBuilder.java1490 行定义.

◆ createImageAttachment() [1/2]

.annotation.NonNull static ImageAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createImageAttachment ( File  file,
String  displayName,
String  nosTokenSceneKey 
)
static

创建图片附件,用于上传图片文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
file Android File 对象。
displayName 图片文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
ImageAttachment 对象。

在文件 MessageBuilder.java1553 行定义.

◆ createImageAttachment() [2/2]

.annotation.NonNull static ImageAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createImageAttachment ( Context  context,
Uri  uri,
String  displayName,
String  nosTokenSceneKey 
)
static

创建图片附件,用于上传图片文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
uri 图片文件 URI 地址。
displayName 图片文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
ImageAttachment 对象。

在文件 MessageBuilder.java1599 行定义.

◆ createImageMessage() [1/6]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createImageMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file 
)
static

创建一条图片消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
返回
IMMessage 对象。

在文件 MessageBuilder.java110 行定义.

◆ createImageMessage() [2/6]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createImageMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri 
)
static

创建一条图片消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 图片文件 URI 地址。
返回
IMMessage 对象。

在文件 MessageBuilder.java146 行定义.

◆ createImageMessage() [3/6]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createImageMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
String  displayName 
)
static

创建一条图片消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
displayName 图片文件显示名称,可不同于文件名。
返回
IMMessage 对象。

在文件 MessageBuilder.java182 行定义.

◆ createImageMessage() [4/6]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createImageMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
String  displayName 
)
static

创建一条图片消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 图片文件 URI 地址。
displayName 图片文件显示名称,可不同于文件名。
返回
IMMessage 对象。

在文件 MessageBuilder.java222 行定义.

◆ createImageMessage() [5/6]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createImageMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
String  displayName,
String  nosTokenSceneKey 
)
static

创建一条图片消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
displayName 图片文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java262 行定义.

◆ createImageMessage() [6/6]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createImageMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
String  displayName,
String  nosTokenSceneKey 
)
static

创建一条图片消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 图片文件 URI 地址。
displayName 图片文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java311 行定义.

◆ createLocationMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createLocationMessage ( String  sessionId,
SessionTypeEnum  sessionType,
double  lat,
double  lng,
String  addr 
)
static

创建一条地理位置消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
lat 位置纬度。
lng 位置经度。
addr 位置描述信息。
返回
IMMessage 对象。

在文件 MessageBuilder.java529 行定义.

◆ createNrtcNetcallMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createNrtcNetcallMessage ( String  sessionId,
SessionTypeEnum  sessionType,
MsgAttachment  netCallAttachment 
)
static

创建一条通话记录消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
netCallAttachment 通话记录附件对象,详见 MsgAttachment。
返回
IMMessage 对象。

在文件 MessageBuilder.java1261 行定义.

◆ createRobotMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createRobotMessage ( String  sessionId,
SessionTypeEnum  sessionType,
String  robotAccount,
String  text,
String  type,
String  content,
String  target,
String  params 
)
static

该方法不推荐使用,请使用 MessageBuilder#createRobotTextMessageMessageBuilder#createRobotTipMessage

在文件 MessageBuilder.java1210 行定义.

◆ createRobotTextMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createRobotTextMessage ( String  sessionId,
SessionTypeEnum  sessionType,
String  text,
MessageRobotInfo  messageRobotInfo 
)
static

创建一条机器人普通文本消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
text 文本消息内容。
messageRobotInfo MessageRobotInfo
返回
IMMessage 对象。

在文件 MessageBuilder.java996 行定义.

◆ createRobotTipMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createRobotTipMessage ( String  sessionId,
SessionTypeEnum  sessionType,
MessageRobotInfo  messageRobotInfo 
)
static

创建一条机器人提醒消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
messageRobotInfo MessageRobotInfo
返回
IMMessage 对象。

在文件 MessageBuilder.java1032 行定义.

◆ createTextMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createTextMessage ( String  sessionId,
SessionTypeEnum  sessionType,
String  text 
)
static

创建一条文本消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
text 文本消息字符串,不得超过 5000 字符。
返回
IMMessage 对象。

在文件 MessageBuilder.java75 行定义.

◆ createTipMessage()

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createTipMessage ( String  sessionId,
SessionTypeEnum  sessionType 
)
static

创建一条提醒消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
返回
IMMessage 对象。

在文件 MessageBuilder.java957 行定义.

◆ createVideoAttachment() [1/2]

.annotation.NonNull static VideoAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createVideoAttachment ( File  file,
long  duration,
int  width,
int  height,
String  displayName,
String  nosTokenSceneKey 
)
static

创建视频附件。用于上传视频文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
file Android File 对象。
duration 视频文件时长,单位为毫秒。
width 视频宽度,单位为像素。
height 视频高度,单位为像素。
displayName 视频文件显示名称,可不同于文件名。
nosTokenSceneKey 视频文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
VideoAttachment 对象。

在文件 MessageBuilder.java1735 行定义.

◆ createVideoAttachment() [2/2]

.annotation.NonNull static VideoAttachment com.netease.nimlib.sdk.msg.MessageBuilder.createVideoAttachment ( Context  context,
Uri  uri,
long  duration,
int  width,
int  height,
String  displayName,
String  nosTokenSceneKey 
)
static

创建视频附件。用于上传视频文件。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
uri 视频文件 URI 地址。
duration 视频文件时长,单位为毫秒。
width 视频宽度,单位为像素。
height 视频高度,单位为像素。
displayName 视频文件显示名称,可不同于文件名。
nosTokenSceneKey 视频文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
VideoAttachment 对象。

在文件 MessageBuilder.java1793 行定义.

◆ createVideoMessage() [1/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createVideoMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
long  duration,
int  width,
int  height,
String  displayName 
)
static

创建一条视频消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
duration 视频文件时长,单位为毫秒。
width 视频宽度,单位为像素。
height 视频高度,单位为像素。
displayName 视频文件显示名称,可不同于文件名。
返回
IMMessage 对象。

在文件 MessageBuilder.java587 行定义.

◆ createVideoMessage() [2/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createVideoMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
long  duration,
int  width,
int  height,
String  displayName 
)
static

创建一条视频消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 视频文件 URI 地址。
duration 视频文件时长,单位为毫秒。
width 视频宽度,单位为像素。
height 视频高度,单位为像素。
displayName 视频文件显示名称,可不同于文件名。
返回
IMMessage 对象。

在文件 MessageBuilder.java640 行定义.

◆ createVideoMessage() [3/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createVideoMessage ( String  sessionId,
SessionTypeEnum  sessionType,
File  file,
long  duration,
int  width,
int  height,
String  displayName,
String  nosTokenSceneKey 
)
static

创建一条视频消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
file Android File 对象。
duration 视频文件时长,单位为毫秒。
width 视频宽度,单位为像素。
height 视频高度,单位为像素。
displayName 视频文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java692 行定义.

◆ createVideoMessage() [4/4]

static IMMessage com.netease.nimlib.sdk.msg.MessageBuilder.createVideoMessage ( Context  context,
String  sessionId,
SessionTypeEnum  sessionType,
Uri  uri,
long  duration,
int  width,
int  height,
String  displayName,
String  nosTokenSceneKey 
)
static

创建一条视频消息。

使用前提:
已登录 IM。
参数说明:
参数名称 描述
context Android Context 对象。
sessionId 会话 ID,根据会话类型(sessionType)判断:
  • 如果是单聊,则 sessionId 为用户的云信 IM 帐号(即 accid)
  • 如果是群聊,则 sessionId 为群组 ID
sessionType 会话类型,详见 SessionTypeEnum。
uri 视频文件 URI 地址。
duration 视频文件时长,单位为毫秒。
width 视频宽度,单位为像素。
height 视频高度,单位为像素。
displayName 视频文件显示名称,可不同于文件名。
nosTokenSceneKey 图片文件上传时使用的 NOS Scene Key,详见 NimNosSceneKeyConstant。
返回
IMMessage 对象。

在文件 MessageBuilder.java757 行定义.


该类的文档由以下文件生成: