RCKitApplication | Global IM UIKit

Hierarchy

EventDispatcher<EventDefined>
- RCKitApplication

Methods

addEventListener

addEventListener<K>(type: string | K, listener: ((evt: EventDefined[K]) => void), target?: any): void

Inherited from EventDispatcher.addEventListener
- Defined in src/core/EventDispatcher.ts:13
Type Parameters
- K extends keyof EventDefined
Parameters
- type: string | K
- listener: ((evt: EventDefined[K]) => void)
  - - (evt: EventDefined[K]): void
    - Parameters
      - evt: EventDefined[K]
      Returns void
- Optional target: any
Returns void

onceEventListener

onceEventListener<K>(type: string | K, listener: ((evt: EventDefined[K]) => void), target?: any): void

Inherited from EventDispatcher.onceEventListener
- Defined in src/core/EventDispatcher.ts:22
Type Parameters
- K extends keyof EventDefined
Parameters
- type: string | K
- listener: ((evt: EventDefined[K]) => void)
  - - (evt: EventDefined[K]): void
    - Parameters
      - evt: EventDefined[K]
      Returns void
- Optional target: any
Returns void

removeEventListener

removeEventListener<K>(type: string | K, listener: ((evt: EventDefined[K]) => void), target?: any): void

Inherited from EventDispatcher.removeEventListener
- Defined in src/core/EventDispatcher.ts:31
Type Parameters
- K extends keyof EventDefined
Parameters
- type: string | K
- listener: ((evt: EventDefined[K]) => void)
  - - (evt: EventDefined[K]): void
    - Parameters
      - evt: EventDefined[K]
      Returns void
- Optional target: any
Returns void

removeEventListeners

removeEventListeners(type: string): void

Inherited from EventDispatcher.removeEventListeners
- Defined in src/core/EventDispatcher.ts:41
Parameters
- type: string
Returns void

removeAllEventListeners

removeAllEventListeners(): void

Inherited from EventDispatcher.removeAllEventListeners
- Defined in src/core/EventDispatcher.ts:45
Returns void

dispatchEvent

dispatchEvent<K>(event: EventDefined[K], defer?: boolean): void

Inherited from EventDispatcher.dispatchEvent
- Defined in src/core/EventDispatcher.ts:56
派发事件，以同步或异步的方式执行事件监听器。

description
当 defer 为 true 时，会将事件监听器的执行推迟到下一个事件循环中，而非立即执行。

Type Parameters
- K extends keyof EventDefined
Parameters
- event: EventDefined[K]
  
  事件对象
- defer: boolean = true
  
  异步执行事件监听器，默认为 true。
Returns void

setCommandSwitch

setCommandSwitch(command: RCKitCommand, enable: boolean): void

- Defined in src/core/RCKitApplication.ts:118
定义功能开关，可通过 RCKitCommand 查看所有支持的功能配置项。必须在 ready 之前调用。

Parameters
- command: RCKitCommand
- enable: boolean
Returns void

getCommandSwitch

getCommandSwitch(command: RCKitCommand): boolean

- Defined in src/core/RCKitApplication.ts:125
查询功能开关开启状态，可通过 RCKitCommand 查看所有支持的功能配置项。

Parameters
- command: RCKitCommand
Returns boolean

registerCustomElement

registerCustomElement<T>(tag: T, opts: IRCKitDefineCustomElementOptions<{ value: IRCKitOverrideAbleComponentProps[T] }>): void

注册自定义组件，以替换 SDK 默认组件，必须在 ready 之前调用。

example

app.registerCustomElement(RCKitOverrideAbleComponent.HQVoiceMessage, {
   template: '<span class="test" @click="handleClick">{{ content }}</span>',
   setup(props, ctx) {
     const { computed, lang } = ctx;
     const handleClick = () => {
       // 处理自定义事件
     };
     return {
       content: computed(() => {
         return lang.value === 'en_US' ? 'Hello' : '你好';
       }),
     },
   },
   styles: ['.test { color: red; }'],
});

