IBreakoutRoomHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IBREAKOUTROOMHELPER_H
#define ZRC_IBREAKOUTROOMHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
 
enum BO_ASSIGN_PARTICIPANTS_TYPE
{
    ASSIGN_PARTICIPANTS_AUTOMATICALLY = 0,    
    ASSIGN_PARTICIPANTS_MANUALLY = 1,         
    LET_PARTICIPANTS_CHOOSE_ROOM = 2          
};
 
struct BOOptions
{
    bool     isParticipantCanChooseRoom = false;                    
    bool     isParticipantCanReturnToMainSessionAtAnyTime = true;   
    bool     isAutoMoveAllAssignedParticipantsEnabled = false;      
    bool     isBOTimerEnabled = false;                              
    uint64_t boTimerDuration = 0;                                   
    bool     isNotifyMeWhenTimeIsUp = false;                        
    BO_STOP_COUNTDOWN countdownSeconds = BO_STOP_NOT_COUNTDOWN;     
 
    BO_STOP_COUNTDOWN defaultCountDown = BO_STOP_COUNTDOWN_SECONDS_60;  
    uint64_t          defaultBOTimerDuration = 30 * 60;                 
    bool              isPreAssignEnabled = false;                       
    int               maxRoomCount = 100;                               
};
 
class IBOCreatorHelperSink
{
public:
    virtual ~IBOCreatorHelperSink() {}
 
    virtual void OnBOOptionsNotification(const BOOptions& boOptions) = 0;
 
    virtual void OnBORoomInfoListChanged(const std::vector<BreakoutRoomInfo>& boRoomInfoList) = 0;
};
 
class IBOCreatorHelper
{
public:
    virtual void RegisterSink(IBOCreatorHelperSink* pSink) = 0;
 
    virtual ZRCSDKError CreateBreakoutRooms(int count, BO_ASSIGN_PARTICIPANTS_TYPE type) = 0;
 
    virtual ZRCSDKError SetBOOptions(const BOOptions& boOptions) = 0;
    virtual ZRCSDKError GetBOOptions(BOOptions& boOptions) = 0;
 
    virtual ZRCSDKError AssignUsersToBO(const std::vector<std::string>& userGUIDList, const std::string& sessionBID) = 0;
 
    virtual ZRCSDKError RenameBreakoutRoom(const std::string& sessionBID, const std::string& newBOName) = 0;
    virtual ZRCSDKError AddBreakoutRoom() = 0;
    virtual ZRCSDKError DeleteBreakoutRoom(const std::string& sessionBID) = 0;
 
    virtual ZRCSDKError IsWebPreAssignBOEnabled(bool& enabled) = 0;
    virtual ZRCSDKError RecoverToWebPreAssignBO() = 0;
};
 
 
class IBOAdminHelperSink
{
public:
    virtual ~IBOAdminHelperSink() {}
 
    virtual void OnBOHelpRequestReceived(const std::string& userGUID, const BreakoutRoomInfo& boRoomInfo) = 0;
 
    virtual void OnBOEndTimerUpdate(uint64_t remainingSecond) = 0;
 
    virtual void OnBOTimeIsUpNotification() = 0;
};
 
class IBOAdminHelper
{
public:
    virtual void RegisterSink(IBOAdminHelperSink* pSink) = 0;
 
    virtual ZRCSDKError StartBreakoutRooms() = 0;
 
    virtual ZRCSDKError StopBreakoutRooms() = 0;
 
    virtual ZRCSDKError MoveUserToRunningBO(const std::string& userGUID, const std::string& sessionBID) = 0;
 
    virtual ZRCSDKError InviteBOUserReturnToMainSession(const std::string& userGUID) = 0;
 
    virtual ZRCSDKError JoinBOByUserRequest(const std::string& userGUID, const BreakoutRoomInfo& boRoomInfo) = 0;
    virtual ZRCSDKError IgnoreUserHelpRequest(const std::string& userGUID) = 0;
 
    virtual ZRCSDKError BroadcastMessageToBreakoutRoom(const std::string& message) = 0;
    virtual ZRCSDKError CanBroadcastMessageToBO(bool& canBroadcast) = 0;
};
 
 
class IBOAssistantHelper
{
public:
 
    virtual ZRCSDKError JoinBreakoutRoom(const std::string& sessionBID) = 0;
 
    virtual ZRCSDKError LeaveBreakoutRoom(const std::string& sessionBID) = 0;
 
