@onyx-p/imlib-web 1.2.2 → 1.2.4

package/dist/types/model/messages/recallCommandMessage.d.ts

@@ -0,0 +1,9 @@
+import { IBaseMessageBody } from "../baseMessage";
+/**
+ *  撤回通知消息（被撤回消息摘要）
+ */
+export interface IRecallCommandMessageBody extends IBaseMessageBody {
+    messageUId: string;
+}
+declare const RecallCommandMessage: new (content: IRecallCommandMessageBody) => import("../baseMessage").BaseMessage<IRecallCommandMessageBody>;
+export default RecallCommandMessage;

package/dist/types/model/messages/textMessage.d.ts

@@ -0,0 +1,12 @@
+import { IMentionedInfo } from '../baseMessage';
+/**
+ * 文本消息
+ */
+export interface ITextMessageBody extends IMentionedInfo {
+    /**
+     * 文本消息内容
+     */
+    content: string;
+}
+declare const TextMessage: new (content: ITextMessageBody) => import("../baseMessage").BaseMessage<ITextMessageBody>;
+export default TextMessage;

package/dist/types/model/messages/videoMessage.d.ts

@@ -0,0 +1,30 @@
+import { IMentionedInfo } from '../baseMessage';
+export interface IVideoMessageBody extends IMentionedInfo {
+    /**
+     * 远程媒体资源地址
+     */
+    videoObjectKey: string;
+    /**
+     * 缩略图的远程媒体资源地址
+     */
+    thumbnailObjectKey: string;
+    /**
+     * 编解码类型，默认为 mp4
+     */
+    extension?: string;
+    encryptKey?: string;
+    /**
+     * 视频宽度
+     */
+    width: number;
+    /**
+     * 视频高度
+     */
+    height: number;
+    /**
+     * 视频时长描述
+     */
+    during: string;
+}
+declare const VideoMessage: new (content: IVideoMessageBody) => import("../baseMessage").BaseMessage<IVideoMessageBody>;
+export default VideoMessage;

package/dist/types/model/messages/voiceMessage.d.ts

@@ -0,0 +1,18 @@
+import { IMentionedInfo } from '../baseMessage';
+export interface IHQVoiceMessageBody extends IMentionedInfo {
+    /**
+     * 远程媒体资源地址
+     */
+    audioObjectKey: string;
+    /**
+     * 语音消息的时长，最大值为 60 （单位：秒）
+     */
+    length: number;
+    /**
+     * 编解码类型，默认为 m4a 音频
+     */
+    extension?: string;
+    encryptKey?: string;
+}
+declare const VoiceMessage: new (content: IHQVoiceMessageBody) => import("../baseMessage").BaseMessage<IHQVoiceMessageBody>;
+export default VoiceMessage;

package/dist/types/model/statusTypes.d.ts