Type Parameters

T extends "HQVoiceMessageComponent"

Parameters

tag: T

自定义组件标签名
opts: IRCKitDefineCustomElementOptions<{ value: IRCKitOverrideAbleComponentProps[T] }>

自定义组件定义

Returns void

registerMessageType

registerMessageType<T>(messageType: string, options: IRCKitRegisterMessageTypeOpts): (new (content: T) => BaseMessage<T>)

- Defined in src/core/RCKitApplication.ts:162
注册自定义消息类型，必须在 ready 之前调用。

Type Parameters
- T = any
Parameters
- messageType: string
- options: IRCKitRegisterMessageTypeOpts
Returns (new (content: T) => BaseMessage<T>)
- - new (content: T): BaseMessage<T>
  - Parameters
    - content: T
    Returns BaseMessage<T>

cloneLanguageEntries

cloneLanguageEntries(lang: string): null | {}

- Defined in src/core/RCKitApplication.ts:174
获取内置语言包词条拷贝

Parameters
- lang: string
  
  传参确认要获取的语言包
Returns null | {}

registerLanguagePack

registerLanguagePack(lang: string, entries: IRCKitLanguageEntries | {}, direction?: RCKitLanguageDirection): void

- Defined in src/core/RCKitApplication.ts:187
注册语言包，也可用于覆盖既有语言包；仅 ready 调用前有效。

Parameters
- lang: string
  
  语言包定义，如 zh_CN
- entries: IRCKitLanguageEntries | {}
  
  语言包词条定义
- direction: RCKitLanguageDirection = 'ltr'
  
  语言的行文方向，默认 'ltr'; 仅当首次注册指定语言包时有效。
Returns void

setLanguage

setLanguage(lang: string): void

- Defined in src/core/RCKitApplication.ts:197
语言切换功能接口

Parameters
- lang: string
  
  要切换的目标语言
Returns void

getLanguage

getLanguage(): string

- Defined in src/core/RCKitApplication.ts:204
获取当前使用的语言

Returns string

getSupportedLanguages

getSupportedLanguages(): string[]

- Defined in src/core/RCKitApplication.ts:211
获取支持的语言列表

Returns string[]

setPushConfigHook

setPushConfigHook(hook: IRCKitPushConfigHook): void

- Defined in src/core/RCKitApplication.ts:224
设置自定义推送配置钩子，用于在消息发送前，修改移动端接收推送时的标题、内容等。

Parameters
- hook: IRCKitPushConfigHook
Returns void

updateUserProfile

updateUserProfile(profile: IRCKitUserProfile): void

- Defined in src/core/RCKitApplication.ts:237
更新用户信息

Parameters
- profile: IRCKitUserProfile
Returns void

updateGroupProfile

updateGroupProfile(profile: IRCKitGroupProfile): void

- Defined in src/core/RCKitApplication.ts:246
更新群组信息

Parameters
- profile: IRCKitGroupProfile
Returns void

updateUserOnlineStatus

updateUserOnlineStatus(userId: string, online: boolean): void

- Defined in src/core/RCKitApplication.ts:256
更新用户在线状态

Parameters
- userId: string
  
  用户 ID
- online: boolean
  
  在线状态
Returns void

updateGroupMembers

updateGroupMembers(groupId: string, members: IRCKitGroupMemberProfile[]): void

- Defined in src/core/RCKitApplication.ts:267
立即刷新用户成员列表，调用该方法会同步更新群组 memberCount 信息。该操作仅影响本地缓存数据与 UI 显示，不会向融云服务端发送请求。

Parameters
- groupId: string
  
  群组 ID
- members: IRCKitGroupMemberProfile[]
  
  成员列表
Returns void

addGroupMembers

addGroupMembers(groupId: string, members: IRCKitGroupMemberProfile[]): void

- Defined in src/core/RCKitApplication.ts:276
添加群组成员，调用该方法会同步更新群组 memberCount 信息。该操作仅影响本地缓存数据与 UI 显示，不会向融云服务端发送请求。

