IParticipantHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IPARTICIPANTHELPER_H
#define ZRC_IPARTICIPANTHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum ZRWUserChangeType
{
    ZRW_JOIN = 0,     
    ZRW_LEAVE = 1,    
};
 
enum ClaimHostResult
{
    ClaimHostResultSuccess = 0,           
    ClaimHostResultInvalidHostKey = 1,    
    ClaimHostResultUnknownError = 2       
};
 
enum ReportIssueType
{
    ISSUE_TYPE_OFFENSIVE_ILLEGAL_ABUSIVE = 0x40,
    ISSUE_TYPE_SUICIDE_SELF_HARM = 0x80,
    ISSUE_TYPE_PRIVATE_INFORMATION = 0x100,
    ISSUE_TYPE_SPAM = 0x200,
    ISSUE_TYPE_COPYRIGHT_TRADEMARK_INFRINGEMENT = 0x400,
    ISSUE_TYPE_IMPERSONATION = 0x800,
    ISSUE_TYPE_ILL_TELL_YOU_LATER = 0x1
};
 
enum ConfSessionType
{
    CurrentSession = 1,    
    MasterSession = 2,     
};
 
class IParticipantHelperSink
{
public:
    virtual ~IParticipantHelperSink() {}
 
    virtual void OnInitMeetingParticipants(const std::vector<MeetingParticipant>& participants, int32_t totalParticipantsCount,
                                           bool needCleanUpUserList, ConfSessionType session) = 0;
 
    virtual void OnUserJoin(const std::vector<MeetingParticipant>& participants, ConfSessionType session) = 0;
 
    virtual void OnUserLeave(const std::vector<MeetingParticipant>& participants, ConfSessionType session) = 0;
 
    virtual void OnUserUpdate(const std::vector<MeetingParticipant>& participants, ConfSessionType session) = 0;
 
    virtual void OnHostChangedNotification(int32_t hostUserID, bool amIHost, ConfSessionType session) = 0;
 
    virtual void OnMeetingParticipantsChanged(ConfSessionType session) = 0;
 
    virtual void OnUpdateHideProfilePictures(bool isHideProfilePictures) = 0;
 
    virtual void OnHideFullRoomViewNotification(const std::vector<int32_t>& userIDs) = 0;
 
    virtual void OnClaimHostNotification(ClaimHostResult result) = 0;
 
    virtual void OnUpdateSharingAnnotationInfo(bool support, bool enable) = 0;
 
    virtual void OnAllowAttendeesRenameThemselvesNotification(bool allow) = 0;
 
    virtual void OnAllowAttendeesShareWhiteboardsNotification(bool isSupported, bool isAllowed) = 0;
 
     virtual void OnAllowRaiseHandForAttendeeNotification(bool canRaiseHandForAttendee) = 0;
 
    virtual void OnUpdateOnZRWUserChangeNotification(ZRWUserChangeType type, int32_t zrwUserID) = 0;
 
    virtual void OnUpdateHasRemoteControlAdmin(bool isAdminExist) = 0;
 
    virtual void OnUpdateHasRemoteControlAssistant(bool isAssistantExist) = 0;
 
    virtual void OnDownloadingFinished(const std::string& localFilePath, uint32_t result) = 0;
};
 
class IParticipantHelper
{
public:
    virtual ~IParticipantHelper() {}
 
    virtual ZRCSDKError RegisterSink(IParticipantHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IParticipantHelperSink* pSink) = 0;
 
    virtual ZRCSDKError GetParticipantsInMeeting(std::vector<MeetingParticipant>& participants, ConfSessionType session) = 0;
 
    virtual ZRCSDKError GetVirtualParticipantsInMeeting(std::vector<MeetingParticipant>& participants, ConfSessionType session) = 0;
 
    virtual ZRCSDKError GetParticipantsInSilentMode(std::vector<MeetingParticipant>& participants) = 0;
 
    virtual ZRCSDKError GetParticipantsLeftMeeting(std::vector<MeetingParticipant>& participants) = 0;
 
    virtual ZRCSDKError AssignHost(int32_t userID) = 0;
 
    virtual ZRCSDKError AssignCohost(int32_t userID, bool assign) = 0;
 
    virtual ZRCSDKError ClaimHost(const std::string& key) = 0;
 
    virtual ZRCSDKError EnableAttendeesAnnotateOnShare(bool enable) = 0;
 
    virtual ZRCSDKError RenameUser(int32_t userID, const std::string& name) = 0;
 
    virtual ZRCSDKError AllowAttendeesRenameThemselves(bool allow) = 0;
 
    virtual ZRCSDKError IsAttendeesRenameThemselvesEnabled(bool& enable) = 0;
 
    virtual ZRCSDKError IsAttendeesRenameThemselvesLocked(bool& locked) = 0;
 
    virtual ZRCSDKError IsAttendeesRenameThemselvesAllowed(bool& allow) = 0;
 
    virtual ZRCSDKError AllowWebinarAttendeeRaiseHand(bool allow) = 0;
 
    virtual ZRCSDKError RaiseHand(bool raise) = 0;
 
    virtual ZRCSDKError LowerUserHand(int32_t userID) = 0;
 
    virtual ZRCSDKError LowerAllHands() = 0;
 
    virtual ZRCSDKError LowerAllAttendeesHands() = 0;
 
    virtual ZRCSDKError ExpelUser(int32_t userID) = 0;
 
    virtual ZRCSDKError ExpelUsers(const std::vector<int32_t>& userIDs) = 0;
 
    virtual ZRCSDKError HideProfilePictures(bool hidden) = 0;
    
    virtual ZRCSDKError IsFullRoomViewAvailableForUser(bool& isAvailable, int32_t userID) = 0;
 
    virtual ZRCSDKError HideFullRoomView(bool isHide, int32_t userID) = 0;
 
    virtual ZRCSDKError DownloadUserAvatar(std::string avatarUrl, std::string localFilePath) = 0;
 
    virtual ZRCSDKError AllowAttendeesShareWhiteboards(bool allow) = 0;
 
    virtual ZRCSDKError SuspendParticipantsActivities() = 0;
 
    virtual ZRCSDKError ReportIssue(const std::vector<int32_t>& userIDs, int32_t type, const std::string& email) = 0;
};
 
NS_ZRCSDK_END
#endif    //ZRC_IPARTICIPANTHELPER_H