nim_qchat_message.h 文件参考

#include "nim_qchat_defines/nim_qchat_message_def.h"
#include "public_defines.h"

浏览源代码.

函数
NIM_SDK_DLL_API void	nim_qchat_reg_recv_msg_cb (const NIMQChatRegRecvMsgCbParam *param)
	注册接收消息回调
NIM_SDK_DLL_API void	nim_qchat_reg_msg_updated_cb (const NIMQChatRegMsgUpdatedCbParam *param)
	注册消息更新回调
NIM_SDK_DLL_API void	nim_qchat_send_msg (const NIMQChatSendMessageParam *param)
	发送圈组消息
NIM_SDK_DLL_API void	nim_qchat_update_msg (const NIMQChatUpdateMessageParam *param)
	更新圈组消息
NIM_SDK_DLL_API void	nim_qchat_revoke_msg (const NIMQChatRevokeMessageParam *param)
	撤回圈组消息，撤回未读消息不影响未读数
NIM_SDK_DLL_API void	nim_qchat_delete_msg (const NIMQChatDeleteMessageParam *param)
	删除圈组消息，删除未读消息影响未读数
NIM_SDK_DLL_API void	nim_qchat_query_history_msg (const NIMQChatGetMessagesParam *param)
	查询历史消息
NIM_SDK_DLL_API void	nim_qchat_query_history_msg_cache (const NIMQChatGetMessagesCacheParam *param)
	从本地缓存中查询消息历史, 仅用于无网络情况或加速页面显示时使用，恢复通信后应使用GetMessages的结果进行覆盖
NIM_SDK_DLL_API void	nim_qchat_get_last_messages (const NIMQChatGetLastMessagesParam *param)
	查询频道最后一条消息
NIM_SDK_DLL_API void	nim_qchat_mark_message_read (const NIMQChatMarkMessageReadParam *param)
	标记消息已读
NIM_SDK_DLL_API void	nim_qchat_reply_message (const NIMQChatReplyMessageParam *param)
	回复指定消息
NIM_SDK_DLL_API void	nim_qchat_get_message_history_by_ids (const NIMQChatGetMessageHistoryByIdsParam *param)
	根据一批消息 ID 查询消息详情
NIM_SDK_DLL_API void	nim_qchat_get_refer_messages (const NIMQChatGetReferMessagesParam *param)
	检索一条消息得依赖消息
NIM_SDK_DLL_API void	nim_qchat_get_mentioned_me_messages (const NIMQChatGetMentionedMeMessagesParam *param)
	查询未读消息中 @ 当前用户的消息
NIM_SDK_DLL_API void	nim_qchat_are_mentioned_me_messages (const NIMQChatAreMentionedMeMessagesParam *param)
	查询消息是否 @ 当前用户
NIM_SDK_DLL_API void	nim_qchat_get_thread_messages (const NIMQChatGetThreadMessagesParam *param)
	获取 thread 消息列表
NIM_SDK_DLL_API void	nim_qchat_get_thread_root_messages_meta (const NIMQChatGetThreadRootMessagesMetaParam *param)
	查询一批 thread root 消息的基本信息（回复数量、最后回复时间）
NIM_SDK_DLL_API void	nim_qchat_add_quick_comment (const NIMQChatAddQuickCommentParam *param)
	添加快捷评论
NIM_SDK_DLL_API void	nim_qchat_remove_quick_comment (const NIMQChatRemoveQuickCommentParam *param)
	移除指定快捷评论
NIM_SDK_DLL_API void	nim_qchat_get_quick_comments (const NIMQChatGetQuickCommentsParam *param)
	批量获取一个消息关联的快捷评论列表
NIM_SDK_DLL_API void	nim_qchat_search_msg_by_page (const NIMQChatMessageSearchPageParam *param)
	消息搜索
NIM_SDK_DLL_API void	nim_qchat_insert_or_replace_text_cache (const NIMQChatInsertOrReplaceTextCacheParam *param)
	插入或更新自定义文本缓存
NIM_SDK_DLL_API void	nim_qchat_delete_text_cache (const NIMQChatDeleteTextCacheParam *param)
	删除自定义文本缓存
