@rongcloud/imlib-v2 - v2.10.0

Type declaration

• MessageType: { AcceptMessage: string; ChangeModeMessage: string; ChangeModeResponseMessage: string; ChrmKVNotificationMessage: string; CommandMessage: string; CommandNotificationMessage: string; ContactNotificationMessage: string; CustomerContact: string; CustomerStatusUpdateMessage: string; DiscussionNotificationMessage: string; EvaluateMessage: string; FileMessage: string; GIFMessage: string; GroupNotificationMessage: string; HQVoiceMessage: string; HandShakeMessage: string; HandShakeResponseMessage: string; HandshakeMessage: string; HungupMessage: string; ImageMessage: string; InformationNotificationMessage: string; InviteMessage: string; JrmfRedPacketMessage: string; JrmfRedPacketOpenedMessage: string; LocationMessage: string; LogCommandMessage: string; MediaModifyMessage: string; MemberModifyMessage: string; ProfileNotificationMessage: string; PublicServiceCommandMessage: string; PublicServiceMultiRichContentMessage: string; PublicServiceRichContentMessage: string; RCCombineMessage: string; ReadReceiptMessage: string; ReadReceiptRequestMessage: string; ReadReceiptResponseMessage: string; RecallCommandMessage: string; ReferenceMessage: string; RichContentMessage: string; RingingMessage: string; SightMessage: string; SummaryMessage: string; SuspendMessage: string; SyncReadStatusMessage: string; TerminateMessage: string; TextMessage: string; TypingStatusMessage: string; UnknownMessage: string; VoiceMessage: string }

  • AcceptMessage: string

  • ChangeModeMessage: string

  • ChangeModeResponseMessage: string

  • ChrmKVNotificationMessage: string

  • CommandMessage: string

  • CommandNotificationMessage: string

  • ContactNotificationMessage: string

  • CustomerContact: string

  • CustomerStatusUpdateMessage: string

  • DiscussionNotificationMessage: string

  • EvaluateMessage: string

  • FileMessage: string

  • GIFMessage: string

  • GroupNotificationMessage: string

  • HQVoiceMessage: string

  • HandShakeMessage: string

  • HandShakeResponseMessage: string

  • HandshakeMessage: string

  • HungupMessage: string

  • ImageMessage: string

  • InformationNotificationMessage: string

  • InviteMessage: string

  • JrmfRedPacketMessage: string

  • JrmfRedPacketOpenedMessage: string

  • LocationMessage: string

  • LogCommandMessage: string

  • MediaModifyMessage: string

  • MemberModifyMessage: string

  • ProfileNotificationMessage: string

  • PublicServiceCommandMessage: string

  • PublicServiceMultiRichContentMessage: string

  • PublicServiceRichContentMessage: string

  • RCCombineMessage: string

  • ReadReceiptMessage: string

  • ReadReceiptRequestMessage: string

  • ReadReceiptResponseMessage: string

  • RecallCommandMessage: string

  • ReferenceMessage: string

  • RichContentMessage: string

  • RingingMessage: string

  • SightMessage: string

  • SummaryMessage: string

  • SuspendMessage: string

  • SyncReadStatusMessage: string

  • TerminateMessage: string

  • TextMessage: string

  • TypingStatusMessage: string

  • UnknownMessage: string

  • VoiceMessage: string

• RegisterMessage: {}

  • [messageType: string]: ThisType<BaseMessage>

• RegisterMessageTypeMapping: {}

  • [key: string]: string

• _voipProvider: ICallLibReceivedMsgListener

• connect:function

  • connect(token: string, callback: IConnectCallback): Promise<void>

  • 连接 IM 服务

    Parameters

    • token: string

      用于连接鉴权

    • callback: IConnectCallback

      连接状态回调

    Returns Promise<void>

• createLogger:function

  • createLogger(tag: string, type: LogType): null | Logger

  • 创建 Logger 实例

    Parameters

    • tag: string

      标签，以 'RC' 开头的为 SDK 内部使用

    • type: LogType

    Returns null | Logger

    Logger