    virtual ZRCSDKError ResponseHostInviteToMainSession(bool accept) = 0;
};
 
 
enum BO_HELP_ATTENDEE_RESULT
{
    BO_HELP_ATTENDEE_RESULT_UNKNOWN = -1,             
    BO_HELP_ATTENDEE_RESULT_ACCEPT = 0,               
    BO_HELP_ATTENDEE_RESULT_BUSY = 1,                 
    BO_HELP_ATTENDEE_RESULT_IGNORE = 2,               
    BO_HELP_ATTENDEE_RESULT_HOST_ALREADY_IN_BO = 3    
};
 
class IBOAttendeeHelperSink
{
public:
    virtual ~IBOAttendeeHelperSink() {}
 
    virtual void OnBOHelpAttendeeResult(BO_HELP_ATTENDEE_RESULT result) = 0;
};
 
class IBOAttendeeHelper
{
public:
    virtual void RegisterSink(IBOAttendeeHelperSink* pSink) = 0;
 
    virtual ZRCSDKError JoinBreakoutRoom() = 0;
    virtual ZRCSDKError LeaveBreakoutRoom() = 0;
 
    virtual ZRCSDKError AskHostForHelpInBO() = 0;
 
    virtual ZRCSDKError IsHostInThisBO(bool& in) = 0;
 
    virtual ZRCSDKError IsCanReturnMainSession(bool& canReturn) = 0;
};
 
 
class IBODataHelperSink
{
public:
    virtual ~IBODataHelperSink() {}
 
    virtual void OnBOUserStatusChanged(BO_USER_STATUS boUserStatus, const BreakoutRoomInfo& boRoomInfo) = 0;
    
    virtual void OnInitBOParticipants(const std::vector<MeetingParticipant>& participants, int32_t totalParticipantsCount, bool needCleanUpUserList) = 0;
 
    virtual void OnBOUserJoin(const std::vector<MeetingParticipant>& participants) = 0;
 
    virtual void OnBOUserLeave(const std::vector<MeetingParticipant>& participants) = 0;
 
    virtual void OnBOUserUpdate(const std::vector<MeetingParticipant>& participants) = 0;
};
 
class IBODataHelper
{
public:
    virtual void RegisterSink(IBODataHelperSink* pSink) = 0;
 
    virtual ZRCSDKError GetBOUserStatus(BO_USER_STATUS& boUserStatus) = 0;
 
    virtual ZRCSDKError GetBreakoutRoomList(std::vector<BreakoutRoomInfo>& boRoomList) = 0;
    
    virtual ZRCSDKError GetBreakoutRoomUserList(std::vector<MeetingParticipant>& userList) = 0;
};
 
 
class IBreakoutRoomHelperSink
{
public:
    virtual ~IBreakoutRoomHelperSink() {}
 
    virtual void OnBOStatusChanged(BO_STATUS boStatus) = 0;
 
    virtual void OnBOSwitchRequestReceived(const std::string& fromUserName, const BreakoutRoomInfo& newBORoomInfo) = 0;
 
    virtual void OnHostInviteReturnToMainSession(const std::string& fromUserName) = 0;
 
    virtual void OnBOStopCountDown(uint64_t remainingSeconds) = 0;
 
    virtual void OnStartJoinBONotification() = 0;
};
 
class IBreakoutRoomHelper
    : public IBOCreatorHelper
    , public IBOAdminHelper
    , public IBOAssistantHelper
    , public IBOAttendeeHelper
    , public IBODataHelper
{
public:
    virtual ~IBreakoutRoomHelper() {}
 
    virtual ZRCSDKError RegisterSink(IBreakoutRoomHelperSink* pSink) = 0;
    virtual ZRCSDKError DeregisterSink(IBreakoutRoomHelperSink* pSink) = 0;
 
    virtual IBOCreatorHelper* GetBOCreatorHelper() = 0;
 
    virtual IBOAdminHelper* GetBOAdminHelper() = 0;
 
    virtual IBOAssistantHelper* GetBOAssistantHelper() = 0;
 
    virtual IBOAttendeeHelper* GetBOAttendeeHelper() = 0;
 
    virtual IBODataHelper* GetBODataHelper() = 0;
 
    virtual ZRCSDKError IsBOEnabled(bool& enabled) = 0;
 
    virtual ZRCSDKError IsBOStarted(bool& started) = 0;
 
    virtual ZRCSDKError IsInMainSession(bool& isInMainSession) = 0;
 
    virtual ZRCSDKError GetBOStatus(BO_STATUS& boStatus) = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IBREAKOUTROOMHELPER_H