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:48
Type Parameters
- K extends keyof EventDefined
Parameters
- event: EventDefined[K]
- defer: boolean = true
Returns void

setCommandSwitch

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

- Defined in src/core/RCKitApplication.ts:114
Define feature switches, and you can view all supported configuration items through RCKitCommand. This must be called before ready.

Parameters
- command: RCKitCommand
- enable: boolean
Returns void

getCommandSwitch

getCommandSwitch(command: RCKitCommand): boolean

- Defined in src/core/RCKitApplication.ts:121
Query the status of feature switches. You can view all supported configuration items through RCKitCommand.

Parameters
- command: RCKitCommand
Returns boolean

registerCustomElement

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

[ZH] 注册自定义组件，以替换 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:180
Register custom message types, must be called before 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:187
Parameters
- lang: string
Returns null | {}

registerLanguagePack

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

- Defined in src/core/RCKitApplication.ts:200
Register a language package, which can also be used to override an existing language package; only valid before the ready call.

Parameters
- lang: string
  
  Language package definition, such as zh_CN.
- entries: IRCKitLanguageEntries | {}
  
  Language package entry definition.
- direction: RCKitLanguageDirection = 'ltr'
  
  Text direction for the language, default is 'ltr'; effective only when the language package is registered for the first time.
Returns void

setLanguage

setLanguage(lang: string): void

- Defined in src/core/RCKitApplication.ts:210
Language switch functionality interface.

Parameters
- lang: string
  
  Target language to switch to.
Returns void

getLanguage

getLanguage(): string

- Defined in src/core/RCKitApplication.ts:217
Get the current language in use.

Returns string

getSupportedLanguages

getSupportedLanguages(): string[]

- Defined in src/core/RCKitApplication.ts:224
Retrieve the list of supported languages.

Returns string[]

setPushConfigHook

setPushConfigHook(hook: IRCKitPushConfigHook): void

- Defined in src/core/RCKitApplication.ts:237
Set a custom push configuration hook to modify the title, content, and other details of the push notification received on mobile devices before the message is sent.

Parameters
- hook: IRCKitPushConfigHook
Returns void

updateUserProfile

updateUserProfile(profile: IRCKitUserProfile): void

- Defined in src/core/RCKitApplication.ts:250
Update user information

Parameters
- profile: IRCKitUserProfile
Returns void

updateGroupProfile

updateGroupProfile(profile: IRCKitGroupProfile): void

- Defined in src/core/RCKitApplication.ts:259
Update group information

Parameters
- profile: IRCKitGroupProfile
Returns void

updateUserOnlineStatus

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

- Defined in src/core/RCKitApplication.ts:269
Update user online status

Parameters
- userId: string
  
  user ID
- online: boolean
  
  online status
Returns void

updateGroupMembers

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

- Defined in src/core/RCKitApplication.ts:280
Immediately refresh the user member list. Calling this method will synchronize the group memberCount information. This operation only affects local cached data and UI display, and will not send requests to the RongCloud server.

Parameters
- groupId: string
  
  group ID
- members: IRCKitGroupMemberProfile[]
  
  Member List
Returns void

addGroupMembers

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

- Defined in src/core/RCKitApplication.ts:289
Add Group Members. Calling this method will synchronize the group's memberCount information. This operation only affects local cache data and UI display, and does not send requests to the RongCloud server.

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

removeGroupMembers

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

- Defined in src/core/RCKitApplication.ts:298
Remove group members. Calling this method will synchronize the group’s memberCount information. This operation only affects local cache data and UI display, and does not send requests to the RongCloud server.

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

cloneConversationMenu

cloneConversationMenu(): IRCKitConversationMenuItem[]

- Defined in src/core/RCKitApplication.ts:310
Retrieve conversation menu copy.

Returns IRCKitConversationMenuItem[]

setConversationMenu

setConversationMenu(menu: IRCKitConversationMenuItem[]): void

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

cloneMessageMenu

cloneMessageMenu(): IRCKitMessageMenuItem[]

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

setMessageMenu

setMessageMenu(menu: IRCKitMessageMenuItem[]): void

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

openConversation

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

- Defined in src/core/RCKitApplication.ts:335
Open a specified conversation. If the conversation does not exist in the currently displayed conversation list, a new conversation will be created and placed as far forward as possible in the list.

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

getOpenedConversation

getOpenedConversation(): null | IRCKitCachedConversation

- Defined in src/core/RCKitApplication.ts:343
Get the currently opened conversation. If no conversation is open, it will return null.

Returns null | IRCKitCachedConversation

setConversationExtension

setConversationExtension(extensions: IRCKitConversationExtension[]): void

- Defined in src/core/RCKitApplication.ts:354
Add functionality extensions to the right-side conversation detail panel. This must be called before ready to be effective.
description
- After adding the extension, when the user clicks on it, the RCKitEvents.CONVERSATION_EXTENSION_CLICK event will be dispatched to the business layer.
Parameters
- extensions: IRCKitConversationExtension[]
Returns void

cloneInputMenu

cloneInputMenu(): IRCKitInputMenu

- Defined in src/core/RCKitApplication.ts:370
Copy the input box menu configuration

Returns IRCKitInputMenu

setInputMenu

setInputMenu(menu: IRCKitInputMenu): void

- Defined in src/core/RCKitApplication.ts:379
Set up new input box menu configurations.

Parameters
- menu: IRCKitInputMenu
Returns void

cloneMessageBubbleCfg

cloneMessageBubbleCfg(): IRCKitMessageBubbleCfg

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

setMessageBubbleCfg

setMessageBubbleCfg(config: IRCKitMessageBubbleCfg): void

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

cloneImageEmojiLibraries

cloneImageEmojiLibraries(): IRCKitImageEmojiLibrary[]

- Defined in src/core/RCKitApplication.ts:396
Get a copy of the list of existing picture emoji libraries.

Returns IRCKitImageEmojiLibrary[]

setImageEmojiLibraries

setImageEmojiLibraries(libraries: IRCKitImageEmojiLibrary[]): void

- Defined in src/core/RCKitApplication.ts:404
Set up the list of picture emoji libraries.

Parameters
- libraries: IRCKitImageEmojiLibrary[]
Returns void

cloneChatEmojiLibrary

cloneChatEmojiLibrary(): IRCKitChatEmojiLibrary

- Defined in src/core/RCKitApplication.ts:411
Get a copy of the existing character emoji library.

Returns IRCKitChatEmojiLibrary

setChatEmojiLibrary

setChatEmojiLibrary(library: IRCKitChatEmojiLibrary): void

- Defined in src/core/RCKitApplication.ts:419
Set up the character emoji library

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:434
send message

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:444
Insert a message locally.

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

ready

ready(): void

- Defined in src/core/RCKitApplication.ts:451
The configuration of the Notification SDK is completed so that the SDK can be initialized according to the configuration.

Returns void

ifReady

ifReady(): boolean

- Defined in src/core/RCKitApplication.ts:466
Detect whether the SDK has been initialized.

Returns boolean

getCurrenUserId

getCurrenUserId(): string

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

destroy

destroy(): void

- Defined in src/core/RCKitApplication.ts:477
Uninitialize

Returns void

Constructors

constructor

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

Overrides EventDispatcher<EventDefined>.constructor
- Defined in src/core/RCKitApplication.ts:89
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