IM

  • IM > API 文档 > ANDROID API > BMXChatService

    BMXChatService

    最近更新时间:2021-07-19 10:55:33

    类 BMXChatService

    • java.lang.Object

      • im.floo.floolib.BMXChatService

    • public class BMXChatService
      extends java.lang.Object
      

      聊天Service

      • 字段详细资料

        • swigCMemOwn

          protected transient boolean swigCMemOwn
          
      • 构造器详细资料

        • BMXChatService

          protected BMXChatService(long cPtr,
                                   boolean cMemoryOwn)
          
      • 方法详细资料

        • getCPtr

          protected static long getCPtr(BMXChatService obj)
          
        • finalize

          protected void finalize()
          

          覆盖:

          finalize 在类中 java.lang.Object

        • delete

          public void delete()
          
        • sendMessage

          public void sendMessage(BMXMessage msg)
          

          发送消息,消息状态变化会通过listener通知

          参数:

          msg - 发送的消息

        • resendMessage

          public void resendMessage(BMXMessage msg)
          

          重新发送消息,消息状态变化会通过listener通知

          参数:

          msg - 重新发送的消息

        • recallMessage

          public void recallMessage(BMXMessage msg)
          

          撤回消息,消息状态变化会通过listener通知

          参数:

          msg - 撤回的消息

        • forwardMessage

          public BMXErrorCode forwardMessage(BMXMessageList list,
                                             BMXConversation to,
                                             BMXMessage newMsg)
          

          合并转发消息

          参数:

          list - 转发的消息列表

          to - 消息被转发到的会话

          newMsg - 转发的消息列表合并后生成的新的单条转发消息

          返回:

          BMXErrorCode

        • forwardMessage

          public void forwardMessage(BMXMessage msg)
          

          简单转发消息,用户应当通过BMXMessage::createForwardMessage()先创建转发消息

          参数:

          msg - 转发的消息

        • ackMessage

          public void ackMessage(BMXMessage msg)
          

          发送已读回执

          参数:

          msg - 需要发送已读回执的消息

        • ackPlayMessage

          public void ackPlayMessage(BMXMessage msg)
          

          发送已播放回执

          参数:

          msg - 需要发送已读回播放的消息

        • readCancel

          public void readCancel(BMXMessage msg)
          

          标记此消息为未读,该消息同步到当前用户的所有设备

          参数:

          msg - 需要发送消息已读取消的消息

        • readAllMessage

          public void readAllMessage(BMXMessage msg)
          

          标记此消息及之前全部消息为已读,该消息同步到当前用户的所有设备

          参数:

          msg - 需要标记为此消息以前全部消息为已读的消息

        • removeMessage

          public void removeMessage(BMXMessage msg,
                                    boolean synchronize)
          

          删除此消息,该消息同步到当前用户的其它设备

          参数:

          msg - 需要删除的消息

          synchronize - 是否同步到其它设备,不同步的情况下只会删除本地存储的该条消息

        • removeMessage

          public void removeMessage(BMXMessage msg)
          
        • downloadThumbnail

          public void downloadThumbnail(BMXMessage msg,
                                        BMXChatService.ThumbnailStrategy strategy)
          

          下载缩略图,下载状态变化和进度通过listener通知 缩略图生成策略,1 - 第三方服务器生成, 2 - 本地服务器生成,默认值是 1。

          参数:

          msg - 需要下载缩略图的消息

          strategy - 缩略图生成策略,1 - 第三方服务器生成, 2 - 本地服务器生成,默认值是 1。

        • downloadThumbnail

          public void downloadThumbnail(BMXMessage msg)
          
        • downloadAttachment

          public void downloadAttachment(BMXMessage msg)
          

          下载附件,下载状态变化和进度通过listener通知

          参数:

          msg - 需要下载附件的消息

        • downloadAttachmentByUrl

          public void downloadAttachmentByUrl(long msgId,
                                              java.lang.String url,
                                              java.lang.String path)
          

          下载附件,下载状态变化和进度通过listener通知

          参数:

          msgId - 需要下载附件的消息

          url - 文件远程地址

          path - 文件本地路径

        • cancelUploadAttachment

          public void cancelUploadAttachment(BMXMessage msg)
          

          取消上传附件

          参数:

          msg - 需要取消上传附件的消息

        • cancelDownloadAttachment

          public void cancelDownloadAttachment(BMXMessage msg)
          

          取消上传附件

          参数:

          msg - 需要取消上传附件的消息

        • insertMessages

          public BMXErrorCode insertMessages(BMXMessageList list)
          

          插入消息

          参数:

          list - 插入消息列表

          返回:

          BMXErrorCode

        • getMessage

          public BMXMessage getMessage(long msgId)
          

          读取一条消息

          参数:

          msgId - 需要获取消息的消息id

          返回:

          BMXMessage

        • deleteConversation

          public void deleteConversation(long conversationId,
                                         boolean synchronize)
          

          删除会话

          参数:

          conversationId - 需要删除会话的会话id

          synchronize - 是否同步删除其它设备该会话,默认为false,仅删除本设备会话

        • deleteConversation

          public void deleteConversation(long conversationId)
          
        • openConversation

          public BMXConversation openConversation(long conversationId,
                                                  BMXConversation.Type type,
                                                  boolean createIfNotExist)
          

          打开一个会话

          参数:

          conversationId - 需要打开的会话的会话id

          type - 会话的类型,单聊还是群聊。

          createIfNotExist - 会话不存在的情况下是否要创建本地会话,默认为创建

          返回:

          BMXConversation

        • openConversation

          public BMXConversation openConversation(long conversationId,
                                                  BMXConversation.Type type)
          
        • attachmentDir

          public java.lang.String attachmentDir()
          

          获取附件保存路径

          返回:

          std::string

        • attachmentDirForConversation

          public java.lang.String attachmentDirForConversation(long conversationId)
          

          获取会话的附件保存路径

          参数:

          conversationId - 需要获取会话附件路径的会话id

          返回:

          std::string

        • getAllConversations

          public BMXConversationList getAllConversations()
          

          获取所有会话

          返回:

          BMXConversationList

        • getAllConversationsUnreadCount

          public int getAllConversationsUnreadCount()
          

          获取所有会话的全部未读数(标记为屏蔽的个人和群组的未读数不统计在内)

          返回:

          int

        • retrieveHistoryMessages

          public BMXErrorCode retrieveHistoryMessages(BMXConversation conversation,
                                                      long refMsgId,
                                                      long size,
                                                      BMXMessageList result)
          

          拉取历史消息

          参数:

          conversation - 需要拉取历史消息的会话

          refMsgId - 拉取会话消息的起始消息Id

          size - 拉取的最大消息条数

          result - 拉取操作获取的消息列表,外部初始化传入空列表。

          返回:

          BMXErrorCode

        • searchMessagesByKeyWords

          public BMXErrorCode searchMessagesByKeyWords(java.lang.String keywords,
                                                       long refTime,
                                                       long size,
                                                       BMXMessageListList result,
                                                       BMXConversation.Direction arg4)
          

          搜索消息

          参数:

          keywords - 搜索的关键字

          refTime - 搜索消息的起始时间

          size - 搜索的最大消息条数

          result - 搜索到的消息结果列表,外部初始化传入空列表。

          arg4 - 消息搜索方向,默认(Direction::Up)是从更早的消息中搜索

          返回:

          BMXErrorCode

        • searchMessagesByKeyWords

          public BMXErrorCode searchMessagesByKeyWords(java.lang.String keywords,
                                                       long refTime,
                                                       long size,
                                                       BMXMessageListList result)
          
        • searchMessages

          public BMXErrorCode searchMessages(java.lang.String keywords,
                                             long refTime,
                                             long size,
                                             BMXMessageListList result,
                                             BMXConversation.Direction arg4)
          

          搜索消息

          参数:

          keywords - 搜索的关键字

          refTime - 搜索消息的起始时间

          size - 搜索的最大消息条数

          result - 搜索到的消息结果列表,外部初始化传入空列表。

          arg4 - 消息搜索方向,默认(Direction::Up)是从更早的消息中搜索

          返回:

          BMXErrorCode

        • searchMessages

          public BMXErrorCode searchMessages(java.lang.String keywords,
                                             long refTime,
                                             long size,
                                             BMXMessageListList result)
          
        • getGroupAckMessageUserIdList

          public BMXErrorCode getGroupAckMessageUserIdList(BMXMessage msg,
                                                           ListOfLongLong groupMemberIdList)
          

          获取发送的群组消息已读用户id列表

          参数:

          msg - 需要获取已读用户id列表的消息

          groupMemberIdList - 对该条消息已读的用户id列表,初始传入为空列表

          返回:

          BMXErrorCode

        • getGroupAckMessageUnreadUserIdList

          public BMXErrorCode getGroupAckMessageUnreadUserIdList(BMXMessage msg,
                                                                 ListOfLongLong groupMemberIdList)
          

          获取发送的群组消息未读用户id列表

          参数:

          msg - 需要获取未读用户id列表的消息

          groupMemberIdList - 对该条消息未读的用户id列表,初始传入为空列表

          返回:

          BMXErrorCode

        • getGroupPlayAckMessageUserIdList

          public BMXErrorCode getGroupPlayAckMessageUserIdList(BMXMessage msg,
                                                               ListOfLongLong groupMemberIdList)
          

          获取发送的群组消息已播放用户id列表

          参数:

          msg - 需要获取已播放用户id列表的消息

          groupMemberIdList - 对该条消息已播放的用户id列表,初始传入为空列表

          返回:

          BMXErrorCode

        • getGroupUnPlayAckMessageUserIdList

          public BMXErrorCode getGroupUnPlayAckMessageUserIdList(BMXMessage msg,
                                                                 ListOfLongLong groupMemberIdList)
          

          获取发送的群组消息未播放用户id列表

          参数:

          msg - 需要获取未播放用户id列表的消息

          groupMemberIdList - 对该条消息未播放的用户id列表,初始传入为空列表

          返回:

          BMXErrorCode

        • addChatListener

          public void addChatListener(BMXChatServiceListener listener)
          

          添加聊天监听者

          参数:

          listener - 聊天监听者

        • removeChatListener

          public void removeChatListener(BMXChatServiceListener listener)
          

          移除聊天监听者

          参数:

          listener - 聊天监听者

    以上内容是否对您有帮助?
  • Qvm free helper
    Close