NIM_SDK_DLL_API void	nim_qchat_get_text_cache (const NIMQChatGetTextCacheParam *param)
	获取自定义文本缓存

详细描述

作者

NetEase Yunxin

版本

0.1

日期

2022-01-17

版权所有

(c) 2022, NetEase Inc. All rights reserved

函数说明

nim_qchat_add_quick_comment()

void nim_qchat_add_quick_comment

(

const NIMQChatAddQuickCommentParam *

param

)

添加快捷评论

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatAddQuickCommentParam

返回

void

nim_qchat_are_mentioned_me_messages()

NIM_SDK_DLL_API void nim_qchat_are_mentioned_me_messages

(

const NIMQChatAreMentionedMeMessagesParam *

param

)

查询消息是否 @ 当前用户

void nim_qchat_are_mentioned_me_messages(const NIMQChatAreMentionedMeMessagesParam* param)

自从

v9.9.0

参数

param

接口参数

参见

NIMQChatAreMentionedMeMessagesParam

返回

void

nim_qchat_delete_msg()

nim_qchat_delete_msg

(

const NIMQChatDeleteMessageParam *

param

)

删除圈组消息，删除未读消息影响未读数

参数

param

更新的消息内容

参见

NIMQChatDeleteMessageParam

返回

void

nim_qchat_delete_text_cache()

NIM_SDK_DLL_API void nim_qchat_delete_text_cache

(

const NIMQChatDeleteTextCacheParam *

param

)

删除自定义文本缓存

void nim_qchat_delete_text_cache(const NIMQChatDeleteTextCacheParam* param)

参数

param

接口参数

参见

NIMQChatDeleteTextCacheParam

返回

void

nim_qchat_get_last_messages()

void nim_qchat_get_last_messages

(

const NIMQChatGetLastMessagesParam *

param

)

查询频道最后一条消息

参数

[in]

param

接口参数

参见

NIMQChatGetLastMessagesParam

返回

void

nim_qchat_get_mentioned_me_messages()

NIM_SDK_DLL_API void nim_qchat_get_mentioned_me_messages

(

const NIMQChatGetMentionedMeMessagesParam *

param

)

查询未读消息中 @ 当前用户的消息

void nim_qchat_get_mentioned_me_messages(const NIMQChatGetMentionedMeMessagesParam* param)

自从

v9.9.0

参数

param

接口参数

参见

NIMQChatGetMentionedMeMessagesParam

返回

void

nim_qchat_get_message_history_by_ids()

void nim_qchat_get_message_history_by_ids

(

const NIMQChatGetMessageHistoryByIdsParam *

param

)

根据一批消息 ID 查询消息详情

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatGetMessageHistoryByIdsParam

返回

void

nim_qchat_get_quick_comments()

NIM_SDK_DLL_API void nim_qchat_get_quick_comments

(

const NIMQChatGetQuickCommentsParam *

param

)

批量获取一个消息关联的快捷评论列表

void nim_qchat_get_quick_comments(const NIMQChatGetQuickCommentsParam* param)

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatGetQuickCommentsParam

返回

void

nim_qchat_get_refer_messages()

NIM_SDK_DLL_API void nim_qchat_get_refer_messages

(

const NIMQChatGetReferMessagesParam *

param

)

检索一条消息得依赖消息

void nim_qchat_get_refer_messages(const NIMQChatGetReferMessagesParam* param)

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatGetReferMessagesParam

返回

void

nim_qchat_get_text_cache()

NIM_SDK_DLL_API void nim_qchat_get_text_cache

(

const NIMQChatGetTextCacheParam *

param

)

获取自定义文本缓存

void nim_qchat_get_text_cache(const NIMQChatGetTextCacheParam* param)

参数

param

接口参数

参见

NIMQChatGetTextCacheParam

返回

void

nim_qchat_get_thread_messages()

void nim_qchat_get_thread_messages

(

const NIMQChatGetThreadMessagesParam *

param

)

获取 thread 消息列表

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatGetMessagesThreadParam

返回

