给最后用户提供统一的施用体验,发表实时通讯(IM)服务之后

对话成员变动响应接口

首要用来处理对话中成员变动的轩然大波,接口定义在
AVIMConversationEventHandler,首要函数为:

  /**
   * 实现本方法以处理聊天对话中的参与者离开事件
   *
   * @param members 离开的参与者
   * @param kickedBy 踢人者,自愿退出的情况下踢人者就是参与者
   */
  public abstract void onMemberLeft(AVIMClient client,
      AVIMConversation conversation, List<String> members, String kickedBy);

  /**
   * 实现本方法以处理聊天对话中的参与者加入事件
   *
   * @param members 加入的参与者
   * @param invitedBy 邀请人,有可能是加入的参与者本身
   */
  public abstract void onMemberJoined(AVIMClient client,
      AVIMConversation conversation, List<String> members, String invitedBy);

  /**
   * 实现本方法来处理当前用户被踢出某个聊天对话事件
   *
   * @param kickedBy 踢出你的人
   */
  public abstract void onKicked(AVIMClient client, AVIMConversation conversation,
      String kickedBy);

  /**
   * 实现本方法来处理当前用户被邀请到某个聊天对话事件
   *
   * @param conversation 被邀请的聊天对话
   * @param operator 邀请你的人
   */
  public abstract void onInvited(AVIMClient client, AVIMConversation conversation,
      String operator);

通过
AVIMMessageManager.setConversationEventHandler(AVIMConversationEventHandler handler)
可以安装全局的 Conversation伊夫ntHandler。

实时新闻 AVMessage

在 LeanMessage 中兼有的新闻都以 AVMessage 的实例,AVMessage
只帮助文件,并且长度不能超越5KB。音讯分为暂态(transient)和百折不挠音讯两连串型。全数持久音信都会在
LeanMessage
云端保存,所以用户离线之后也能够赢得文告和选取,而暂态消息并不会离线保存,适合开发者用来拓展商谈决定。

AVMessage 的概念如清单 1 所示:

public class AVMessage implements Parcelable {
  private List<String> toPeerIds; // 消息接收方的 PeerID,支持一个或多个

  String groupId; // 消息所属群组的ID,对于普通一对一聊天消息而言,此值为空
  String message; // 消息体
  long timestamp; // 消息发送时间戳
  boolean isTransient; // 是否是暂态消息
  String fromPeerId; // 消息发送方的 PeerID

  public AVMessage();
  public AVMessage(String message);
  public AVMessage(String message, List<String> toPeerIds, boolean isTransient);
  public AVMessage(String message, boolean isTransient);
}

LeanMessage
为富有历史音信都提供了蕴藏和询问的功用,存款和储蓄时间则基于开发者的门类有所分裂。

音信响应接口

第2用以处理新音信到达事件,接口定义在
MessageHandlerAVIMMessageHandler
是二个空的贯彻类,大家应当通过重载 AVIMMessageHandler
的有关办法来成功消息处理。首要的法门有:

  // 收到新的消息
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation);

  // 自己发送的消息已经被对方接收
  @Override
  public void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client);

通过 AVIMMessageManager.registerDefaultMessageHandler(handler)
能够安装全局的 MessageHandler。

大家兑现这叁类接口,就足以处理全部的打招呼新闻了。示例代码如下:

class CustomNetworkHandler extends AVIMClientEventHandler {
  @Override
  public void onConnectionPaused(AVIMClient client) {
    // 请按自己需求改写
    Logger.d("connect paused");
  }

  @Override
  public void onConnectionResume(AVIMClient client) {
    // 请按自己需求改写
    Logger.d("connect resume");
  }
}

class CustomConversationHandler extends AVIMConversationEventHandler {
  public private Context gContext = null;
  private void toast(String str) {
    Toast.makeText(gContext, str, Toast.LENGTH_SHORT).show();
  }
  private void toast(Context context, String str) {
    Toast.makeText(context, str, Toast.LENGTH_SHORT).show();
  }

  @Override
  public void onMemberLeft(AVIMClient client, AVIMConversation conversation, List<String> members, String kickedBy) {
    // 请按自己需求改写
    toast(MsgUtils.nameByUserIds(members) + " left, kicked by " + MsgUtils.nameByUserId(kickedBy));
    //注:MsgUtils 是一个辅助类,nameByUserIds 用来将 userId 转换成用户名
  }

  @Override
  public void onMemberJoined(AVIMClient client, AVIMConversation conversation, List<String> members, String invitedBy) {
    // 请按自己需求改写
    toast(MsgUtils.nameByUserIds(members) + " joined , invited by " + MsgUtils.nameByUserId(invitedBy));
    //注:MsgUtils 是一个辅助类,nameByUserIds 用来将 userId 转换成用户名
  }

  @Override
  public void onKicked(AVIMClient client, AVIMConversation conversation, String kickedBy) {
    // 请按自己需求改写
    toast("you are kicked by " + MsgUtils.nameByUserId(kickedBy));
  }

  @Override
  public void onInvited(AVIMClient client, AVIMConversation conversation, String operator) {
    // 请按自己需求改写
    toast("you are invited by " + MsgUtils.nameByUserId(operator));
  }
};

class CustomMsgHandler extends AVIMMessageHandler {
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 请按自己需求改写
    String msgContent = message.getContent();
    Logger.d(conversation.getConversationid() + " 收到一条新消息:" + msgContent);
  }

  @Override
  public void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 请按自己需求改写
    Logger.d("发往对话 " + conversation.getConversationid() + " 的消息 "+ message.getMessageId() +" 已被接收");
  }
}

// 设置事件响应接口
AVIMClient.setClientEventHandler(new CustomNetworkHandler());
AVIMMessageManager.setConversationEventHandler(new CustomConversationHandler());
AVIMMessageManager.registerDefaultMessageHandler(new CustomMsgHandler());

聊天会话 Session

每1个 Peer 通过开启(open)多个对话(Session)而进入实时音讯服务,Peer
能够在3个对话中关切(watch)三个或多少个Peer,当被关切者上下线时,会接收公告。Peer
在拉开对话后不得不向友好关怀的其他 Peers 发送新闻,但能够收到任何 Peer
发来的消息,相当于说单向关心时,新闻能够顺遂地由关切者发往被关心者。

Session 有如下三种境况:

  • opened。 Session 被符合规律打开,此时得以拓展寻常的通讯;
  • pause。 网络特别(譬如 wifi 断开,三G/②G 切换,iOS
    应用进入后台,等),Session 进入暂停状态,当互连网恢复生机时,Session
    会自动重连;
  • resume。 应用转入前台,会话重新创建起来(此情状只在 iOS 设备上有效)
  • closed。 Session 停止,仅在呈现调用了 Session.close
    方法时才会发生。用户注销实时通讯服务,不再尚可到音讯或推送公告;

Session 上能够展开的操作有:

  • open 以一个 Peer ID 打开 Session
  • watch 关切1组 Peer ID,关怀后得以接受那几个 Peer
    的上下线通告,发送音讯
  • unwatch 撤消对1组 Peer ID 的关注
  • sendMessage 给1组 Peer ID 发送新闻
  • queryOnlinePeer 查找当前在线的 Peers
  • getHistoryMessageQuery 查找历史音信
  • setSignatureFactory 设置签名类(为了保证安全性,前面会讲述)
  • close 注销服务,关闭 Session

分子管理

在查询到聊天室成员之后,能够让用户特邀一些要好的心上人进入,作为管理员也可以去除一些「可怕」的分子。
参与新成员的 API 如下:

// 假设需要邀请 Alex,Ben,Chad 三人加入对话
List<String> userIds = new ArrayList<String>();
userIds.add("Alex");
userIds.add("Ben");
userIds.add("Chad");
conversation.addMembers(userIds, new AVIMConversationCallback() {
  @Override
  public void done(AVException error) {
    if (null != error) {
      // 加入失败,报错.
      error.printStackTrace();
    } else {
      // 发出邀请,此后新成员就可以看到这个对话中的所有消息了。
      Logger.d("invited.");
    }
  }
});

诚邀成功今后,相关方收到布告的时序是这么的:

    操作者(管理员)                    被邀请者                        其他人
1, 发出请求 addMembers
2,                               收到 onInvited 通知
3, 收到 onMemberJoined 通知      收到 onMemberJoined 通知      收到 onMemberJoined 通知

对应地,踢人时的调用 API 是:

List<String> userIds = new ArrayList<String>();
userIds.add("Alex");
conversation.kickMembers(userIds, new AVIMConversationCallback() {
  @Override
  public void done(AVException error) {
    if (null != error) {
      // 失败,报错.
      error.printStackTrace();
    } else {
      // 成功。
      Logger.d("kicked.");
    }
  }
});

