IPresenceHelper Class Reference

Presence Helper Interface. More...

#include <presence_helper_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IPresenceHelperEvent *pEvent)=0
	Sets the presence helper callback event handler.
virtual SDKError	RequestStarContact ()=0
	Sends a request to get the starred contact ids.
virtual SDKError	AddStarContact (const zchar_t *contactId)=0
	Sends a request to add the contact ID to the starred contact list.
virtual SDKError	UnStarContact (const zchar_t *contactId)=0
	Sends a request to remove the contact ID from starred contact list.
virtual SDKError	InviteContact (const zchar_t *contactId)=0
	Sends an invitation to a contact to join a meeting.
virtual IBatchRequestContactHelper *	GetBatchRequestContactHelper ()=0
	Gets the Batch request contact controller.

Detailed Description

Presence Helper Interface.

Definition at line 296 of file presence_helper_interface.h.

Member Function Documentation

AddStarContact()

virtual SDKError IPresenceHelper::AddStarContact ( const zchar_t * contactId )

pure virtual

Sends a request to add the contact ID to the starred contact list.

Parameters

contactId

The contact ID.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

GetBatchRequestContactHelper()

virtual IBatchRequestContactHelper * IPresenceHelper::GetBatchRequestContactHelper ( )

pure virtual

Gets the Batch request contact controller.

Returns

If the function succeeds, the return value is a pointer to IBatchRequestContactHelper. Otherwise, this function returns nullptr.

InviteContact()

virtual SDKError IPresenceHelper::InviteContact ( const zchar_t * contactId )

pure virtual

Sends an invitation to a contact to join a meeting.

Parameters

contactId

The contact ID.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

RequestStarContact()

virtual SDKError IPresenceHelper::RequestStarContact ( )

pure virtual

Sends a request to get the starred contact ids.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SetEvent()

virtual SDKError IPresenceHelper::SetEvent ( IPresenceHelperEvent * pEvent )

pure virtual

Sets the presence helper callback event handler.

Parameters

pEvent

A pointer to receive presence helper event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

UnStarContact()

virtual SDKError IPresenceHelper::UnStarContact ( const zchar_t * contactId )

pure virtual

Sends a request to remove the contact ID from starred contact list.

Parameters

contactId

The contact ID.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.