Options
All
  • Public
  • Public/Protected
  • All
Menu

@rongcloud/imlib-v4 - v4.5.0

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

GetHistoryMessageOption

GetHistoryMessageOption: { count?: number; order?: 0 | 1; timestamp?: number }

Type declaration

  • Optional count?: number

    获取消息的数量，范围: 1-20

  • Optional order?: 0 | 1

    获取消息的排列顺序

    • 0: 升序
    • 1: 降序
  • Optional timestamp?: number

    获取此时间之前的消息，0 为从当前时间拉取

GetHistoryMessageResult

GetHistoryMessageResult: { hasMore: boolean; list: IAReceivedMessage[] }

Type declaration

IInitOption

IInitOption: { appkey: string; checkCA?: boolean; connectType?: "websocket" | "comet"; customCMP?: string[]; debug?: boolean; detect?: undefined; indexDBSwitch?: boolean; logLevel?: LogLevel; navigators?: string[]; logStdout?: any }

Type declaration

  • appkey: string

    应用 appkey 标识

  • Optional checkCA?: boolean

    是否校验证书，默认为 true

  • Optional connectType?: "websocket" | "comet"

    连接方式，默认使用 'websocket'

  • Optional customCMP?: string[]

    小程序平台专属配置

  • Optional debug?: boolean
    deprecated
  • Optional detect?: undefined
    deprecated
  • Optional indexDBSwitch?: boolean

    是否打开 IndexDB 存储, 默认为 true

  • Optional logLevel?: LogLevel

    修改 engine log 打印等级

  • Optional navigators?: string[]

    自定义导航地址，公有云用户不推荐修改

  • logStdout?:function
    • logStdout(logLevel: LogLevel, content: string): void

    • 修改默认的 log 输出函数

      Parameters

      Returns void

IRemoveChatroomEntryOption

IRemoveChatroomEntryOption: { isSendNotification?: boolean; key: string; notificationExtra?: string }

Type declaration

  • Optional isSendNotification?: boolean
  • key: string
  • Optional notificationExtra?: string

ISetChatroomEntryOption

ISetChatroomEntryOption: { isAutoDelete?: boolean; isSendNotification?: boolean; key: string; notificationExtra?: string; value: string }

Type declaration

  • Optional isAutoDelete?: boolean
  • Optional isSendNotification?: boolean
  • key: string
  • Optional notificationExtra?: string
  • value: string

Variables

CHATROOM_ENTRY_TYPE

CHATROOM_ENTRY_TYPE: typeof ChatroomEntryType = ChatroomEntryType
deprecated

CHATROOM_ORDER

CHATROOM_ORDER: { ASC: number; DESC: number } = ...

Type declaration

  • ASC: number
  • DESC: number

CONNECTION_STATUS

CONNECTION_STATUS: { BLOCKED: number; CONNECTED: number; CONNECTING: number; DISCONNECTED: number; KICKED_OFFLINE_BY_OTHER_CLIENT: number; NETWORK_UNAVAILABLE: number; SOCKET_ERROR: number } = ...

Type declaration

  • BLOCKED: number
  • CONNECTED: number
  • CONNECTING: number
  • DISCONNECTED: number
  • KICKED_OFFLINE_BY_OTHER_CLIENT: number
  • NETWORK_UNAVAILABLE: number
  • SOCKET_ERROR: number

CONNECT_TYPE

CONNECT_TYPE: { COMET: string; WEBSOCKET: string } = ...

业务层枚举, 此处枚举会暴露给开发者

Type declaration

  • COMET: string
  • WEBSOCKET: string

CONVERSATION_TYPE

CONVERSATION_TYPE: typeof ConversationType = ConversationType
deprecated

ERROR_CODE

ERROR_CODE: { [ key in number | string]: number | string } = {}

FILE_TYPE

FILE_TYPE: typeof FileType = FileType
deprecated

MENTIONED_TYPE

MENTIONED_TYPE: { ALL: number; SINGAL: number } = ...

Type declaration

  • ALL: number
  • SINGAL: number

MESSAGE_DIRECTION

MESSAGE_DIRECTION: typeof MessageDirection = MessageDirection
deprecated

MESSAGE_TYPE

MESSAGE_TYPE: { CHRM_KV_NOTIFY: string; COMBINE: string; EXPANSION_NOTIFY: string; FILE: string; GIF: string; HQ_VOICE: string; IMAGE: string; LOCATION: string; LOG_COMMAND: string; REFERENCE: string; RICH_CONTENT: string; SIGHT: string; TEXT: string; VOICE: string } = ...

Type declaration

  • CHRM_KV_NOTIFY: string
  • COMBINE: string
  • EXPANSION_NOTIFY: string
  • FILE: string
  • GIF: string
  • HQ_VOICE: string
  • IMAGE: string
  • LOCATION: string
  • LOG_COMMAND: string
  • REFERENCE: string
  • RICH_CONTENT: string
  • SIGHT: string
  • TEXT: string
  • VOICE: string

MESSAGS_TIME_ORDER

MESSAGS_TIME_ORDER: { ASC: number; DESC: number } = ...

Type declaration

  • ASC: number
  • DESC: number

NOTIFICATION_STATUS

NOTIFICATION_STATUS: { DO_NOT_DISTURB: NotificationStatus; NOTIFY: NotificationStatus } = ...
deprecated

Type declaration

RECALL_MESSAGE_TYPE

RECALL_MESSAGE_TYPE: "RC:RcCmd" = 'RC:RcCmd'

RECEIVED_STATUS

RECEIVED_STATUS: { DOWNLOADED: number; LISTENED: number; READ: number; RETRIEVED: number; UNREAD: number } = ...

Type declaration

  • DOWNLOADED: number
  • LISTENED: number
  • READ: number
  • RETRIEVED: number
  • UNREAD: number

SDK_VERSION

SDK_VERSION: string = __VERSION__

Functions

Const getInstance

  • Returns IMClient

Const init

Generated using TypeDoc