踢人时,相关方收到通告的时序如下:

    操作者(管理员)                被踢者                       其他人
1, 发出请求 kickMembers
2,                          收到 onKicked 通知
3, 收到 onMemberLeft 通知                             收到 onMemberLeft 通知

注意!
假若邀约、踢人操作发生的时候,被邀约者/被踢者当前不在线,那么通告音信并不会被离线缓存,所以她们再上线的时候将不会接收布告。

查询聊天室成员

在投入一个聊天室之后,大家先是步正是探望有啥样人在这些群组里面。LeanMessage
和 LeanStorage 是构成在一块儿的,通过应用 LeanStorage
的数码存款和储蓄功用,来保存1个聊天室的骨干音信(表名:AVOSRealtimeGroups),在
LeanStorage 应用管理平台的多寡主导,大家能够见见 AVOSRealtimeGroups
的保有字段。

LeanStorage
的数码基本
LeanStorage
也是 LeanCloud
平台的着力服务之壹,提供了应用内数据和文书数量的积存成效。对于使用内数据,LeanStorage
接济 schema free 的仓库储存,开发者不供给事先定义数据的格局,只要符合 JSON
格式的 Object 都足以随意存储到 LeanStorage 云端。同时,LeanStorage
也提供贰个 Web
版的数据管理界面,能够1二分有利地增、删、改、查任何数据。

本来,在大家精通1个聊天室的 groupId 的时候,也足以在代码中,通过
AVObject 的 fetch 接口来查阅那么些聊天室的组员情况,代码如清单 玖 所示:

    AVObject groupObject = AVObject.createWithoutData("AVOSRealtimeGroups",groupId);
    groupObject.fetch();//如果您在UI进程中,请使用异步方法调用
    List groupMembers= groupObject.getList("m");

防止系统线程阻塞!
回看一下,在移动应用程序中,长日子的操作(如网络、文件或长的乘除)不该在主系统线程上形成。相反,应在一个单身的干活线程中实践它们。阻塞系统线程会对应用程序的用户界面包车型地铁响应能力产生负面影响,有相当大希望引致强行关闭您的应用程序。

群组聊天

与前方的单聊类似,群组聊天也急需先成立贰个会话(AVIMConversation),然后发送、接收新的音信。

LeanMessage 移动支付
SDK 是由 LeanCloud
提供的,专为 iOS、Android 和 WindowsPhone® 等客户端程序提供利用内聊天的
API 和劳动,并且也提供了 JavaScript
API,方便开发者打通网页和客户端应用,给最后用户提供联合的采纳体验。使用
LeanMessage
API,您能够相当的慢地以最少工作量让您的移动使用支撑实时聊天,获得壹种如微信一般的联系体验。

登录

若果聊天发起方名字为 汤姆,为直观起见,大家选择用户名来作为 clientId
登录聊天系统(LeanCloud 云端只供给 clientId
在使用内唯一即可,具体用什么数据由应用层决定),代码如下:

AVIMClient imClient = AVIMClient.getInstance("Tom");
imClient.open(new IMClientCallback(){
  @Override
  public void done(AVIMClient client, AVException e) {
    if (null != e) {
      // 出错了,可能是网络问题无法连接 LeanCloud 云端,请检查网络之后重试。
      // 此时聊天服务不可用。
      e.printStackTrace();
    } else {
      // 成功登录,可以开始进行聊天了(假设为 MainActivity)。
      Intent intent = new Intent(currentActivity, MainActivity.class);
      currentActivity.startActivity(intent);
    };
  }
});

基本概念

与壹般的单聊相比,群聊扩张了如下八个基本概念:

  • 群组 AVGroup

AVGroup
代表多个聊天群组,能够对应到实在的三人聊天、聊天群、聊天室等,每一个AVGroup 有贰个唯壹的 ID(groupID,由 LeanMessage
云端分配),其定义如清单 陆 所示:

   public class AVGroup implements Group {
      String roomId;
      String selfId;
      Session session;
   }

1个 Peer
参预群后向群发送的新闻能够被抱有群成员接受。当有新成员进入可能既有成员退出时,全体群成员都会赢得文告。AVGroup
上能够开展的操作有:

public interface Group{
    public void join();
    public void sendMessage(AVMessage msg);
    public void kickMember(List<String> peerIds);
    public void inviteMember(List<String> peerIds);
    public void quit();
    public String getGroupId();
    public String getSelfId();
    public AVHistoryMessageQuery getHistoryMessageQuery();
}
  • 群组新闻接受器 AVGroupMessageReceiver

与 AVMessageReceiver 类似,AVGroupMessageReceiver
主要用来处理群组操作的结果。其详细定义如清单 柒 所示:

  /**
   *在加入聊天室成功后被调用 如果join时,没有带groupId,您可以在返回的group中间获取groupId
   */
  @Override
  public abstract void onJoined(Context context, Group group);

  /**
   * 当你被别人邀请进入某个聊天室以后
   * 
   * @param group
   * @param byPeerId
   *        这个人邀请了你
   */
  @Override
  public abstract void onInvited(Context context, Group group, String byPeerId);

  /**
   * 当你被别人踢出聊天室以后
   * 
   * @param group
   * @param byPeerId
   *            是他踢了你
   */
  @Override
  public abstract void onKicked(Context context, Group group, String byPeerId);

  /**
   * 处理消息发送成功事件
   */
  @Override
  public abstract void onMessageSent(Context context, Group group,
        AVMessage message);

  /**
   * 用来处理消息发送失败事件
   * 可以缓存起来,事后重发
   */
  @Override
  public abstract void onMessageFailure(Context context, Group group,
        AVMessage message);

  /**
   * 收到消息以后被调用
   * 一般通过这个接口来处理和接受来自Group的消息
   * @param context
   * @param group
   * @param message
   * @param fromPeerId
   *            发消息者
   */
  @Override
  public abstract void onMessage(Context context, Group group,
        AVMessage message);

  /**
   * 处理退出成功事件
   */
  @Override
  public abstract void onQuit(Context context, Group group);

  /**
   * 处理Group操作被拒绝的时间
   * @param context
   * @param group
   * @param op 这里可能存在的操作有 "join","invite","kick"
   * @param targetIds
   *            一般来说是指被操作的对象,在join操作中间就是指groupId本身,
   *            invite和kick中则指被邀请或者被踢除的peerIds
   */
  @Override
  public abstract void onReject(Context context, Group group, String op,
        List<String> targetIds);

  /**
   * 处理新用户加入事件
   */
  @Override
  public abstract void onMemberJoin(Context context, Group group,
        List<String> joinedPeerIds);

  /**
   * 处理用户退出事件
   */
  @Override
  public abstract void onMemberLeft(Context context, Group group,
        List<String> leftPeerIds);

  /**
   * 处理所有Group相关的异常
   */
  @Override
  public abstract void onError(Context context, Group group, Throwable e);

树立对话

假设大家要跟「Bob」这一个用户展开聊天,大家先创立一个对话,代码如下:

List<String> clientIds = new ArrayList<String>();
clientIds.add("Tom");
clientIds.add("Bob");

// 我们给对话增加一个自定义属性 type,表示单聊还是群聊
// 常量定义:
// int ConversationType_OneOne = 0; // 两个人之间的单聊
// int ConversationType_Group = 1;  // 多人之间的群聊
Map<String, Object> attr = new HashMap<String, Object>();
attr.put("type", ConversationType_OneOne);