• getInstance:function

  • getInstance(): IMClient

  • 单例模式，用于获取 IMClient 实例

    Returns IMClient

• getMessageObjectName:function

  • getMessageObjectName(messageType: string): string

  • 根据 messageType 获取对应的消息 objectName 值 若无记录，则返回原字符串

    todo

    优化算法

    Parameters

    • messageType: string

    Returns string

• init:function

  • init(appkey: string, _: void, options?: IInitOption): void

  • 初始化 IM SDK

    Parameters

    • appkey: string

    • _: void

      该参数已废弃，为保持向前兼容，保留占位参数

    • options: IInitOption = {}

    Returns void

• messageWatch:function

  • messageWatch(watcher: IRTCMsgListener): void

  • RTC Lib 内部使用消息监听器

    Parameters

    • watcher: IRTCMsgListener

    Returns void

• reconnect:function

  • reconnect(callback: IConnectCallback, options?: IReconnectOptions): void

  • 重连 im 服务

    description

    Web IM 3.0 开始 SDK 内部会进行自动重连，不需要主动调用此方法。此方法建议主动断开连接后，再次链接时调用。

    Parameters

    • callback: IConnectCallback

      重连状态回调

    • Optional options: IReconnectOptions

      该参数已废弃

    Returns void

• registerMessageType:function

  • registerMessageType(messageType: string, objectName: string, mesasgeTag: MessageTag, searchProps: string[]): void

  • 注册自定义消息

    Parameters

    • messageType: string

      v2 中定义的消息类型，如：TextMessage

    • objectName: string

      与移动端对齐的消息结构类型，如：RC:TxtMsg

    • mesasgeTag: MessageTag

      是否存储或计数标记

    • searchProps: string[]

      消息属性名称列表

    Returns void

• setChatRoomStatusListener:function

  • setChatRoomStatusListener(listenner: IChatRoomListener): void

  • 聊天室信息监听

    Parameters

    • listenner: IChatRoomListener

    Returns void

• setConnectionStatusListener:function

  • setConnectionStatusListener(listener: IConnectionStatusListener): void

  • 添加连接状态变更事件监听

    Parameters

    • listener: IConnectionStatusListener

    Returns void

• setConversationStatusListener:function

  • setConversationStatusListener(listener: IConversationStatusListener): void

  • 会话状态监听器

    Parameters

    • listener: IConversationStatusListener

    Returns void

• setConversationTagListener:function

  • setConversationTagListener(listener: ITagListener): void

  • 会话中tag状态监听

    Parameters

    • listener: ITagListener

    Returns void

• setMessageBlockedListener:function

  • setMessageBlockedListener(listenner: IMessageBlockedListener): void

  • 敏感词监听

    Parameters

    • listenner: IMessageBlockedListener

    Returns void

• setMessageExpansionListener:function

  • setMessageExpansionListener(listener: IMessageExpansionListener): void

  • 消息扩展监听

    Parameters

    • listener: IMessageExpansionListener

    Returns void

• setOnReceiveMessageListener:function

  • setOnReceiveMessageListener(listener: IReceiveMessageListener): void

  • 添加消息监听器

    Parameters

    • listener: IReceiveMessageListener

    Returns void

• setPullOffLineFinished:function

  • setPullOffLineFinished(listener: IPullFinishedListener): void

  • 用于拉取完毕监听

    Parameters

    • listener: IPullFinishedListener

    Returns void

• setTagListener:function

  • setTagListener(listener: ITagListener): void

  • tag监听

    Parameters

    • listener: ITagListener

    Returns void

• setTypingStatusListener:function

  • setTypingStatusListener(listenner: ITypingListener): void

  • typing监听

    Parameters

    • listenner: ITypingListener

    Returns void

• statusWatch:function

  • statusWatch(watcher: IRTCConnectionStatusListener): void

  • RTC Lib 内部使用状态监听器

    Parameters

    • watcher: IRTCConnectionStatusListener

    Returns void