IContactHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_ICONTACTHELPER_H
#define ZRC_ICONTACTHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum IMAccountStatus
{
    IMAccountStatusActive = 0,          
    IMAccountStatusDeactivated = 1,     
    IMAccountStatusTerminate = 2        
};
 
enum IMBuddyType
{
    IMBuddyTypeNone = 0,                          
    IMBuddyTypeDefault = 1 << 0,                  
    IMBuddyTypeZoomRoom = 1 << 1,                 
    IMBuddyTypeSharedGlobalDirectory = 1 << 2,    
    IMBuddyTypePersonalContacts = 1 << 3,         
    IMBuddyTypeZoomPhoneApplicance = 1 << 4,      
    IMBuddyTypeNormal = 1 << 5                    
};
 
enum IMPresenceStatus
{
    IMPresenceStatusNone,            
    IMPresenceStatusAvailable,       
    IMPresenceStatusUnAvailable,     
    IMPresenceStatusInMeeting,       
    IMPresenceStatusBusy,            
    IMPresenceStatusDoNotDisturb,    
    IMPresenceStatusAway,            
    IMPresenceStatusPhoneCall,       
    IMPresenceStatusPresenting,      
    IMPresenceStatusCalendar,        
    IMPresenceStatusOutOfOffice      
};
 
struct PhoneContact
{
    std::string label;          
    std::string countryCode;    
    std::string phoneNumber;    
};
 
struct CloudPBXInfo
{
    std::string                 extension;      
    std::string                 companyNumber;  
    std::vector<std::string>    directNumbers;  
};
 
struct Contact
{
    IMAccountStatus  accountStatus = IMAccountStatusActive;    
    IMBuddyType      buddyType = IMBuddyTypeNone;              
    IMPresenceStatus presenceStatus = IMPresenceStatusNone;    
    std::string      contactID;                                
    std::string      screenName;                               
    std::string      firstName;                                
    std::string      lastName;                                 
    std::string      phoneNumber;                              
    std::string      email;                                    
    std::string      pronouns;                                 
    std::string      company;                                  
    std::string      department;                               
    std::string      jobTitle;                                 
    std::string      avatarURL;                                
    std::string      location;                                 
    std::string      signature;                                
    uint32_t         signatureStartTimestamp = 0;              
    uint32_t         signatureEndTimestamp = 0;                
    std::string      sipPhoneNumber;                           
    CloudPBXInfo     cloudPBXInfo;                             
    std::vector<PhoneContact> phoneInfos;                      
};
 
struct ContactTypeInfo
{
    IMBuddyType buddyType = IMBuddyTypeNone;    
    uint32_t    count = 0;                      
};
 
struct DynamicContactListInfo
{
    bool                 isSearchSipContactResult = false;           
    uint32_t             startIndex = 0;                             
    uint32_t             numberOfContacts = 0;                       
    std::string          filter;                                     
    uint32_t             totalNumberOfContactsInSearchResult = 0;    
    std::vector<Contact> contacts;                                   
    uint64_t             buddyTypeBits = 0;    
};
 
struct FavoritesList
{
    std::vector<Contact>          favoriteContacts;             
    std::vector<LegacyRoomSystem> favoriteLegacyRoomSystems;    
    std::vector<PhoneContact>     favoritePhoneContacts;        
};
 
class IContactHelperSink
{
public:
    virtual ~IContactHelperSink() {}
 
    virtual void OnImUpdateContactNotification(const std::vector<Contact>& contacts) = 0;
 
    virtual void OnDynamicContactBasicInfoNotification(const std::vector<ContactTypeInfo>& typeInfos, uint32_t numberOfContacts, uint32_t numberOfZoomRooms) = 0;
 
    virtual void OnDynamicContactListNotification(const DynamicContactListInfo& info) = 0;
 
    virtual void OnUpdateFavoritesList(const FavoritesList& list) = 0;
 
    virtual void OnStartReceivingLegacyRoomList(bool isSelfRooms) = 0;
 
    virtual void OnAddLegacyRooms(const std::vector<LegacyRoomSystem>& roomList, bool isSelfRooms) = 0;
 
    virtual void OnFinishReceivingLegacyRoomList(bool isSelfRooms) = 0;
};
 
class IContactHelper
{
public:
    virtual ~IContactHelper() {}
 
    virtual ZRCSDKError RegisterSink(IContactHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IContactHelperSink* pSink) = 0;
 
    virtual ZRCSDKError SubscribeByContactID(const std::vector<std::string>& contactIDs, bool isSearchSipContact) = 0;
 
    virtual ZRCSDKError Subscribe(uint32_t startIndex, uint32_t count, bool isSearchSipContact) = 0;
 
    virtual ZRCSDKError RequestContactsDetail(const std::vector<std::string>& contactIDs) = 0;
 
    virtual ZRCSDKError RequestContactsDynamically(uint32_t startIndex, uint32_t count, bool isSearchSipContact, uint64_t buddyTypeBits) = 0;
 
    virtual ZRCSDKError SearchContactsDynamically(uint32_t startIndex, uint32_t count, bool isSearchSipContact, const std::string& searchFilter, uint64_t buddyTypeBits) = 0;
 
    virtual ZRCSDKError GetLegacyRoomList(std::vector<LegacyRoomSystem>& roomList, bool isSelfRooms) = 0;
};
 
NS_ZRCSDK_END
#endif    //ZRC_ICONTACTHELPER_H