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.
virtual const ChatStatus *	GetChatStatus ()=0
	Get the authority status to send current message.
virtual SDKError	SetParticipantsChatPrivilege (SDKChatPrivilege privilege)=0
	Set the chat privilege of participants.
virtual bool	IsMeetingChatLegalNoticeAvailable ()=0
	Determine whether the legal notice for chat is available.
virtual const zchar_t *	getChatLegalNoticesPrompt ()=0
	Get the chat legal notices prompt.
virtual const zchar_t *	getChatLegalNoticesExplained ()=0
	Get the chat legal notices explained.
virtual bool	IsShareMeetingChatLegalNoticeAvailable ()=0
	Determine whether the legal notice for sharing in meeting chat is available.
virtual const zchar_t *	GetShareMeetingChatStartedLegalNoticeContent ()=0
	Get the sharing in meeting chat started legal notices content.
virtual const zchar_t *	GetShareMeetingChatStoppedLegalNoticeContent ()=0
	Get the sharing in meeting chat stopped legal notices content.
virtual bool	IsChatMessageCanBeDeleted (const zchar_t *msgID)=0
	Determine whether the message can be delete.
virtual SDKError	DeleteChatMessage (const zchar_t *msgID)=0
virtual IList< const zchar_t * > *	GetAllChatMessageID ()=0
	Get all chat message id.
virtual IChatMsgInfo *	GetChatMessageById (const zchar_t *msgID)=0
virtual IChatMsgInfoBuilder *	GetChatMessageBuilder ()=0
	Get the chat message builder which can help construct the message entity.
virtual SDKError	SendChatMsgTo (IChatMsgInfo *msg)=0
virtual bool	IsFileTransferEnabled ()=0
	Determine whether file transfer is enabled.
virtual SDKError	TransferFile (const zchar_t *filePath, unsigned int userid)=0
	Send file to specify user in current session.
virtual SDKError	TransferFileToAll (const zchar_t *filePath)=0
	Send file to all users in current session.
virtual const zchar_t *	GetTransferFileTypeAllowList ()=0
	Get the list of allowed file types in transfer.
virtual unsigned long long	GetMaxTransferFileSizeBytes ()=0
	Get the maximum size for file transfer.

Detailed Description

Meeting chat controller interface.

Definition at line 716 of file meeting_chat_interface.h.

Member Function Documentation

DeleteChatMessage()

virtual SDKError IMeetingChatController::DeleteChatMessage ( const zchar_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 zchar_t * > * IMeetingChatController::GetAllChatMessageID ( )

pure virtual

Get all chat message id.

getChatLegalNoticesExplained()

virtual const zchar_t * IMeetingChatController::getChatLegalNoticesExplained ( )

pure virtual

Get the chat legal notices explained.

getChatLegalNoticesPrompt()

virtual const zchar_t * IMeetingChatController::getChatLegalNoticesPrompt ( )

pure virtual

Get the chat legal notices prompt.

GetChatMessageBuilder()

virtual IChatMsgInfoBuilder * IMeetingChatController::GetChatMessageBuilder ( )

pure virtual

Get the chat message builder which can help construct the message entity.

GetChatMessageById()

virtual IChatMsgInfo * IMeetingChatController::GetChatMessageById ( const zchar_t * msgID )

pure virtual

Get chat message by message ID.

Parameters

msgID

is the message ID.

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 nullptr. To get extended error information, see ChatStatus.

GetMaxTransferFileSizeBytes()

virtual unsigned long long IMeetingChatController::GetMaxTransferFileSizeBytes ( )

pure virtual

Get the maximum size for file transfer.

Returns

The maximum number of bytes for file transfer.

GetShareMeetingChatStartedLegalNoticeContent()

virtual const zchar_t * IMeetingChatController::GetShareMeetingChatStartedLegalNoticeContent ( )

pure virtual

Get the sharing in meeting chat started legal notices content.

GetShareMeetingChatStoppedLegalNoticeContent()

virtual const zchar_t * IMeetingChatController::GetShareMeetingChatStoppedLegalNoticeContent ( )

pure virtual

Get the sharing in meeting chat stopped legal notices content.

GetTransferFileTypeAllowList()

virtual const zchar_t * IMeetingChatController::GetTransferFileTypeAllowList ( )

pure virtual

Get the list of allowed file types in transfer.

Returns

The value of allowed file types in transfer, comma-separated if there are multiple values. Exe files are by default forbidden from being transferred.

IsChatMessageCanBeDeleted()

virtual bool IMeetingChatController::IsChatMessageCanBeDeleted ( const zchar_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.

IsFileTransferEnabled()

virtual bool IMeetingChatController::IsFileTransferEnabled ( )

pure virtual

Determine whether file transfer is enabled.

Returns

True indicates file transfer is enabled, 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 ( IChatMsgInfo * msg )

pure virtual

Send a chat message.

Parameters

msg	Specify the message detail info .

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.

SetParticipantsChatPrivilege()

virtual SDKError IMeetingChatController::SetParticipantsChatPrivilege ( SDKChatPrivilege privilege )

pure virtual

Set the chat privilege 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.

TransferFile()

virtual SDKError IMeetingChatController::TransferFile ( const zchar_t * filePath, unsigned int userid )

pure virtual

Send file to specify user in current session.

Parameters

filePath	The absolute path of the file.
user	Send the file to this user.

Returns

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

Remarks

this interface is related to chat privilege, see SDKChatPrivilege enum.

TransferFileToAll()

virtual SDKError IMeetingChatController::TransferFileToAll ( const zchar_t * filePath )

pure virtual

Send file to all users in current session.

Parameters

filePath

The absolute path of the file.

Returns

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

Remarks

this interface is related to chat privilege, see SDKChatPrivilege enum.