<ZDKCallsProvider> Protocol Reference

Active calls information provider. More...

#import <ZDKCallsProvider.h>

Inheritance diagram for <ZDKCallsProvider>:

Instance Methods
(void)	- setActiveCall:callChange:
	Sets the currently active call and specifies what to happen with all the rest calls (if any) More...
(id< ZDKCall >)	- createCallWithDefaultAccount:video:
	Creates a call with the default account. More...
(void)	- addActiveCallListener:
	Adds a new calls provider event listener. More...
(void)	- dropActiveCallListener:
	Removes a specific already added calls provider event listener. More...
(NSString *)	- handlesDescription
Instance Methods inherited from <ZDKZHandle>
(long int)	- handle
(void)	- initialize
(void)	- releaseReference
(NSString *)	- handlesDescription

Properties
id< ZDKCall > _Nullable	activeCall
	Gets the currently active call. More...
NSArray< id< ZDKCall > > *	calls
	Gets a list with all calls. More...
int	callsCount
	Gets the count of all calls. More...

Detailed Description

Active calls information provider.

Method Documentation

addActiveCallListener:

- (void) addActiveCallListener:

(id< ZDKCallsProviderEventsHandler >)

value

Adds a new calls provider event listener.

All added listeners will be notified for each event.

Parameters

[in]

value

The calls provider event listener to be added

See also

ZDKCallsProviderEventsHandler, dropActiveCallListener()

createCallWithDefaultAccount:video:

- (id< ZDKCall >) createCallWithDefaultAccount:		(NSString *)	calleeNumber
video:		(BOOL)	video

Creates a call with the default account.

Creates a call with the ZDKAccountProvider's defaultAccount().

Parameters

[in]	calleeNumber	The number to be dialed
[in]	video	Indicator whether the call to have video or not

Returns

The call

See also

ZDKCall, defaultAccount()

dropActiveCallListener:

- (void) dropActiveCallListener:

(id< ZDKCallsProviderEventsHandler >)

value

Removes a specific already added calls provider event listener.

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

Parameters

[in]

value

The calls provider event listener to be removed

See also

ZDKCallsProviderEventsHandler, addActiveCallListener()

handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

setActiveCall:callChange:

- (void) setActiveCall:		(id< ZDKCall > _Nullable)	call
callChange:		(ZDKActiveCallChange)	callChange

Sets the currently active call and specifies what to happen with all the rest calls (if any)

NOTE!!! Does NOT change the new active call's state! It is up to the API user to decide what to do with it!

Parameters

[in]	call	The currently active call
[in]	callChange	The action to be taken for all of the rest calls (if any)

See also

ZDKCall, ActiveCallChange

Property Documentation

activeCall

- (id<ZDKCall> _Nullable) activeCall

readnonatomicassign

Gets the currently active call.

Returns

The currently active call

See also

ZDKCall

calls

- (NSArray<id<ZDKCall> >*) calls

readnonatomicassign

Gets a list with all calls.

Returns

List with all calls

See also

ZDKCall

callsCount

- (int) callsCount

readnonatomicassign

Gets the count of all calls.

Returns

The number of all calls

---

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

• Providers/ZDKCallsProvider.h