Symbian^3 Application Developer Library >

MCCPCall Class Reference

class MCCPCall

All common methods for different calls. Events, errors, status notifications etc are received via MCCPCallObserver class

Since
S60 3.2
Public Member Functions
void AddObserverL (const MCCPCallObserver &)
TInt Answer ()
TInt Cancel ()
MCCPCallObserver::TCCPCallControlCaps Caps ()
TInt Dial ()
const TDesC & DialledParty ()
MCCPForwardProvider * ForwardProviderL (const MCCPForwardObserver &)
TInt HangUp ()
TInt Hold ()
TBool IsCallForwarded ()
TBool IsMobileOriginated ()
TBool IsSecured ()
const CCCPCallParameters & Parameters ()
TInt Queue ()
TInt Reject ()
const TDesC & RemoteParty ()
const TDesC & RemotePartyName ()
TInt RemoveObserver (const MCCPCallObserver &)
TInt Resume ()
TInt Ringing ()
TBool SecureSpecified ()
void SetParameters (const CCCPCallParameters &)
MCCPCallObserver::TCCPCallState State ()
TInt Swap ()
TCCPTone Tone ()
MCCPTransferProvider * TransferProviderL (const MCCPTransferObserver &)
TUid Uid ()
Protected Member Functions
~MCCPCall ()

Constructor & Destructor Documentation

~MCCPCall()

~MCCPCall ( ) [protected, inline, virtual]
Protected destructor. Object cannot be deleted from plug-in client (CCE).
Since
S60 3.2

Member Functions Documentation

AddObserverL(const MCCPCallObserver &)

void AddObserverL ( const MCCPCallObserver & aObserver ) [pure virtual]
Adds a new observer for MCCECall object. Called in MT call case. In MO case observer will be given at call construction.
Since
S60 v3.2
leave
system error if observer adding fails.

Parameters

const MCCPCallObserver & aObserver Observer

Answer()

TInt Answer ( ) [pure virtual]
Answer an incoming call. Returns any error asyncronous via MCCPCallObserver . 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 MCCPCallObserver::ECCPStateRinging or MCCPCallObserver::ECCPStateQueued .
Since
S60 3.2

Cancel()

TInt Cancel ( ) [pure virtual]
Called by CCE instead of HangUp when Dial has been called and state change to MCCPCallObserver::ECCPStateConnecting has not been received. Cancels the last ongoing request. Used for Dial only. Not supported for other actions. 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.
Since
S60 3.2
Pre-condition
MCCPCall::Dial has been called and call state is MCCPCallObserver::ECCPIdle

Caps()

MCCPCallObserver::TCCPCallControlCaps Caps ( ) const [pure virtual]
Returns call control caps for this call. This tells for CCE what call can currently do.
Since
S60 3.2

Dial()

TInt Dial ( ) [pure virtual]
Starts dialing to recipient. Recipient was set at call creation. 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 MCCPCallObserver::ECCPStateIdle and call type is MO.
Since
S60 3.2

DialledParty()

const TDesC & DialledParty ( ) const [pure virtual]
Returns the original dialled party. The original number (e.g. including DTMF) dialled for an outgoing call. Can be different than returned from MCCPCall::RemoteParty() .
Since
S60 3.2

ForwardProviderL(const MCCPForwardObserver &)

MCCPForwardProvider * ForwardProviderL ( const MCCPForwardObserver & aObserver ) [pure virtual]
Get forward provider. Must return the already created object if called again after initial creation.
Since
Series 60 3.2
leave
On error case, system error code.

Parameters

const MCCPForwardObserver & aObserver Observer class for forward events.

HangUp()

TInt HangUp ( ) [pure virtual]
Ends an ongoing call. Does not delete the call. Call is deleted when CConvergedCallProvider::ReleaseCall is called. 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 MCCPCallObserver::ECCPStateIdle .
Since
S60 3.2

Hold()