Parameters
- groupId: string
- members: IRCKitGroupMemberProfile[]
Returns void

removeGroupMembers

removeGroupMembers(groupId: string, members: string[]): void

- Defined in src/core/RCKitApplication.ts:285
删除群组成员，调用该方法会同步更新群组 memberCount 信息。该操作仅影响本地缓存数据与 UI 显示，不会向融云服务端发送请求。

Parameters
- groupId: string
- members: string[]
Returns void

cloneConversationMenu

cloneConversationMenu(): IRCKitConversationMenuItem[]

- Defined in src/core/RCKitApplication.ts:297
获取会话菜单拷贝

Returns IRCKitConversationMenuItem[]

setConversationMenu

setConversationMenu(menu: IRCKitConversationMenuItem[]): void

- Defined in src/core/RCKitApplication.ts:301
Parameters
- menu: IRCKitConversationMenuItem[]
Returns void

cloneMessageMenu

cloneMessageMenu(): IRCKitMessageMenuItem[]

- Defined in src/core/RCKitApplication.ts:305
Returns IRCKitMessageMenuItem[]

setMessageMenu

setMessageMenu(menu: IRCKitMessageMenuItem[]): void

- Defined in src/core/RCKitApplication.ts:309
Parameters
- menu: IRCKitMessageMenuItem[]
Returns void

openConversation

openConversation(conversation: IConversationOption): Promise<{ code: number }>

- Defined in src/core/RCKitApplication.ts:322
打开指定会话，若会话不存在于当前显示的会话列表内，新建会话并将其置于会话列表尽可能靠前位置

Parameters
- conversation: IConversationOption
Returns Promise<{ code: number }>

getOpenedConversation

getOpenedConversation(): null | IRCKitCachedConversation

- Defined in src/core/RCKitApplication.ts:330
获取当前打开中的会话，若未打开任何会话，则返回 null

Returns null | IRCKitCachedConversation

setConversationExtension

setConversationExtension(extensions: IRCKitConversationExtension[]): void

- Defined in src/core/RCKitApplication.ts:341
向右侧会话详情面板添加功能拓展，仅在 ready 之前调用有效。
description
- 添加拓展后，当用户点击时，会向业务层派发 RCKitEvents.CONVERSATION_EXTENSION_CLICK 事件。
Parameters
- extensions: IRCKitConversationExtension[]
Returns void

cloneInputMenu

cloneInputMenu(): IRCKitInputMenu

- Defined in src/core/RCKitApplication.ts:357
获取输入框菜单配置拷贝

Returns IRCKitInputMenu

setInputMenu

setInputMenu(menu: IRCKitInputMenu): void

- Defined in src/core/RCKitApplication.ts:366
设置新的输入框菜单配置

Parameters
- menu: IRCKitInputMenu
Returns void

cloneMessageBubbleCfg

cloneMessageBubbleCfg(): IRCKitMessageBubbleCfg

- Defined in src/core/RCKitApplication.ts:370
Returns IRCKitMessageBubbleCfg

setMessageBubbleCfg

setMessageBubbleCfg(config: IRCKitMessageBubbleCfg): void

- Defined in src/core/RCKitApplication.ts:375
Parameters
- config: IRCKitMessageBubbleCfg
Returns void

cloneImageEmojiLibraries

cloneImageEmojiLibraries(): IRCKitImageEmojiLibrary[]

- Defined in src/core/RCKitApplication.ts:383
获取已存在的图片表情库列表拷贝

Returns IRCKitImageEmojiLibrary[]

setImageEmojiLibraries

setImageEmojiLibraries(libraries: IRCKitImageEmojiLibrary[]): void

- Defined in src/core/RCKitApplication.ts:391
设置图片表情库列表

Parameters
- libraries: IRCKitImageEmojiLibrary[]
Returns void

cloneChatEmojiLibrary

