NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
nim::MsgLog::QueryMsgByKeywordParam类 参考

#include <nim_cpp_msglog.h>

Public 成员函数

 QueryMsgByKeywordParam ()=default
 

Public 属性

std::string keyword_
 要查询的关键字
 
std::string account_id_
 查询 ID,对方的 account ID 或者群组 team ID,可留空将不作为查询条件
 
nim::NIMSessionType to_type_ {kNIMSessionTypeP2P}
 enum 会话类型,双人0,群组1 (nim_msglog_def.h),当 id_ 为空时,to_type_ 不作为查询条件
 
std::vector< nim::NIMMessageType > type_
 std::list 要获取的消息类型,默认只有文本类消息,可自行扩充其他类型消息,除通知类消息不受支持外,其他类型消息(包括自定义消息)均可检索
 
uint32_t limit_count_ {100}
 uint32_t 本次查询的消息条数上限,默认 100 条
 
time_t from_time_ {0}
 time_t 起始时间点,单位:毫秒
 
time_t end_time_ {0}
 time_t 结束时间点,单位:毫秒
 
NIMMsglogSearchDirection direction_ {kForward}
 查询方向,
 
NIMMsglogSearchSegmentEngine segment_engine_ {kSegmentEngineSimple}
 enum 全文检索对搜索词分词逻辑,默认为 kSimple
 
bool enable_pinyin_ {true}
 bool 是否使用拼音检索,默认为 true
 

详细描述

根据关键字本地查询消息参数

构造及析构函数说明

◆ QueryMsgByKeywordParam()

nim::MsgLog::QueryMsgByKeywordParam::QueryMsgByKeywordParam ( )
default

类成员变量说明

◆ account_id_

std::string nim::MsgLog::QueryMsgByKeywordParam::account_id_

查询 ID,对方的 account ID 或者群组 team ID,可留空将不作为查询条件

◆ direction_

NIMMsglogSearchDirection nim::MsgLog::QueryMsgByKeywordParam::direction_ {kForward}

查询方向,

参见
NIMMsglogSearchDirection

◆ enable_pinyin_

bool nim::MsgLog::QueryMsgByKeywordParam::enable_pinyin_ {true}

bool 是否使用拼音检索,默认为 true

◆ end_time_

time_t nim::MsgLog::QueryMsgByKeywordParam::end_time_ {0}

time_t 结束时间点,单位:毫秒

◆ from_time_

time_t nim::MsgLog::QueryMsgByKeywordParam::from_time_ {0}

time_t 起始时间点,单位:毫秒

◆ keyword_

std::string nim::MsgLog::QueryMsgByKeywordParam::keyword_

要查询的关键字

◆ limit_count_

uint32_t nim::MsgLog::QueryMsgByKeywordParam::limit_count_ {100}

uint32_t 本次查询的消息条数上限,默认 100 条

◆ segment_engine_

NIMMsglogSearchSegmentEngine nim::MsgLog::QueryMsgByKeywordParam::segment_engine_ {kSegmentEngineSimple}

enum 全文检索对搜索词分词逻辑,默认为 kSimple

参见
NIMMsglogSearchSegmentEngine

◆ to_type_

nim::NIMSessionType nim::MsgLog::QueryMsgByKeywordParam::to_type_ {kNIMSessionTypeP2P}

enum 会话类型,双人0,群组1 (nim_msglog_def.h),当 id_ 为空时,to_type_ 不作为查询条件

◆ type_

std::vector<nim::NIMMessageType> nim::MsgLog::QueryMsgByKeywordParam::type_

std::list 要获取的消息类型,默认只有文本类消息,可自行扩充其他类型消息,除通知类消息不受支持外,其他类型消息(包括自定义消息)均可检索


该类的文档由以下文件生成: