Symbian^3 Application Developer Library >

CMceOutRefer Class Reference

class CMceOutRefer : public CMceRefer

Class for mobile originated MCE refers.

CMceOutRefer represents outgoing request to remote terminal to perform an action. This request may or may not also implicitically generate an event. This is indicated by type while instantiating the class. If event is generated, instance of CMceOutEvent is returned in ReferL function call. This will lead to notifications send by remote terminal received through MMceEventObserver::NotifyReceived() function.

The refer is finally terminated by the remote endpoint.

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

mceclient.lib

Inherits from

Public Member Functions
~CMceOutRefer ()
TBool IsInRefer ()
IMPORT_C CMceOutRefer * NewL ( CMceManager &, CSIPProfile &, const TDesC8 &, const TDesC8 &, TType , HBufC8 *)
IMPORT_C CMceOutRefer * NewL ( CMceEvent &, const TDesC8 &, TType )
IMPORT_C CMceOutRefer * NewL ( CMceSession &, const TDesC8 &, TType )
IMPORT_C CMceOutRefer * NewL ( CMceRefer &, const TDesC8 &, TType )
IMPORT_C CMceOutEvent * ReferL ( CDesC8Array *, HBufC8 *, HBufC8 *)
Private Member Functions
CMceOutRefer ( CMceManager &, TUint32 , TUint32 , TType )
void ConstructL (const TDesC8 &, const TDesC8 &, TType , HBufC8 *)
void ConstructL (const TDesC8 &, const TDesC8 &, TType , const TDesC8 &)
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

CMceOutRefer(CMceManager &, TUint32, TUint32, TType)

CMceOutRefer ( CMceManager & aManager,
TUint32 aProfileId,
TUint32 aDialogId,
TType aType
) [private]

C++ default constructor.

Parameters

CMceManager & aManager
TUint32 aProfileId
TUint32 aDialogId
TType aType

~CMceOutRefer()

IMPORT_C ~CMceOutRefer ( )

Destructor.

Member Functions Documentation

ConstructL(const TDesC8 &, const TDesC8 &, TType, HBufC8 *)

void ConstructL ( const TDesC8 & aRecipient,
const TDesC8 & aReferTo,
TType aType,
HBufC8 * aOriginator
) [private]

second-phase constructor

Parameters

const TDesC8 & aRecipient
const TDesC8 & aReferTo
TType aType
HBufC8 * aOriginator

ConstructL(const TDesC8 &, const TDesC8 &, TType, const TDesC8 &)

void ConstructL ( const TDesC8 & aRecipient,
const TDesC8 & aReferTo,
TType aType,
const TDesC8 & aOriginator
) [private]

second-phase constructor

Parameters

const TDesC8 & aRecipient
const TDesC8 & aReferTo
TType aType
const TDesC8 & aOriginator

IsInRefer()

TBool IsInRefer ( ) const [virtual]

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

NewL(CMceManager &, CSIPProfile &, const TDesC8 &, const TDesC8 &, TType, HBufC8 *)

IMPORT_C CMceOutRefer * NewL ( CMceManager & aManager,
CSIPProfile & aProfile,
const TDesC8 & aRecipient,
const TDesC8 & aReferTo,
TType aType = ENoSuppression,
HBufC8 * aOriginator = 0
) [static]

Two-phased constructor.

Parameters

CMceManager & aManager
CSIPProfile & aProfile
const TDesC8 & aRecipient
const TDesC8 & aReferTo
TType aType = ENoSuppression
HBufC8 * aOriginator = 0

NewL(CMceEvent &, const TDesC8 &, TType)

IMPORT_C CMceOutRefer * NewL ( CMceEvent & aEvent,
const TDesC8 & aReferTo,
TType aType = ENoSuppression
) [static]

Two-phased constructor. Should be used when refer is associated to existing event. This guarantees that refer is sent to same remote terminal with the event.

Parameters

CMceEvent & aEvent
const TDesC8 & aReferTo
TType aType = ENoSuppression

NewL(CMceSession &, const TDesC8 &, TType)

IMPORT_C CMceOutRefer * NewL ( CMceSession & aSession,
const TDesC8 & aReferTo,
TType aType = ENoSuppression
) [static]

Two-phased constructor. Should be used when refer is associated to existing session. This guarantees that refer is sent to same remote terminal with the session.

Parameters

CMceSession & aSession
const TDesC8 & aReferTo
TType aType = ENoSuppression

NewL(CMceRefer &, const TDesC8 &, TType)

IMPORT_C CMceOutRefer * NewL ( CMceRefer & aRefer,
const TDesC8 & aReferTo,
TType aType = ENoSuppression
) [static]

Two-phased constructor. Should be used when refer is associated to existing refer. This guarantees that refers are sent to same remote terminal.

Parameters

CMceRefer & aRefer
const TDesC8 & aReferTo
TType aType = ENoSuppression

ReferL(CDesC8Array *, HBufC8 *, HBufC8 *)

IMPORT_C CMceOutEvent * ReferL ( CDesC8Array * aHeaders = 0,
HBufC8 * aContentType = 0,
HBufC8 * aContent = 0
)
Refers to ongoing session.
Pre-condition
State() == CMceRefer::EIdle
Post-condition
State() == CMCRefer::EPending

Parameters

CDesC8Array * aHeaders = 0
HBufC8 * aContentType = 0
HBufC8 * aContent = 0

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.