Skip to content

ChatAPI.md

Latest commit

 

History

History
394 lines (270 loc) · 22.1 KB

ChatAPI.md

File metadata and controls

394 lines (270 loc) · 22.1 KB
Raw

RTM Server Java SDK Chat API Docs

Index

[TOC]

-------------------------发送聊天信息接口--------------------------

发送 P2P 聊天消息

// sync methods
long sendChat(long fromUid, long toUid, String message, String attrs);
long sendChat(long fromUid, long toUid, String message, String attrs, int timeoutInseconds);

// async methods
void sendChat(long fromUid, long toUid, String message, String attrs, SendMessageLambdaCallback callback);
void sendChat(long fromUid, long toUid, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送 P2P 控制命令

// sync methods
long sendCmd(long fromUid, long toUid, String message, String attrs);
long sendCmd(long fromUid, long toUid, String message, String attrs, int timeoutInseconds);

// async methods
void sendCmd(long fromUid, long toUid, String message, String attrs, SendMessageLambdaCallback callback);
void sendCmd(long fromUid, long toUid, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送多人 P2P 聊天消息

// sync methods
long sendChats(long fromUid, Set<Long> toUids, String message, String attrs);
long sendChats(long fromUid, Set<Long> toUids, String message, String attrs, int timeoutInseconds);

// async methods
void sendChats(long fromUid, Set<Long> toUids, String message, String attrs, SendMessageLambdaCallback callback);
void sendChats(long fromUid, Set<Long> toUids, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送多人 P2P 控制命令

// sync methods
long sendCmds(long fromUid, Set<Long> toUids, String message, String attrs);
long sendCmds(long fromUid, Set<Long> toUids, String message, String attrs, int timeoutInseconds);

// async methods
void sendCmds(long fromUid, Set<Long> toUids, String message, String attrs, SendMessageLambdaCallback callback);
void sendCmds(long fromUid, Set<Long> toUids, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送 Group 聊天消息

// sync methods
long sendGroupChat(long fromUid, long groupId, String message, String attrs);
long sendGroupChat(long fromUid, long groupId, String message, String attrs, int timeoutInseconds);

// async methods
void sendGroupChat(long fromUid, long groupId, String message, String attrs, SendMessageLambdaCallback callback);
void sendGroupChat(long fromUid, long groupId, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送 Group 控制命令

// sync methods
long sendGroupCmd(long fromUid, long groupId, String message, String attrs);
long sendGroupCmd(long fromUid, long groupId, String message, String attrs, int timeoutInseconds);

// async methods
void sendGroupCmd(long fromUid, long groupId, String message, String attrs, SendMessageLambdaCallback callback);
void sendGroupCmd(long fromUid, long groupId, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送 Room 聊天消息

// sync methods
long sendRoomChat(long fromUid, long roomId, String message, String attrs);
long sendRoomChat(long fromUid, long roomId, String message, String attrs, int timeoutInseconds);

// async methods
void sendRoomChat(long fromUid, long roomId, String message, String attrs, SendMessageLambdaCallback callback);
void sendRoomChat(long fromUid, long roomId, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送 Room 控制命令

// sync methods
long sendRoomCmd(long fromUid, long roomId,  String message, String attrs);
long sendRoomCmd(long fromUid, long roomId, String message, String attrs, int timeoutInseconds);

// async methods
void sendRoomCmd(long fromUid, long roomId, String message, String attrs, SendMessageLambdaCallback callback);
void sendRoomCmd(long fromUid, long roomId, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明：

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送 Broadcast 聊天消息

// sync methods
long sendBroadcastChat(long fromUid, String message, String attrs);
long sendBroadcastChat(long fromUid, String message, String attrs, int timeoutInseconds);

// async methods
void sendBroadcastChat(long fromUid, String message, String attrs, SendMessageLambdaCallback callback);
void sendBroadcastChat(long fromUid, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明:

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口, mtime以及 error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

发送 Broadcast 控制命令

// sync methods
long sendBroadcastCmd(long fromUid, String message, String attrs);
long sendBroadcastCmd(long fromUid, String message, String attrs, int timeoutInseconds);

// async methods
void sendBroadcastCmd(long fromUid, String message, String attrs, SendMessageLambdaCallback callback);
void sendBroadcastCmd(long fromUid, String message, String attrs, SendMessageLambdaCallback callback, int timeoutInseconds);

参数说明:

  • String attrs: 消息的属性信息，建议使用可解析的json字符串，默认为空字符串

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • SendMessageLambdaCallback callback: 为异步回调返回接口， mtime以及error信息将通过callback返回

      public interface SendMessageLambdaCallback{
      void done(long time, int errorCode, String errorMessage);
  }

返回值:

  • sync: 同步接口正常时返回mtime，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回mtime，或者error信息，当errorCode不等于ErrorCode.FPNN_EC_OK.value()，则为error返回，可查看message错误信息.

获取聊天

// sync methods
RTMHistoryMessageUnit getP2pChat(long messageId, long fromUid, long toUid);
RTMHistoryMessageUnit getP2pChat(long messageId, long fromUid, long toUid, int timeInseconds);
RTMHistoryMessageUnit getGroupChat(long messageId, long fromUid, long groupId);
RTMHistoryMessageUnit getGroupChat(long messageId, long fromUid, long groupId, int timeInseconds);
RTMHistoryMessageUnit getRoomChat(long messageId, long fromUid, long roomId);
RTMHistoryMessageUnit getRoomChat(long messageId, long fromUid, long roomId, int timeInseconds);
RTMHistoryMessageUnit getBroadcastChat(long messageId, long fromUid);
RTMHistoryMessageUnit getBroadcastChat(long messageId, long fromUid, int timeInseconds);

// async methods
void getP2PChat(long messageId, long fromUid, long toUid, GetRetrievedMessageLambdaCallback callback);
void getP2PChat(long messageId, long fromUid, long toUid, GetRetrievedMessageLambdaCallback callback, int timeInseconds);
void getGroupChat(long messageId, long fromUid, long groupId, GetRetrievedMessageLambdaCallback callback);
void getGroupChat(long messageId, long fromUid, long groupId, GetRetrievedMessageLambdaCallback callback, int timeInseconds);
void getRoomChat(long messageId, long fromUid, long roomId, GetRetrievedMessageLambdaCallback callback);
void getRoomChat(long messageId, long fromUid, long roomId, GetRetrievedMessageLambdaCallback callback, int timeInseconds);
void getBroadcastChat(long messageId, long fromUid, GetRetrievedMessageLambdaCallback callback);
void getBroadcastChat(long messageId, long fromUid, GetRetrievedMessageLambdaCallback callback, int timeInseconds);

参数说明:

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • GetRetrievedMessageLambdaCallback callback: 为异步回调返回接口

      public interface GetRetrievedMessageLambdaCallback{
      void done(RTMServerClientBase.RTMHistoryMessageUnit result, int errorCode, String errorMessage);
  }
  
  public static class RTMMessage{
      public byte messageType;
      public long toId;     // for serverpush
      public long fromUid;
      public long modifiedTime;
      public long messageId;
      public String stringMessage;
      public byte[] binaryMessage;
      public String attrs;
      public FileMsgInfo fileMsgInfo = null;

      @Override
      public String toString(){
          return " ,[One RTMMessage: mtype = " + messageType + " ,fromuid = " + fromUid + " ,mtime = " + modifiedTime
                  + " ,mid = " + messageId + " ,message = " + stringMessage + " ,binaryMessage = " + binaryMessage + " ,attrs = " + attrs + "]";
      }
  }

  public static class  RTMHistoryMessageUnit{
      public long cursorId;
      public RTMMessage message = null;

      @Override
      public String toString(){
          if(message != null){
              return cursorId + message.toString();
          }
          return "";
      }
  }

参见: FileMsgInfo

返回值:

  • sync: 同步接口正常时返回获取到的HistoryMessage对象，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回获取到的HistoryMessage对象，或者error信息, 当errorCode不等于ErrorCode.FPNN_EC_OK.value(),则为error返回，可查看message错误信息.

删除聊天

// sync methods
void deleteP2PChat(long messageId, long fromUid, long toUid);
void deleteP2PChat(long messageId, long fromUid, long toUid, int timeInseconds);
void deleteGroupChat(long messageId, long fromUid, long groupId);
void deleteGroupChat(long messageId, long fromUid, long groupId, int timeInseconds);
void deleteRoomChat(long messageId, long fromUid, long roomId);
void deleteRoomChat(long messageId, long fromUid, long roomId, int timeInseconds);
void deleteBroadcastChat(long messageId, long fromUid);
void deleteBroadcastChat(long messageId, long fromUid, int timeInseconds);

// async methods
void deleteP2PChat(long messageId, long fromUid, long toUid, DoneLambdaCallback callback);
void deleteP2PChat(long messageId, long fromUid, long toUid, DoneLambdaCallback callback, int timeInseconds);
void deleteGroupChat(long messageId, long fromUid, long groupId, DoneLambdaCallback callback);
void deleteGroupChat(long messageId, long fromUid, long groupId, DoneLambdaCallback callback, int timeInseconds);
void deleteRoomChat(long messageId, long fromUid, long roomId, DoneLambdaCallback callback);
void deleteRoomChat(long messageId, long fromUid, long roomId, DoneLambdaCallback callback, int timeInseconds);
void deleteBroadcastChat(long messageId, long fromUid, DoneLambdaCallback callback);
void deleteBroadcastChat(long messageId, long fromUid, DoneLambdaCallback callback, int timeInseconds);

参数说明:

  • int timeoutInseconds: 发送超时，缺少timeoutInseconds参数，或timeoutInseconds为0时，将采用RTM Server Client实例的配置，即调用
    client.setQuestTimeout(int timeout)设置的超时时间，若RTM Server Client实例未配置，将采用 fpnn相应的超时配置，默认为5seconds.

  • DoneLambdaCallback callback: 为异步回调返回接口, 错误码和错误信息将通过callback返回

      public interface DoneLambdaCallback {
      void done(int errorCode, String message);
  }

返回值:

  • sync: 同步接口正常时返回空，错误返回时将抛出异常RTMException或者其他系统性异常，对于RTMException异常可通过toString方法查看error信息.

  • async: 异步接口不会抛出异常，通过callback返回接口调用结果，当errorCode不等于ErrorCode.FPNN_EC_OK.value()，则为error返回，可查看message错误信息.