void

nim_qchat_get_thread_root_messages_meta()

void nim_qchat_get_thread_root_messages_meta

(

const NIMQChatGetThreadRootMessagesMetaParam *

param

)

查询一批 thread root 消息的基本信息（回复数量、最后回复时间）

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatGetThreadRootMessagesMetaParam

返回

void

nim_qchat_insert_or_replace_text_cache()

NIM_SDK_DLL_API void nim_qchat_insert_or_replace_text_cache

(

const NIMQChatInsertOrReplaceTextCacheParam *

param

)

插入或更新自定义文本缓存

void nim_qchat_insert_or_replace_text_cache(const NIMQChatInsertOrReplaceTextCacheParam* param)

参数

param

接口参数

参见

NIMQChatInsertOrReplaceTextCacheParam

返回

void

nim_qchat_mark_message_read()

void nim_qchat_mark_message_read

(

const NIMQChatMarkMessageReadParam *

param

)

标记消息已读

参数

[in]

param

接口参数

参见

NIMQChatMarkMessageReadParam

返回

void

nim_qchat_query_history_msg()

void nim_qchat_query_history_msg

(

const NIMQChatGetMessagesParam *

param

)

查询历史消息

参数

[in]

param

接口参数

参见

NIMQChatGetMessagesParam

返回

void

nim_qchat_query_history_msg_cache()

void nim_qchat_query_history_msg_cache

(

const NIMQChatGetMessagesCacheParam *

param

)

从本地缓存中查询消息历史, 仅用于无网络情况或加速页面显示时使用，恢复通信后应使用GetMessages的结果进行覆盖

参数

param

要查询的服务器、频道

参见

NIMQChatGetMessagesCacheParam

返回

void

nim_qchat_reg_msg_updated_cb()

void nim_qchat_reg_msg_updated_cb

(

const NIMQChatRegMsgUpdatedCbParam *

param

)

注册消息更新回调

参数

[in]

param

接口参数

参见

NIMQChatRegMsgUpdatedCbParam

返回

void

nim_qchat_reg_recv_msg_cb()

void nim_qchat_reg_recv_msg_cb

(

const NIMQChatRegRecvMsgCbParam *

param

)

注册接收消息回调

参数

[in]

param

接口参数

参见

NIMQChatRegRecvMsgCbParam

返回

void

nim_qchat_remove_quick_comment()

NIM_SDK_DLL_API void nim_qchat_remove_quick_comment

(

const NIMQChatRemoveQuickCommentParam *

param

)

移除指定快捷评论

void nim_qchat_remove_quick_comment(const NIMQChatRemoveQuickCommentParam* param)

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatRemoveQuickCommentParam

返回

void

nim_qchat_reply_message()

void nim_qchat_reply_message

(

const NIMQChatReplyMessageParam *

param

)

回复指定消息

自从

v9.1.0

参数

param

接口参数

参见

NIMQChatReplyMessageParam

返回

void

nim_qchat_revoke_msg()

void nim_qchat_revoke_msg

(

const NIMQChatRevokeMessageParam *

param

)

撤回圈组消息，撤回未读消息不影响未读数

参数

param

更新的消息内容

参见

NIMQChatRevokeMessageParam

返回

void

nim_qchat_search_msg_by_page()

NIM_SDK_DLL_API void nim_qchat_search_msg_by_page

(

const NIMQChatMessageSearchPageParam *

param

)

消息搜索

void nim_qchat_search_msg_by_page(const NIMQChatMessageSearchPageParam* param)

自从

v9.4.0

参数

param

接口参数

参见

NIMQChatMessageSearchPageParam

返回

void

nim_qchat_send_msg()

void nim_qchat_send_msg

(

const NIMQChatSendMessageParam *

param

)

发送圈组消息

参数

[in]

param

接口参数

参见

NIMQChatSendMessageParam

返回

void

nim_qchat_update_msg()

void nim_qchat_update_msg

(

const NIMQChatUpdateMessageParam *

param

)

更新圈组消息

参数

param

更新的消息内容

参见

NIMQChatUpdateMessageParam

返回

void