<ZDKConferenceProvider> Protocol Reference

Conference controlling helper. More...

#import <ZDKConferenceProvider.h>

Inheritance diagram for <ZDKConferenceProvider>:

Instance Methods
(id< ZDKConference >)	- createConference:
	Creates a new conferene with the provided calls. More...
(id< ZDKConference > _Nullable)	- getConference:
	Gets the conference with the specified ID. More...
(BOOL)	- isCallInConference:
	Checks whether the call with the provided ID is part of any conference. More...
(id< ZDKConference > _Nullable)	- conferenceContainingCall:
	Gets the conference in which the provided call is part of. More...
(void)	- addConferenceProviderListener:
	Adds a new conference provider event listener. More...
(void)	- dropConferenceProviderListener:
	Removes a specific already added conference provider event listener. More...
(NSString *)	- handlesDescription
Instance Methods inherited from <ZDKZHandle>
(long int)	- handle
(void)	- initialize
(void)	- releaseReference
(NSString *)	- handlesDescription

Properties
NSArray< id< ZDKConference > > *	listConferences
	Gets a list with all conferences. More...
int	conferencesCount
	Gets the count of all conferences. More...
int	callsInConferences
	Gets the total count of calls in all conferences. More...
id< ZDKBrandingInfo > _Nullable	brandingInfo
	Gets the conference branding info. More...

Detailed Description

Conference controlling helper.

Method Documentation

addConferenceProviderListener:

- (void) addConferenceProviderListener:

(id< ZDKConferenceProviderEventsHandler >)

value

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

ZDKConferenceProviderEventsHandler, dropConferenceProviderListener()

conferenceContainingCall:

- (id< ZDKConference > _Nullable) conferenceContainingCall:

(id< ZDKCall >)

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]

call

The call to be searched for

Returns

The call's conference if exists or null pointer otherwise

See also

isCallInConference()

createConference:

- (id< ZDKConference >) createConference:

(NSArray *)

calls

Creates a new conferene with the provided calls.

ZDKConferenceProviderEventsHandler's onConferenceAdded() is invoked on successful creation of the conference. ZDKConferenceEventsHandler'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

ZDKConference, ZDKConferenceEventsHandler, ZDKConferenceProviderEventsHandler

dropConferenceProviderListener:

- (void) dropConferenceProviderListener:

(id< ZDKConferenceProviderEventsHandler >)

value

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

ZDKConferenceProviderEventsHandler, addConferenceProviderListener()

getConference:

- (id< ZDKConference > _Nullable) getConference:

(long int)

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]

hConf

The ID of the requested conference

Returns

The requested conference if exists or null pointer otherwise

handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

isCallInConference:

- (BOOL) isCallInConference:

(long int)

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]

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

Property Documentation

brandingInfo

- (id<ZDKBrandingInfo> _Nullable) brandingInfo

readnonatomicassign

Gets the conference branding info.

Returns

The conference branding info

See also

ZDKBrandingInfo

callsInConferences

- (int) callsInConferences

readnonatomicassign

Gets the total count of calls in all conferences.

Returns

The number of all calls in conferences

conferencesCount

- (int) conferencesCount

readnonatomicassign

Gets the count of all conferences.

Returns

The number of all conferences

listConferences

- (NSArray<id<ZDKConference> >*) listConferences

readnonatomicassign

Gets a list with all conferences.

Returns

List with all conferences

See also

ZDKConference

---

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

• Providers/ZDKConferenceProvider.h