zdk.net
Public Member Functions | Public Attributes | Properties | List of all members
ZDK_NET::ConferenceProvider Class Reference

Conference controlling helper. More...

#include <ConferenceProvider.h>

Inheritance diagram for ZDK_NET::ConferenceProvider:
ZDK_NET::ZHandle

Public Member Functions

 ConferenceProvider (ZDK::Shared::ConferenceProvider src)
 
ZDK_NET::ConferenceCreateConference (List< Call^>^ calls)
 Creates a new conferene with the provided calls. More...
 
ZDK_NET::ConferenceGetConference (long long hConf)
 Gets the conference with the specified ID. More...
 
bool IsCallInConference (long long hCall)
 Checks whether the call with the provided ID is part of any conference. More...
 
ZDK_NET::ConferenceConferenceContainingCall (ZDK_NET::Call^ call)
 Gets the conference in which the provided call is part of. More...
 
void AddConferenceProviderListener (ZDK_NET::ConferenceProviderEventsHandler^ value)
 Adds a new conference provider event listener. More...
 
void DropConferenceProviderListener (ZDK_NET::ConferenceProviderEventsHandler^ value)
 Removes a specific already added conference provider event listener. More...
 
virtual long long Handle () override
 
virtual void Initialize () override
 
virtual void ReleaseReference () override
 

Public Attributes

ZDK::IConferenceProvider * cppRef = nullptr
 

Properties

List< Conference^>^ ListConferences [get]
 Gets a list with all conferences. More...
 
int ConferencesCount [get]
 Gets the count of all conferences. More...
 
int CallsInConferences [get]
 Gets the total count of calls in all conferences. More...
 
ZDK_NET::BrandingInfoBrandingInfo [get]
 Gets the conference branding info. More...
 

Detailed Description

Conference controlling helper.

Member Function Documentation

◆ AddConferenceProviderListener()

void ZDK_NET::ConferenceProvider::AddConferenceProviderListener ( ZDK_NET::ConferenceProviderEventsHandler value)

Adds a new conference provider event listener.

All added listeners will be notified for each event.

Parameters
[in]valueThe conference provider event listener to be added
See also
ConferenceProviderEventsHandler, DropConferenceProviderListener()

◆ ConferenceContainingCall()

ZDK_NET::Conference ^ ZDK_NET::ConferenceProvider::ConferenceContainingCall ( ZDK_NET::Call call)

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]callThe call to be searched for
Returns
The call's conference if exists or null pointer otherwise
See also
IsCallInConference()

◆ CreateConference()

ZDK_NET::Conference ^ ZDK_NET::ConferenceProvider::CreateConference ( List< Call^>^  calls)

Creates a new conferene with the provided calls.

ConferenceProviderEventsHandler's OnConferenceAdded() is invoked on successful creation of the conference. ConferenceEventsHandler'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]callsList of the calls to be added in the conference
Returns
The newly created conference
See also
Conference, ConferenceEventsHandler, ConferenceProviderEventsHandler

◆ DropConferenceProviderListener()

void ZDK_NET::ConferenceProvider::DropConferenceProviderListener ( ZDK_NET::ConferenceProviderEventsHandler value)

Removes a specific already added conference provider event listener.

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

Parameters
[in]valueThe conference provider event listener to be removed
See also
ConferenceProviderEventsHandler, AddConferenceProviderListener()

◆ GetConference()

ZDK_NET::Conference ^ ZDK_NET::ConferenceProvider::GetConference ( long long  hConf)

Gets the conference with the specified ID.

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

Parameters
[in]hConfThe ID of the requested conference
Returns
The requested conference if exists or null pointer otherwise

◆ IsCallInConference()

bool ZDK_NET::ConferenceProvider::IsCallInConference ( long long  hCall)

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]hCallThe 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()

Property Documentation

◆ BrandingInfo

ZDK_NET:: BrandingInfo^ ZDK_NET::ConferenceProvider::BrandingInfo
get

Gets the conference branding info.

Returns
The conference branding info
See also
BrandingInfo

◆ CallsInConferences

int ZDK_NET::ConferenceProvider::CallsInConferences
get

Gets the total count of calls in all conferences.

Returns
The number of all calls in conferences

◆ ConferencesCount

int ZDK_NET::ConferenceProvider::ConferencesCount
get

Gets the count of all conferences.

Returns
The number of all conferences

◆ ListConferences

List< Conference^>^ ZDK_NET::ConferenceProvider::ListConferences
get

Gets a list with all conferences.

Returns
List with all conferences
See also
Conference

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