Collapse all Symbian^3 Product Developer Library

MCCPConferenceCall Class Reference

class MCCPConferenceCall

Conference call object.

Since: S60 3.2

Public Member Functions
void	AddCallL(MCCPCall *)
void	AddObserverL(const MCCPConferenceCallObserver &)
TInt	CallCount()
void	CurrentCallsToConferenceL()
TInt	GetCallArray(RPointerArray< MCCPCall > &)
void	GoOneToOneL(MCCPCall &)
TInt	HangUp()
TInt	Hold()
void	RemoveCallL(MCCPCall *)
TInt	RemoveObserver(const MCCPConferenceCallObserver &)
TInt	Resume()
TUint32	ServiceId()
TInt	Swap()

Protected Member Functions
	~MCCPConferenceCall()

Constructor & Destructor Documentation

~MCCPConferenceCall()

~MCCPConferenceCall

(

)

[protected, inline, virtual]

Protected destructor. Object cannot be deleted from plug-in client (CCE).

Since: S60 3.2

Member Functions Documentation

AddCallL(MCCPCall *)

void

AddCallL

(

MCCPCall *

aCall

)

[pure virtual]

Adds a new call to conference call. When plug-in regards the call as added it will notify observer about it with call added notification MCCPConferenceCallObserver::ECCPConferenceCallAdded.

Since: S60 3.2

leave: In case of an error system wide error code.

leave: KErrAlreadyExists call is already part of conference.

leave: KErrNotReady In case conference is not on hold or idle.

Pre-condition: Conference call state is MCCPConferenceCallObserver::ECCPConferenceHold or MCCPConferenceCallObserver::ECCPConferenceIdle.

Post-condition: Added call is notified calling MCCPConferenceCallObserver::ConferenceCallEventOccurred.; If conference becomes active regarding its internal plug-in based logic state is MCCPConferenceCallObserver::ECCPConferenceActive.

Parameters

MCCPCall * aCall

Call to be added to conference.

AddObserverL(const MCCPConferenceCallObserver &)

void

AddObserverL

(

const MCCPConferenceCallObserver &

aObserver

)

[pure virtual]

Add an observer for conference call related events. Currently CCE will set only one observer.

Since: S60 v3.2

leave: System error if observer adding fails.

Parameters

const MCCPConferenceCallObserver & aObserver

Observer to be added

CallCount()

TInt

CallCount

(

)

const [pure virtual]

Returns number of calls active calls in the conference.

Since: S60 3.2

CurrentCallsToConferenceL()

void

CurrentCallsToConferenceL

(

)

[pure virtual]

Add all current calls in the plug-in to conference. Each succesfully added call will be separately notified using MCCPConferenceCallObserver::ECCPConferenceCallAdded. If call is not added to conference it is not notified and can be regareded as not part of conference

Since: S60 3.2

leave: In case of an error system wide error code.

GetCallArray(RPointerArray< MCCPCall > &)

TInt

GetCallArray

(

RPointerArray< MCCPCall > &

aCallArray

)

[pure virtual]

Gets conference participants

Since: S60 3.2

Parameters

RPointerArray< MCCPCall > & aCallArray

Reference to call array

GoOneToOneL(MCCPCall &)

void

GoOneToOneL

(

MCCPCall &

aCall

)

[pure virtual]

Switch to a private call with given call that is part of conference. When call is regared as removed from conference it will be notified using MCCPConferenceCallObserver::ECCPConferenceCallRemoved.

Since: S60 3.2

leave: KErrNotFound call was not part of conference.

Post-condition: After successful actions conference call state is MCCPConferenceCallObserver::ECCPConferenceHold and private call will become active one.

Parameters

MCCPCall & aCall

Call to go one-to-one with.

HangUp()

TInt

HangUp

(

)

[pure virtual]

Ends an ongoing conference call. Does not delete the call. Call deletion is requested calling CConvergedCallProvider::ReleaseConferenceCall. If the request cannot be started then an error will be returned immediately as return value. In succesfull case KErrNone will be returned and the requested action has been started.

Pre-condition: Call state is not MCCPConferenceCallObserver::ECCPConferenceIdle.

Since: S60 3.2

Hold()

TInt

Hold

(

)

[pure virtual]

Puts conference call on hold. If the request cannot be started then an error will be returned immediately as return value. In succesfull case KErrNone will be returned and the requested action has been started.

Pre-condition: Call state is MCCPConferenceCallObserver::ECCPConferenceActive.

Since: S60 3.2

RemoveCallL(MCCPCall *)

void

RemoveCallL

(

MCCPCall *

aCall

)

[pure virtual]

Removes a call from conference call. Can be called on any state. When plug-in regards the call as removed it will notify observer about it with call removed notification MCCPConferenceCallObserver::ECCPConferenceCallRemoved.

Since: S60 3.2

leave: In case of an error system wide error code.

leave: KErrNotFound call was not part of conference.

leave: KErrNotReady In case conference is not connected (MCCPConferenceCallObserver::ECCPConferenceActive) state.

Pre-condition: Conference call state is MCCPConferenceCallObserver::ECCPConferenceActive or MCCPConferenceCallObserver::ECCPConferenceIdle.

Post-condition: Removed call is notified calling MCCPConferenceCallObserver::ConferenceCallEventOccurred.; If conference becomes idle regarding its internal plug-in based logic state is MCCPConferenceCallObserver::ECCPConferenceIdle.

Parameters

MCCPCall * aCall

Call to be removed from conference.

RemoveObserver(const MCCPConferenceCallObserver &)

TInt

RemoveObserver

(

const MCCPConferenceCallObserver &

aObserver

)

[pure virtual]

Remove an observer.

Since: S60 v3.2

Parameters

const MCCPConferenceCallObserver & aObserver

Observer for conference.

Resume()

TInt

Resume

(

)

[pure virtual]

Resumes previously held conference call. If the request cannot be started then an error will be returned immediately as return value. In succesfull case KErrNone will be returned and the requested action has been started.

Pre-condition: Call state is MCCPConferenceCallObserver::ECCPConferenceHold.

Since: S60 3.2

ServiceId()

TUint32

ServiceId

(

)

const [pure virtual]

Returns the service-id used for the call.

Since: S60 3.2

Swap()

TInt

Swap

(

)

[pure virtual]

Swaps a connected conference call between Hold and Resume. If the request cannot be started then an error will be returned immediately as return value. In succesfull case KErrNone will be returned and the requested action has been started.

Pre-condition: Call state is MCCPConferenceCallObserver::ECCPConferenceHold or MCCPConferenceCallObserver::ECCPConferenceActive

Since: S60 3.2