融云IM整理 01— （API）
###常用的的方法有
- 获取Token
- 链接融云服务器
- 发文本消息
- 发送图片消息
- 发送语音消息
- 发送文件消息
- 发送自定义消息
- 插入消息(只在本地存储,不发送)
- 获取本地未读消息数
- 读取本地存储的历史消息
- 读取远程服务器的消息
- 获取位置共享信息
- 获取会话(Conversation)信息
- 删除会话(Conversation)信息
- 清空消息
- 断开连接, 继续接收Push消息
- 断开连接, 不再接收Push消息
获取Token
FakeServer.getToken(getSenderIdTest(), mSenderNameTest, mPortraitUriTest, new HttpUtil.OnResponse() {
@Override
public void onResponse(int code, String body) {
if (code == 200) {
JSONObject jsonObj = null;
try {
jsonObj = new JSONObject(body);
} catch (JSONException e) {
e.printStackTrace();
}
token = jsonObj.optString("token");
Log.i(TAG, "获取的 token 值为:\n" + token + '\n');
} else {
Log.i(TAG, "获取 token 失败" + '\n');
}
}
});
链接融云服务器
RongIMClient.connect(token, new RongIMClient.ConnectCallback() {
/**
* Token 错误，在线上环境下主要是因为 Token 已经过期，您需要向 App Server 重新请求一个新的 Token
*/
@Override
public void onTokenIncorrect() {
Log.d(TAG, "Token 错误---onTokenIncorrect---" + '\n');
}
/**
* 连接融云成功
* @param userid 当前 token
*/
@Override
public void onSuccess(String userid) {
Log.d(TAG, "连接融云成功---onSuccess---用户ID:" + userid + '\n');
}
/**
* 连接融云失败
* @param errorCode 错误码，可到官网 查看错误码对应的注释
*/
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "连接融云失败, 错误码: " + errorCode + '\n');
}
});
发文本消息
RongIMClient.getInstance().sendMessage(Conversation.ConversationType.PRIVATE, getReceiverIdTest(),
messageContent, null, null, new IRongCallback.ISendMessageCallback() {
@Override
public void onAttached(Message message) {
Log.d(TAG, "发送的文本消息已保存至本地数据库中");
}
@Override
public void onSuccess(Message message) {
if (message.getContent() instanceof TextMessage) {
Log.d(TAG, "成功发送文本消息: " + ((TextMessage) message.getContent()).getContent());
Log.d(TAG, "文本消息的附加信息: " + ((TextMessage) message.getContent()).getExtra() + '\n');
}
}
@Override
public void onError(Message message, RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "发送消息失败，错误码: " + errorCode.getValue() + '\n');
}
});
获取图片信息
File imageFileSource = new File(getCacheDir(), "source.jpg");
File imageFileThumb = new File(getCacheDir(), "thumb.jpg");
InputStream inputStream = null;
FileOutputStream fosSource = null;
FileOutputStream fosThumb = null;
BufferedOutputStream bufSource = null;
BufferedOutputStream bufThumb = null;
try {
// 读取图片
inputStream = getAssets().open("opera.jpg");
// getAssets().close();
Bitmap bmpSource = BitmapFactory.decodeStream(inputStream);
imageFileSource.createNewFile();
fosSource = new FileOutputStream(imageFileSource);
bufSource = new BufferedOutputStream(fosSource);
// 保存原始图片
bmpSource.compress(Bitmap.CompressFormat.JPEG, 100, bufSource);
// 生成缩略图
Matrix matrix = new Matrix();
matrix.setRectToRect(new RectF(0, 0, bmpSource.getWidth(), bmpSource.getHeight()),
new RectF(0, 0, 240, 240), Matrix.ScaleToFit.CENTER);
Bitmap bmpThumb = Bitmap.createBitmap(bmpSource, 0, 0, bmpSource.getWidth(), bmpSource.getHeight(), matrix, true);
imageFileThumb.createNewFile();
fosThumb = new FileOutputStream(imageFileThumb);
bufThumb = new BufferedOutputStream(fosThumb);
// 保存缩略图
bmpThumb.compress(Bitmap.CompressFormat.JPEG, 60, bufThumb);
ImageMessage imageMessage = ImageMessage.obtain(Uri.fromFile(imageFileThumb), Uri.fromFile(imageFileSource));
return imageMessage;
} catch (IOException e) {
e.printStackTrace();
return null;
} finally {
if (inputStream != null)
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
if (fosSource != null)
try {
fosSource.close();
} catch (IOException e) {
e.printStackTrace();
}
if (bufSource != null)
try {
bufSource.close();
} catch (IOException e) {
e.printStackTrace();
}
if (fosThumb != null)
try {
fosThumb.close();
} catch (IOException e) {
e.printStackTrace();
}
if (bufThumb != null)
try {
bufThumb.close();
} catch (IOException e) {
e.printStackTrace();
}
}
发送图片信息
RongIMClient.getInstance().sendImageMessage(Conversation.ConversationType.PRIVATE, getReceiverIdTest(),
imgMessage, null, null, new RongIMClient.SendImageMessageCallback() {
// 保存数据库成功
@Override
public void onAttached(Message message) {
Log.d(TAG, "发送的图片消息已保存至本地数据库中");
}
// 发送失败
@Override
public void onError(Message message, RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "发送消息失败，错误码: " + errorCode.getValue() + '\n');
}
// 发送成功
@Override
public void onSuccess(Message message) {
if (message.getContent() instanceof ImageMessage) {
Log.d(TAG, "成功发送图片消息, Uri --> " + ((ImageMessage) message.getContent()).getThumUri() + '\n');
// Log.d(TAG, "成功发送图片消息: " + ((ImageMessage) message.getContent()).getLocalUri());
// Log.d(TAG, "成功发送图片消息: " + ((ImageMessage) message.getContent()).getRemoteUri() + '\n');
}
}
// 发送进度
@Override
public void onProgress(Message message, int i) {
if (!mProgressDialog.isShowing())
mProgressDialog.show();
mProgressDialog.setProgress(i);
}
});
获取语音信息
File voiceFile = new File(getCacheDir(), "voice.amr");
InputStream inputStream = null;
OutputStream outputStream = null;
try {
// 读取音频文件
inputStream = getResources().openRawResource(R.raw.hella);
outputStream = new FileOutputStream(voiceFile);
byte[] buffer = new byte[1024];
int bytesRead;
// 写入缓存文件
while ((bytesRead = inputStream.read(buffer)) != -1)
outputStream.write(buffer, 0, bytesRead);
VoiceMessage voiceMessage = VoiceMessage.obtain(Uri.fromFile(voiceFile), 15);
return voiceMessage;
} catch (FileNotFoundException e) {
e.printStackTrace();
return null;
} catch (IOException e) {
e.printStackTrace();
return null;
} finally {
if (inputStream != null)
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
if (outputStream != null) {
try {
outputStream.flush();
outputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
发送语音消息
RongIMClient.getInstance().sendMessage(Conversation.ConversationType.PRIVATE, getReceiverIdTest(),
voiceMessage, null, null, new IRongCallback.ISendMessageCallback() {
@Override
public void onAttached(Message message) {
Log.d(TAG, "发送的语音消息已保存至本地数据库中");
}
@Override
public void onSuccess(Message message) {
Log.d(TAG, "成功发送语音消息,Uri --> " + ((VoiceMessage) message.getContent()).getUri());
Log.d(TAG, "成功发送语音消息,时长: " + ((VoiceMessage) message.getContent()).getDuration() + '\n');
}
@Override
public void onError(Message message, RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "发送消息失败，错误码: " + errorCode.getValue() + '\n');
}
});
发送自定义消息
RongIMClient.getInstance().sendMessage(Conversation.ConversationType.PRIVATE, getReceiverIdTest(),
customizeMessage, null, null, new IRongCallback.ISendMessageCallback() {
@Override
public void onAttached(Message message) {
Log.d(TAG, "发送的自定义消息已保存至本地数据库中");
}
@Override
public void onSuccess(Message message) {
if (message.getContent() instanceof CustomizeMessage) {
Log.d(TAG, "成功发送自定义消息，它的时间戳: " + ((CustomizeMessage) message.getContent()).getSendTime());
Log.d(TAG, "自定义消息的内容: " + ((CustomizeMessage) message.getContent()).getContent() + '\n');
}
}
@Override
public void onError(Message message, RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "发送消息失败，错误码: " + errorCode.getValue() + '\n');
}
});
插入消息（只在本地存储不发送）
TextMessage textMessage = TextMessage.obtain("融云客服为您服务");
RongIMClient.getInstance().insertMessage(Conversation.ConversationType.PRIVATE, getReceiverIdTest(), getSenderIdTest(),
textMessage, new RongIMClient.ResultCallback<Message>() {
@Override
public void onSuccess(Message message) {
if (message != null)
Log.d(TAG, "成功插入消息: " + ((TextMessage) message.getContent()).getContent() + '\n');
else
Log.d(TAG, "待插入的消息不存在" + '\n');
}
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "插入消息失败，错误码: " + errorCode.getValue() + '\n');
}
});
获取本地未读消息
RongIMClient.getInstance().getUnreadCount(Conversation.ConversationType.PRIVATE, getReceiverIdTest(), new RongIMClient.ResultCallback<Integer>() {
@Override
public void onSuccess(Integer integer) {
Log.d(TAG, "发送端(本端):" + getSenderIdTest() + " 未读消息数: " + integer + '\n');
}
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "获取未读消息数失败，错误码: " + errorCode.getValue() + '\n');
}
});
获取本地存储的历史消息
RongIMClient.getInstance().getHistoryMessages(Conversation.ConversationType.PRIVATE, getReceiverIdTest(), -1, 25,
new RongIMClient.ResultCallback<List<Message>>() {
@Override
public void onSuccess(List<Message> messages) {
if (messages != null) {
Log.d(TAG, "本地存储的历史消息个数为 " + messages.size());
for (Message message : messages) {
handleMessage(message.getContent());
}
} else
Log.d(TAG, "本地存储的历史消息个数为 0" + '\n');
}
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "读取本地存储的历史消息失败，错误码: " + errorCode.getValue() + '\n');
}
});
读取服务器远程消息
RongIMClient.getInstance().getRemoteHistoryMessages(Conversation.ConversationType.PRIVATE, getReceiverIdTest(), 0, 10, new RongIMClient.ResultCallback<List<Message>>() {
@Override
public void onSuccess(List<Message> messages) {
if (messages != null) {
Log.d(TAG, "远端服务器存储的历史消息个数为 " + messages.size());
for (Message message : messages) {
handleMessage(message.getContent());
}
} else
Log.d(TAG, "远端服务器存储的历史消息个数为 0" + '\n');
}
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "读取远端服务器存储的历史消息失败，错误码: " + errorCode.getValue() + '\n');
}
});
获取位置共享信息
RealTimeLocationConstant.RealTimeLocationErrorCode mLocationStatus = RongIMClient.getInstance().startRealTimeLocation(Conversation.ConversationType.PRIVATE, getReceiverIdTest());
Log.d(TAG, "是否成功开启位置共享功能: " + mLocationStatus.getMessage() + '\n');
获取会话(Conversation)信息
RongIMClient.getInstance().getConversation(Conversation.ConversationType.PRIVATE, getReceiverIdTest(),
new RongIMClient.ResultCallback<Conversation>() {
@Override
public void onSuccess(Conversation conversation) {
if (conversation != null) {
Log.d(TAG, "获取的会话信息:");
Log.d(TAG, "会话类型: " + conversation.getConversationType());
Log.d(TAG, "发送者ID: " + conversation.getSenderUserId());
Log.d(TAG, "接收者ID: " + conversation.getTargetId());
Log.d(TAG, "最新一条消息的ID: " + conversation.getLatestMessageId());
Log.d(TAG, "最新一条消息内容:");
handleMessage(conversation.getLatestMessage());
Log.d(TAG, "消息提醒状态: " + ((conversation.getNotificationStatus().getValue() == 1) ? "接收消息" : "消息免打扰"));
Log.d(TAG, "未读消息数: " + conversation.getUnreadMessageCount() + '\n');
} else
Log.d(TAG, "会话不存在" + '\n');
}
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "获取会话信息失败，错误码: " + errorCode.getValue() + '\n');
}
});
删除会话信息
RongIMClient.getInstance().removeConversation(Conversation.ConversationType.PRIVATE, getReceiverIdTest(),
new RongIMClient.ResultCallback<Boolean>() {
@Override
public void onSuccess(Boolean aBoolean) {
if (aBoolean)
Log.d(TAG, "删除会话信息成功" + '\n');
else
Log.d(TAG, "删除会话信息失败" + '\n');
}
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "删除会话信息失败，错误码: " + errorCode.getValue() + '\n');
}
});
清空消息
RongIMClient.getInstance().clearMessages(Conversation.ConversationType.PRIVATE, getReceiverIdTest(),
new RongIMClient.ResultCallback<Boolean>() {
@Override
public void onSuccess(Boolean aBoolean) {
if (aBoolean)
Log.d(TAG, "执行清空消息成功" + '\n');
else
Log.d(TAG, "执行清空消息失败" + '\n');
}
@Override
public void onError(RongIMClient.ErrorCode errorCode) {
Log.d(TAG, "执行清空消息失败，错误码: " + errorCode.getValue() + '\n');
}
});
根据不同的messageContent, 在"结果"页面做出相应的显示
private void handleMessage(MessageContent messageContent) {
if (messageContent == null)
return;
if (messageContent instanceof TextMessage) {
Log.d(TAG, "文本消息: " + ((TextMessage) messageContent).getContent());
} else if (messageContent instanceof ImageMessage) {
Log.d(TAG, "图片消息, Uri --> " + ((ImageMessage) messageContent).getThumUri());
} else if (messageContent instanceof VoiceMessage) {
Log.d(TAG, "语音消息, Uri --> " + ((VoiceMessage) messageContent).getUri());
} else if (messageContent instanceof FileMessage) {
Log.d(TAG, "文件消息, Uri --> " + ((FileMessage) messageContent).getFileUrl());
} else if (messageContent instanceof CustomizeMessage) {
Log.d(TAG, "自定义消息的内容: " + ((CustomizeMessage) messageContent).getContent());
}
}
注意事项
- 使用音视频开发
CallLib 仅支持 armeabi-v7a 和 x86 架构 CPU （组件功能），如果您使用了我们的音视频通话功能，注意需要把 IMLib 和 PushLib 组件中其它 CPU 架构的 so 删除。或者您也可以在应用的 build.gradle 文件中增加如下配置来过滤 so :
defaultConfig {
applicationId "XXX"
...
ndk {
abiFilters "armeabi-v7a", "x86"
}
}
- 配置IMLib
打开 IMLib Module 的 AndroidManifest.xml 文件，把 meta-data RONG_CLOUD_APP_KEY 的值修改为您自己的 AppKey. 如图：
<meta-data
android:name="RONG_CLOUD_APP_KEY"
android:value="您的应用 AppKey" />
- 配置定位
打开应用的 App Module 的 AndroidManifest.xml 文件， 把从高德官网获取的 AppKey 添加到 meta-data 里 (如果您不使用位置功能，可跳过此步骤)。
<meta-data
android:name="com.amap.api.v2.apikey"
android:value="高德地图的 AppKey" />
初始化
RongIM.init(this);
