IBatchRequestContactHelper Class Reference

#include <presence_helper_interface.h>

Public Member Functions
virtual SDKError	CreateBatchRequestBegin ()=0
	Prepare to batch request for contact helper.
virtual bool	AddContactToList (const zchar_t *contactId)=0
	Add the contact ID to a prepared list.
virtual SDKError	CommitContactDetailInfoRequest ()=0
	Batch request contact detail information according to the prepare list.
virtual SDKError	CommitSubscribeContactPresence ()=0
	Batch subscribe contact presence status according to the prepare list.
virtual SDKError	CommitUnSubscribeContactPresence ()=0
	Batch unsubscribe contact presence status according to the prepare list.
virtual SDKError	CommitInviteContact ()=0
	Batch invite contact to join meeting according to the prepare list.

Detailed Description

Definition at line 237 of file presence_helper_interface.h.

Member Function Documentation

AddContactToList()

virtual bool IBatchRequestContactHelper::AddContactToList ( const zchar_t * contactId )

pure virtual

Add the contact ID to a prepared list.

Parameters

contactId,the

contact ID you want to request.

Returns

true if the contact ID is added to the prepared list successfully.

Note

The max number of the prepared list is 20.

CreateBatchRequestBegin() must be called before this function is called. Otherwise this returns false.

CommitContactDetailInfoRequest()

virtual SDKError IBatchRequestContactHelper::CommitContactDetailInfoRequest ( )

pure virtual

Batch request contact detail information according to the prepare list.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

Call CreateBatchRequestBegin() before calling this function. Otherwise, it returns SDKERR_WRONG_USAGE.

CommitInviteContact()

virtual SDKError IBatchRequestContactHelper::CommitInviteContact ( )

pure virtual

Batch invite contact to join meeting according to the prepare list.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

Call CreateBatchRequestBegin() before calling this function. Otherwise, it returns SDKERR_WRONG_USAGE.

CommitSubscribeContactPresence()

virtual SDKError IBatchRequestContactHelper::CommitSubscribeContactPresence ( )

pure virtual

Batch subscribe contact presence status according to the prepare list.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

Call CreateBatchRequestBegin() before calling this function. Otherwise, it returns SDKERR_WRONG_USAGE. The expiration time of the subscription is three hours.

CommitUnSubscribeContactPresence()

virtual SDKError IBatchRequestContactHelper::CommitUnSubscribeContactPresence ( )

pure virtual

Batch unsubscribe contact presence status according to the prepare list.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

Call CreateBatchRequestBegin() before calling this function. Otherwise, it returns SDKERR_WRONG_USAGE.

CreateBatchRequestBegin()

virtual SDKError IBatchRequestContactHelper::CreateBatchRequestBegin ( )

pure virtual

Prepare to batch request for contact helper.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

If the function succeeds, all the added contact IDs are removed and the prepared list you added by calling AddContactToList is cleared.