imClient.createConversation(clientIds, attr, new AVIMConversationCreatedCallback() {
  @Override
  public void done(AVIMConversation conversation, AVException e) {
    if (null != conversation) {
      // 成功了,这时候可以显示对话的 Activity 页面(假定为 ChatActivity)了。
      Intent intent = new Intent(this, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      startActivity(intent);
    }
  }
});

建立的「对话」在控制台怎么查看

如你所见,大家创制多个会话的时候,钦点了成员(汤姆 和
鲍勃)和一个额外的属性({type: 0})。这几个数据保存到云端后,你在
控制台 -> 存储 -> 数据 里面会看到,_Conversation
表中加进了一条记下,新记录的 m 属性值为["Tom", "Bob"]attr
属性值为{"type":0}。如您所料,m 属性就是对应着成员列表,attr
属性就是用户扩张的额外属性值(以目的的样式储存)。

基本概念和类

下载和装置

可以到 LeanCloud
官方下载点下载
LeanCloud IM SDK v二 版本。将下载到的 jar 包参预工程即可。

援救富媒体的谈天音信

地点的代码演示了如何发送文书音信,然则以往的交互格局已经尤其三种化,图片、语音、录制已是格外广阔的媒体类型。而从
AVMessage 的定义来看,只帮助不超越 5KB 大小的公文,那么 LeanMessage
又怎么能帮助富媒体的闲聊消息吧?

记得 LeanStorage 中的 AVFile 吗?
AVFile 是 LeanStorage
提供的非结构化数据存款和储蓄化解方案,能够让您的应用程序将2进制文件存款和储蓄到云端服务器中,并且自动提供
CDN
加速服务,能带给用户越来越高效的下载体验。比如大规模的文件类型图像文件、印象文件、音乐文件和别的其余2进制数据都足以使用。具体表达能够瞻仰Android
开发文书档案

对此图片、语音、摄像那类较大的非结构化数据,存款和储蓄到云端文件系统之后,在音信中发送
url 已是产业界惯例,并且 LeanMessage 中 AVMessage
类的定义并从未鲜明新闻体是怎样品种,所以大家能够丰硕利用那壹扩大空间,结合
AVFile 来发送、接收富媒体的聊天新闻。完毕方式如清单 伍 所示:

AVFile file = AVFile.withAbsoluteLocalPath("test.jpg", Environment.getExternalStorageDirectory() + "/test.jpg");
file.saveInBackground(new SaveCallback() {
    // override
    public void done(AVException ex) {
        if (null != ex) {
            // error
        } else {
            // construct message body under json format.
            HashMap<String, Object> params = new HashMap<String, Object>();
            params.put("type", "image");
            params.put("context", "嗨,你好,我是 Tom");
            params.put("attachment", file.getUrl());

            List<String> peerIds = new LinkedList<String>();
            peerIds.add("Bob");
            session.sendMessage(new AVMessage(JSON.toJSONString(params), peers, false));
        }
    }
});

新本子的 LeanMessage SDK
会辅助富媒体新闻,防止让每一种开发者都重复做类似的行事。

基类:AVIMTypedMessage

拥有富媒体音信的基类,其宣称为

//SDK定义的消息类型,LeanCloud SDK 自身使用的类型是负数,所有正数留给开发者自定义扩展类型使用,0 作为「没有类型」被保留起来。
enum AVIMReservedMessageType {
  UnsupportedMessageType(0),
  TextMessageType(-1),
  ImageMessageType(-2),
  AudioMessageType(-3),
  VideoMessageType(-4),
  LocationMessageType(-5),
  FileMessageType(-6);
};

public abstract class AVIMTypedMessage extends AVIMMessage {
  public AVIMTypedMessage();

  public int getMessageType();

  @Override
  public final String getContent();

  @Override
  public final void setContent(String content);
}

闲聊参预者 Peer

在 LeanMessage 实时新闻世界中,每1个加入者(壹般而言是「人」)都是叁个Peer。Peer 拥有一个在使用内唯一标识自己的 ID(称为
PeerID,字符串类型,长度不超过 50
字节,具体数值由使用自个儿明确),系统中的每一条音讯都出自于八个Peer,发送到多少个或多少个 Peer。并且,LeanMessage 的音讯服务允许三个 Peer
在三个不等装备上登录,也允许一个配备上同时登录多个Peer,究竟该怎样行使,由使用依照使用意况温馨挑选。

此处要专注的是,PeerID 是由使用开发者本身賦值的,LeanMessage
本人并从未别的强制需要,所以:

  • 实时音讯系统是足以和用户账户种类解耦合的,应用开发者不供给把除了
    PeerID 以外的其它新闻报告 LeanMessage;
  • LeanMessage 在音讯转载的时候是依据 PeerID
    来唯一定位的,因而一旦运用本身协理同1账户的多点登录,那么
    LeanMessage 就会把消息布告到独具终端;
  • 匿名聊天/非匿名聊天那都以应用层自个儿控制的,若是运用自己能为匿名用户钦赐一个唯一的
    ID,那么这么些用户参预到聊天系统里来,是全然未有毛病的。

为了幸免纷扰,3个 Peer
须要先关心(watch)了对方才能给对方发送新闻;因为 LeanMessage
提供了越来越细粒度的权能决定,应用开发者能够在关怀(watch)动作上扩充签名来保管安全性。那点前边会进展详尽表明。

采纳群组新闻

吸收1个群组的音讯,与接受单聊的音讯也是均等的。

始发在此以前
由于本文的指标,小编借使您曾经丰盛熟识使用 JSON、Android 和 Eclipse
进行移动使用编制程序的基本概念。在你持续读书本文此前,请访问 leancloud.cn
并创建您的应用程序。只需根据注册页面中的不难指令即可。

旋律音信(AVIMAudioMessage)

AVIMFileMessage
子类,专门用来发送语音和附带文本的混合音讯,其构造函数注明为:

// 传入本地文件路径,构造消息对象
public AVIMAudioMessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMAudioMessage(File localFile) throws FileNotFoundException, IOException;   
// 传入 AVFile 实例,构造消息对象
public AVIMAudioMessage(AVFile file);

发送音频音信的言传身教代码为:

String localAudioPath;
try {
  AVIMAudioMessage message = new AVIMAudioMessage(localAudioPath);
  message.setText("听听我唱的小苹果:)");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

选拔到这么新闻随后,开发者能够经过如下方法,获取到多少音频元数据(时间长度duration、音频 size)和三个涵盖音频数据的 AVFile 对象:

  • double getDuration() 方法会重返音频的长短(单位:秒)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会再次来到2个音频文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会再次回到音频文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会重临音频文件的莫过于尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会再次回到随音频一起发送的文本信息。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)能够收获音频的别的元数据音讯。

成员管理

在询问到聊天室成员之后,能够让用户约请部分和谐的意中高丽参预,作为管理员也得以去除1些「可怕」的分子。代码如清单
⑩ 所示:

    Group group = SessionManager.getInstance(selfId).getGroup(groupId);
    List<String> toInvite = Arrays.asList("peerId1","peerId2","peerId3");
    group.inviteMember(toInvite);
    List<String> toKickOff = Arrays.asList("badBoy1","badBoy2");
    group.kickMembers(toKickOff);

诚邀成功之后,布告的流程是这么的:

    操作者(管理员)                           被邀请者                        其他人
1,发出请求 inviteMember
2,AVGroupMessageReceiver.onInvited
3,                                      AVGroupMessageReceiver.onJoined
4,AVGroupMessageReceiver.onMemberJoin                          AVGroupMessageReceiver.onMemberJoin

对应地,踢人的流水线如下:

    操作者(管理员)                           被踢者                         其他人
1,发出请求 kickMember
2,AVGroupMessageReceiver.onKicked
3,                                    AVGroupMessageReceiver.onQuit
4,AVGroupMessageReceiver.onMemberLeft                         AVGroupMessageReceiver.onMemberLeft

何以增加本身的富媒体音信

继续于
AVIMTypedMessage,开发者也得以扩展自个儿的富媒体新闻。其需要和手续是:

  • 贯彻新的信息类型,继承自 AVIMTypedMessage。那里必要留意两点:
    • 在 class 上平添三个 @AVIMMessageType(type=1二3) 的
      Annotation,具体新闻类型的值(123)由开发者本人支配(LeanCloud
      内建的新闻类型应用负数,全数正数都预留给开发者扩张使用)。
    • 在消息内部属性上要扩充 @AVIMMessageField(name=””) 的
      Annotation,name
      为可选字段在申明字段属性,同时自定义的字段要有对应的
      getter/setter 方法。
  • 调用
    AVIMMessageManager.registerAVIMMessageType(Class<? extends AVIMTypedMessage> messageType)
    函数实行项目注册
  • 调用
    AVIMMessageManager.registerMessageHandler(Class<? extends AVIMMessage> clazz, MessageHandler<?> handler)
    函数进行消息处理 handler 注册。

AVIMTextMessage 的源码如下,可供参考:

@AVIMMessageType(type = -1)
public class AVIMTextMessage extends AVIMTypedMessage {

  @AVIMMessageField(name = "_lctext")
  String text;
  @AVIMMessageField(name = "_lcattrs")
  Map<String, Object> attrs;

  public String getText() {
    return this.text;
  }

  public void setText(String text) {
    this.text = text;
  }

  public Map<String, Object> getAttrs() {
    return this.attrs;
  }

  public void setAttrs(Map<String, Object> attr) {
    this.attrs = attr;
  }
}

纵览查看全部聊天室

翻看全数聊天室的艺术和查阅单个聊天室成员的不贰秘籍类似,皆以一直通过 AVQuery
依旧 AVObject 来遍历 AVOSRealtimeGroups 表落成的,那里不再赘述。

始建群组

和单聊类似,建立叁个多少人闲谈的群组也是很简短的。例如:

Map<String, Object> attr = new HashMap<String, Object>();
attr.put("type", ConversationType_Group);
imClient.createConversation(clientIds, attr, new AVIMConversationCreatedCallback() {
  @Override
  public void done(AVIMConversation conversation, AVException e) {
    if (null != conversation) {
      // 成功了!
      Intent intent = new Intent(currentActivity, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      currentActivity.startActivity(intent);
    }
  }
});

成功未来,大家就足以进来聊天界面了。

聊天记录和安全

前方完毕了单聊、群聊、富媒体聊天诸多成效,不过开发者恐怕早就意识了,那都以一贯调用
LeanMessage SDK
来完毕的,对于大家开发者来说,能控制的东西很少,在安全性上会存在部分担心。譬如:万1不怀好意的人破解了自家的
appId 和 appKey,是否就足以在本身的闲话社区里面为非作歹?

为了满意开发者对权力和注解的供给,LeanMessage
还规划了操作签名的建制。大家得以在 LeanCloud
应用控制台、设置、应用选项中强制启用签名(强烈推荐那样做)。启用后,全部的
Session open 和 watch
行为都须要申明签名,那样开发者就可以对用户登录以及他得以关注如何人,进而可以给哪个人发新闻实行丰裕的操纵。

署名选择 Hmac-sha一 算法,输出字节流的十6进制字符串 (hex
dump),签名的新闻格式如下:

app_id:peer_id:watch_peer_ids:timestamp:nonce

其中:

  • app_id 是你的行使 ID
  • peer_id 是打开此 Session 的 Peer ID
  • watch_peer_ids 是 open 或 watch 请求中关怀的 peer
    ids,升序排序后以: 分隔
  • timestamp 是时下的 UTC 时间距离 unix epoch 的秒数
  • nonce 为随机字符串

在群组操作中,LeanMessage
对加群、特邀和踢出群这多个动作也允许加入签名,它的签字格式是:

app_id:peer_id:group_id:group_peer_ids:timestamp:nonce:action

其中:

  • app_id, peer_id, timestamp 和 nonce 同上
  • group_id 是此番作为涉嫌的群组 ID,对于开创群尚未有 id
    的情况,group_id 是空字符串
  • group_peer_ids 是: 分隔的升序排序的 peer id,即特邀和踢出的
    peer_id;对加入群的场地,那里是空字符串
  • action 是这次行为的动作,三种行为分别对应常量 join, invite 和 kick

签字的 key 是运用的 master key。开发者能够兑现协调的
SignatureFactory,调用远程的服务器的签名接口得到签名。假若未有团结的服务器,能够一贯在
LeanCloud 的云代码上经过 Web Hosting
动态接口达成和谐的签订契约接口。在活动使用中一向做签名是丰盛危险的,它大概引致你的
master key 泄漏。

LeanCloud 的 appKey 分类
在 LeanCloud 平台上申请了选择之后,LeanCloud 会分配给大家七个key:2个 appKey,贰个 master Key。在那之中 appKey
能够实施一些惯常的操作,并且受到 LeanCloud
平台安全设置的限量,类似于操作系统中的普通 User
账号,所以能够平昔用在客户端;master Key
则持有具备权力,类似于操作系统中的 Root/Administrator
账号,所以请稳妥保管。

好,有了签名机制之后,大家到底该怎么利用呢?我们只要求贯彻自身的
SignatureFactory,然后在拉开 session 的时候,把这一个 signatureFactory
传进去即可。示例代码如清单 1叁 所示:

// Signature 定义如下,由 LeanMessage 提供
public class Signature {
    private String signature;
    private long timestamp;
    private String nonce;
    private List<String> signedPeerIds;

    // getter / setter for properties
    ......
}
// customise signature factory,由开发者实现
public MySignatureFactory implements SignatureFactory {
    @override
    public Signature createSignature(String selfId, List<String> watchIds) {
        // call remote server for correct signature.
    }
   @override
    public Signature createGroupSignature(String groupId, String selfId, List<String> targetPeerIds,
  String action) {
        // call remote server for correct group signature.
    }
}

// open session with signature factory.
SignatureFactory signatureFacatory = new MySignatureFactory();
SessionManager sm = SessionManager.getInstance(selfId);
sm.setSignatureFactory(signatureFactory);
sm.open(selfId);

设定了 SignatureFactory 之后,对于须要鉴权的操作,LeanMessage SDK
与劳动器端通信的时候都会带上应用自身生成的 Signature 新闻,那样
LeanMessage 服务器端就会利用 app 的 masterKey
来证实音讯的实惠,保险聊天渠道的安全。

新闻接收

在 鲍勃 那1端,要能接收到音讯,须要如下几步:

壹,进行伊始化;

二,完毕和谐的 AVIMMessageHandler,响应新音信到达公告,主借使之类函数:

public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client);

对此 Tom 发过来的音讯,要呈现出来,我们只需兑现 onMessage
即可,示例代码如下:

class CustomMessageHandler extends AVIMMessageHandler {
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 新消息到来了。在这里增加你自己的处理代码。
    String msgContent = message.getContent();
    Logger.d(conversation.getConversationid() + " 收到一条新消息:" + msgContent);
  }
}

