CBIOClientMtm Class Reference

#include <mw/biocmtm.h>

Link against: bioc.lib

class CBIOClientMtm : public CBaseMtm
Public Member Functions
~CBIOClientMtm()
virtual voidAddAddresseeL(const TDesC &)
virtual voidAddAddresseeL(const TDesC &, const TDesC &)
virtual TMsvPartList Find(const TDesC &, TMsvPartList)
virtual CMsvOperation *ForwardL(TMsvId, TMsvPartList, TRequestStatus &)
voidHandleEntryEvent(TMsvEntryEvent, TAny *, TAny *, TAny *)
virtual CMsvOperation *InvokeAsyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &, TRequestStatus &)
virtual voidInvokeSyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &)
virtual voidLoadMessageL()
IMPORT_C CBIOClientMtm *NewL(CRegisteredMtmDll &, CMsvSession &)
virtual TInt QueryCapability(TUid, TInt &)
virtual voidRemoveAddressee(TInt)
virtual CMsvOperation *ReplyL(TMsvId, TMsvPartList, TRequestStatus &)
virtual voidSaveMessageL()
virtual TMsvPartList ValidateMessage(TMsvPartList)
Protected Member Functions
virtual voidContextEntrySwitched()
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 & )

voidAddAddresseeL(const TDesC &aRealAddress)[virtual]

Reimplemented from CBaseMtm::AddAddresseeL(const TDesC &)

Leaves with KErrNotSupported.

Parameters
aRealAddressUnused

AddAddresseeL ( const TDesC &, const TDesC & )

voidAddAddresseeL(const TDesC &aRealAddress,
const TDesC &aAlias
)[virtual]

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

Leaves with KErrNotSupported.

Parameters
aRealAddressUnused
aAliasUnused

ContextEntrySwitched ( )

voidContextEntrySwitched()[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,
TMsvPartListaPartList
)[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
aTextToFindThe plain-text version of the text to be found.
aPartListIndicates 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(TMsvIdaDestination,
TMsvPartListaPartList,
TRequestStatus &aCompletionStatus
)[virtual]

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

Leaves with KErrNotSupported.

Parameters
aDestinationUnused
aPartListUnused
aCompletionStatusUnused
Return Value
Unused

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

voidHandleEntryEvent(TMsvEntryEventaEvent,
TAny *aArg1,
TAny *aArg2,
TAny *aArg3
)

Does nothing.

Parameters
aEventUnused
aArg1Unused
aArg2Unused
aArg3Unused

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

CMsvOperation *InvokeAsyncFunctionL(TIntaFunctionId,
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
aFunctionIdID of the requested operation: this must be a TBiosCmds value.
aSelectionMessage entry to parse or process.
aParameterUnused
aCompletionStatusThe 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 & )

voidInvokeSyncFunctionL(TIntaFunctionId,
const CMsvEntrySelection &aSelection,
TDes8 &aParameter
)[virtual]

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

Leaves with KErrNotSupported.

Parameters
aFunctionIdUnused
aSelectionUnused
aParameterUnused

LoadMessageL ( )

voidLoadMessageL()[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
aRegisteredMtmDllRegistration data for the MTM DLL
aSessionThe CMsvSession of the client requesting the object
Return Value
New BIO client MTM object

QueryCapability ( TUid, TInt & )

TInt QueryCapability(TUidaCapability,
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
aCapabilityUID of capability to be queried
aResponseResponse 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 )

voidRemoveAddressee(TIntaIndex)[virtual]

Reimplemented from CBaseMtm::RemoveAddressee(TInt)

Does nothing.

Parameters
aIndexUnused

ReplyL ( TMsvId, TMsvPartList, TRequestStatus & )

CMsvOperation *ReplyL(TMsvIdaDestination,
TMsvPartListaPartlist,
TRequestStatus &aCompletionStatus
)[virtual]

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

Leaves with KErrNotSupported.

Parameters
aDestinationUnused
aPartlistUnused
aCompletionStatusUnused
Return Value
Unused

SaveMessageL ( )

voidSaveMessageL()[virtual]

Reimplemented from CBaseMtm::SaveMessageL()

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

ValidateMessage ( TMsvPartList )

TMsvPartList ValidateMessage(TMsvPartListaPartList)[virtual]

Reimplemented from CBaseMtm::ValidateMessage(TMsvPartList)

Does nothing.

Parameters
aPartListUnused
Return Value
Always 0