Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRCKitRegisterMessageTypeOpts

Hierarchy

  • IRCKitRegisterMessageTypeOpts

Index

Properties

Methods

Properties

Optional isCounted

isCounted?: boolean

Whether to count

Optional isPersited

isPersited?: boolean

Whether to store the message

description
  • true: The message will be stored in the database and displayed in the message list. Developers must provide a digest function and may define a component to specify its presentation in the message list.
  • false: The message will not be stored in the database or displayed in the message list. The SDK will emit the message through the RCKitEvents.UNSCHEDULED_MESSAGES event for developers to handle manually.

Optional isStatusMessage

isStatusMessage?: boolean

Is it a status message: Status messages are not counted, not stored, and do not enter offline compensation. They can only be received when online.

Optional searchProps

searchProps?: string[]

Retrieval message key, used for message search matching.

Optional component

component?: IRCKitCustomMessageComponentOpts

When isPersited is true, the corresponding bubble UI rendering component can be defined by assigning the component property. When this value is empty, the SDK will use the digest summary calculation function to render the message as a gray bar message for display.

Methods

Optional digest

  • Message Digest Calculation Function, used for the display of custom messages in the conversation list and message list. In the case where both the component and digest attributes are defined simultaneously, the SDK will prioritize using the component component for message rendering.

    Parameters

    Returns string