com.plv.livescenes.chatroom

接口 IPLVChatroomManager

所有已知实现类:

PLVChatroomManager

public interface IPLVChatroomManager

聊天室接口

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	IPLVChatroomManager.RequestApiListener<D> 请求api的监听器
static interface	IPLVChatroomManager.RoomStatusListener 房间状态监听器

方法概要

限定符和类型	方法和说明
void	addOnRoomStatusListener(IPLVChatroomManager.RoomStatusListener listener) 添加房间状态监听器
void	addSendChatImageListener(PLVSendChatImageListener sendChatImageListener) 添加发送图片的监听器
void	destroy() 销毁
PLVChatFunctionSwitchVO	getChatFunctionSwitchVO() 获取聊天室功能的开关实例，为null时用requestFunctionSwitch方法请求
<any>	getHistoryQuestionMessage(java.lang.String roomId, java.lang.String userId, int start, int end) 获取历史提问信息
int	getOnlineCount() 获取聊天室的在线人数
void	getOverLengthFullMessage(java.lang.String msgId, Ack ack) 过长消息获取完整的消息内容
void	init() 初始化
boolean	isCloseRoom() 当前聊天室是否关闭
int	kick(java.lang.String userId) 踢人
void	removeOnRoomStatusListener(IPLVChatroomManager.RoomStatusListener listener) 移除房间状态监听器
void	removeSendChatImageListener(PLVSendChatImageListener sendChatImageListener) 移除发送图片的监听器
int	removeShield(java.lang.String userId) 解除禁言某个用户
void	requestFunctionSwitch(<any> consumer) 请求功能开关接口
void	sendChatImage(PLVSendLocalImgEvent localImgEvent, java.lang.String sessionId) 发送聊天图片
int	sendChatMessage(PLVLocalMessage localMessage, java.lang.String sessionId) 发送聊天信息至聊天室
int	sendChatMessage(PLVLocalMessage localMessage, java.lang.String sessionId, boolean needIdCallback, Ack ack) 发送聊天信息至聊天室
<DataBean> void	sendCustomMsg(PLVBaseCustomEvent<DataBean> baseCustomEvent) 发送自定义信息
int	sendEmotionImage(PLVChatEmotionEvent emotionEvent, Ack ack) 发送个性表情
void	sendInteractiveSocketMessage(java.lang.String event, java.lang.Object value, int retryCount, java.lang.String what) 发送互动应用消息，带超时重传
void	sendLikes(int count, java.lang.String sessionId) 发送点赞
void	sendLikes(java.lang.String sessionId) 发送点赞
int	sendLookAtMeMessage() 发送看我信息
int	sendQuestionMessage(PLVQuestionMessage questionMessage) 发送提问信息
int	sendQuoteMessage(PLVLocalMessage localMessage, java.lang.String sessionId, boolean needIdCallback, Ack ack, java.lang.String quoteId) 发送回复信息
int	sendQuoteMessage(PLVLocalMessage localMessage, java.lang.String sessionId, java.lang.String quoteId) 发送回复信息
void	setNickName(java.lang.String name) 修改昵称
void	setOnlineCount(int onlineCount)
void	setOnlineCountListener(IPLVOnlineCountListener onlineCountListener) 在线人数监听器
void	setProhibitedWordListener(IPLVProhibitedWordListener prohibitedWordListener) 设置发送违禁词时的监听
void	setSendCustomMsgListener(PLVSendCustomMsgListener sendCustomMsgListener) 设置发送自定义信息的监听器
void	setSocketCallbackListener(PLVSocketCallbackListener listener) socket发送消息回调
int	shield(java.lang.String userId) 禁言某个用户
void	toggleRoom(boolean isClose, IPLVChatroomManager.RequestApiListener<java.lang.String> listener) 通过调用api接口关闭/打开聊天室。
void	toggleRoomByEvent(IPLVChatroomManager.RequestApiListener<java.lang.String> listener) 通过发送socket事件关闭/打开聊天室。
int	unKick(java.lang.String userId) 移回踢出的用户

方法详细资料

init

void init()

初始化

destroy

void destroy()

销毁

sendChatMessage

int sendChatMessage(PLVLocalMessage localMessage,
                    java.lang.String sessionId)

发送聊天信息至聊天室

参数:

localMessage - 聊天信息实体

sessionId - 直播或回放的场次id，没有时可以传null

返回:

PLVLocalMessage.SendValue

sendChatMessage

int sendChatMessage(PLVLocalMessage localMessage,
                    java.lang.String sessionId,
                    boolean needIdCallback,
                    Ack ack)

发送聊天信息至聊天室

参数:

localMessage - 聊天信息实体

sessionId - 直播或回放的场次id，没有时可以传null

needIdCallback - 是否需要回调信息id

ack - ack回调

返回:

sendQuoteMessage

int sendQuoteMessage(PLVLocalMessage localMessage,
                     java.lang.String sessionId,
                     java.lang.String quoteId)

发送回复信息

参数:

localMessage - 聊天信息实体

sessionId - 直播或回放的场次id，没有时可以传null

quoteId - 信息Id

返回:

PLVLocalMessage.SendValue

sendQuoteMessage

