Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IContactHelperSink Class Referenceabstract

Contact helper event callback. More...

#include <IContactHelper.h>

Public Member Functions

virtual ~IContactHelperSink ()
 
virtual void OnImUpdateContactNotification (const std::vector< Contact > &contacts)=0
 IM contacts update notification.
 
virtual void OnDynamicContactBasicInfoNotification (const std::vector< ContactTypeInfo > &typeInfos, uint32_t numberOfContacts, uint32_t numberOfZoomRooms)=0
 Dynamic contact basic info notification.
 
virtual void OnDynamicContactListNotification (const DynamicContactListInfo &info)=0
 Dynamic contact list notification.
 
virtual void OnUpdateFavoritesList (const FavoritesList &list)=0
 Update favorite list notification.
 
virtual void OnStartReceivingLegacyRoomList (bool isSelfRooms)=0
 Start receiving legacy room list notification.
 
virtual void OnAddLegacyRooms (const std::vector< LegacyRoomSystem > &roomList, bool isSelfRooms)=0
 Add legacy rooms notification.
 
virtual void OnFinishReceivingLegacyRoomList (bool isSelfRooms)=0
 Finishing receiving legacy room list notification.
 

Detailed Description

Contact helper event callback.

Definition at line 133 of file IContactHelper.h.

Constructor & Destructor Documentation

◆ ~IContactHelperSink()

virtual IContactHelperSink::~IContactHelperSink ( )
inlinevirtual

Definition at line 136 of file IContactHelper.h.

136{}

Member Function Documentation

◆ OnAddLegacyRooms()

virtual void IContactHelperSink::OnAddLegacyRooms ( const std::vector< LegacyRoomSystem > &  roomList,
bool  isSelfRooms 
)
pure virtual

Add legacy rooms notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
roomListThe legacy room list.
isSelfRoomsTRUE indicates is self rooms. Otherwise meeting's rooms.

◆ OnDynamicContactBasicInfoNotification()

virtual void IContactHelperSink::OnDynamicContactBasicInfoNotification ( const std::vector< ContactTypeInfo > &  typeInfos,
uint32_t  numberOfContacts,
uint32_t  numberOfZoomRooms 
)
pure virtual

Dynamic contact basic info notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0

Use basic info to request needed contacts dynamically.

Parameters
typeInfosContact type infos
numberOfContactsContact number of IM contacts
numberOfZoomRoomsContact number of Zoom Rooms

◆ OnDynamicContactListNotification()

virtual void IContactHelperSink::OnDynamicContactListNotification ( const DynamicContactListInfo info)
pure virtual

Dynamic contact list notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
infoDynamic contact list info

◆ OnFinishReceivingLegacyRoomList()

virtual void IContactHelperSink::OnFinishReceivingLegacyRoomList ( bool  isSelfRooms)
pure virtual

Finishing receiving legacy room list notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
isSelfRoomsTRUE indicates is self rooms. Otherwise meeting's rooms.

◆ OnImUpdateContactNotification()

virtual void IContactHelperSink::OnImUpdateContactNotification ( const std::vector< Contact > &  contacts)
pure virtual

IM contacts update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
contactsUpdated contacts.

◆ OnStartReceivingLegacyRoomList()

virtual void IContactHelperSink::OnStartReceivingLegacyRoomList ( bool  isSelfRooms)
pure virtual

Start receiving legacy room list notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
isSelfRoomsTRUE indicates is self rooms. Otherwise meeting's rooms.

◆ OnUpdateFavoritesList()

virtual void IContactHelperSink::OnUpdateFavoritesList ( const FavoritesList list)
pure virtual

Update favorite list notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
listThe favorite list.