cloneChatEmojiLibrary(): IRCKitChatEmojiLibrary

- Defined in src/core/RCKitApplication.ts:398
获取已存在的字符表情库拷贝

Returns IRCKitChatEmojiLibrary

setChatEmojiLibrary

setChatEmojiLibrary(library: IRCKitChatEmojiLibrary): void

- Defined in src/core/RCKitApplication.ts:406
设置字符表情库

Parameters
- library: IRCKitChatEmojiLibrary
Returns void

sendMessage

sendMessage(conversation: IConversationOption, message: BaseMessage<any>, options?: ISendMessageOptions): Promise<{ code: number; message?: IAReceivedMessage }>

- Defined in src/core/RCKitApplication.ts:421
发送消息

Parameters
- conversation: IConversationOption
  
  会话
- message: BaseMessage<any>
  
  消息
- Optional options: ISendMessageOptions
  
  发送选项
Returns Promise<{ code: number; message?: IAReceivedMessage }>

insertMessage

insertMessage(conversation: IConversationOption, message: BaseMessage<any>): Promise<{ code: number }>

- Defined in src/core/RCKitApplication.ts:431
向本地插入一条消息

Parameters
- conversation: IConversationOption
  
  会话
- message: BaseMessage<any>
  
  消息
Returns Promise<{ code: number }>

ready

ready(): void

- Defined in src/core/RCKitApplication.ts:438
通知 SDK 配置准备完成，以便 SDK 依据配置进行初始化。

Returns void

ifReady

ifReady(): boolean

- Defined in src/core/RCKitApplication.ts:453
检测 SDK 是否已完成初始化

Returns boolean
是否已完成初始化

getCurrenUserId

getCurrenUserId(): string

- Defined in src/core/RCKitApplication.ts:457
Returns string

destroy

destroy(): void

- Defined in src/core/RCKitApplication.ts:464
反初始化

Returns void

Constructors

constructor

new RCKitApplication(context: PluginContext, _logger: ILogger, opts: IRCKitInitOpts): RCKitApplication

Overrides EventDispatcher<EventDefined>.constructor
- Defined in src/core/RCKitApplication.ts:93
Parameters
- context: PluginContext
- _logger: ILogger
- opts: IRCKitInitOpts
Returns RCKitApplication

Hierarchy

Index

Methods

Constructors

Methods

addEventListener

Type Parameters

K extends keyof EventDefined

Parameters

type: string | K

listener: ((evt: EventDefined[K]) => void)

Parameters

evt: EventDefined[K]

Returns void

Optional target: any

Returns void

onceEventListener

Type Parameters

K extends keyof EventDefined

Parameters

type: string | K

listener: ((evt: EventDefined[K]) => void)

Parameters

evt: EventDefined[K]

Returns void

Optional target: any

Returns void

removeEventListener

Type Parameters

K extends keyof EventDefined

Parameters

type: string | K

listener: ((evt: EventDefined[K]) => void)

Parameters

evt: EventDefined[K]

Returns void

Optional target: any

Returns void

removeEventListeners

Parameters

type: string

Returns void

removeAllEventListeners

Returns void

dispatchEvent

Type Parameters

K extends keyof EventDefined

Parameters

event: EventDefined[K]

defer: boolean = true

Returns void

setCommandSwitch

Parameters

command: RCKitCommand

enable: boolean

Returns void

getCommandSwitch

Parameters

command: RCKitCommand

Returns boolean

registerCustomElement

Type Parameters

T extends "HQVoiceMessageComponent"

Parameters

tag: T

opts: IRCKitDefineCustomElementOptions<{ value: IRCKitOverrideAbleComponentProps[T] }>

Returns void

registerMessageType

Type Parameters

T = any

Parameters

messageType: string

options: IRCKitRegisterMessageTypeOpts

Returns (new (content: T) => BaseMessage<T>)

Parameters

content: T

Returns BaseMessage<T>

cloneLanguageEntries

Parameters

lang: string