NIM C# SDK  6.3.0
NIM.NIMSubscribeApi Class Reference

Public Member Functions

delegate void PushEventDelegate (ResponseCode code, NIMEventInfo info)
 接收订阅的事件的回调函数定义 More...
 
delegate void BatchPushEventDelegaet (ResponseCode code, List< NIMEventInfo > infoList)
 批量接收订阅的事件的回调函数定义 More...
 
delegate void PublishEventDelegate (ResponseCode code, NIMEventInfo info)
 发布事件的回调函数定义 More...
 
delegate void SubscribeEventDelegate (ResponseCode code, int type, List< string > failedIDList)
 订阅事件的回调函数定义 More...
 
delegate void UnSubscribeEventDelegate (ResponseCode code, int type, List< string > failedIDList)
 按账号取消指定事件的订阅关系的回调函数定义 More...
 
delegate void BatchUnscribeEventDelegate (ResponseCode code, int type)
 取消指定事件的全部订阅关系的回调函数定义 More...
 
delegate void QuerySubscribeDelegate (ResponseCode code, List< NIMSubscribeStatus > subscribeList)
 查询指定事件的全部订阅关系的回调函数定义 More...
 

Static Public Member Functions

static void RegPushEventCb (PushEventDelegate cb)
 (全局回调)统一注册接收订阅的事件的回调函数 More...
 
static void RegBatchPushEventCb (BatchPushEventDelegaet cb)
 (全局回调)统一注册批量接收订阅的事件的回调函数 More...
 
static bool Publish (NIMEventInfo info, PublishEventDelegate cb, object data=null)
 发布事件 More...
 
static bool Subscribe (int eventType, long period, NIMEventSubscribeSyncEventType syncType, List< string > idList, SubscribeEventDelegate cb)
 订阅事件 More...
 
static bool UnSubscribe (int eventType, List< string > idList, UnSubscribeEventDelegate cb)
 按账号取消指定事件的订阅关系 More...
 
static bool BatchUnSubscribe (int eventType, BatchUnscribeEventDelegate cb)
 取消指定事件的全部订阅关系 More...
 
static bool QuerySubscribe (int eventType, List< string > idList, QuerySubscribeDelegate cb)
 按账号查询指定事件订阅关系 More...
 
static bool BatchQuerySubscribe (int eventType, QuerySubscribeDelegate cb)
 查询指定事件的全部订阅关系 More...
 

Member Function Documentation

◆ BatchPushEventDelegaet()

delegate void NIM.NIMSubscribeApi.BatchPushEventDelegaet ( ResponseCode  code,
List< NIMEventInfo infoList 
)

批量接收订阅的事件的回调函数定义

Parameters
code错误码

<param name="infoList"事件信息列表

◆ BatchQuerySubscribe()

static bool NIM.NIMSubscribeApi.BatchQuerySubscribe ( int  eventType,
QuerySubscribeDelegate  cb 
)
static

查询指定事件的全部订阅关系

Parameters
eventType事件类型
cb
Returns

◆ BatchUnscribeEventDelegate()

delegate void NIM.NIMSubscribeApi.BatchUnscribeEventDelegate ( ResponseCode  code,
int  type 
)

取消指定事件的全部订阅关系的回调函数定义

Parameters
code错误码
type取消的事件类型

◆ BatchUnSubscribe()

static bool NIM.NIMSubscribeApi.BatchUnSubscribe ( int  eventType,
BatchUnscribeEventDelegate  cb 
)
static

取消指定事件的全部订阅关系

Parameters
eventType事件类型
cb
Returns

◆ Publish()

static bool NIM.NIMSubscribeApi.Publish ( NIMEventInfo  info,
PublishEventDelegate  cb,
object  data = null 
)
static

发布事件

Parameters
info事件信息
cb
data
Returns

◆ PublishEventDelegate()

delegate void NIM.NIMSubscribeApi.PublishEventDelegate ( ResponseCode  code,
NIMEventInfo  info 
)

发布事件的回调函数定义

Parameters
code错误码
info发布的事件信息

◆ PushEventDelegate()

delegate void NIM.NIMSubscribeApi.PushEventDelegate ( ResponseCode  code,
NIMEventInfo  info 
)

接收订阅的事件的回调函数定义

Parameters
code错误码
info事件信息

◆ QuerySubscribe()

static bool NIM.NIMSubscribeApi.QuerySubscribe ( int  eventType,
List< string >  idList,
QuerySubscribeDelegate  cb 
)
static

按账号查询指定事件订阅关系

Parameters
eventType事件类型
idList用户列表
cb
Returns

◆ QuerySubscribeDelegate()

delegate void NIM.NIMSubscribeApi.QuerySubscribeDelegate ( ResponseCode  code,
List< NIMSubscribeStatus subscribeList 
)

查询指定事件的全部订阅关系的回调函数定义

Parameters
code错误码
subscribeList订阅关系信息列表

◆ RegBatchPushEventCb()

static void NIM.NIMSubscribeApi.RegBatchPushEventCb ( BatchPushEventDelegaet  cb)
static

(全局回调)统一注册批量接收订阅的事件的回调函数

Parameters
cb

◆ RegPushEventCb()

static void NIM.NIMSubscribeApi.RegPushEventCb ( PushEventDelegate  cb)
static

(全局回调)统一注册接收订阅的事件的回调函数

Parameters
cb

◆ Subscribe()

static bool NIM.NIMSubscribeApi.Subscribe ( int  eventType,
long  period,
NIMEventSubscribeSyncEventType  syncType,
List< string >  idList,
SubscribeEventDelegate  cb 
)
static

订阅事件

Parameters
eventType事件类型
period订阅有效期,单位:秒,范围:60s到30天
syncType订阅后是否立即同步最新事件,见NIMEventSubscribeSyncType定义

<param name="idList"用户列表>

Parameters
cb
Returns

◆ SubscribeEventDelegate()

delegate void NIM.NIMSubscribeApi.SubscribeEventDelegate ( ResponseCode  code,
int  type,
List< string >  failedIDList 
)

订阅事件的回调函数定义

Parameters
code错误码
type订阅的事件类型
failedIDList订阅失败的帐号列表

◆ UnSubscribe()

static bool NIM.NIMSubscribeApi.UnSubscribe ( int  eventType,
List< string >  idList,
UnSubscribeEventDelegate  cb 
)
static

按账号取消指定事件的订阅关系

Parameters
eventType事件类型
idList用户列表
cb
Returns

◆ UnSubscribeEventDelegate()

delegate void NIM.NIMSubscribeApi.UnSubscribeEventDelegate ( ResponseCode  code,
int  type,
List< string >  failedIDList 
)

按账号取消指定事件的订阅关系的回调函数定义

Parameters
code错误码
type取消订阅的事件类型
failedIDList取消订阅失败的帐号列表