CBIOClientMtm Class Reference

#include <mw/biocmtm.h>

Link against: bioc.lib

class CBIOClientMtm : public CBaseMtm

Inherits from

CBIOClientMtm
- CBaseMtm

Public Member Functions
	~CBIOClientMtm()
virtual void	AddAddresseeL(const TDesC &)
virtual void	AddAddresseeL(const TDesC &, const TDesC &)
virtual TMsvPartList	Find(const TDesC &, TMsvPartList)
virtual CMsvOperation *	ForwardL(TMsvId, TMsvPartList, TRequestStatus &)
void	HandleEntryEvent(TMsvEntryEvent, TAny , TAny , TAny *)
virtual CMsvOperation *	InvokeAsyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &, TRequestStatus &)
virtual void	InvokeSyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &)
virtual void	LoadMessageL()
IMPORT_C CBIOClientMtm *	NewL(CRegisteredMtmDll &, CMsvSession &)
virtual TInt	QueryCapability(TUid, TInt &)
virtual void	RemoveAddressee(TInt)
virtual CMsvOperation *	ReplyL(TMsvId, TMsvPartList, TRequestStatus &)
virtual void	SaveMessageL()
virtual TMsvPartList	ValidateMessage(TMsvPartList)

Protected Member Functions
virtual void	ContextEntrySwitched()

Inherited Attributes
	CBaseMtm::iAddresseeList
	CBaseMtm::iCharFormatLayer
	CBaseMtm::iMsvEntry
	CBaseMtm::iParaFormatLayer

Inherited Enumerations
	MMsvEntryObserver:TMsvEntryEvent

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	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()
	CBaseMtm::AddAddresseeL(TMsvRecipientType,const TDesC &)
	CBaseMtm::AddAddresseeL(TMsvRecipientType,const TDesC &,const TDesC &)
	CBaseMtm::AddAttachmentL(RFile &,const TDesC8 &,TUint,TRequestStatus &)
	CBaseMtm::AddAttachmentL(const TDesC &,const TDesC8 &,TUint,TRequestStatus &)
	CBaseMtm::AddEntryAsAttachmentL(TMsvId,TRequestStatus &)
	CBaseMtm::AddLinkedAttachmentL(const TDesC &,const TDesC8 &,TUint,TRequestStatus &)
	CBaseMtm::AddresseeList()const
	CBaseMtm::BioTypeChangedL(TUid)
	CBaseMtm::Body()
	CBaseMtm::Body()const
	CBaseMtm::CBaseMtm(CRegisteredMtmDll &,CMsvSession &)
	CBaseMtm::CancelAttachmentOperation()
	CBaseMtm::ChangeDefaultServiceL(const TMsvId &)
	CBaseMtm::CreateAttachmentL(const TDesC &,RFile &,const TDesC8 &,TUint,TRequestStatus &)
	CBaseMtm::CreateMessageL(TMsvId)
	CBaseMtm::DefaultServiceL()const
	CBaseMtm::Entry()const
	CBaseMtm::Extension_(TUint,TAny &,TAny )
	CBaseMtm::Filler1()
	CBaseMtm::Filler2()
	CBaseMtm::GetExtensionData()
	CBaseMtm::GetInterface(TUid)
	CBaseMtm::HandleEntryEventL(TMsvEntryEvent,TAny ,TAny ,TAny *)
	CBaseMtm::HasContext()const
	CBaseMtm::RemoveDefaultServiceL()
	CBaseMtm::RestoreBodyL(CMsvStore &)
	CBaseMtm::Session()
	CBaseMtm::SetCurrentEntryL(CMsvEntry *)
	CBaseMtm::SetExtensionData(TAny *)
	CBaseMtm::SetMessageCharacterSet(TUint)
	CBaseMtm::SetSubjectL(const TDesC &)
	CBaseMtm::StoreBodyL(CMsvStore &)
	CBaseMtm::SubjectL()const
	CBaseMtm::SwitchCurrentEntryL(TMsvId)
	CBaseMtm::Type()const
	CBaseMtm::~CBaseMtm()

Detailed Description

BIO client MTM interface.