TInt Hold ( ) [pure virtual]
Puts 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 MCCPCallObserver::ECCPStateConnected or MCCPCallObserver::ECCPStateTransferring . Transferring state is allowed only if previous state before transferring state was on-hold.
Since
S60 3.2

IsCallForwarded()

TBool IsCallForwarded ( ) const [pure virtual]
Return boolean value if the call is forwarded or not.
Since
S60 3.2

IsMobileOriginated()

TBool IsMobileOriginated ( ) const [pure virtual]
Returns boolean value if the call is mobile originated or not.
Since
S60 3.2

IsSecured()

TBool IsSecured ( ) const [pure virtual]
Get call's secure status.
Since
Series 60 3.2

Parameters()

const CCCPCallParameters & Parameters ( ) const [pure virtual]
Cet call parameters.
Since
S60 3.2

Queue()

TInt Queue ( ) [pure virtual]
Reguests plug-in to queue the 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. In case call waiting is temporarily not supported when called returns not ready indication.
Pre-condition
Call state is MCCPCallObserver::ECCPStateIdle .
Post-condition
When succesfull, call state is changed to MCCPCallObserver::ECCPStateQueued .
If queueing is not supported by the plug-in call is disconnected by the plug-in.
Since
S60 3.2

Reject()

TInt Reject ( ) [pure virtual]
Reject an incoming 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 MCCPCallObserver::ECCPStateRinging or MCCPCallObserver::ECCPStateQueued .
Since
S60 3.2

RemoteParty()

const TDesC & RemoteParty ( ) const [pure virtual]
Returns the remote party number or address of the call. In case returned remote party value is KNullDesC it means the remote party is regarded as anonymous.
Since
S60 3.2

RemotePartyName()

const TDesC & RemotePartyName ( ) [pure virtual]
Returns the remote party name of the call.
Since
S60 5.0

RemoveObserver(const MCCPCallObserver &)

TInt RemoveObserver ( const MCCPCallObserver & aObserver ) [pure virtual]
Remove an observer.
Since
S60 v3.2

Parameters

const MCCPCallObserver & aObserver Observer

Resume()

TInt Resume ( ) [pure virtual]
Resume previously held 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 MCCPCallObserver::ECCPStateHold .
Since
S60 3.2

Ringing()

TInt Ringing ( ) [pure virtual]
Indicate call is ringning. 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. Optionally ringing state can be set for MO call too.
Pre-condition
Call state is MCCPCallObserver::ECCPStateIdle .
Since
S60 3.2

SecureSpecified()

TBool SecureSpecified ( ) const [pure virtual]
Return if call secure status is specified or not.
Since
Series 60 5.0

SetParameters(const CCCPCallParameters &)

void SetParameters ( const CCCPCallParameters & aNewParams ) [pure virtual]
Set call parameters.
Since
S60 3.2

Parameters

const CCCPCallParameters & aNewParams New call paramater information.

State()

MCCPCallObserver::TCCPCallState State ( ) const [pure virtual]
Returns the state of the call.
Since
S60 3.2

Swap()

TInt Swap ( ) [pure virtual]
Swaps the 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 MCCPCallObserver::ECCPStateHold or MCCPCallObserver::ECCPStateConnected .
Since
S60 3.2

Tone()

TCCPTone Tone ( ) const [pure virtual]
Returns the inband tone associated to an error condition or a state transition of a call. See defenition for TCCPTone.
Since
S60 3.2

TransferProviderL(const MCCPTransferObserver &)

MCCPTransferProvider * TransferProviderL ( const MCCPTransferObserver & aObserver ) [pure virtual]
Get transfer provider. Must return the already created object if called again after initial creation.
Since
Series 60 3.2
leave
On error case, system error code.

Parameters

const MCCPTransferObserver & aObserver Observer class for transfer events

Uid()

TUid Uid ( ) const [pure virtual]
Returns UID of the plug-in used for this call
Since
S60 3.2

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.