IMeetingChatController Class Reference

Meeting chat controller interface. More...

#include <meeting_chat_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingChatCtrlEvent *pEvent)=0
	Set meeting chat callback event. More...
virtual const ChatStatus *	GetChatStatus ()=0
	Get the authority status to send current message. More...
virtual SDKError	SetParticipantsChatPriviledge (SDKChatPriviledge priviledge)=0
	Set the chat priviledge of participants. More...
virtual SDKError	SendChatMsgTo (wchar_t *content, unsigned int receiver, SDKChatMessageType type)=0
	Send chat message in the normal meeting. More...
virtual bool	IsMeetingChatLegalNoticeAvailable ()=0
	Determine whether the legal notice for chat is available. More...
virtual const wchar_t *	getChatLegalNoticesPrompt ()=0
	Get the chat legal notices prompt. More...
virtual const wchar_t *	getChatLegalNoticesExplained ()=0
	Get the chat legal notices explained. More...
virtual bool	IsShareMeetingChatLegalNoticeAvailable ()=0
	Determine whether the legal notice for sharing in meeting chat is available. More...
virtual const wchar_t *	GetShareMeetingChatStartedLegalNoticeContent ()=0
	Get the sharing in meeting chat started legal notices content. More...
virtual const wchar_t *	GetShareMeetingChatStoppedLegalNoticeContent ()=0
	Get the sharing in meeting chat stopped legal notices content. More...
virtual bool	IsChatMessageCanBeDeleted (const wchar_t *msgID)=0
	Determine whether the message can be delete. More...
virtual SDKError	DeleteChatMessage (const wchar_t *msgID)=0
virtual IList< const wchar_t * > *	GetAllChatMessageID ()=0
	Get all chat message id. More...

Detailed Description

Meeting chat controller interface.

Definition at line 195 of file meeting_chat_interface.h.

Member Function Documentation

DeleteChatMessage()

virtual SDKError IMeetingChatController::DeleteChatMessage ( const wchar_t *  msgID )

pure virtual

Delete chat message by message id.

Parameters

msgID

is the message id.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

GetAllChatMessageID()

virtual IList< const wchar_t * > * IMeetingChatController::GetAllChatMessageID ( )

pure virtual

Get all chat message id.

getChatLegalNoticesExplained()

virtual const wchar_t * IMeetingChatController::getChatLegalNoticesExplained ( )

pure virtual

Get the chat legal notices explained.

getChatLegalNoticesPrompt()

virtual const wchar_t * IMeetingChatController::getChatLegalNoticesPrompt ( )

pure virtual

Get the chat legal notices prompt.

GetChatStatus()

virtual const ChatStatus * IMeetingChatController::GetChatStatus ( )

pure virtual

Get the authority status to send current message.

Returns

If the function succeeds, the return value is a pointer to the structure of ChatStatus. For more details, see ChatStatus structure. Otherwise failed, the return value is NULL. To get extended error information, see ChatStatus.

GetShareMeetingChatStartedLegalNoticeContent()

virtual const wchar_t * IMeetingChatController::GetShareMeetingChatStartedLegalNoticeContent ( )

pure virtual

Get the sharing in meeting chat started legal notices content.

GetShareMeetingChatStoppedLegalNoticeContent()

virtual const wchar_t * IMeetingChatController::GetShareMeetingChatStoppedLegalNoticeContent ( )

pure virtual

Get the sharing in meeting chat stopped legal notices content.

IsChatMessageCanBeDeleted()

virtual bool IMeetingChatController::IsChatMessageCanBeDeleted ( const wchar_t *  msgID )

pure virtual

Determine whether the message can be delete.

Parameters

msgID

is the message id.

Returns

True indicates the message can be delete. Otherwise False.

IsMeetingChatLegalNoticeAvailable()

virtual bool IMeetingChatController::IsMeetingChatLegalNoticeAvailable ( )

pure virtual

Determine whether the legal notice for chat is available.

Returns

True indicates the legal notice for chat is available. Otherwise False.

IsShareMeetingChatLegalNoticeAvailable()

virtual bool IMeetingChatController::IsShareMeetingChatLegalNoticeAvailable ( )

pure virtual

Determine whether the legal notice for sharing in meeting chat is available.

Returns

True indicates the legal notice for chat is available. Otherwise False.

SendChatMsgTo()

virtual SDKError IMeetingChatController::SendChatMsgTo ( wchar_t *  content, unsigned int  receiver, SDKChatMessageType  type  )

pure virtual

Send chat message in the normal meeting.

Parameters

receiver	Specify the user ID who receives the chat message. The message will be sent to all when the value is zero(0).
content	The content of the chat message.
type	The type of the chat message

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

SetEvent()

virtual SDKError IMeetingChatController::SetEvent ( IMeetingChatCtrlEvent *  pEvent )

pure virtual

Set meeting chat callback event.

Parameters

pEvent

A pointer to the IMeetingChatCtrlEvent to receive chat callback event. For more details, see IMeetingChatCtrlEvent.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks

The event is used by SDK to pass the callback event to user's application. If this function is not called or fails, the user's application can not retrieve the callback event.

SetParticipantsChatPriviledge()

virtual SDKError IMeetingChatController::SetParticipantsChatPriviledge ( SDKChatPriviledge  priviledge )

pure virtual

Set the chat priviledge of participants.

Parameters

priviledge

The chat priviledge of participants

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.