The BIO client MTM is simply responsible for requesting BIO message parser operations to the BIO Server MTM through InvokeAsyncFunctionL(). Many of the other base class functions are implemented to do nothing.

Constructor & Destructor Documentation

~CBIOClientMtm ( )

~CBIOClientMtm

(

)

Destructor.

Member Function Documentation

AddAddresseeL ( const TDesC & )

void

AddAddresseeL

(

const TDesC &

aRealAddress

)

[virtual]

Reimplemented from CBaseMtm::AddAddresseeL(const TDesC &)

Leaves with KErrNotSupported.

Parameters
aRealAddress	Unused

AddAddresseeL ( const TDesC &, const TDesC & )

void	AddAddresseeL	(	const TDesC &	aRealAddress,
			const TDesC &	aAlias
		)	[virtual]

Reimplemented from CBaseMtm::AddAddresseeL(const TDesC &,const TDesC &)

Leaves with KErrNotSupported.

Parameters
aRealAddress	Unused
aAlias	Unused

ContextEntrySwitched ( )

void

ContextEntrySwitched

(

)

[protected, virtual]

Reimplemented from CBaseMtm::ContextEntrySwitched()

Called by the base class functions SwitchCurrentEntryL() and SetCurrentEntryL() when the context is changed to another entry.

Client applications do not use this function. It is relevant only to implementers of derived classes.

Requirements:

An implementation should clear:

1. address data stored in iAddresseeList

2. any caches of MTM-specific entry data relating to a previous context. For example, if the implementation has a private buffer storing a message subject, for access through Subject(), this buffer should be cleared.

Find ( const TDesC &, TMsvPartList )

TMsvPartList	Find	(	const TDesC &	aTextToFind,
			TMsvPartList	aPartList
		)	[virtual]

Reimplemented from CBaseMtm::Find(const TDesC &,TMsvPartList)

Searches the specified message part(s) for the plain-text version of the text to be found.

Supported messages parts are KMsvMessagePartBody, KMsvMessagePartOriginator, and KMsvMessagePartDescription.

Parameters
aTextToFind	The plain-text version of the text to be found.
aPartList	Indicates the message parts which should be searched.

Return Value: 0, if the text was not found, or searching is unsupported. If the text was found, a bitmask of the TMsvPartList IDs for each part in which the text was present.

ForwardL ( TMsvId, TMsvPartList, TRequestStatus & )

CMsvOperation *	ForwardL	(	TMsvId	aDestination,
			TMsvPartList	aPartList,
			TRequestStatus &	aCompletionStatus
		)	[virtual]

Reimplemented from CBaseMtm::ForwardL(TMsvId,TMsvPartList,TRequestStatus &)

Leaves with KErrNotSupported.

Parameters
aDestination	Unused
aPartList	Unused
aCompletionStatus	Unused

Return Value: Unused

HandleEntryEvent ( TMsvEntryEvent, TAny , TAny , TAny * )

void	HandleEntryEvent	(	TMsvEntryEvent	aEvent,
			TAny *	aArg1,
			TAny *	aArg2,
			TAny *	aArg3
		)

Does nothing.

Parameters
aEvent	Unused
aArg1	Unused
aArg2	Unused
aArg3	Unused

InvokeAsyncFunctionL ( TInt, const CMsvEntrySelection &, TDes8 &, TRequestStatus & )

CMsvOperation *	InvokeAsyncFunctionL	(	TInt	aFunctionId,
			const CMsvEntrySelection &	aSelection,
			TDes8 &	aParameter,
			TRequestStatus &	aCompletionStatus
		)	[virtual]

Reimplemented from CBaseMtm::InvokeAsyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &,TRequestStatus &)

Requests a BIO message to be parsed or processed.

The behaviour resulting from the request is specific to the BIO message type. Typically, parsing causes an interpretation of the raw message body, and storage of the results. Processing causes some system action to take place according to the instructions in the message.

Parameters
aFunctionId	ID of the requested operation: this must be a TBiosCmds value.
aSelection	Message entry to parse or process.
aParameter	Unused
aCompletionStatus	The request status to be completed when the operation has finished

Return Value: If successful, this is an asynchronously completing operation. If failed, this is a completed operation, with status set to the relevant error code.

