#include <mw/biocmtm.h>
Link against: bioc.lib
class CBIOClientMtm : public 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 |
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.
void | AddAddresseeL | ( | const TDesC & | aRealAddress | ) | [virtual] |
Reimplemented from CBaseMtm::AddAddresseeL(const TDesC &)
Leaves with KErrNotSupported.
Parameters | |
---|---|
aRealAddress | Unused |
Reimplemented from CBaseMtm::AddAddresseeL(const TDesC &,const TDesC &)
Leaves with KErrNotSupported.
Parameters | |
---|---|
aRealAddress | Unused |
aAlias | Unused |
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.
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. |
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 |
void | HandleEntryEvent | ( | TMsvEntryEvent | aEvent, |
TAny * | aArg1, | |||
TAny * | aArg2, | |||
TAny * | aArg3 | |||
) |
Does nothing.
Parameters | |
---|---|
aEvent | Unused |
aArg1 | Unused |
aArg2 | Unused |
aArg3 | Unused |
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 |
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 |
void | LoadMessageL | ( | ) | [virtual] |
Reimplemented from CBaseMtm::LoadMessageL()
Loads the current context's message body from storage.
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 |
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. |
void | RemoveAddressee | ( | TInt | aIndex | ) | [virtual] |
Reimplemented from CBaseMtm::RemoveAddressee(TInt)
Does nothing.
Parameters | |
---|---|
aIndex | Unused |
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 |
void | SaveMessageL | ( | ) | [virtual] |
Reimplemented from CBaseMtm::SaveMessageL()
Commits cached changes to the current context's body text to storage.
TMsvPartList | ValidateMessage | ( | TMsvPartList | aPartList | ) | [virtual] |
Reimplemented from CBaseMtm::ValidateMessage(TMsvPartList)
Does nothing.
Parameters | |
---|---|
aPartList | Unused |