Conference controlling helper. More...

#include <IConferenceProvider.h>

Inheritance diagram for ZDK::IConferenceProvider:

Public Member Functions
virtual ZDK::Shared::Conference	CreateConference (ZDK::Shared::ItemList< ZDK::Shared::Call > calls)=0
	Creates a new conferene with the provided calls. More...

virtual ZDK::Shared::ItemList< ZDK::Shared::Conference >	ListConferences () const =0
	Gets a list with all conferences. More...

virtual int	ConferencesCount () const =0
	Gets the count of all conferences. More...

virtual ZDK::Shared::Conference	GetConference (ZDK::ZDKHandle hConf) const =0
	Gets the conference with the specified ID. More...

virtual int	CallsInConferences () const =0
	Gets the total count of calls in all conferences. More...

virtual bool	IsCallInConference (ZDK::ZDKHandle hCall) const =0
	Checks whether the call with the provided ID is part of any conference. More...

virtual ZDK::Shared::Conference	ConferenceContainingCall (ZDK::Shared::Call call) const =0
	Gets the conference in which the provided call is part of. More...

virtual ZDK::Shared::BrandingInfo	BrandingInfo () const =0
	Gets the conference branding info. More...

virtual void	AddConferenceProviderListener (ZDK::Shared::ConferenceProviderEventsHandler value)=0
	Adds a new conference provider event listener. More...

virtual void	DropConferenceProviderListener (ZDK::Shared::ConferenceProviderEventsHandler value)=0
	Removes a specific already added conference provider event listener. More...

Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle	Handle () const =0

virtual	operator ZDK::ZDKHandle () const =0

virtual void	Initialize ()=0

virtual void	ReleaseReference ()=0

Detailed Description

Conference controlling helper.

Member Function Documentation

◆ AddConferenceProviderListener()

virtual void ZDK::IConferenceProvider::AddConferenceProviderListener ( ZDK::Shared::ConferenceProviderEventsHandler value )

pure virtual

Adds a new conference provider event listener.

All added listeners will be notified for each event.

Parameters

[in] value The conference provider event listener to be added

See also: IConferenceProviderEventsHandler, DropConferenceProviderListener()

◆ BrandingInfo()

virtual ZDK::Shared::BrandingInfo ZDK::IConferenceProvider::BrandingInfo ( ) const

pure virtual

Gets the conference branding info.

Returns: The conference branding info

See also: IBrandingInfo

◆ CallsInConferences()

virtual int ZDK::IConferenceProvider::CallsInConferences ( ) const

pure virtual

Gets the total count of calls in all conferences.

Returns: The number of all calls in conferences

◆ ConferenceContainingCall()

virtual ZDK::Shared::Conference ZDK::IConferenceProvider::ConferenceContainingCall ( ZDK::Shared::Call call ) const

pure virtual

Gets the conference in which the provided call is part of.

Returns the conference in which the given call is part of, if it is part of any, otherwise a null pointer is returned.

Parameters

[in] call The call to be searched for

Returns: The call's conference if exists or null pointer otherwise

See also: IsCallInConference()

◆ ConferencesCount()

virtual int ZDK::IConferenceProvider::ConferencesCount ( ) const

pure virtual

Gets the count of all conferences.

Returns: The number of all conferences

◆ CreateConference()

virtual ZDK::Shared::Conference ZDK::IConferenceProvider::CreateConference ( ZDK::Shared::ItemList< ZDK::Shared::Call > calls )

pure virtual

Creates a new conferene with the provided calls.

IConferenceProviderEventsHandler's OnConferenceAdded() is invoked on successful creation of the conference. IConferenceEventsHandler's OnConferenceParticipantJoined() is invoked for each added call to the conferene.

Creating an empty conference (with empty calls list) is not supported!

To remove a conference simply remove all its calls/participants. It is not allowed to have an empty conference, and that is why such are automatically destroyed! OnConferenceRemoved() is invoked in this case.

Parameters

[in] calls List of the calls to be added in the conference

Returns: The newly created conference

See also: IConference, IConferenceEventsHandler, IConferenceProviderEventsHandler

◆ DropConferenceProviderListener()

virtual void ZDK::IConferenceProvider::DropConferenceProviderListener ( ZDK::Shared::ConferenceProviderEventsHandler value )

pure virtual

Removes a specific already added conference provider event listener.

All added/left listeners will be notified for each event.

Parameters

[in] value The conference provider event listener to be removed

See also: IConferenceProviderEventsHandler, AddConferenceProviderListener()

◆ GetConference()

virtual ZDK::Shared::Conference ZDK::IConferenceProvider::GetConference ( ZDK::ZDKHandle hConf ) const

pure virtual

Gets the conference with the specified ID.

Returns the conference with the specified ID if exist, otherwise a null pointer is returned.

Parameters

[in] hConf The ID of the requested conference

Returns: The requested conference if exists or null pointer otherwise

◆ IsCallInConference()

virtual bool ZDK::IConferenceProvider::IsCallInConference ( ZDK::ZDKHandle hCall ) const

pure virtual

Checks whether the call with the provided ID is part of any conference.

Returns whether a call with the provided ID exists and is part of any active conference.

Parameters

[in] hCall The ID of the call to be searched for

Returns

0 - The call is not in conference, or does not exists at all
1 - The call is in conference

See also: ConferenceContainingCall()

◆ ListConferences()

virtual ZDK::Shared::ItemList<ZDK::Shared::Conference> ZDK::IConferenceProvider::ListConferences ( ) const

pure virtual

Gets a list with all conferences.

Returns: List with all conferences

See also: IConference

The documentation for this class was generated from the following file:

Providers/IConferenceProvider.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddConferenceProviderListener()

◆ BrandingInfo()

◆ CallsInConferences()

◆ ConferenceContainingCall()

◆ ConferencesCount()

◆ CreateConference()

◆ DropConferenceProviderListener()

◆ GetConference()

◆ IsCallInConference()

◆ ListConferences()