三,举办登录,代码也与发送端1样。

完整代码如下:

// 自定义消息响应类
class CustomMessageHandler extends AVIMMessageHandler {
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 新消息到来了。在这里增加你自己的处理代码。
    String msgContent = message.getContent();
    Logger.d(conversation.getConversationid() + " 收到一条新消息:" + msgContent);
  }
}

// application 的初始化部分
public void onCreate(){
  ...
  AVOSCloud.initialize(this,"{{appId}}","{{appKey}}");
  AVIMMessageManager.registerDefaultMessageHandler(new CustomMessageHandler());
  ...
}

// 用户登录部分
AVIMClient imClient = AVIMClient.getInstance("Bob");
imClient.open(new IMClientCallback(){
  @Override
  public void done(AVIMClient client, AVException e) {
    if (null != e) {
      // 出错了,可能是网络问题无法连接 LeanCloud 云端,请检查网络之后重试。
      // 此时聊天服务不可用。
      e.printStackTrace();
    } else {
      // 成功登录,可以开始进行聊天了。
    };
  }
});

注意!
AVIMMessageManager.registerDefaultMessageHandler() 一定要在
AVIMClient.open() 从前调用,否则恐怕导致服务器发回去的有些音信丢失。

群组聊天

在闲谈的急需里,还有一个很要紧的意况,就是群组聊天。之前方 AVMessage
的定义我们得以猜到,LeanMessage
应该是永葆群聊的,那其实该怎么促成吗?上面大家一步一步来尝试一下。

摄像新闻(AVIMVideoMessage)

AVIMFileMessage
子类,专门用来发送录制和附带文本的混合音讯,其构造函数证明为:

// 传入本地文件路径,构造消息对象
public AVIMVideoMessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMVideoMessage(File localFile) throws FileNotFoundException, IOException;
// 传入 AVFile 文件,构造消息对象
public AVIMVideoMessage(AVFile file);

出殡录制音信的示范代码为:

String localVideoPath;
try {
  AVIMVideoMessage message = new AVIMVideoMessage(localVideoPath);
  message.setText("敢不敢跟我比一比");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

收下到那般新闻随后,开发者能够能够通过如下方法,获取到几何录制元数据(时长duration、摄像 size)和多个饱含摄像数据的 AVFile 对象:

  • double getDuration() 方法会再次回到录像的尺寸(单位:秒)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会再次来到七个录像文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会重临录制文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会重返录制文件的实际上尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会重返随摄像一起发送的文书消息。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)能够赢得录制的此外元数据音信。

正文介绍了富含单聊、群聊、历史记录和利用鉴权的主导 API
类。您将学习怎么样简单举办用户间1对1单聊,以及怎么样创制群组让多用户实行群聊,还有怎样通过签订契约来对聊天通道实行支配,以维护利用和用户的隐情。示例均创设于
LeanMessage SDK for Android
之上(请参阅Android开发指南)。

非凡的文件聊天

笔者们先从最简便易行的环节出手,看看怎么用 LeanCloud IM SDK v二落实一对一文本摆龙门阵。

往聊天室发送消息

出殡新闻分外简单,通过如下代码就足以向特定聊天室发送消息了:

    Group group = SessionManager.getInstance(selfId).getGroup(groupId);
    group.sendMessage(new AVMessage("hello world"));

出殡成功未来,AVGroupMessageReceiver 子类中的 onMessageSent
方法会被调用,反之则 onMessageFailure 方法会被调用。

