AVDChat

Superclass:
AVDModule
Declared In:

Introduction

房间中聊天模块接口.

房间聊天模块定义房间中公聊和私聊等聊天功能接口。



Methods

+getChat:
-getPrivateHistoryMessage:begin:count:userId:
-getPublicHistoryMessage:begin:count:
-sendPrivateMessage:toUser:
-sendPublicMessage:

getChat:


+ (AVDChat* ) getChat:(AVDRoom*)room; 
Return Value

返回聊天模块对象。

Discussion

获取聊天功能模块对象

@param[in] *room 房间对象指针


getPrivateHistoryMessage:begin:count:userId:


- (NSMutableArray*) getPrivateHistoryMessage:(BOOL)latest 
        begin:(NSInteger)begindex count:(NSInteger)count userId:(AVDUserId)userId; 
Return Value

返回消息列表。

返回数组中存放着AVDMessage对象:

Discussion

获取私聊历史消息记录

@param[in] latest 是否是最新记录(即反序)。 @param[in] begindex 消息起始索引。 @param[in] count 请求消息数量。 @param[in] userId 聊天对方的用户Id。


getPublicHistoryMessage:begin:count:


- (NSMutableArray*) getPublicHistoryMessage:(BOOL)latest 
        begin:(NSInteger)begindex count:(NSInteger)count; 
Return Value

返回消息列表。

返回数组中存放着AVDMessage对象:

Discussion

获取公聊历史消息记录

@param[in] latest 是否是最新记录(即反序)。 @param[in] begindex 消息起始索引。 @param[in] count 请求消息数量。


sendPrivateMessage:toUser:


- (AVDResult) sendPrivateMessage:(NSString *)message toUser:(AVDUserId)toId; 
Return Value

返回错误代码。

Discussion

发送私聊消息

@param[in] *message 消息内容。 @param[in] toId 私聊消息目的用户Id。


sendPublicMessage:


- (AVDResult) sendPublicMessage:(NSString *)message; 
Return Value

返回错误代码。

Discussion

发送公聊消息

@param[in] *message 消息内容。