IContactHelper Class Reference

Contact helper interface. More...

#include <IContactHelper.h>

Public Member Functions
virtual	~IContactHelper ()
virtual ZRCSDKError	RegisterSink (IContactHelperSink *pSink)=0
	Register contact helper callback sink.
virtual ZRCSDKError	DeregisterSink (IContactHelperSink *pSink)=0
	Deregister contact helper callback sink.
virtual ZRCSDKError	SubscribeByContactID (const std::vector< std::string > &contactIDs, bool isSearchSipContact)=0
	Subscribe contact by contact ID, you will be notified the changes after the subscription.
virtual ZRCSDKError	Subscribe (uint32_t startIndex, uint32_t count, bool isSearchSipContact)=0
	Subscribe contact in range, you will be notified the changes after the subscription.
virtual ZRCSDKError	RequestContactsDetail (const std::vector< std::string > &contactIDs)=0
	Request contacts detail.
virtual ZRCSDKError	RequestContactsDynamically (uint32_t startIndex, uint32_t count, bool isSearchSipContact, uint64_t buddyTypeBits)=0
	Request contacts dynamically.
virtual ZRCSDKError	SearchContactsDynamically (uint32_t startIndex, uint32_t count, bool isSearchSipContact, const std::string &searchFilter, uint64_t buddyTypeBits)=0
	Search contacts dynamically.
virtual ZRCSDKError	GetLegacyRoomList (std::vector< LegacyRoomSystem > &roomList, bool isSelfRooms)=0
	Query current legacy room list.

Detailed Description

Contact helper interface.

Definition at line 216 of file IContactHelper.h.

Constructor & Destructor Documentation

~IContactHelper()

virtual IContactHelper::~IContactHelper ( )

inlinevirtual

Definition at line 219 of file IContactHelper.h.

{}

Member Function Documentation

DeregisterSink()

virtual ZRCSDKError IContactHelper::DeregisterSink ( IContactHelperSink *  pSink )

pure virtual

Deregister contact helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IContactHelperSink that receives the contact helper event callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

GetLegacyRoomList()

virtual ZRCSDKError IContactHelper::GetLegacyRoomList ( std::vector< LegacyRoomSystem > &  roomList, bool  isSelfRooms  )

pure virtual

Query current legacy room list.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

[out]	roomList	Legacy room list.
	isSelfRooms	TRUE indicates to query self rooms. Otherwise query current meeting's rooms.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RegisterSink()

virtual ZRCSDKError IContactHelper::RegisterSink ( IContactHelperSink *  pSink )

pure virtual

Register contact helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IContactHelperSink that receives the contact helper event callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RequestContactsDetail()

virtual ZRCSDKError IContactHelper::RequestContactsDetail ( const std::vector< std::string > &  contactIDs )

pure virtual

Request contacts detail.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

contactIDs

Specify the contactIDs to request.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RequestContactsDynamically()

virtual ZRCSDKError IContactHelper::RequestContactsDynamically ( uint32_t  startIndex, uint32_t  count, bool  isSearchSipContact, uint64_t  buddyTypeBits  )

pure virtual

Request contacts dynamically.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

startIndex	Request contacts start index.
count	Request contacts count
isSearchSipContact	TRUE indicate to search sip contacts.
buddyTypeBits	Specify the buddy type bits to be requested, see IMBuddyType enum.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

SearchContactsDynamically()

virtual ZRCSDKError IContactHelper::SearchContactsDynamically ( uint32_t  startIndex, uint32_t  count, bool  isSearchSipContact, const std::string &  searchFilter, uint64_t  buddyTypeBits  )

pure virtual

Search contacts dynamically.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

startIndex	Search contacts start index.
count	Search contacts count
isSearchSipContact	TRUE indicate to search sip contacts.
searchFilter	Search contacts by filter.
buddyTypeBits	Specify the buddy type bits to be searched, see IMBuddyType enum.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Subscribe()

virtual ZRCSDKError IContactHelper::Subscribe ( uint32_t  startIndex, uint32_t  count, bool  isSearchSipContact  )

pure virtual

Subscribe contact in range, you will be notified the changes after the subscription.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

startIndex	Start index
count	Subscribe contacts count, suggest 50.
isSearchSipContact	TRUE indicate to search sip contacts.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

SubscribeByContactID()

virtual ZRCSDKError IContactHelper::SubscribeByContactID ( const std::vector< std::string > &  contactIDs, bool  isSearchSipContact  )

pure virtual

Subscribe contact by contact ID, you will be notified the changes after the subscription.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

contactIDs	Specify the contactIDs to subscribe.
isSearchSipContact	TRUE indicate to search sip contacts.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.