开放聊天室

开放聊天室(也叫暂态对话)能够用来很多地点,譬如弹幕、直播等等。在
LeanCloud IM SDK
中,开放聊天室是一类特殊的群组,它也支撑创建、参与/踢出成员等操作,音讯记录会被保存并可供获取;与常见群组分裂等的地点实际显示为:

  • 不援协助调查询成员列表,你能够透过相关 API 查询在线人数;
  • 不补助离线新闻、离线推送布告等作用;
  • 从未有过成员进入、离开的文告;
  • 二个用户3次登录只好进入三个怒放聊天室,参预新的开放聊天室后会自动离开原先的聊天室;
  • 进入后半时辰内断网重连会活动进入原聊天室,当先那几个时刻则必要重新参预;

一定的公文聊天

驾驭了那八个概念之后,大家就足以先河进入实际聊天环节了。

率先大家须求在 application 的 onCreate 函数中展开 LeanCloud
最主题的早先化:

@Override
public void onCreate() {
  super.onCreate();
  AVOSCloud.initialize(this, "pleaseReplaceWithYourAppId", "pleaseReplaceWithYourAppKey");
}

接下去我们来看一下哪些进行一对1的着力聊天。首先,大家需求开启三个会话(Session),示例代码如清单
二 所示:

SessionManager session = SessionManager.getInstance(selfId);//获取SessionManager实例,以便于后续的操作。这里的 selfId 可以是用户的实际 id,也可以是其他唯一的字符串,譬如「Tom」。
List<String> watchedIds = new LinkedList<String>();
session.open(watchedIds); //打开Session,同时关注一些 PeerID。此时没有关注对象

注意!

1般而言,会话的开启是在用户登录之后的 RootActivity
中开展的。对于帮助匿名聊天的使用,也足以在 Application
运维的时候进行。千万不要在一个最近或短暂的 Activity
中拉开聊天会话。上边代码中 SessionManager 也是 Session
的子类,所以可以直接调用 Session 的不二等秘书诀。

接下去,大家开始跟「Bob」那么些用户展开聊天。为了给她发送消息,大家先要关切(watch)他,代码如下:

List<String> peerIds = new LinkedList<String>();
peerIds.add("Bob");
session.watchPeers(peerIds);

现在大家给「鲍伯」发送一条新闻:

List<String> peerIds = new LinkedList<String>();
peerIds.add("Bob");
session.sendMessage(new AVMessage("嗨,你好,我是 Tom", peers, false));

好了,那样一条音讯就发送过去了。然而难题来了,对于「Bob」而言,他怎么才能接过外人发给她的音讯呢?

地点对于 Session 的富有操作都是异步的。与1般 Android
异步方法调用不一致,LeanMessage SDK 的异步并不是因此 Callback 或者类似
RubiconsyncTask 的体制完成的,而是通过持续 AVMessageReceiver 这一BoardcastReceiver,完毕以下办法来拍卖来自服务器端的响应的。AVMessageReceiver
接口定义如清单 三 所示:

/**
 * 当服务器成功与客户端打开session时产生本次回调
 */
public abstract void onSessionOpen(Context context, Session session);

/**
 * 在 session 暂停时调用,一般都是由网络连接丢失导致的隐性调用
 */
public abstract void onSessionPaused(Context context, Session session);

/**
 * Session 恢复时,一般都是网络连接恢复以后的
 * 这个时候你可以处理一些由于网络异常导致的失败消息
 */
public abstract void onSessionResumed(Context context, Session session);

/**
 * 从某个Peer接收到消息时,会收到一次调用
 */
public abstract void onMessage(Context context, Session session,
        AVMessage msg);

/**
 * 服务器反馈消息已经成功发送时,会收到调用
 */
public abstract void onMessageSent(Context context, Session session,
        AVMessage msg);

/**
 * 在消息发送失败时,产生的调用 在这里你可以保存一下发送失败的消息以便未来重发
 */
public abstract void onMessageFailure(Context context, Session session,
        AVMessage msg);

/**
 * 当关注的一些peers上线时,产生的调用
 */
public abstract void onStatusOnline(Context context, Session session,
        List<String> peerIds);

/**
 * 当关注的一些peers下线时,产生的调用
 */
public abstract void onStatusOffline(Context context, Session session,
        List<String> peerIds);

/**
 * 当与服务器发生交互的过程中的任何错误,都在这里被返回
 */
public abstract void onError(Context context, Session session, Throwable e);

从地点接口的定义中,我们能够见到,要收下到人家发过来的消息,只供给响应
onMessage() 方法即可。代码示例如清单 4 所示:

public class CustomeMsgReceiver extends AVMessageReceiver {
    @Override
    public void onMessage(final Context context, Session session, AVMessage avMsg) {
        Logger.d("onMessage "+avMsg.getMessage());
        // 进行上层逻辑处理,譬如 UI 展示,或者消息提醒。
    }
}

// 在 AndroidManifest.xml 文件中声明这一 BoardcastReceiver。
<receiver android:name=".receiver.CustomeMsgReceiver">
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
        <action android:name="com.avoscloud.session.action" />
    </intent-filter>
</receiver>

往群组发送新闻

出殡新闻非凡简单,与日前单聊的光景一样。

我们会专注到,AVIMConversation 还有2个出殡和埋葬音讯的艺术:

public void sendMessage(final AVIMMessage message, final int messageFlag,
      final AVIMConversationCallback callback)

而那边 flag 的概念有如下叁体系型:

  • 暂态音讯(AVIMConversation.TRANSIENT_MESSAGE_FLAG)。那种消息不会被自动保存(未来在历史消息中不能够找到它),也不援救延迟接收,离线用户更不会吸收接纳推送公告,所以适合用来做控制协议。譬如聊天进程中「某某正在输入中…」那样的情形音讯,就适合通过暂态新闻来发送。
  • 普普通通信息(AVIMConversation.NONTRANSIENT_MESSAGE_FLAG)。那种消息正是大家最常用的新闻类型,在
    LeanCloud
    云端会活动保存起来,协助延迟接收和离线推送,未来在历史音讯中可以找到它。
  • 待回执音信(AVIMConversation.RECEIPT_MESSAGE_FLAG)。这也是一种家常音讯,只是音讯被对方接收之后
    LeanCloud 服务端会发送2个回执布告给发送方(那正是AVIMMessageHandler 中
    public void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client)
    函数被调用的空子)。

结束语

LeanMessage
是三个相当安静可信的闲聊服务平台,提供的功力也得以满意大家利用开发者的要求。那里本人透过介绍
LeanMessage API 来兑现应用内的单聊、群聊、富媒体音讯等基本作用,但是LeanMessage 还帮助越来越多高阶功效,譬如 Super
Peer、敏感词过滤、信息实时监听等等,有趣味的朋友能够持续探索。

多少个至关心尊崇要的回调接口

从上边包车型大巴例证中能够看出,要收下到别人给您发送的信息,须要重载
AVIMMessageHandler 类。从 v2 版发轫,LeanCloud IM SDK
多量利用回调来举报操作结果,然则对于部分悲哀的音讯通告,则依旧利用接口来贯彻的,包涵:

  • 此时此刻互连网出现转移
  • 对话中有新的音信
  • 对话中有新成员参与
  • 对话中有成员离开
  • 被特邀出席某对话
  • 被踢出对话

LeanCloud IM SDK 内部选用了三种接口来响应这几个事件。

加入聊天室

由于1切实时通讯成效都以创制在 Session
的功底上,所以大家要进入2个聊天室也急需建立在一个业已打开的 Session
上。 已经打开三个 Session 今后,能够通过以下操作来出席三个 Group:

    Group group = SessionManager.getInstance(selfId).getGroup();//准备新建一个聊天室
    //Group group = SessionManager.getInstance(selfId).getGroup(groupId); 加入一个已经存在的聊天室
    group.join(); // LeanMessage 云端会判断 groupId 是否存在,如果不存在就新建一个 Group,否则加入已有 Group

投入成功未来 AVGroupMessageReceiver 子类中的 onJoined 方法就会被调用。

参与开放聊天室

若是任何极端用户都足以进入开放聊天室。作为开发者,大家得以因此通过特定条件检索到具备开放聊天室,然后允许用户自由进入,其演示代码为:

conversation.join(new AVIMConversationCallback(){
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了:(
    } else {
      // 成功,此时可以进入聊天界面了。。。
      Intent intent = new Intent(currentActivity, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      currentActivity.startActivity(intent);
    }
  }
});

收取聊天室音信

