IMeetingChatController Class Reference

Meeting chat controller interface. More...

#include <meeting_chat_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingChatCtrlEvent *pEvent)=0
	Sets meeting chat callback event.
virtual const ChatStatus *	GetChatStatus ()=0
	Gets the authority status to send current message.
virtual SDKError	SetParticipantsChatPrivilege (SDKChatPrivilege privilege)=0
	Sets the chat privilege of participants.
virtual bool	IsMeetingChatLegalNoticeAvailable ()=0
	Determines whether the legal notice for chat is available.
virtual const zchar_t *	getChatLegalNoticesPrompt ()=0
	Gets the chat legal notices prompt.
virtual const zchar_t *	getChatLegalNoticesExplained ()=0
	Gets the chat legal notices explained.
virtual bool	IsShareMeetingChatLegalNoticeAvailable ()=0
	Determines whether the legal notice for sharing in meeting chat is available.
virtual const zchar_t *	GetShareMeetingChatStartedLegalNoticeContent ()=0
	Gets the sharing in meeting chat started legal notices content.
virtual const zchar_t *	GetShareMeetingChatStoppedLegalNoticeContent ()=0
	Gets the sharing in meeting chat stopped legal notices content.
virtual bool	IsChatMessageCanBeDeleted (const zchar_t *msgID)=0
	Determines whether the message can be deleted.
virtual SDKError	DeleteChatMessage (const zchar_t *msgID)=0
	Delete chat message by message id.
virtual IList< const zchar_t * > *	GetAllChatMessageID ()=0
	Gets all chat message id.
virtual IChatMsgInfo *	GetChatMessageById (const zchar_t *msgID)=0
	Gets chat message by message ID.
virtual IChatMsgInfoBuilder *	GetChatMessageBuilder ()=0
	Gets the chat message builder which can help construct the message entity.
virtual SDKError	SendChatMsgTo (IChatMsgInfo *msg)=0
	Sends a chat message.
virtual bool	IsFileTransferEnabled ()=0
	Determines whether file transfer is enabled.
virtual SDKError	TransferFile (const zchar_t *filePath, unsigned int userid)=0
	Sends file to specify user in current session.
virtual SDKError	TransferFileToAll (const zchar_t *filePath)=0
	Sends file to all users in current session.
virtual const zchar_t *	GetTransferFileTypeAllowList ()=0
	Gets the list of allowed file types in transfer.
virtual unsigned long long	GetMaxTransferFileSizeBytes ()=0
	Gets the maximum size for file transfer.

Detailed Description

Meeting chat controller interface.

Definition at line 966 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, this function returns an error.

GetAllChatMessageID()

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

pure virtual

Gets all chat message id.

getChatLegalNoticesExplained()

virtual const zchar_t * IMeetingChatController::getChatLegalNoticesExplained ( )

pure virtual

Gets the chat legal notices explained.

getChatLegalNoticesPrompt()

virtual const zchar_t * IMeetingChatController::getChatLegalNoticesPrompt ( )

pure virtual

Gets the chat legal notices prompt.

GetChatMessageBuilder()

virtual IChatMsgInfoBuilder * IMeetingChatController::GetChatMessageBuilder ( )

pure virtual

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

GetChatMessageById()

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

pure virtual

Gets chat message by message ID.

Parameters

msgID

is the message ID.

GetChatStatus()

virtual const ChatStatus * IMeetingChatController::GetChatStatus ( )

pure virtual

Gets the authority status to send current message.

Returns

If the function succeeds, the return value is a pointer to the structure of ChatStatus. Otherwise, the return value is nullptr.

GetMaxTransferFileSizeBytes()

virtual unsigned long long IMeetingChatController::GetMaxTransferFileSizeBytes ( )

pure virtual

Gets the maximum size for file transfer.

Returns

The maximum number of bytes for file transfer.

GetShareMeetingChatStartedLegalNoticeContent()

virtual const zchar_t * IMeetingChatController::GetShareMeetingChatStartedLegalNoticeContent ( )

pure virtual

Gets the sharing in meeting chat started legal notices content.

GetShareMeetingChatStoppedLegalNoticeContent()

virtual const zchar_t * IMeetingChatController::GetShareMeetingChatStoppedLegalNoticeContent ( )

pure virtual

Gets the sharing in meeting chat stopped legal notices content.

GetTransferFileTypeAllowList()

virtual const zchar_t * IMeetingChatController::GetTransferFileTypeAllowList ( )

pure virtual

Gets 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

Determines whether the message can be deleted.

Parameters

msgID

is the message id.

Returns

true if the message can be deleted. Otherwise, false.

IsFileTransferEnabled()

virtual bool IMeetingChatController::IsFileTransferEnabled ( )

pure virtual

Determines whether file transfer is enabled.

Returns

true if file transfer is enabled. Otherwise, false.

IsMeetingChatLegalNoticeAvailable()

virtual bool IMeetingChatController::IsMeetingChatLegalNoticeAvailable ( )

pure virtual

Determines whether the legal notice for chat is available.

Returns

true if the legal notice for chat is available. Otherwise, false.

IsShareMeetingChatLegalNoticeAvailable()

virtual bool IMeetingChatController::IsShareMeetingChatLegalNoticeAvailable ( )

pure virtual

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

Returns

true if the legal notice for sharing in meeting chat is available. Otherwise, false.

SendChatMsgTo()

virtual SDKError IMeetingChatController::SendChatMsgTo ( IChatMsgInfo * msg )

pure virtual

Sends a chat message.

Parameters

msg	Specify the message detail info.

SetEvent()

virtual SDKError IMeetingChatController::SetEvent ( IMeetingChatCtrlEvent * pEvent )

pure virtual

Sets meeting chat callback event.

Parameters

pEvent

A pointer to the IMeetingChatCtrlEvent to receive chat callback event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note

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

Sets the chat privilege of participants.

Parameters

privilege

The chat privilege of participants.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

TransferFile()

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

pure virtual

Sends 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, this function returns an error.

Note

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

TransferFileToAll()

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

pure virtual

Sends 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, this function returns an error.

Note

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