从服务器搜索消息的参数配置类。

该功能需要在 Console 开通「消息搜索」增值服务。

Hierarchy

  • ChatBase<EMMessageSearchOption>
    • MessageSearchOption

Constructors

Properties

hObject: EMMessageSearchOption

Methods

  • 获取搜索关键词列表。

    Returns string[]

    • 返回搜索关键词列表。
  • Returns EMMessageSearchOption

  • 设置会话 ID 过滤。可选。

    • 单聊:对端用户 ID;
    • 群聊:群组 ID。

    Parameters

    • OptionalconversationId: string

      会话 ID。不传或传空表示不过滤会话。

    Returns void

  • 设置消息查询的结束时间,Unix 时间戳,单位为毫秒。需与 setStartTime 同时指定。

    Parameters

    • endTime: number

      结束时间。默认 -1,表示忽略该参数。

    Returns void

  • 设置搜索关键词。

    可传入单个关键词,或关键词数组。单个关键词会归一为只有一项的数组后再下发。 列表只有一项时按单关键词搜索;多项时按 setKeywordMatchType 匹配。 每个关键词长度为 1-120 个字符,关键词总长度最多 120 个字符,最多支持 5 个关键词。

    Parameters

    • keywordList: string | string[]

      搜索关键词,或关键词数组。

    Returns void

  • 设置关键词列表匹配类型。仅当关键词多于一项时生效。

    公开取值与 Android / iOS 一致:OR = 0,AND = 1。

    Parameters

    Returns void

  • 设置要搜索的消息类型。

    可传入单个类型,或类型数组。单个类型会归一为只有一项的数组后再下发。 不设置表示不按类型过滤。

    Parameters

    Returns void

  • 设置搜索范围。默认仅搜索消息内容。

    Parameters

    Returns void

  • 设置消息查询的起始时间,Unix 时间戳,单位为毫秒。需与 setEndTime 同时指定。

    Parameters

    • startTime: number

      起始时间。默认 -1,表示忽略该参数。

    Returns void