接受多个聊天室的音讯,与选拔单聊的音讯未有差距于,必要开发者完结AVGroupMessageReceiver 接口,并在 AndroidManifest.xml
中登记即可,如代码清单 八 所示:

public class CustomeGroupMsgReceiver extends AVGroupMessageReceiver {
    ...
    @Override
    public void onMessage(final Context context, Group group, AVMessage avMsg) {
        Logger.d("onMessage "+avMsg.getMessage());
        // 进行上层逻辑处理,譬如 UI 展示,或者消息提醒。
    }
    ...
}

// 在 AndroidManifest.xml 文件中声明这一 BoardcastReceiver。
<receiver android:name=".receiver.CustomeGroupMsgReceiver">
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
        <action android:name="com.avoscloud.session.action" />
    </intent-filter>
</receiver>

互连网事件响应接口

第二用以处理网络生成事件,接口定义在
AVIMClientEventHandler,首要函数为:

  /**
   * 实现本方法以处理网络断开事件
   */
  public abstract void onConnectionPaused(AVIMClient client);

  /**
   * 实现本方法以处理网络恢复事件
   */
  public abstract void onConnectionResume(AVIMClient client);

在互连网中断的情景下,全体的消息收发和对话操作都会冒出难点。

通过 AVIMClient.setClientEventHandler(AVIMClientEventHandler handler)
能够设定全局的 Client伊夫ntHandler。

询问历史消息

LeanMessage 会将非暂态音信自动保存在云端,之后开发者能够由此AVHistoryMessageQuery 那个目的来拓展查询。AVHistoryMessageQuery
定义如清单 11 所示:

public class AVHistoryMessageQuery {
    int limit;
    String convid;
    String from;
    long timestamp;

    /**
     * 设置查询返回集合的大小
     * 默认100,最大1000
     */
    public void setLimit(int limit);

    /**
     * 设定聊天的发起人是谁
     */
    public void setFrom(String from);

    /**
     * 设置查询从哪个时间开始的聊天记录
     */
    public void setTimestamp(long timestamp);

    /**
     * 指定聊天记录查询条件中,聊天发送的对象条件
     */
    public void setPeerIds(List<String> peerIds);

    /**
     * 同步方法查询聊天记录
     * 请确保在一个异步方法中调用此方法,否则会出现UI线程中的网络请求而导致的UI卡死
     */
    public List<AVHistoryMessage> find() throws AVException;

    /**
     * 异步方法查询聊天记录
     */
    public void findInBackground(HistoryMessageCallback callback);

    /**
     * 此接口为异步查询聊天记录的回调类
     */
    public static interface HistoryMessageCallback;
}

由此 AVHistoryMessageQuery 查询获得的结果是
AVHistoryMessage,该类的概念如清单 1二 所示:

public class AVHistoryMessage extends AVMessage {
    /**
     * 查看是否属于聊天室聊天记录
     */
    public boolean isRoom();

    /**
     * 查看聊天记录所在的conversation Id,对于 Group 来说等于 GroupID,对于单聊来说,是内部生成的一个值。
     */
    public String getConvid();
}

聊天记录的查询的为主办法跟 AVQuery 类似可是略有区别。 针对 Session
的聊天记录和聊天室 Group
的聊天记录查询略有差别,不过基本流程是平等(代码清单 1二):

       String selfId = "Tom";
       SessionManager sm = SessionManager.getInstance(selfId);
       List<String> peers = new ArrayList<String>();
       peers.add(selfId);
       peers.add("Bob");
       AVHistroyMessageQuery sessionHistoryQuery = sm.getHistroyMessageQuery();
       sessionHistoryQuery.setLimit(100);  //设置查询结果大小
       sessionHistoryQuery.setPeerIds(peers); // 设置单聊的参与方,多个参与者之间是「与」的关系
       sessionHistoryQuery.setTimestamp(1413184345686);  //查询时间片1413184345686以前的聊天记录
       sessionHistoryQuery.findInBackground(new HistoryMessageCallback() {
             @Override
             public void done(List<AVHistoryMessage> messages, AVException error) {
                  System.out.println(messages.size());
             }
       });//查询session里的聊天记录

       Group group = sm.getGroup("140a534fd092809500e6d651e73400c7");
       AVHistroyMessageQuery groupHistoryQuery = group.getHistoryMessageQuery();//获取AVHistoryMessageQuery对象来查询聊天室的聊天记录
       groupHistoryQuery.findInBackground(new HistoryMessageCallback(){
            @Override
            public void done(List<AVHistoryMessage> messages,AVException error){
              for(AVHistoryMessage msg:messages){
                 System.out.println(msg.getMessage());
              }
            }
       })

地方第一个查询会获得「汤姆」和「Bob」在特定时间点此前的 十0
条聊天记录;第3个查询会获得特定聊天室的全部聊天记录(若是总数不超过一千 条的话)。

图像音信(AVIMImageMessage)

AVIMFileMessage
子类,专门用来发送图像和附带文本的混合音讯,其构造函数证明为:

// 传入本地文件路径,构造消息对象
public AVIMImageMessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMImageMessage(File localFile) throws FileNotFoundException, IOException;
// 传入 AVFile 实例,构造消息对象
public AVIMImageMessage(AVFile file);

发送图像消息的示范代码为:

String localImagePath;
try {
  AVIMImageMessage message = new AVIMImageMessage(localImagePath);
  message.setText("你说我好看不?");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

选取到那般音讯随后,开发者能够因而如下方法,获取到多少图像元数据(width,height,图像
size)和一个分包图像数据的 AVFile 对象:

  • int getWidth() 方法会重返图像的宽度(单位:pixel)
  • int getHeight() 方法会再次来到图像的万丈(单位:pixel)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会再次回到八个图像文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会再次回到图像文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会重返图像文件的实在尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会重回随图像壹起发送的公文音讯。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)能够获得图像的其他元数据消息。

启用离线新闻推送(仅对 iOS 平台用户有效)

不论是是单聊依旧群聊,当用户 A
发出消息后,如若指标对话中有一对用户最近不在线,LeanCloud
云端能够提供离线推送的方法来唤起用户。那一成效暗许是关门的,你能够在
LeanCloud 应用控制罗利打开它。开启方法如下:

  • 签到 LeanCloud 应用控制台,选取正确的选取进入;
  • 慎选最顶端的「音信」服务,依次点击左边菜单「实时新闻」->「设置」;
  • 在左边「iOS
    用户离线时的推送内容」下填好您要推送出去的信息内容,保存;

这么 iOS 平台上的用户就能够选择 Push Notification
了(当然,前提是行使自身申请到了 RemoteNotification
权限,也将正确的推送证书上传到了 LeanCloud 控制台)。

群组音信免骚扰(仅对 iOS 平台用户有效)

任凭是单聊依然群聊,对于发往普通的 Conversation
的常备音讯,即便接收方当前不在线,LeanCloud 云端帮助通过 Push
Notification
的不二等秘书诀实行提示。1般景况下这都以很好的,可是假诺有个别群组特别活泼,这离线用户就会接到过多的推送,会形成非常大的滋扰。

对此 LeanCloud IM 服务也允许单个用户来关闭/打开有个别对话的离线推送功效。

文本音信(AVIMFileMessage)

AVIMTypedMessage
子类,用来发送带附件的音讯,开发者能够用它来发送「离线文件」。对于此类消息,LeanCloud
IM SDK 内部会先把文件上传到 LeanCloud 文件存款和储蓄服务器(自带 CDN
作用),然后把公文元数据(url,文件大小等等)放在新闻包内发送到
LeanCloud 实时通讯服务端。其构造函数注脚为:

// 传入本地文件路径,构造消息对象
public AVIMFileessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMFileMessage(File localFile) throws FileNotFoundException, IOException;
// 传入 AVFile 实例,构造消息对象
public AVIMFileMessage(AVFile file);

与公事音讯看似,文件新闻也援救附带文本和别的自定义属性,能够由此如下方法添加
/ 获取愈多新闻:

  • String getText() / void setText(String text)
  • Map<String, Object> getAttrs() / void setAttrs(Map<String,
    Object> attr);

出殡文书新闻的言传身教代码为:

