NIM CPP SDK  7.8.1
Typedefs
nim_session_online_service_def.h File Reference

会话服务接口相关的常量函数等定义头文件 More...

#include "public_define/nim_util_include.h"

Go to the source code of this file.

Typedefs

typedef void(* nim_session_online_service_query_session_list_cb_func) (int rescode, const char *result, const void *user_data)
 
typedef void(* nim_session_online_service_query_session_cb_func) (int rescode, const char *result, const void *user_data)
 
typedef void(* nim_session_online_service_update_session_cb_func) (int rescode, const void *user_data)
 
typedef void(* nim_session_online_service_delete_session_cb_func) (int rescode, const void *user_data)
 
typedef void(* nim_session_online_service_session_changed_cb_func) (const char *session_info, const void *user_data)
 

Variables

会话服务 【会话信息】定义
static const char * kMINSessionOLSRVInfoType = "info_session_type"
 
static const char * kMINSessionOLSRVInfoID = "info_session_id"
 
static const char * kMINSessionOLSRVInfoUpdateT = "info_update_time"
 
static const char * kMINSessionOLSRVInfoEXT = "info_ext"
 
static const char * kMINSessionOLSRVInfoLastMSG = "info_last_msg"
 
会话服务 【查询会话列表】参数定义
static const char * kMINSessionOLSRVQueryListRESCode = "query_list_res_code"
 
static const char * kMINSessionOLSRVQueryListMinTimestamp = "query_list_min_timestamp"
 
static const char * kMINSessionOLSRVQueryListMaxTimestamp = "query_list_max_timestamp"
 
static const char * kMINSessionOLSRVQueryListNeedLastMsg = "query_list_need_last_msg"
 
static const char * kMINSessionOLSRVQueryListLimit = "query_list_limit"
 
static const char * kMINSessionOLSRVQueryListHasMore = "query_list_has_more"
 
static const char * kMINSessionOLSRVQueryListInfos = "query_list_sessions"
 
会话服务 【查询会话】参数定义
static const char * kMINSessionOLSRVQueryType = "query_session_type"
 
static const char * kMINSessionOLSRVQueryID = "query_session_id"
 
会话服务 【更新会话】参数定义
static const char * kMINSessionOLSRVUpdateType = "update_session_type"
 
static const char * kMINSessionOLSRVUpdateID = "update_session_id"
 
static const char * kMINSessionOLSRVUpdateEXT = "update_ext"
 
会话服务 【删除会话】参数定义
static const char * kMINSessionOLSRVDeleteType = "delete_session_type"
 
static const char * kMINSessionOLSRVDeleteID = "delete_session_id"
 

Detailed Description

会话服务接口相关的常量函数等定义头文件

Author
cqu227hk
Date
2019/10/21

Typedef Documentation

◆ nim_session_online_service_delete_session_cb_func

void(* nim_session_online_service_delete_session_cb_func)(int rescode, const void *user_data)

删除会话的回调函数定义

Parameters
[out]rescode操作结果,成功200
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_session_online_service_query_session_cb_func

void(* nim_session_online_service_query_session_cb_func)(int rescode, const char *result, const void *user_data)

查询会话的回调函数定义

Parameters
[out]rescode操作结果,成功200
[out]result会话Json string
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_session_online_service_query_session_list_cb_func

void(* nim_session_online_service_query_session_list_cb_func)(int rescode, const char *result, const void *user_data)

查询会话列表的回调函数定义

Parameters
[out]rescode操作结果,成功200
[out]result会话列表Json string
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_session_online_service_session_changed_cb_func

void(* nim_session_online_service_session_changed_cb_func)(const char *session_info, const void *user_data)

会话变更时的回调函数定义

Parameters
[out]session_info变更会话的信息
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

◆ nim_session_online_service_update_session_cb_func

void(* nim_session_online_service_update_session_cb_func)(int rescode, const void *user_data)

更新会话的回调函数定义

Parameters
[out]rescode操作结果,成功200
[out]user_dataAPP的自定义用户数据,SDK只负责传回给回调函数,不做任何处理!
Returns
void 无返回值

Variable Documentation

◆ kMINSessionOLSRVDeleteID

const char* kMINSessionOLSRVDeleteID = "delete_session_id"
static

string 会话ID

◆ kMINSessionOLSRVDeleteType

const char* kMINSessionOLSRVDeleteType = "delete_session_type"
static

int 会话类型

◆ kMINSessionOLSRVInfoEXT

const char* kMINSessionOLSRVInfoEXT = "info_ext"
static

string 扩展字段,可自定义

◆ kMINSessionOLSRVInfoID

const char* kMINSessionOLSRVInfoID = "info_session_id"
static

string 会话ID

◆ kMINSessionOLSRVInfoLastMSG

const char* kMINSessionOLSRVInfoLastMSG = "info_last_msg"
static

string 最后一条消息的相关数据 json格式,

◆ kMINSessionOLSRVInfoType

const char* kMINSessionOLSRVInfoType = "info_session_type"
static

int 会话类型

◆ kMINSessionOLSRVInfoUpdateT

const char* kMINSessionOLSRVInfoUpdateT = "info_update_time"
static

uint64_t 会话最后更新时间

◆ kMINSessionOLSRVQueryID

const char* kMINSessionOLSRVQueryID = "query_session_id"
static

string 会话ID

◆ kMINSessionOLSRVQueryListHasMore

const char* kMINSessionOLSRVQueryListHasMore = "query_list_has_more"
static

bool 结果集是否完整 如果为"false" 可以根据上一请求的 MaxTimestamp 再次发起增时请求

◆ kMINSessionOLSRVQueryListInfos

const char* kMINSessionOLSRVQueryListInfos = "query_list_sessions"
static

array 查询到的会话列表

◆ kMINSessionOLSRVQueryListLimit

const char* kMINSessionOLSRVQueryListLimit = "query_list_limit"
static

int,获取的最多记录数量,最大100,缺省100

◆ kMINSessionOLSRVQueryListMaxTimestamp

const char* kMINSessionOLSRVQueryListMaxTimestamp = "query_list_max_timestamp"
static

uint64_t 最大时间戳,翻页时使用

◆ kMINSessionOLSRVQueryListMinTimestamp

const char* kMINSessionOLSRVQueryListMinTimestamp = "query_list_min_timestamp"
static

uint64_t 最小时间戳

◆ kMINSessionOLSRVQueryListNeedLastMsg

const char* kMINSessionOLSRVQueryListNeedLastMsg = "query_list_need_last_msg"
static

bool 结果中是否需要返回最近一条消息,缺省true

◆ kMINSessionOLSRVQueryListRESCode

const char* kMINSessionOLSRVQueryListRESCode = "query_list_res_code"
static

int 查询结果错误码 200成功

◆ kMINSessionOLSRVQueryType

const char* kMINSessionOLSRVQueryType = "query_session_type"
static

int 会话类型

◆ kMINSessionOLSRVUpdateEXT

const char* kMINSessionOLSRVUpdateEXT = "update_ext"
static

string 扩展字段,可自定义

◆ kMINSessionOLSRVUpdateID

const char* kMINSessionOLSRVUpdateID = "update_session_id"
static

string 会话ID

◆ kMINSessionOLSRVUpdateType

const char* kMINSessionOLSRVUpdateType = "update_session_type"
static

int 会话类型