@@ -0,0 +1,409 @@
+/**
+ * 连接状态
+ */
+export declare enum ConnectionStatus {
+    /**
+     * 连接成功。
+     */
+    CONNECTED = 0,
+    /**
+     * 连接中。
+     */
+    CONNECTING = 1,
+    /**
+     * 正常断开连接。
+     */
+    DISCONNECTED = 2,
+    /**
+     * 网络不可用。
+     */
+    NETWORK_UNAVAILABLE = 3,
+    /**
+     * 连接关闭。
+     */
+    CONNECTION_CLOSED = 4,
+    /**
+     * 用户账户在其他设备登录，本机会被踢掉线。
+     */
+    KICKED_OFFLINE_BY_OTHER_CLIENT = 6,
+    /**
+     * websocket 连接失败
+     */
+    WEBSOCKET_UNAVAILABLE = 7,
+    /**
+     * websocket 报错
+     */
+    WEBSOCKET_ERROR = 8,
+    /**
+     * 用户被封禁
+     */
+    BLOCKED = 9,
+    /**
+     * 服务器主动断开
+     */
+    DISCONNECT_BY_SERVER = 13
+}
+/**
+ * IM  错误码范围段
+ * 2 开头为 IM Server 返回错误码
+ * 3 开头： 30000 到 33xxx 为协议栈错误码，34001 ~ 34999 为移动端自定错误码
+ *   备注：iOS 与 Android 错误码一致。Web 与移动端一致的错误码，也用此片段，比如 34008 （消息不支持扩展）
+ * 35001 ~ 39999 为 Web 端错误码 备注：由于 Web IM 历史版本 35xxx 36xxx 37xxx 38xxx 39xxxx 都占用过，所以错误码段范围较大
+ */
+export declare enum ErrorCode {
+    /** 超时 */
+    TIMEOUT = -1,
+    /**
+     * 未知原因失败。
+     */
+    UNKNOWN = -2,
+    /** 参数错误 */
+    PARAMETER_ERROR = -3,
+    /**
+     * 成功
+     */
+    SUCCESS = 0,
+    /**
+     * 己方网络出错
+     */
+    NETWORK_ERROR = 7,
+    /**
+     * 消息加密失败
+     */
+    MSG_ENCRYPT_ERROR = 6001,
+    /**
+     * 群组 Id 无效
+     */
+    RC_DISCUSSION_GROUP_ID_INVALID = 20407,
+    /**
+     * 发送频率过快
+     */
+    SEND_FREQUENCY_TOO_FAST = 20604,
+    /**
+     * 群组被禁言
+     */
+    FORBIDDEN_IN_GROUP = 22408,
+    RECALL_MESSAGE = 25101,
+    /**
+     * 不在群组。
+     */
+    NOT_IN_GROUP = 22406,
+    /**
+     * 敏感词屏蔽
+     */
+    SENSITIVE_SHIELD = 21501,
+    /**
+     *获取用户失败
+     */
+    GET_USERINFO_ERROR = 23407,
+    /**
+     * 在黑名单中。
+     */
+    REJECTED_BY_BLACKLIST = 405,
+    /**
+     * 通信过程中，当前 Socket 不存在。
+     */
+    RC_NET_CHANNEL_INVALID = 30001,
+    /**
+     * Socket 连接不可用。
+     */
+    RC_NET_UNAVAILABLE = 30002,
+    /**
+     * 通信超时。
+     */
+    RC_MSG_RESP_TIMEOUT = 30003,
+    /**
+     * 创建 Socket 失败。
+     */
+    RC_SOCKET_NOT_CREATED = 30010,
+    /**
+     * Socket 被断开。
+     */
+    RC_SOCKET_DISCONNECTED = 30011,
+    /**
+     * PING 超时。
+     */
+    RC_PONG_RECV_FAIL = 30013,
+    /**
+     * 消息发送失败。
+     */
+    RC_MSG_SEND_FAIL = 30014,
+    /**
+     * JSON 后的消息体超限, 目前最大 128kb
+     */
+    RC_MSG_CONTENT_EXCEED_LIMIT = 30016,
+    /**
+     * 做 connect 连接时，收到的 ACK 超时。
+     */
+    RC_CONN_ACK_TIMEOUT = 31000,
+    /**
+     * 参数错误，App Id 错误。
+     */
+    RC_CONN_ID_REJECT = 31002,
+    /**
+     * 服务器不可用。
+     */
+    RC_CONN_SERVER_UNAVAILABLE = 31003,
+    /**
+     * Token 错误。
+     */
+    RC_CONN_USER_OR_PASSWD_ERROR = 31004,
+    /**
+     * websocket 鉴权失败
+     */
+    RC_CONN_NOT_AUTHRORIZED = 31005,
+    /**
+     * Disconnect，由服务器返回，比如用户互踢。
+     */
+    RC_DISCONN_KICK = 31010,
+    /**
+     * 开启禁止把已在线客户端踢下线开关后，该错误码标识已有同类型端在线，禁止链接；
+     */
+    RC_DISCONN_SAME_CLIENT_ON_LINE = 31023,
+    /**
+     * 未调用 init 初始化函数。
+     */
+    BIZ_ERROR_CLIENT_NOT_INIT = 33001,
+    /**
+     * 传入参数无效。
+     */
+    BIZ_ERROR_INVALID_PARAMETER = 33003,
+    /**
+     * 重新连接成功。
+     */
+    BIZ_ERROR_RECONNECT_SUCCESS = 33005,
+    /**
+     * 连接中，再调用 connect 被拒绝。
+     */
+    BIZ_ERROR_CONNECTING = 33006,
+    /**
+     * 消息存入本地数据库失败
+     */
+    MSG_INSERT_ERROR = 33008,
+    /**
+     * 删除本地消息失败
+     */
+    MSG_DEL_ERROR = 33009,
+    /**
+     * 删除会话失败
+     */
+    CONVER_REMOVE_ERROR = 34001,
+    /**
+     *拉取历史消息
+     */
+    CONVER_GETLIST_ERROR = 34002,
+    /**
+     * 会话指定异常
+     */
+    CONVER_SETOP_ERROR = 34003,
+    /**
+     * 获取会话未读消息总数失败
+     */
+    CONVER_TOTAL_UNREAD_ERROR = 34004,
+    /**
+     * 获取指定会话类型未读消息数异常
+     */
+    CONVER_TYPE_UNREAD_ERROR = 34005,
+    /**
+     * 获取指定用户ID&会话类型未读消息数异常
+     */
+    CONVER_ID_TYPE_UNREAD_ERROR = 34006,
+    /**
+     * 会话数量超出上限
+     */
+    CONVER_OUT_LIMIT_ERROR = 34013,
+    /**
+     *  媒体文件上传异常，媒体文件不存在或文件大小为 0 或超过限制
+     */
+    MEDIA_EXCEPTION = 34018,
+    /**
+     * 获取会话失败
+     */
+    CONVER_GET_ERROR = 35021,
+    /**
+     * 群组信息异常
+     */
+    GROUP_SYNC_ERROR = 35001,
+    /**
+     * 已连接或者内部重连中，不允许调用重连，需先调用 disconnect 方法
+     */
+    CAN_NOT_RECONNECT = 35007,
+    /**
+     * 开启`禁止把已在线客户端踢下线`开关后，该错误码标识已有同类型端在线，禁止链接
+     */
+    HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
+    /**
+     * IM 在初次连接成功后，需立即同步消息，标记上线，然后获取全量超级群会话列表，列表同步完成前，所有超级群相关功能接口应不可用
+     */
+    METHOD_NOT_AVAILABLE = 35011,
+    /**
+     * 该功能不支持超级群
+     */
+    METHOD_NOT_SUPPORT = 35012,
+    /**
+     * 消息数量没在范围内
+     */
+    MSG_LIMIT_ERROR = 35013,
+    /**
+     * 该功能仅支持超级群
+     */
+    METHOD_ONLY_SUPPORT_ULTRA_GROUP = 35014,
+    /**
+     * 上传文件失败
+     */
+    UPLOAD_FILE_FAILED = 35020,
+    /**
+     * 获取草稿失败
+     */
+    DRAF_GET_ERROR = 38001,
+    /**
+     * 保存草稿失败
+     */
+    DRAF_SAVE_ERROR = 38002,
+    /**
+     * 删除草稿失败
+     */
+    DRAF_REMOVE_ERROR = 38003,
+    /**
+     * 方法未支持
+     */
+    NOT_SUPPORT = 39002
+}
+export declare const ErrorDesc: (code: ErrorCode) => string;
+/**
+ * 会话类型
+ */
+export declare enum ConversationType {
+    /**
+     * 单聊
+     */
+    PRIVATE = 1,
+    /**
+     * 群组聊天
+     */
+    GROUP = 3
+}
+/**
+ * 群组 @ 类型
+ */
+export declare enum MentionedType {
+    /**
+     * 所有人
+     */
+    ALL = 1,
+    /**
+     * 部分人
+     */
+    SINGAL = 2
+}
+/**
+ * 会话提醒状态
+ */
+export declare enum NotificationStatus {
+    /**
+     * 免打扰已开启
+     */
+    OPEN = 1,
+    /**
+     * 免打扰已关闭
+     */
+    CLOSE = 2
+}
+/**
+ * 消息的方向
+ */
+export declare enum MessageDirection {
+    /**
+     * 己方发送消息
+     */
+    SEND = 1,
+    /**
+     * 己方接收消息
+     */
+    RECEIVE = 2
+}
+export interface IUserProfile {
+    /**
+     * 用户 ID
+     */
+    id?: string;
+    /**
+     * 用户名
+     */
+    name?: string;
+    /**
+     * user info 中附加信息
+     */
+    extra?: string;
+    /**
+     * 用户头像地址（向移动端兼容）
+     */
+    portrait?: string;
+}
+/**
+ * 发送状态
+ */
+export declare enum SentStatus {
+    /**
+     * 发送中
+     */
+    SENDING = 10,
+    /**
+     * 发送失败
+     */
+    FAILED = 20,
+    /**
+     * 已发送成功
+     */
+    SENT = 30
+}
+export declare enum ReceivedStatus {
+    /**
+     * 初始状态
+     */
+    IDLE = 0,
+    /**
+     * 已接收
+     */
+    RECEIVED = 1,
+    /**
+     * 已读
+     */
+    READ = 2,
+    /**
+     * 已听
+     */
+    LISTENED = 3
+}
+/**
+ * 免打扰等级
+ */
+export declare enum NotificationLevel {
+    /**
+     * 全部消息通知（接收全部消息通知 -- 显示指定关闭免打扰功能）
+     */
+    ALL_MESSAGE = -1,
+    /**
+     * 未设置（向上查询群或者APP级别设置）// 存量数据中 0 表示未设置
+     */
+    NOT_SET = 0,
+    /**
+     * @所有人 或者 @成员列表有自己 时通知；单聊代表消息不通知
+     */
+    AT_MESSAGE_NOTIFICATION = 1,
+    /**
+     * @成员列表有自己时通知，@所有人不通知；单聊代表消息不通知
+     */
+    AT_USER_NOTIFICATION = 2,
+    /**
+     * @ 群用户组通知，通知用户组暂未实现，暂不暴露出去
+     */
+    /**
+     * @ 群全员通知
+     */
+    AT_GROUP_ALL_USER_NOTIFICATION = 4,
+    /**
+     * 消息通知被屏蔽，即不接收消息通知
+     */
+    NOT_MESSAGE_NOTIFICATION = 5
+}