InvokeSyncFunctionL ( TInt, const CMsvEntrySelection &, TDes8 & )

void	InvokeSyncFunctionL	(	TInt	aFunctionId,
			const CMsvEntrySelection &	aSelection,
			TDes8 &	aParameter
		)	[virtual]

Reimplemented from CBaseMtm::InvokeSyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &)

Leaves with KErrNotSupported.

Parameters
aFunctionId	Unused
aSelection	Unused
aParameter	Unused

LoadMessageL ( )

void

LoadMessageL

(

)

[virtual]

Reimplemented from CBaseMtm::LoadMessageL()

Loads the current context's message body from storage.

NewL ( CRegisteredMtmDll &, CMsvSession & )

IMPORT_C CBIOClientMtm *	NewL	(	CRegisteredMtmDll &	aRegisteredMtmDll,
			CMsvSession &	aSession
		)	[static]

Allocates and constructs a new BIO client MTM object.

Parameters
aRegisteredMtmDll	Registration data for the MTM DLL
aSession	The CMsvSession of the client requesting the object

Return Value: New BIO client MTM object

QueryCapability ( TUid, TInt & )

TInt	QueryCapability	(	TUid	aCapability,
			TInt &	aResponse
		)	[virtual]

Reimplemented from CBaseMtm::QueryCapability(TUid,TInt &)

Queries if the MTM supports a particular capability, specified by a UID.

It supports KUidMtmQueryMaxBodySize, KUidMtmQueryMaxTotalMsgSize, KUidMsvMtmQueryEditorUid, KUidMtmQuerySupportedBody, and KUidMtmQueryCanReceiveMsg.

Parameters
aCapability	UID of capability to be queried
aResponse	Response value. The format of the response varies according to the capability.

Return Value: KErrNone: aCapability is a recognised value and a response is returned KErrNotSupported: aCapability is not a recognised value

RemoveAddressee ( TInt )

void

RemoveAddressee

(

TInt

aIndex

)

[virtual]

Reimplemented from CBaseMtm::RemoveAddressee(TInt)

Does nothing.

Parameters
aIndex	Unused

ReplyL ( TMsvId, TMsvPartList, TRequestStatus & )

CMsvOperation *	ReplyL	(	TMsvId	aDestination,
			TMsvPartList	aPartlist,
			TRequestStatus &	aCompletionStatus
		)	[virtual]

Reimplemented from CBaseMtm::ReplyL(TMsvId,TMsvPartList,TRequestStatus &)

Leaves with KErrNotSupported.

Parameters
aDestination	Unused
aPartlist	Unused
aCompletionStatus	Unused

Return Value: Unused

SaveMessageL ( )

void

SaveMessageL

(

)

[virtual]

Reimplemented from CBaseMtm::SaveMessageL()

Commits cached changes to the current context's body text to storage.

ValidateMessage ( TMsvPartList )

TMsvPartList

ValidateMessage

(

TMsvPartList

aPartList

)

[virtual]

Reimplemented from CBaseMtm::ValidateMessage(TMsvPartList)

Does nothing.

Parameters
aPartList	Unused

Return Value: Always 0

CBIOClientMtm Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

~CBIOClientMtm ( )

Member Function Documentation

AddAddresseeL ( const TDesC & )

AddAddresseeL ( const TDesC &, const TDesC & )

ContextEntrySwitched ( )

Find ( const TDesC &, TMsvPartList )

ForwardL ( TMsvId, TMsvPartList, TRequestStatus & )

HandleEntryEvent ( TMsvEntryEvent, TAny *, TAny *, TAny * )

InvokeAsyncFunctionL ( TInt, const CMsvEntrySelection &, TDes8 &, TRequestStatus & )

InvokeSyncFunctionL ( TInt, const CMsvEntrySelection &, TDes8 & )

LoadMessageL ( )

NewL ( CRegisteredMtmDll &, CMsvSession & )

QueryCapability ( TUid, TInt & )

RemoveAddressee ( TInt )

ReplyL ( TMsvId, TMsvPartList, TRequestStatus & )

SaveMessageL ( )

ValidateMessage ( TMsvPartList )

HandleEntryEvent ( TMsvEntryEvent, TAny , TAny , TAny * )