int sendQuoteMessage(PLVLocalMessage localMessage,
                     java.lang.String sessionId,
                     boolean needIdCallback,
                     Ack ack,
                     java.lang.String quoteId)

发送回复信息

参数:

localMessage - 聊天信息实体

sessionId - 直播或回放的场次id，没有时可以传null

needIdCallback - 是否需要回调信息id

ack - ack回调

quoteId - 信息Id

返回:

PLVLocalMessage.SendValue

sendQuestionMessage

int sendQuestionMessage(PLVQuestionMessage questionMessage)

发送提问信息

参数:

questionMessage -

返回:

PLVLocalMessage.SendValue

getHistoryQuestionMessage

<any> getHistoryQuestionMessage(java.lang.String roomId,
                                java.lang.String userId,
                                int start,
                                int end)

获取历史提问信息

sendCustomMsg

<DataBean> void sendCustomMsg(PLVBaseCustomEvent<DataBean> baseCustomEvent)

发送自定义信息

类型参数:

DataBean -

参数:

baseCustomEvent - 自定义信息模型类

setSendCustomMsgListener

void setSendCustomMsgListener(PLVSendCustomMsgListener sendCustomMsgListener)

设置发送自定义信息的监听器

参数:

sendCustomMsgListener -

sendLikes

void sendLikes(java.lang.String sessionId)

发送点赞

参数:

sessionId - 直播或回放的场次id，没有时可以传null

sendLikes

void sendLikes(int count,
               java.lang.String sessionId)

发送点赞

参数:

sessionId - 直播或回放的场次id，没有时可以传null

getOnlineCount

int getOnlineCount()

获取聊天室的在线人数

返回:

setOnlineCount

void setOnlineCount(int onlineCount)

sendLookAtMeMessage

int sendLookAtMeMessage()

发送看我信息

sendEmotionImage

int sendEmotionImage(PLVChatEmotionEvent emotionEvent,
                     Ack ack)

发送个性表情

sendChatImage

void sendChatImage(PLVSendLocalImgEvent localImgEvent,
                   java.lang.String sessionId)

发送聊天图片

addSendChatImageListener

void addSendChatImageListener(PLVSendChatImageListener sendChatImageListener)

添加发送图片的监听器

removeSendChatImageListener

void removeSendChatImageListener(PLVSendChatImageListener sendChatImageListener)

移除发送图片的监听器

setSocketCallbackListener

void setSocketCallbackListener(PLVSocketCallbackListener listener)

socket发送消息回调

setProhibitedWordListener

void setProhibitedWordListener(IPLVProhibitedWordListener prohibitedWordListener)

设置发送违禁词时的监听

参数:

prohibitedWordListener - 发送违禁词时的监听器

setOnlineCountListener

void setOnlineCountListener(IPLVOnlineCountListener onlineCountListener)

在线人数监听器

参数:

onlineCountListener - 监听器

sendInteractiveSocketMessage

void sendInteractiveSocketMessage(java.lang.String event,
                                  java.lang.Object value,
                                  int retryCount,
                                  java.lang.String what)

发送互动应用消息，带超时重传

getOverLengthFullMessage

void getOverLengthFullMessage(java.lang.String msgId,
                              Ack ack)

过长消息获取完整的消息内容

参数:

msgId - 消息id

ack - 完整消息内容回调

getChatFunctionSwitchVO

PLVChatFunctionSwitchVO getChatFunctionSwitchVO()

获取聊天室功能的开关实例，为null时用requestFunctionSwitch方法请求

requestFunctionSwitch

void requestFunctionSwitch(<any> consumer)

请求功能开关接口

shield

int shield(java.lang.String userId)

禁言某个用户

参数:

userId - 连接socket的用户id

返回:

PLVLocalMessage.SendValue

removeShield

int removeShield(java.lang.String userId)

解除禁言某个用户

参数:

userId - 连接socket的用户id

返回:

PLVLocalMessage.SendValue

kick

int kick(java.lang.String userId)

踢人

参数:

userId - 连接socket的用户id

返回:

PLVLocalMessage.SendValue

unKick

int unKick(java.lang.String userId)

移回踢出的用户

参数:

userId - 连接socket的用户id

返回:

PolyvLocalMessage.SendValue

toggleRoom

void toggleRoom(boolean isClose,
                IPLVChatroomManager.RequestApiListener<java.lang.String> listener)

通过调用api接口关闭/打开聊天室。关闭聊天室后，学员将不能发言

参数:

isClose - true：关闭，false：打开

toggleRoomByEvent

void toggleRoomByEvent(IPLVChatroomManager.RequestApiListener<java.lang.String> listener)

通过发送socket事件关闭/打开聊天室。关闭聊天室后，学员将不能发言

isCloseRoom

boolean isCloseRoom()

当前聊天室是否关闭

addOnRoomStatusListener

void addOnRoomStatusListener(IPLVChatroomManager.RoomStatusListener listener)

添加房间状态监听器

removeOnRoomStatusListener

void removeOnRoomStatusListener(IPLVChatroomManager.RoomStatusListener listener)

移除房间状态监听器

setNickName

void setNickName(java.lang.String name)

修改昵称

参数:

name -