IUserIDListBuilder Class Reference

User ID list builder interface. Used to construct the user ID list required by the SDK interfaces that operate on a batch of users. More...

#include <meeting_participants_ctrl_interface.h>

Public Member Functions
virtual	~IUserIDListBuilder ()
virtual SDKError	AddUser (unsigned int userid)=0
	Adds a user ID to the list under construction.
virtual SDKError	RemoveUser (unsigned int userid)=0
	Removes a user ID from the list under construction.
virtual SDKError	Clear ()=0
	Clears all the added user IDs.
virtual IList< unsigned int > *	GetUserIDList ()=0
	Gets the user ID list under construction.

Detailed Description

User ID list builder interface. Used to construct the user ID list required by the SDK interfaces that operate on a batch of users.

Definition at line 496 of file meeting_participants_ctrl_interface.h.

Constructor & Destructor Documentation

~IUserIDListBuilder()

virtual IUserIDListBuilder::~IUserIDListBuilder ( )

inlinevirtual

Definition at line 499 of file meeting_participants_ctrl_interface.h.

{}

Member Function Documentation

AddUser()

virtual SDKError IUserIDListBuilder::AddUser ( unsigned int userid )

pure virtual

Adds a user ID to the list under construction.

Parameters

userid

Specifies the user ID to add.

Returns

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

Clear()

virtual SDKError IUserIDListBuilder::Clear ( )

pure virtual

Clears all the added user IDs.

Returns

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

GetUserIDList()

virtual IList< unsigned int > * IUserIDListBuilder::GetUserIDList ( )

pure virtual

Gets the user ID list under construction.

Returns

If the function succeeds, it returns the user ID list. Otherwise, this function fails and returns nullptr.

Note

The returned object is owned by the SDK and stays valid until the next call to GetUserIDList() or Clear() on the same builder. Do not free it.

RemoveUser()

virtual SDKError IUserIDListBuilder::RemoveUser ( unsigned int userid )

pure virtual

Removes a user ID from the list under construction.

Parameters

userid

Specifies the user ID to remove.

Returns

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