String localZipfilePath;
try {
  AVIMFileMessage message = new AVIMFileMessage(localZipfilePath);
  message.setText("这是你要的文档");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

接过到这么音讯之后,开发者可以透过以下措施,获取到文件元数据(size
等)和1个分包二进制数据的 AVFile 对象:

  • AVFile getAVFile() 方法会重返1个2进制文件的 AVFile
    实例,之后能够通过 AVFile 来成功数据下载大概其余操作,具体能够参见
    AVFile
    说明
  • String getFileUrl() 方法会重回贰进制文件的 url
  • long getSize() 方法会再次来到二进制文件的实在尺寸(单位:byte)
  • Map<String, Object> getFileMetaData()
    能够获取2进制文件的别的元数据音讯。

简介

自去年 LeanCloud
公布实时通讯(IM)服务之后,基于用户反映和工程师对需要的消化和对工作的提炼,上周标准颁发了「实时通信二.0
」。设计意见依然是「灵活、解耦、可组成、可定制」,具体能够参照《实时通讯支出指南》,了然LeanCloud 实时通讯的基本概念和模型。

哪些吸收富媒体新闻

新版 LeanCloud IM SDK 内部封装了对富媒体新闻的扶助,全数富媒体音讯都是从
AVIMTypedMessage 派生出来的。发送的时候能够一向调用
conversation.sendMessage()
函数。在接收端,大家也特意扩大了壹类回调接口
AVIMTypedMessageHandler,其定义为:

public class AVIMTypedMessageHandler<T extends AVIMTypedMessage> extends MessageHandler<T> {

  @Override
  public void onMessage(T message, AVIMConversation conversation, AVIMClient client);

  @Override
  public void onMessageReceipt(T message, AVIMConversation conversation, AVIMClient client);
}

开发者能够编写自个儿的消息处理 handler,然后调用
AVIMMessageManager.registerMessageHandler(Class<? extends AVIMMessage> clazz, MessageHandler<?> handler)
函数来注册目的 handler。

接收端对于富媒体消息的通报处理的示范代码如下:

class MsgHandler extends AVIMTypedMessageHandler<AVIMTypedMessage> {

  @Override
  public void onMessage(AVIMTypedMessage message, AVIMConversation conversation, AVIMClient client) {
    // 请按自己需求改写
    switch(message.getMessageType()) {
    case AVIMReservedMessageType.TextMessageType:
      AVIMTextMessage textMsg = (AVIMTextMessage)message;
      Logger.d("收到文本消息:" + textMsg.getText() + ", msgId:" + textMsg.getMessageId());
      break;
    case AVIMReservedMessageType.FileMessageType:
      AVIMFileMessage fileMsg = (AVIMFileMessage)message;
      Logger.id("收到文件消息。msgId=" + fileMsg.getMessageId() + ", url=" + fileMsg.getFileUrl() + ", size=" + fileMsg.getSize());
      break;
    case AVIMReservedMessageType.ImageMessageType:
      AVIMImageMessage imageMsg = (AVIMImageMessage)message;
      Logger.id("收到图片消息。msgId=" + imageMsg.getMessageId() + ", url=" + imageMsg.getFileUrl() + ", width=" + imageMsg.getWidth() + ", height=" + imageMsg.getHeight());
      break;
    case AVIMReservedMessageType.AudioMessageType:
      AVIMAudioMessage audioMsg = (AVIMAudioMessage)message;
      Logger.id("收到音频消息。msgId=" + audioMsg.getMessageId() + ", url=" + audioMsg.getFileUrl() + ", duration=" + audioMsg.getDuration());
      break;
    case AVIMReservedMessageType.VideoMessageType:
      AVIMVideoMessage videoMsg = (AVIMAudioMessage)message;
      Logger.id("收到视频消息。msgId=" + videoMsg.getMessageId() + ", url=" + videoMsg.getFileUrl() + ", duration=" + videoMsg.getDuration());
      break;
    case AVIMReservedMessageType.LocationMessageType:
      AVIMLocationMessage locMsg = (AVIMLocationMessage)message;
      Logger.id("收到位置消息。msgId=" + locMsg.getMessageId() + ", latitude=" + locMsg.getLocation().getLatitude() + ", longitude=" + locMsg.getLocation().getLongitude());
      break;
    }
  }

  @Override
  public void onMessageReceipt(AVIMTypedMessage message, AVIMConversation conversation, AVIMClient client) {
  }
}
MsgHandler msgHandler = new MsgHandler();
AVIMMessageManager.registerMessageHandler(AVIMTypedMessage.class, msgHandler);

LeanCloud IM SDK 内部音讯分发的逻辑是这么的:对于收到的任一新音讯,SDK
内部都会先解析音讯的项目,根据项目找到开发者为那壹档次注册的拍卖
handler,然后逐一调用这几个 handler 的 onMessage
函数。即便未有找到专门处理那1体系音信的 handler,就会传递给
defaultHandler 处理。

那样壹来,在开发者为 TypedMessage(及其子类) 钦赐了尤其的
handler,也内定了大局的 defaultHandler
了的时候,如若发送端发送的是通用的 AVIMMessage 音信,那么接受端正是
AVIMMessageManager.registerDefaultMessageHandler()中钦赐的 handler
被调用;假若发送的是 AVIMTypedMessage(及其子类)的信息,那么接受端正是
AVIMMessageManager.registerMessageHandler()中钦命的 handler 被调用。

文件新闻(AVIMTextMessage)

AVIMTypedMessage 子类,表示1般的文书新闻,其声称为

public class AVIMTextMessage extends AVIMTypedMessage {
  public String getText();
  public void setText(String text);

  public Map<String, Object> getAttrs();
  public void setAttrs(Map<String, Object> attr);
}

能够看到,对于文本音讯,重要的习性有 textattr 多少个,通过不难的
getter/setter 就能够访问到。要发送文书音信,示例代码为:

AVIMTextMessage message = new AVIMTextMessage();
message.setText("hello");
conversation.sendMessage(message, new AVIMConversationCallback() {
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      Logger.d("message sent.");
    }
  }
});

365体育网投,赢得历史新闻

LeanMessage 会将非暂态新闻自动保存在云端,之后开发者可以透过
AVIMConversation 来取得该对话的持有历史音信。获取历史新闻的 API 如下:

String oldestMsgId;
long oldestMsgTimestamp;
conversation.queryMessages(oldestMsgId,oldestMsgTimestamp, limit, new AVIMHistoryMessageCallback(){
  @Override
  public void done(List<AVIMMessage> messages, AVException e) {
    if (null != e) {
      // 出错了:(
    } else {
      // 成功,可以将消息加入缓存,同时更新 UI
    }
  }
});

注意:
取得历史新闻的时候,LeanCloud
云端是从某条消息初始,往前寻找开发者钦点的 N
条新闻,重临给客户端。为此,获取历史新闻须求传入七个参数:开头新闻的
msgId,开始音讯的出殡和埋葬时间戳,须求获得的音讯条数。

经过那壹 API 获得的新闻正是 AVIMMessage 依旧 AVIMTypedMessage
实例数组,开发者能够像此前接受新音信通告一致处理。

地理地点新闻(AVIMLocationMessage)

AVIMTypedMessage
子类,帮衬发送地理地点音信和附带文本的混合音信,其注解为:

public class AVIMLocationMessage extends AVIMTypedMessage {
  public String getText();
  public void setText(String text);

  public Map<String, Object> getAttrs();
  public void setAttrs(Map<String, Object> attr);

  public AVGeoPoint getLocation();
  public void setLocation(AVGeoPoint location);
}

与公事新闻看似,地理地方音讯只是增多了三个 AV吉优Point 的 Location
属性。要发送地方新闻的言传身教代码为:

AVIMLocationMessage message = new AVIMLocationMessage();
message.setText("快点过来!");
message.setLocation(new AVGeoPoint(15.9, 56.4));
conversation.sendMessage(message, new AVIMConversationCallback() {
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      Logger.d("message sent");
    }
  }
});

收起到这么的新闻之后,开发者能够收获到具体的地理地点数据。

创建开放聊天室

和平日的群组类似,建立二个绽放聊天室也是一点也不细略的,只是在
AVIMClient.createConversation(conversationMembers, name, attributes, isTransient, callback)
中大家需求传入 isTransient=true 选项。例如:

Map<String, Object> attr = new HashMap<String, Object>();
attr.put("type", ConversationType_Group);
imClient.createConversation(clientIds, name, attr, true, new AVIMConversationCreatedCallback() {
  @Override
  public void done(AVIMConversation conversation, AVException e) {
    if (null != conversation) {
      // 成功了,进入聊天室
      Intent intent = new Intent(currentActivity, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      currentActivity.startActivity(intent);
    }
  }
});

始建成功之后,我们就足以进来聊天界面了。开放聊天室的其他操作,都与常见群组操作一样。

支撑富媒体的闲话新闻

上边的代码演示了怎么发送简单文本新闻,可是未来的交互格局已经特别各个化,图像、语音、摄像已是非日常见的音信类型。v二版的 LeanCloud IM SDK 已经能够很好地帮忙那个富媒体音讯,具体表明如下:

出殡消息

成立好对话之后,要发送音信是很简短的:

AVIMMessage message = new AVIMMessage();
message.setContent("hello");
conversation.sendMessage(message, new AVIMConversationCallback() {
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      Logger.d("发送成功,msgId=" + message.getMessageId());
    }
  }
});

