com.zoiper.zdk.Providers

Class ConferenceProvider

java.lang.Object

com.zoiper.zdk.Providers.ConferenceProvider

public class ConferenceProvider
extends java.lang.Object

Conference controlling helper

Constructor Summary

Constructors

Constructor and Description
ConferenceProvider(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
void	addConferenceProviderListener(ConferenceProviderEventsHandler value) Adds a new conference provider event listener All added listeners will be notified for each event.
BrandingInfo	brandingInfo() Gets the conference branding info
int	callsInConferences() Gets the total count of calls in all conferences
Conference	conferenceContainingCall(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.
int	conferencesCount() Gets the count of all conferences
Conference	createConference(java.util.List<Call> calls) Creates a new conferene with the provided calls ConferenceProviderEventsHandler's onConferenceAdded is invoked on successful creation of the conference.
void	dropConferenceProviderListener(ConferenceProviderEventsHandler value) Removes a specific already added conference provider event listener All added/left listeners will be notified for each event.
protected void	finalize() Ensures the underlying native object destruction
Conference	getConference(long hConf) Gets the conference with the specified ID Returns the conference with the specified ID if exist, otherwise a null pointer is returned.
long	handle() Gets the pointer/address to the underlying native object
boolean	isCallInConference(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.
java.util.List<Conference>	listConferences() Gets a list with all conferences

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConferenceProvider

public ConferenceProvider(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

listConferences

public java.util.List<Conference> listConferences()

Gets a list with all conferences

Returns:

List with all conferences

See Also:

Conference

conferencesCount

public int conferencesCount()

Gets the count of all conferences

Returns:

The number of all conferences

callsInConferences

public int callsInConferences()

Gets the total count of calls in all conferences

Returns:

The number of all calls in conferences

brandingInfo

public BrandingInfo brandingInfo()

Gets the conference branding info

Returns:

The conference branding info

See Also:

BrandingInfo

createConference

public Conference createConference(java.util.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:

calls - List of the calls to be added in the conference

Returns:

The newly created conference

See Also:

ConferenceEventsHandler ConferenceProviderEventsHandler

getConference

public Conference getConference(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:

hConf - The ID of the requested conference

Returns:

The requested conference if exists or null pointer otherwise

isCallInConference

public boolean isCallInConference(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:

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

conferenceContainingCall

public Conference conferenceContainingCall(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:

call - The call to be searched for

Returns:

The call's conference if exists or null pointer otherwise

See Also:

isCallInConference

addConferenceProviderListener

public void addConferenceProviderListener(ConferenceProviderEventsHandler value)

Adds a new conference provider event listener All added listeners will be notified for each event.

Parameters:

value - The conference provider event listener to be added

See Also:

dropConferenceProviderListener

dropConferenceProviderListener

public void dropConferenceProviderListener(ConferenceProviderEventsHandler value)

Removes a specific already added conference provider event listener All added/left listeners will be notified for each event.

Parameters:

value - The conference provider event listener to be removed

See Also:

addConferenceProviderListener