CMceInRefer Class Reference

class CMceInRefer : public CMceRefer

Class for mobile terminated MCE refers.

CMceInRefer represents incoming request to perform an action. If the remote terminal expects notifications about how the action is proceeding, instance of CMceInEvent is also passed to the user. User is then responsible of sending notifications and finally terminate the event and refer. If notifications are not expected by the remote terminal, instance of CMceInEvent is not returned and refer is terminated as soon as either accept or reject response is sent.

This class is never instantiated by user, but the ownership is in any case transferred to it. See class MMceInReferObserver.

If for any reason instance of this class is deleted while in accepted state, it is automatically terminated by MCE server.

mceclient.lib

Inherits from

Public Member Functions
~CMceInRefer()
IMPORT_C CMceInEvent *AcceptL()
TBool IsInRefer()
CMceInRefer *NewL(CMceManager &, TUint32, CMceMsgSIPEvent &, CMceInEvent *)
IMPORT_C voidRejectL()
IMPORT_C CMceInEvent *RespondL(const TDesC8 &, TUint32, CDesC8Array *, HBufC8 *, HBufC8 *)
Private Member Functions
CMceInRefer(CMceManager &, TUint32, TUint32, TUint32, TType)
voidConstructL(HBufC8 *, HBufC8 *, HBufC8 *, CMceInEvent *)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CMceRefer::AssociatedEventsL()const
CMceRefer::AssociatedRefersL()const
CMceRefer::AssociatedSession()const
CMceRefer::CMceRefer(CMceManager &,TUint32,TUint32,TType)
CMceRefer::ConstructL(HBufC8 *,HBufC8 *,HBufC8 *,CDesC8Array *)
CMceRefer::DetachReferEvent()
CMceRefer::DialogId()const
CMceRefer::ErrorOccuredL(TInt)
CMceRefer::EventReceivedL(TMceIds &)
CMceRefer::EventReceivedL(TMceIds &,CMceMsgBase &)
CMceRefer::EventReceivedL(TMceIds &,CMceMsgBase &,HBufC8 *)
CMceRefer::EventStateChangedL(TMceEvent &)
CMceRefer::ITCSender()const
CMceRefer::Id()const
CMceRefer::Manager()const
CMceRefer::Originator()const
CMceRefer::PrepareForITC(TMceIds &)
CMceRefer::ProfileId()const
CMceRefer::Recipient()const
CMceRefer::ReferEvent()const
CMceRefer::ReferTo()const
CMceRefer::ResolveStateL()
CMceRefer::State()const
CMceRefer::TransferEventOwnership()
CMceRefer::Type()const
CMceRefer::~CMceRefer()
Inherited Enumerations
CMceRefer:TState
CMceRefer:TType
Inherited Attributes
CMceRefer::iDialogId
CMceRefer::iEvent
CMceRefer::iId
CMceRefer::iManager
CMceRefer::iOriginator
CMceRefer::iOwnedEvent
CMceRefer::iProfileId
CMceRefer::iReceiver
CMceRefer::iRecipient
CMceRefer::iReferTo
CMceRefer::iSender
CMceRefer::iState
CMceRefer::iType

Constructor & Destructor Documentation

CMceInRefer(CMceManager &, TUint32, TUint32, TUint32, TType)

CMceInRefer(CMceManager &aManager,
TUint32aProfileId,
TUint32aId,
TUint32aDialogId,
TTypeaType
)[private]

C++ default constructor.

Parameters

CMceManager & aManager
TUint32 aProfileId
TUint32 aId
TUint32 aDialogId
TType aType

~CMceInRefer()

IMPORT_C~CMceInRefer()

Destructor.

Member Functions Documentation

AcceptL()

IMPORT_C CMceInEvent *AcceptL()
Sends accept respond to an incoming refer.
Pre-condition
State() == CMceRefer::EIdle
Post-condition
State() == CMCRefer::EPending || State() == CMCRefer::EAccepted (for suppressed refers)

ConstructL(HBufC8 *, HBufC8 *, HBufC8 *, CMceInEvent *)

voidConstructL(HBufC8 *aReferTo,
HBufC8 *aRecipient,
HBufC8 *aOrginator,
CMceInEvent *aInEvent
)[private]

second-phase constructor

Parameters

HBufC8 * aReferTo
HBufC8 * aRecipient
HBufC8 * aOrginator
CMceInEvent * aInEvent

IsInRefer()

TBool IsInRefer()const [virtual]

Returns truth value, is the refer in-refer or not.

NewL(CMceManager &, TUint32, CMceMsgSIPEvent &, CMceInEvent *)

CMceInRefer *NewL(CMceManager &aManager,
TUint32aProfileId,
CMceMsgSIPEvent &aEventMsg,
CMceInEvent *aInEvent = NULL
)[static]

Two-phased constructor.

Parameters

CMceManager & aManager
TUint32 aProfileId
CMceMsgSIPEvent & aEventMsg
CMceInEvent * aInEvent = NULL

RejectL()

IMPORT_C voidRejectL()
Rejects incoming refer.
Pre-condition
State() == CMceRefer::EIdle
Post-condition
State() == CMCRefer::ETerminated

RespondL(const TDesC8 &, TUint32, CDesC8Array *, HBufC8 *, HBufC8 *)

IMPORT_C CMceInEvent *RespondL(const TDesC8 &aReason,
TUint32aCode,
CDesC8Array *aHeaders = 0,
HBufC8 *aContentType = 0,
HBufC8 *aContent = 0
)
Sends respond to an incoming refer.
Pre-condition
State() == CMceRefer::EIdle
Post-condition
State() == CMCRefer::ETerminated || State() == CMCRefer::EPending || State() == CMCRefer::EAccepted (for suppressed refers)

Parameters

const TDesC8 & aReason
TUint32 aCode
CDesC8Array * aHeaders = 0
HBufC8 * aContentType = 0
HBufC8 * aContent = 0