NIM C# SDK  6.3.0
NIM.TalkAPI Class Reference

消息相关api More...

Static Public Member Functions

static void SendMessage (NIMIMMessage message, ReportUploadProgressDelegate action=null)
 发送消息 More...
 
static void SendTeamFrocePushMessage (NIMIMMessage message, TeamForecePushMessage forceMsg, ReportUploadProgressDelegate action=null)
 向群组强制推送消息 More...
 
static void StopSendMessage (NIMIMMessage message, ReportUploadProgressDelegate action=null)
 取消发送消息,目前用于取消发送文件消息 More...
 
static void RegTeamNotificationFilterCb (TeamNotificationFilterDelegate action)
 注册接收群通知是否需要过滤的回调 More...
 
static NIMIMMessage CreateRetweetMessage (NIMIMMessage srcMsg, NIMMessageSetting msgSetting, string msgId, string sessionId, Session.NIMSessionType sessionType, long timetag)
 由其他消息生成转发消息 More...
 
static void RegReceiveBatchMessagesCb (ReceiveBatchMesaagesDelegate cb)
 注册接收批量消息回调 (如果在注册了接收消息回调的同时也注册了该批量接口,当有批量消息时,会改走这个接口通知应用层,例如登录后接收到的离线消息等) More...
 
static void RecallMessage (string msgId, string notify, RecallMessageDelegate cb)
 撤回消息 More...
 
static void RecallMessage (NIMIMMessage message, string notify, RecallMessageDelegate cb)
 撤回消息 More...
 
static void RegRecallMessageCallback (RecallMessageDelegate cb)
 注册接收消息撤回通知的回调 More...
 
static string GetAttachmentPathFromMsg (NIMIMMessage msg)
 从消息的中获取附件(图片、语音、视频等)的本地路径 More...
 
static void RegReceiveBroadcastCb (ReceiveBroadcastDelegate cb)
 (全局回调)注册接收广播消息回调 (建议全局注册,统一接受回调后分发消息到具体的会话) More...
 
static void RegReceiveBroadcastMsgsCb (ReceiveBroadcastMsgsDelegate cb)
 注册接收批量广播消息回调 (如果在注册了接收消息回调的同时也注册了该批量接口,当有批量消息时,会改走这个接口通知应用层,例如登录后接收到的离线消息等) More...
 

Properties

static EventHandler< NIMReceiveMessageEventArgsOnReceiveMessageHandler [get, set]
 接收消息事件通知 More...
 
static EventHandler< MessageArcEventArgsOnSendMessageCompleted [get, set]
 发送消息结果通知 More...
 

Detailed Description

消息相关api

Member Function Documentation

◆ CreateRetweetMessage()

static NIMIMMessage NIM.TalkAPI.CreateRetweetMessage ( NIMIMMessage  srcMsg,
NIMMessageSetting  msgSetting,
string  msgId,
string  sessionId,
Session.NIMSessionType  sessionType,
long  timetag 
)
static

由其他消息生成转发消息

Parameters
srcMsg原始消息
msgSetting新的消息属性
msgId新的客户端消息id
sessionId转发目标
sessionType转发目标会话类型
timetag消息时间
Returns

◆ GetAttachmentPathFromMsg()

static string NIM.TalkAPI.GetAttachmentPathFromMsg ( NIMIMMessage  msg)
static

从消息的中获取附件(图片、语音、视频等)的本地路径

Parameters
msg消息对象
Returns
消息如果有附件,不管是否已下载,返回附件的本地路径;消息如果没有附件,返回空字符串""

◆ RecallMessage() [1/2]

static void NIM.TalkAPI.RecallMessage ( string  msgId,
string  notify,
RecallMessageDelegate  cb 
)
static

撤回消息

Parameters
msgId消息 id
notify自定义通知
cb

◆ RecallMessage() [2/2]

static void NIM.TalkAPI.RecallMessage ( NIMIMMessage  message,
string  notify,
RecallMessageDelegate  cb 
)
static

撤回消息

Parameters
messageNIMIMMessage 对象
notify自定义通知
cb

◆ RegRecallMessageCallback()

static void NIM.TalkAPI.RegRecallMessageCallback ( RecallMessageDelegate  cb)
static

注册接收消息撤回通知的回调

Parameters
cb

◆ RegReceiveBatchMessagesCb()

static void NIM.TalkAPI.RegReceiveBatchMessagesCb ( ReceiveBatchMesaagesDelegate  cb)
static

注册接收批量消息回调 (如果在注册了接收消息回调的同时也注册了该批量接口,当有批量消息时,会改走这个接口通知应用层,例如登录后接收到的离线消息等)

Parameters
cb

◆ RegReceiveBroadcastCb()

static void NIM.TalkAPI.RegReceiveBroadcastCb ( ReceiveBroadcastDelegate  cb)
static

(全局回调)注册接收广播消息回调 (建议全局注册,统一接受回调后分发消息到具体的会话)

Parameters
cb

◆ RegReceiveBroadcastMsgsCb()

static void NIM.TalkAPI.RegReceiveBroadcastMsgsCb ( ReceiveBroadcastMsgsDelegate  cb)
static

注册接收批量广播消息回调 (如果在注册了接收消息回调的同时也注册了该批量接口,当有批量消息时,会改走这个接口通知应用层,例如登录后接收到的离线消息等)

Parameters
cb

◆ RegTeamNotificationFilterCb()

static void NIM.TalkAPI.RegTeamNotificationFilterCb ( TeamNotificationFilterDelegate  action)
static

注册接收群通知是否需要过滤的回调

Parameters
action

◆ SendMessage()

static void NIM.TalkAPI.SendMessage ( NIMIMMessage  message,
ReportUploadProgressDelegate  action = null 
)
static

发送消息

Parameters
message消息对象
action文件类消息附件上传进度

◆ SendTeamFrocePushMessage()

static void NIM.TalkAPI.SendTeamFrocePushMessage ( NIMIMMessage  message,
TeamForecePushMessage  forceMsg,
ReportUploadProgressDelegate  action = null 
)
static

向群组强制推送消息

Parameters
message消息对象
forceMsg强制推送内容
action文件类消息附件上传进度

◆ StopSendMessage()

static void NIM.TalkAPI.StopSendMessage ( NIMIMMessage  message,
ReportUploadProgressDelegate  action = null 
)
static

取消发送消息,目前用于取消发送文件消息

Parameters
message消息体
action附件上传进度回调

Property Documentation

◆ OnReceiveMessageHandler

EventHandler<NIMReceiveMessageEventArgs> NIM.TalkAPI.OnReceiveMessageHandler
staticgetset

接收消息事件通知

◆ OnSendMessageCompleted

EventHandler<MessageArcEventArgs> NIM.TalkAPI.OnSendMessageCompleted
staticgetset

发送消息结果通知