nim_talkex.h File Reference

收藏、置顶聊天、PinMessage、ThreadMessage、快捷回复接口头文件 More...

#include "nim_talk_def.h"
#include "nim_talkex_def_collect.h"
#include "nim_talkex_def_pin_message.h"
#include "nim_talkex_def_quick_comment.h"

Go to the source code of this file.

Functions
NIM_SDK_DLL_API void	nim_talkex_collect_add_collect (const char *collect_info, nim_talkex_collect_add_collect_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_collect_remove_collects (const char *collect_list, nim_talkex_collect_remove_collects_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_collect_update_collect_ext (const char *collect_match_param, const char *ext, nim_talkex_collect_update_collect_ext_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_collect_query_collects (const char *query_collect_list_param, nim_talkex_collect_query_collects_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_quick_comment_add_quick_comment (const char *msg, const char *info, nim_talkex_quick_comment_add_quick_comment_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_quick_comment_remove_quick_comment (const char *msg, const char *remove_param, nim_talkex_quick_comment_remove_quick_comment_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_quick_comment_query_quick_comment (const char *query_param, nim_talkex_quick_comment_query_quick_comment_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_quick_comment_reg_add_quick_comment (nim_talkex_quick_comment_add_quick_comment_notify_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_quick_comment_reg_remove_quick_comment (nim_talkex_quick_comment_remove_quick_comment_notify_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_pin_message_add_pin_message (const char *msg, const char *pin_info, nim_talkex_pin_message_add_pin_message_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_pin_message_unpin_message (const char *modify_param, nim_talkex_pin_message_unpin_message_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_pin_message_update_pin_message (const char *modify_param, nim_talkex_pin_message_update_pin_message_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_pin_message_query_all_pin_message (const char *session, int to_type, const nim_talkex_pin_message_query_all_pin_message_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_pin_message_reg_add_pin_message (nim_talkex_pin_message_add_pin_message_notify_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_pin_message_reg_unpin_message (nim_talkex_pin_message_unpin_message_notify_cb_func cb, const void *user_data)
NIM_SDK_DLL_API void	nim_talkex_pin_message_reg_update_pin_message (nim_talkex_pin_message_update_pin_message_notify_cb_func cb, const void *user_data)

Detailed Description

收藏、置顶聊天、PinMessage、ThreadMessage、快捷回复接口头文件

Copyright

(c) 2015-2020, NetEase Inc. All rights reserved

Date

2020/04/20

Function Documentation

nim_talkex_collect_add_collect()

void nim_talkex_collect_add_collect	(	const char *	collect_info,
		nim_talkex_collect_add_collect_cb_func	cb,
		const void *	user_data
	)

添加收藏

Parameters

[in]	collect_info	收藏的内容
[in]	cb	添加收藏回调函数定义 详见 nim_talkex_def_collect.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_collect_query_collects()

void nim_talkex_collect_query_collects	(	const char *	query_collect_list_param,
		nim_talkex_collect_query_collects_cb_func	cb,
		const void *	user_data
	)

分页查询收藏列表

Parameters

[in]	query_collect_list_param	查询参数
[in]	cb	查询结果回调函数定义 详见 nim_talkex_def_collect.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_collect_remove_collects()

void nim_talkex_collect_remove_collects	(	const char *	collect_list,
		nim_talkex_collect_remove_collects_cb_func	cb,
		const void *	user_data
	)

添加收藏

Parameters

[in]	collect_list	要删除的收藏列表
[in]	cb	删除收藏回调函数定义 详见 nim_talkex_def_collect.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_collect_update_collect_ext()

void nim_talkex_collect_update_collect_ext	(	const char *	collect_match_param,
		const char *	ext,
		nim_talkex_collect_update_collect_ext_cb_func	cb,
		const void *	user_data
	)

更新收藏

Parameters

[in]	collect_match_param	收藏匹配参数
[in]	ext	收藏扩展参数
[in]	cb	更新收藏回调函数定义 详见 nim_talkex_def_collect.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_pin_message_add_pin_message()

nim_talkex_pin_message_add_pin_message	(	const char *	msg,
		const char *	pin_info,
		nim_talkex_pin_message_add_pin_message_cb_func	cb,
		const void *	user_data
	)

Pin某条消息

Parameters

[in]	msg	要Pin的消息
[in]	pin_info	Pin的内容 只需赋值 ext参数,其它参数SDK来补充
[in]	cb	执行结果回调函数 详见 nim_talkex_def_pin_message.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_pin_message_query_all_pin_message()

void nim_talkex_pin_message_query_all_pin_message	(	const char *	session,
		int	to_type,
		const nim_talkex_pin_message_query_all_pin_message_cb_func	cb,
		const void *	user_data
	)

查询会话的所有 Pin Message

Parameters

[in]	session	会话ID
[in]	to_type	会话类型
[in]	cb	执行结果回调函数 详见 nim_talkex_def_pin_message.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_pin_message_reg_add_pin_message()

void nim_talkex_pin_message_reg_add_pin_message	(	nim_talkex_pin_message_add_pin_message_notify_cb_func	cb,
		const void *	user_data
	)

注册添加 Pin Message 通知回调

Parameters

[in]	cb	执行结果回调函数 详见 nim_talkex_def_pin_message.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_pin_message_reg_unpin_message()

void nim_talkex_pin_message_reg_unpin_message	(	nim_talkex_pin_message_unpin_message_notify_cb_func	cb,
		const void *	user_data
	)

注册添加 UnPin Message 通知回调

Parameters

[in]	cb	执行结果回调函数 详见 nim_talkex_def_pin_message.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_pin_message_reg_update_pin_message()

void nim_talkex_pin_message_reg_update_pin_message	(	nim_talkex_pin_message_update_pin_message_notify_cb_func	cb,
		const void *	user_data
	)

注册添加 Pin Message 通知回调

Parameters

[in]	cb	执行结果回调函数 详见 nim_talkex_def_pin_message.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_pin_message_unpin_message()

void nim_talkex_pin_message_unpin_message	(	const char *	modify_param,
		nim_talkex_pin_message_unpin_message_cb_func	cb,
		const void *	user_data
	)

UnPin某条消息

Parameters

[in]	modify_param	UnPin Message 参数
[in]	cb	执行结果回调函数 详见 nim_talkex_def_pin_message.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_pin_message_update_pin_message()

void nim_talkex_pin_message_update_pin_message	(	const char *	modify_param,
		nim_talkex_pin_message_update_pin_message_cb_func	cb,
		const void *	user_data
	)

更新 Pin Message ext字段

Parameters

[in]	modify_param	更新 Pin Message 参数
[in]	cb	执行结果回调函数 详见 nim_talkex_def_pin_message.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_quick_comment_add_quick_comment()

void nim_talkex_quick_comment_add_quick_comment	(	const char *	msg,
		const char *	info,
		nim_talkex_quick_comment_add_quick_comment_cb_func	cb,
		const void *	user_data
	)

添加快捷回复

Parameters

[in]	msg	被回复的消息
[in]	info	回复的内容及设置
[in]	cb	查询结果回调函数定义 详见 nim_talkex_def_quick_comment.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_quick_comment_query_quick_comment()

void nim_talkex_quick_comment_query_quick_comment	(	const char *	query_param,
		nim_talkex_quick_comment_query_quick_comment_cb_func	cb,
		const void *	user_data
	)

查询快捷回复

Parameters

[in]	query_param	查询参数，一次最多只能查询20条消息的快捷回复
[in]	cb	查询结果回调函数定义 详见 nim_talkex_def_quick_comment.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_quick_comment_reg_add_quick_comment()

void nim_talkex_quick_comment_reg_add_quick_comment	(	nim_talkex_quick_comment_add_quick_comment_notify_cb_func	cb,
		const void *	user_data
	)

注册添加快捷回复通知回调

Parameters

[in]	cb	查询结果回调函数定义 详见 nim_talkex_def_quick_comment.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_quick_comment_reg_remove_quick_comment()

void nim_talkex_quick_comment_reg_remove_quick_comment	(	nim_talkex_quick_comment_remove_quick_comment_notify_cb_func	cb,
		const void *	user_data
	)

注册添加快捷回复通知回调

Parameters

[in]	cb	查询结果回调函数定义 详见 nim_talkex_def_quick_comment.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值

nim_talkex_quick_comment_remove_quick_comment()

void nim_talkex_quick_comment_remove_quick_comment	(	const char *	msg,
		const char *	remove_param,
		nim_talkex_quick_comment_remove_quick_comment_cb_func	cb,
		const void *	user_data
	)

删除快捷回复

Parameters

[in]	msg	被回复的消息
[in]	info	回复的内容及设置
[in]	cb	查询结果回调函数定义 详见 nim_talkex_def_quick_comment.h
[in]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns

void 无返回值