Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRCKitRegisterMessageTypeOpts

自定义消息注册配置

Hierarchy

  • IRCKitRegisterMessageTypeOpts

Index

Properties

Methods

Properties

Optional isCounted

isCounted?: boolean

是否计数

Optional isPersited

isPersited?: boolean

消息是否存储

description
  • true: 消息将进入数据库存储，并将在消息列表中显示，开发者必须提供 digest 摘要函数，同时可定义 component 组件来声明其在消息列表中的展示方式。
  • false: 消息不会进入数据库存储，也不会在消息列表中显示。SDK 会将消息通过 RCKitEvents.UNSCHEDULED_MESSAGES 事件抛给开发者自行处理。

Optional isStatusMessage

isStatusMessage?: boolean

是否为状态消息：状态消息不计数不存储，且不进入离线补偿，仅限在线时收取

Optional searchProps

searchProps?: string[]

检索消息 key，用于消息搜索匹配

Optional component

component?: IRCKitCustomMessageComponentOpts

当 isPersited 为 true 时，可通过赋值 component 属性来定义相应的气泡 UI 渲染组件。 当该值为空时，SDK 将通过 digest 摘要计算函数，渲染消息为灰条消息进行展示。

Methods

Optional digest

  • 消息摘要计算函数，用于自定义消息在会话列表和消息列表中的展示。 在同时定义了 component 与 digest 属性的情况下，SDK 会优先使用 component 组件进行消息渲染。

    Parameters

    Returns string