ZDK
Public Member Functions | List of all members
ZDK::ICallsProvider Class Referenceabstract

Active calls information provider. More...

#include <ICallsProvider.h>

Inheritance diagram for ZDK::ICallsProvider:
ZDK::IZHandle

Public Member Functions

virtual ZDK::Shared::Call ActiveCall () const =0
 Gets the currently active call. More...
 
virtual void SetActiveCall (ZDK::Shared::Call call, ZDK::ActiveCallChange callChange)=0
 Sets the currently active call and specifies what to happen with all the rest calls (if any) More...
 
virtual ZDK::Shared::ItemList< ZDK::Shared::Call > Calls () const =0
 Gets a list with all calls. More...
 
virtual int CallsCount () const =0
 Gets the count of all calls. More...
 
virtual ZDK::Shared::Call CreateCallWithDefaultAccount (ZDK::Shared::String calleeNumber, bool video)=0
 Creates a call with the default account. More...
 
virtual void AddActiveCallListener (ZDK::Shared::CallsProviderEventsHandler value)=0
 Adds a new calls provider event listener. More...
 
virtual void DropActiveCallListener (ZDK::Shared::CallsProviderEventsHandler value)=0
 Removes a specific already added calls 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

Active calls information provider.

Member Function Documentation

◆ ActiveCall()

virtual ZDK::Shared::Call ZDK::ICallsProvider::ActiveCall ( ) const
pure virtual

Gets the currently active call.

Returns
The currently active call
See also
ICall

◆ AddActiveCallListener()

virtual void ZDK::ICallsProvider::AddActiveCallListener ( ZDK::Shared::CallsProviderEventsHandler  value)
pure virtual

Adds a new calls provider event listener.

All added listeners will be notified for each event.

Parameters
[in]valueThe calls provider event listener to be added
See also
ICallsProviderEventsHandler, DropActiveCallListener()

◆ Calls()

virtual ZDK::Shared::ItemList<ZDK::Shared::Call> ZDK::ICallsProvider::Calls ( ) const
pure virtual

Gets a list with all calls.

Returns
List with all calls
See also
ICall

◆ CallsCount()

virtual int ZDK::ICallsProvider::CallsCount ( ) const
pure virtual

Gets the count of all calls.

Returns
The number of all calls

◆ CreateCallWithDefaultAccount()

virtual ZDK::Shared::Call ZDK::ICallsProvider::CreateCallWithDefaultAccount ( ZDK::Shared::String  calleeNumber,
bool  video 
)
pure virtual

Creates a call with the default account.

Creates a call with the IAccountProvider's DefaultAccount().

Parameters
[in]calleeNumberThe number to be dialed
[in]videoIndicator whether the call to have video or not
Returns
The call
See also
ICall, DefaultAccount()

◆ DropActiveCallListener()

virtual void ZDK::ICallsProvider::DropActiveCallListener ( ZDK::Shared::CallsProviderEventsHandler  value)
pure virtual

Removes a specific already added calls provider event listener.

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

Parameters
[in]valueThe calls provider event listener to be removed
See also
ICallsProviderEventsHandler, AddActiveCallListener()

◆ SetActiveCall()

virtual void ZDK::ICallsProvider::SetActiveCall ( ZDK::Shared::Call  call,
ZDK::ActiveCallChange  callChange 
)
pure virtual

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

Parameters
[in]callThe currently active call
[in]callChangeThe action to be taken for all of the rest calls (if any)
See also
ICall, ActiveCallChange

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