NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
类型定义
nim_talkex_def_pin_message.h 文件参考

PIN Message接口相关的常量函数等定义头文件 更多...

#include "public_defines.h"

浏览源代码.

类型定义

typedef void(* nim_talkex_pin_message_add_pin_message_cb_func) (int code, const char *session, int to_type, const char *pin_info, const void *user_data)
 
typedef void(* nim_talkex_pin_message_unpin_message_cb_func) (int code, const char *session, int to_type, const char *id, const void *user_data)
 
typedef void(* nim_talkex_pin_message_update_pin_message_cb_func) (int code, const char *session, int to_type, const char *pin_info, const void *user_data)
 
typedef void(* nim_talkex_pin_message_query_all_pin_message_cb_func) (int code, const char *session, int to_type, const char *pin_list, const void *user_data)
 
typedef void(* nim_talkex_pin_message_add_pin_message_notify_cb_func) (const char *session, int to_type, const char *pin_info, const void *user_data)
 
typedef void(* nim_talkex_pin_message_unpin_message_notify_cb_func) (const char *session, int to_type, const char *id, const void *user_data)
 
typedef void(* nim_talkex_pin_message_update_pin_message_notify_cb_func) (const char *session, int to_type, const char *pin_info, const void *user_data)
 

变量

Pin Message 属性Json Keys
static const char * kNIMPinMessageInfoKeyID = "id"
 string pin消息的ID 客户端生成服务端没有
 
static const char * kNIMPinMessageInfoKeySessionID = "session_id"
 string pin消息对应的会话ID 客户端数据
 
static const char * kNIMPinMessageInfoKeyServerID = "server_id"
 uint64_t 被 pin 消息的服务端ID
 
static const char * kNIMPinMessageInfoKeyClientID = "client_id"
 string 被 pin 消息的客户商dID
 
static const char * kNIMPinMessageInfoKeyToType = "to_type"
 int 被 pin 消息的会话类型
 
static const char * kNIMPinMessageInfoKeyFromAccID = "from_account"
 string 被 pin 消息的发送方ID
 
static const char * kNIMPinMessageInfoKeyToAccID = "to_account"
 string 被 pin 消息的接收方ID
 
static const char * kNIMPinMessageInfoKeyMSGTime = "message_time"
 uint64_t 被 pin 消息的时间戳
 
static const char * kNIMPinMessageInfoKeyOPAccID = "operator_account"
 string pin 消息的操作ID
 
static const char * kNIMPinMessageInfoKeyExt = "ext"
 pin string 消息的扩展字段
 
static const char * kNIMPinMessageInfoKeyCreateTime = "create_time"
 uint64_t pin 消息的创建时间戳
 
static const char * kNIMPinMessageInfoKeyUpdateTime = "update_time"
 uint64_t pin 消息的更新时间戳
 
UnPin 参数定义Json Keys
static const char * kNIMPinMessageModifyParamKeySession = "session"
 UnPin 消息所属会话
 
static const char * kNIMPinMessageModifyParamKeyToType = "to_type"
 UnPin 消息所属会话类型
 
static const char * kNIMPinMessageModifyParamKeyID = "id"
 Pin Message 的ID 客户端生成服务端没有
 
static const char * kNIMPinMessageModifyParamKeyExt = "ext"
 扩展字段
 

详细描述

PIN Message接口相关的常量函数等定义头文件

版权所有
(c) 2015-2020, NetEase Inc. All rights reserved
日期
2020/04/19

类型定义说明

◆ nim_talkex_pin_message_add_pin_message_cb_func

void(* nim_talkex_pin_message_add_pin_message_cb_func)(int code, const char *session, int to_type, const char *pin_info, const void *user_data)

添加Pin Message回调函数定义

参数
[out]code执行结果
[out]session消息所属会话
[out]to_type会话类型
[out]pin_infoPin Message 内容
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

◆ nim_talkex_pin_message_add_pin_message_notify_cb_func

void(* nim_talkex_pin_message_add_pin_message_notify_cb_func)(const char *session, int to_type, const char *pin_info, const void *user_data)

添加Pin Message通知回调函数定义

参数
[out]session消息所属会话
[out]to_type会话类型
[out]pin_infoPin Message 内容
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

◆ nim_talkex_pin_message_query_all_pin_message_cb_func

void(* nim_talkex_pin_message_query_all_pin_message_cb_func)(int code, const char *session, int to_type, const char *pin_list, const void *user_data)

查询会话的所有 Pin Message回调函数定义