好了,这样一条新闻就发送过去了。然则难点来了,对于「Bob」而言,他怎么才能采纳外人发给她的音讯吧?

初始化

和 LeanCloud 其余服务壹样,实时聊天服务的初步化也是在 Application 的
onCreate 方法中开始展览的:

public class MyApplication extends Application{

    public void onCreate(){
      ...
      AVOSCloud.initialize(this,"{{appId}}","{{appKey}}");
      ...
    }
}

并且在AndroidManifest.xml中间评释:

<manifest>
   ...

   <application
        android:name=".MyApplication"
        ....>
        ...

        <service android:name="com.avos.avoscloud.PushService" />

        <receiver android:name="com.avos.avoscloud.AVBroadcastReceiver">
            <intent-filter>
                <action android:name="android.intent.action.BOOT_COMPLETED" />
                <action android:name="android.intent.action.USER_PRESENT" />
            </intent-filter>
        </receiver>
        ...
   </application>

</manifest>

接下去大家须要做到用户登录。

询问在线人数

通过 AVIMConversation.getMemberCount()
方法能够实时查询开放聊天室的在线人数。示例代码如下:

conversation.getMemberCount(new AVIMConversationMemberCountCallback(){
  @Override
  public void done(Integer memberCount, AVException e) {
    if (null != e) {
      // 出错了:(
    } else {
      // 成功,此时 memberCount 的数值就是实时在线人数
    }
  }
});

搜寻群组

任由是单聊,照旧群聊,在 LeanCloud IM SDK
里面都以对话(Conversation)。我们给对话设置了如下二种天性:

  • conversationId,字符串,对话 id,只读,对话创制之后由 LeanCloud
    云端赋予三个大局唯1的 id。
  • creator,字符串,对话创制者 id,只读,标识对话创设者新闻
  • members,数组,对话加入者,那里记录了拥有的参加者
  • name,字符串,对话的名字,optional,可用来对于群组命名
  • attributes,Map/Dict,自定义属性,optional,供开发者本人壮大用。

我们提供了尤其的类,来查找一定的群组:通过 imClient.getQuery()
获得二个 AVIMConversationQuery 实例,然后调用
AVIMConversationQuery.wherexxx
文山会海措施来充实约束原则。例如要摸索当前报到用户加入的全数群聊对话,其代码为

// 搜索 Tom 参与的所有群组对话
List<String> clients = new ArrayList<String>();
clients.add("Tom");
AVIMConversationQuery conversationQuery = imClient.getQuery();
conversationQuery.containsMember(clients);

// 之前有常量定义:
// const int ConversationType_OneOne = 0;
// const int ConversationType_Group = 1;
conversationQuery.whereEqualTo("attr.type", ConversationType_Group);

conversationQuery.findInBackground(new AVIMConversationQueryCallback(){
  @Override
  public void done(List<AVIMConversation> conversations, AVException e) {
    if (null != e) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      if (null != conversation) {
        Logger.d("找到了符合条件的 " + conversations.size() + " 个对话");
      } else {
        Logger.d("没有找到符合条件的对话");
      }
    }
  }
});

AVIMConversationQuery 中设置条件的法门与 AVQuery 类似。这里
conversationQuery.containsMember()
表示对话的积极分子中足足含有这个职员,可用来依据部分成员查找对话;与此类似的还有三个
conversationQuery.withMembers()
则表示有且仅有那些分子,用来依照全体成员查找指标对话;conversationQuery.whereXXX()
雨后苦笋措施可用来界定对话名称和自定义属性,这里要强调的一些是,对于自定义属性的束缚原则,属性名一定要以
attr 初始,如上例所示,限定额外的 type 条件的时候需求钦点的属性名是
attr.type。具体能够参见其头文件。

签署和云浮

为了满意开发者对权力和认证的渴求,LeanCloud
还安排了操作签名的体制。大家可以在 LeanCloud
应用控制奥兰多的「设置」->「应用选项」->「聊天推送」下边勾选「聊天服务签约认证」来启用签名(强烈推荐那样做)。启用后,全部的用户登录、对话创制/参加、特邀成员、踢出成员等操作都急需验证签名,那样开发者就能够对音信实行丰裕的主宰。

客户端那边终究该怎么运用呢?大家只需求贯彻 SignatureFactory
接口,然后在用户登录从前,把那些接口的实例赋值给 AVIMClient
即可(AVIMClient.setSignatureFactory(factory))。

设定了 signatureFactory 之后,对于急需鉴权的操作,LeanCloud IM SDK
与服务器端通讯的时候都会带上应用本人生成的 Signature 消息,LeanCloud
云端会利用 app 的 masterKey 来证实消息的卓有作用,保证聊天渠道的平安。

对此 SignatureFactory 接口,大家只须求达成那八个函数即可:

  /**
   * 实现一个基础签名方法 其中的签名算法会在SessionManager和AVIMClient(V2)中被使用
   */
  public Signature createSignature(String peerId, List<String> watchIds) throws SignatureException;

  /**
   * 实现AVIMConversation相关的签名计算
   */
  public Signature createConversationSignature(String conversationId, String clientId,
      List<String> targetIds, String action) throws SignatureException;

createSignature
函数会在用户登录的时候被调用,createConversationSignature
会在对话创制/参预、邀约成员、踢出成员等操作时被调用。

您须要做的正是遵纪守法前文所述的签名算法完成签订契约,个中 Signature
表明如下:

public class Signature {
  public List<String> getSignedPeerIds();
  public void setSignedPeerIds(List<String> signedPeerIds);

  public String getSignature();
  public void setSignature(String signature);

  public long getTimestamp();
  public void setTimestamp(long timestamp);

  public String getNonce();
  public void setNonce(String nonce);
}

在那之中八本性子分别是:

  • signature 签名
  • timestamp 时间戳,单位秒
  • nonce 随机字符串 nonce
  • signedPeerIds 放行的 clientId 列表,v2 中已经丢掉不用

上面的代码展示了依照 LeanCloud
云代码举行签订契约时,客户端的落到实处部分,你能够参见它来完毕本身的逻辑完成:

public class KeepAliveSignatureFactory implements SignatureFactory {
 @Override
 public Signature createSignature(String peerId, List<String> watchIds) {
   Map<String,Object> params = new HashMap<String,Object>();
   params.put("self_id",peerId);
   params.put("watch_ids",watchIds);

   try{
     Object result =  AVCloud.callFunction("sign",params);
     if(result instanceof Map){
       Map<String,Object> serverSignature = (Map<String,Object>) result;
       Signature signature = new Signature();
       signature.setSignature((String)serverSignature.get("signature"));
       signature.setTimestamp((Long)serverSignature.get("timestamp"));
       signature.setNonce((String)serverSignature.get("nonce"));
       return signature;
     }
   }catch(AVException e){
     throw (SignatureFactory.SignatureException) e;
   }
   return null;
 }

  @Override
  public Signature createConversationSignature(String convId, String peerId, List<String> targetPeerIds,String action){
   Map<String,Object> params = new HashMap<String,Object>();
   params.put("self_id",peerId);
   params.put("group_id",convId);
   params.put("group_peer_ids",targetPeerIds);
   params.put("action",action);

   try{
     Object result = AVCloud.callFunction("group_sign",params);
     if(result instanceof Map){
        Map<String,Object> serverSignature = (Map<String,Object>) result;
        Signature signature = new Signature();
        signature.setSignature((String)serverSignature.get("signature"));
        signature.setTimestamp((Long)serverSignature.get("timestamp"));
        signature.setNonce((String)serverSignature.get("nonce"));
        return signature;
     }
   }catch(AVException e){
     throw (SignatureFactory.SignatureException) e;
   }
   return null;
  }
}

LeanCloud IM SDK
专注做好底层的电视发表服务,有更加多能够定制化的地点,譬如说:

  • 账户种类和 IM 系统是分手的;
  • 音讯成为离线推送的时候,推送内容开发者是能够定制的;
  • 通过 web hook,开发者能够对消息举办越来越多处理;
  • 闲聊进程中通过新闻鉴权机制,开发者能够有更加多控制;

因为贫乏 UI
组件,实事求是地讲在新用户接入花费只怕稍高,可是在事情规模扩大、产品必要变多未来,相信大家会进一步喜欢
LeanCloud 那种自由灵活的运用体验,以及稳定飞速的劳务品质。

相关文章