参数
[out]code执行结果
[out]session消息所属会话
[out]to_type会话类型
[out]pin_listPin Message list
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

◆ nim_talkex_pin_message_unpin_message_cb_func

void(* nim_talkex_pin_message_unpin_message_cb_func)(int code, const char *session, int to_type, const char *id, const void *user_data)

添加Pin Message回调函数定义

参数
[out]code执行结果
[out]session消息所属会话
[out]to_type会话类型
[out]idPin Message id
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

◆ nim_talkex_pin_message_unpin_message_notify_cb_func

void(* nim_talkex_pin_message_unpin_message_notify_cb_func)(const char *session, int to_type, const char *id, const void *user_data)

添加UnPin Message通知回调函数定义

参数
[out]session消息所属会话
[out]to_type会话类型
[out]idPin Message id
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

◆ nim_talkex_pin_message_update_pin_message_cb_func

void(* nim_talkex_pin_message_update_pin_message_cb_func)(int code, const char *session, int to_type, const char *pin_info, const void *user_data)

更新 Pin Message ext字段回调函数定义

参数
[out]code执行结果
[out]session消息所属会话
[out]to_type会话类型
[out]pin_infoPin Message 内容
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

◆ nim_talkex_pin_message_update_pin_message_notify_cb_func

void(* nim_talkex_pin_message_update_pin_message_notify_cb_func)(const char *session, int to_type, const char *pin_info, const void *user_data)

添加 更新 Pin Message通知回调函数定义

参数
[out]session消息所属会话
[out]to_type会话类型
[out]pin_infoPin Message 内容
[out]user_dataAPP的自定义用户数据，SDK只负责传回给回调函数，不做任何处理！
返回
void 无返回值

变量说明

◆ kNIMPinMessageInfoKeyClientID

const char* kNIMPinMessageInfoKeyClientID = "client_id"
static

string 被 pin 消息的客户商dID

◆ kNIMPinMessageInfoKeyCreateTime

const char* kNIMPinMessageInfoKeyCreateTime = "create_time"
static

uint64_t pin 消息的创建时间戳

◆ kNIMPinMessageInfoKeyExt

const char* kNIMPinMessageInfoKeyExt = "ext"
static

pin string 消息的扩展字段

◆ kNIMPinMessageInfoKeyFromAccID

const char* kNIMPinMessageInfoKeyFromAccID = "from_account"
static

string 被 pin 消息的发送方ID

◆ kNIMPinMessageInfoKeyID

const char* kNIMPinMessageInfoKeyID = "id"
static

string pin消息的ID 客户端生成服务端没有

◆ kNIMPinMessageInfoKeyMSGTime

const char* kNIMPinMessageInfoKeyMSGTime = "message_time"
static

uint64_t 被 pin 消息的时间戳

◆ kNIMPinMessageInfoKeyOPAccID

const char* kNIMPinMessageInfoKeyOPAccID = "operator_account"
static

string pin 消息的操作ID

◆ kNIMPinMessageInfoKeyServerID

const char* kNIMPinMessageInfoKeyServerID = "server_id"
static

uint64_t 被 pin 消息的服务端ID

◆ kNIMPinMessageInfoKeySessionID

const char* kNIMPinMessageInfoKeySessionID = "session_id"
static

string pin消息对应的会话ID 客户端数据

◆ kNIMPinMessageInfoKeyToAccID

const char* kNIMPinMessageInfoKeyToAccID = "to_account"
static

string 被 pin 消息的接收方ID

◆ kNIMPinMessageInfoKeyToType

const char* kNIMPinMessageInfoKeyToType = "to_type"
static

int 被 pin 消息的会话类型

◆ kNIMPinMessageInfoKeyUpdateTime

const char* kNIMPinMessageInfoKeyUpdateTime = "update_time"
static

uint64_t pin 消息的更新时间戳

◆ kNIMPinMessageModifyParamKeyExt

const char* kNIMPinMessageModifyParamKeyExt = "ext"
static

扩展字段

◆ kNIMPinMessageModifyParamKeyID

const char* kNIMPinMessageModifyParamKeyID = "id"
static

Pin Message 的ID 客户端生成服务端没有

◆ kNIMPinMessageModifyParamKeySession

const char* kNIMPinMessageModifyParamKeySession = "session"
static

UnPin 消息所属会话

◆ kNIMPinMessageModifyParamKeyToType

const char* kNIMPinMessageModifyParamKeyToType = "to_type"
static

UnPin 消息所属会话类型