![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
mtclbase.h
Link against:
msgs.lib
CBaseMtm
Supported from 5.0
Provides a high-level interface for accessing and manipulating a Message Server entry.
Message client applications use the class to access such functionality polymorphically. MTM implementers implement a derived class to provide such functionality for their message protocol.
In pre-Unicode versions this class had the import library mcld.lib.
The following are some significant groups of functions:
Context functions: the SetCurrentEntryL() and SwitchCurrentEntryL() functions change the context—the entry on which later actions are performed. After creating a new Client-side MTM object, a message client application should set an initial context before using other functions. Note that: any changes made to an existing context are not automatically saved: the message client application should ensure this itself by calling SaveMessageL(); no message data for the new context is retrieved from the Message Server, to retrieve entry data, call LoadMessageL() after setting the context; calling Body() immediately after setting the context returns an empty CRichText object: this is because the private cache of context body text that the base class maintains is re-initialised to an empty value. MTM implementers should note that the virtual ContextEntrySwitched() is called from these functions to allow derived classes to also clear any caches of MTM-specific entry data.
Store and restore entry data functions: the changes that a message client application makes to a message context through Client-side MTM functions, such as altering the body text obtained through Body(), are, for efficiency, cached in memory by a Client-side MTM. The message store and restore functions are concerned with transferring data between that cache and committed storage. Note that, unlike message contexts, message client applications are not expected to manipulate directly service contexts. Instead, the corresponding User Interface MTM will provide dialogs to allow the user to alter service settings, and call Client-side MTM functions to handle their retrieval and storage. ER5 expects the base class functions to handle storage and retrieval for both message and service contexts, and their implementations must detect what the context is, and act accordingly. Post-ER5, the API is clarified by restricting the base class functions to handle message contexts only. To handle service contexts, a Client-side MTM must define its own functions for the User Interface MTM to call.
Store and restore body text functions: the base class maintains a private CRichText object cache to store the body text for the current context. This can be accessed for reading and writing by message client applications through Body(). StoreBodyL() and RestoreBodyL() encapsulate for implementers of derived classes the retrieval and storage of this CRichText object to a CMsvStore.
Address list functions: the format and storage of message addresses is MTM-specific. AddresseeList(), AddAddresseeL(), and RemoveAddressee() are designed to allow clients with no MTM-specific knowledge to access address information in a generic way. The base class has a protected data member iAddresseeList, an array of descriptors, which these functions manipulate. Implementations should save the address information to the appropriate place in the message store when the message is stored.
MTM-specific functionality: MTM components can offer protocol-specific functionality not provided by base class interface functions. MTM components define IDs that correspond to each protocol-specific operation offered, and implement the InvokeSyncFunctionL() and InvokeAsyncFunctionL() functions to allow clients to access these operations by passing in the appropriate ID. Two functions are provided to allow the MTM component to offer both synchronous and asynchronous functionality. Message client applications can dynamically add user-interface features for these operations using CBaseMtmUiData::MtmSpecificFunctions(). MTM developers should document the IDs if they wish to make the operations available to clients.
|
Defined in CBaseMtm:
AddAddresseeL(), AddresseeList(), BioTypeChangedL(), Body(), CBaseMtm(), ContextEntrySwitched(), CreateAttachmentL(), CreateMessageL(), DeleteAttachmentL(), Entry(), Find(), ForwardL(), HandleEntryEventL(), HasContext(), InvokeAsyncFunctionL(), InvokeSyncFunctionL(), LoadMessageL(), QueryCapability(), RemoveAddressee(), ReplyL(), RestoreBodyL(), RestoreL(), SaveMessageL(), Session(), SetCurrentEntryL(), SetSubjectL(), StoreBodyL(), StoreL(), SubjectL(), SwitchCurrentEntryL(), Type(), ValidateMessage(), iAddresseeList, iCharFormatLayer, iMsvEntry, iParaFormatLayer, ~CBaseMtm()
Inherited from CBase:
operator new()
Inherited from MMsvEntryObserver:
EMsvChildrenChanged,
EMsvChildrenInvalid,
EMsvChildrenMissing,
EMsvContextInvalid,
EMsvDeletedChildren,
EMsvEntryChanged,
EMsvEntryDeleted,
EMsvEntryMoved,
EMsvNewChildren,
EMsvStoreCommitted,
EMsvStoreCreated,
EMsvStoreDeleted,
HandleEntryEvent(),
TMsvEntryEvent
protected: CBaseMtm(CRegisteredMtmDll& aRegisteredMtmDll,CMsvSession& aSession);
Creates a CBaseMtm with member variables initialised from the passed arguments.
Client applications do not use this function. It is relevant only to implementers of derived classes.
The value of aSession can be accessed through Session().
Derived classes can implement a constructor to perform any additional MTM-specific setup that can be safely carried out in a constructor. Such constructors must call the base class constructor function.
Derived classes also implement two-phase construction functions (NewL(), ConstructL()) to create a new instance of the object, in which any dynamic allocation should be performed. Client-side MTMs also implement a factory function by which a MTM registry can request an instance of the class.
|
~CBaseMtm();
Cleans up the base class.
CBaseMtm -derived objects must be deleted by client applications when they are no longer required.
Derived classes can implement a destructor to do any additional clean up tasks that they require.
|
virtual void BioTypeChangedL(TUid aBioTypeUid);
Supported from 6.0
Informs client-side MTM that the context's BIO field is being changed as a result of a call to CSendAs::SetBioTypeL().
CSendAs::SetBioTypeL() calls this function before setting the BIO field in the context's index entry. This allows a client-side MTM to perform MTM specific actions when the BIO type changes.
CSendAs will not change the BIO type if this function leaves.
The default implementation is to do nothing.
|
virtual void CreateMessageL(TMsvId aServiceId);
Supported from 6.0
Creates a new message entry as a child of the current context.
The default implementation creates an empty entry with its visible flag set to false and its in-preparation flag set to true.
|
void SetCurrentEntryL(CMsvEntry* aEntry);
Sets the entry on which later actions are performed to the specified CMsvEntry.
|
|
void SwitchCurrentEntryL(TMsvId aId);
Changes the entry on which later actions are performed to the entry with the specified TMsvId.
|
|
protected: virtual void ContextEntrySwitched()=0;
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:
address data stored in iAddresseeList
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.
TBool HasContext() const;
Tests if an MTM context has been set.
A Client-side MTM has no context until one is set through SwitchCurrentEntryL() or SetCurrentEntryL() .
|
|
virtual void RestoreL()=0;
Withdrawn in 5.1
Loads the cache with the message data for the current context—can be used for both message and service contexts.
It is typically used after the context has been set with SetCurrentEntryL() or SwitchCurrentEntryL(). CBaseMtm functions to manipulate the entry can only be called after this function has been called.
Requirements:
An implementation must restore the store and index entry relating to the context.
For a message context, typically, the message store should be opened for reading with CMsvEntry::ReadStoreL(). It should be then be read to set the following:
body text: call RestoreBodyL() to update the cached body text
address list: read the appropriate MTM-specific area of the store to update iAddresseeList
subject: if supported, read the appropriate MTM-specific area of the store and update the cache with SetSubjectL()
For a service context, the service settings should be read from the MTM-specific stream in which they are stored.
virtual void LoadMessageL()=0;
Supported from 5.1
Loads the cache with the message data for the current context—can only be called on message contexts.
It is typically used after the context has been set with SetCurrentEntryL() or SwitchCurrentEntryL(). CBaseMtm functions to manipulate the entry can only be called after this function has been called.
Requirements:
An implementation must restore the store and index entry relating to the message context. Typically, the message store should be opened for reading with CMsvEntry::ReadStoreL(). It should be then be read to set the following:
body text: call RestoreBodyL() to update the cached body text
address list: read the appropriate MTM-specific area of the store to update iAddresseeList
subject: if supported, read the appropriate MTM-specific area of the store and update the cache with SetSubjectL()
The function should panic for non-message contexts.
|
virtual void StoreL()=0;
Withdrawn in 5.1
Commits cached changes to the storage controlled by the Message Server—can be used for both message and service contexts. It should be called in the following circumstances:
to preserve changes when the context is changed, or when the Client-side MTM object is deleted
to enable other parts of Messaging to access the updated entry, as required, for example, before sending a message
Requirements:
An implementation must update the store and index entry relating to the context.
For a message context, typically, the message store should be opened for editing with CMsvEntry::EditStoreL(). It should be updated as follows:
body text: call StoreBodyL() to update the store’s body text stream
address list: update the appropriate MTM-specific area of the store from the data in iAddresseeList
subject: if supported, update the appropriate MTM-specific area of the store from the private cache set by SetSubjectL()
Changes can then be committed to the store with CMsvStore::CommitL().
The index entry should also be updated to reflect changes. Possible fields that may need updating include: Description (for subject changes); Details and Multiple Recipients (for recipient changes); and Size. Index entry changes are committed using CMsvEntry::ChangeL().
For a service context, the service settings should be written to the MTM-specific message store stream in which they are stored.
|
virtual void SaveMessageL()=0;
Supported from 5.1
Commits cached changes to the storage controlled by the Message Server—can only be called on message contexts. It should be called in the following circumstances:
to preserve changes when the context is changed, or when the Client-side MTM object is deleted
to enable other parts of the Messaging to access the updated entry, as required, for example, before sending a message
Requirements:
An implementation must update the store and index entry relating to the message context. Typically, the message store should be opened for editing with CMsvEntry::EditStoreL(). It should be updated as follows:
body text: call StoreBodyL() to update the store’s body text stream
address list: update the appropriate MTM-specific area of the store from the data in iAddresseeList
subject: if supported, update the appropriate MTM-specific area of the store from the private cache set by SetSubjectL()
Changes can then be committed to the store with CMsvStore::CommitL().
The index entry should also be updated to reflect changes. Possible fields that may need updating include: Description (for subject changes); Details and Multiple Recipients (for recipient changes); and Size. Index entry changes are committed using CMsvEntry::ChangeL().
The function should panic for non-message contexts.
|
|
protected: void StoreBodyL(CMsvStore& aStore);
Stores and commits the current cached CRichText body text to the appropriate stream in the specified message store. Client applications do not use this function. It is relevant only to implementers of derived classes.
The function overwrites any existing data in that stream. The implementation must have write access to aStore.
A typical use of this function is from SaveMessageL().
|
|
protected: void RestoreBodyL(CMsvStore& aStore);
Gets the current cached CRichText from the appropriate stream in the specified message store. Client applications do not use this function. It is relevant only to implementers of derived classes.
A typical use of this function is from LoadMessageL().
|
|
|
virtual CMsvOperation* ReplyL(TMsvId aDestination, TMsvPartList aPartlist, TRequestStatus& aCompletionStatus)=0;
Creates a reply message to the current message context.
Some MTMs may support inclusion of elements, specified by aPartlist, from the original message in the reply. The parent for the new entry is specified in aDestination.
The returned CMsvOperation object completes when creating the reply is complete. On completion, the context is set to the reply message.
Requirements:
A typical implementation for this function would include the following steps:
create a new message in the specified destination by calling CMsvEntry::CreateL()
set the entry index values as appropriate
set the properties of the message as required. The normal minimum is to set the address to the sender of the original message. An implementation may also follow the options specified in aPartlist to set other properties, for example, to include the original message text.
set the context to the reply
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
If message replies are not supported, implementations should leave with KErrNotSupported.
The implementation of this function may be similar to that of ForwardL(), allowing opportunities for code sharing.
|
|
|
virtual CMsvOperation* ForwardL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus)=0;
Creates a forwarded message from the current message context. Some MTMs may support inclusion of elements, specified by aPartlist, from the original message in the forwarded message. The parent for the new entry is specified in aDestination. The returned CMsvOperation object completes when editing the forwarded message is complete. On completion, the context is set to the forwarded message.
Requirements:
A typical implementation for this function would include the following steps:
create a new message in the specified destination by calling CMsvEntry::CreateL()
set the entry index values as appropriate
set message content as required. The normal minimum is to include the text of the original message. An implementation may also follow the options specified in aPartlist to include other properties of the original message.
set the context to the reply
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
If forwarded messages are not supported, implementations should leave with KErrNotSupported.
The implementation of this function may be similar to that of ReplyL(), allowing opportunities for code sharing.
|
|
|
|
virtual TMsvPartList ValidateMessage(TMsvPartList aPartList)=0;
Validates the current message context.
The precise validation performed is specific to the MTM, but, typically, checks that the specified message parts are well-formed.
Requirements:
Implementation of this function is highly protocol-specific. A minimum step is to check that the current context is a message.
|
|
virtual TMsvPartList Find(const TDesC& aTextToFind, TMsvPartList aPartList)=0;
Searches the specified message part(s) for the plain-text version of the text to be found.
If the specified part list indicates a part that is not supported, or is not present in the current message, the function behaves as if the specified part exists but does not contain the required text.
Requirements:
The parts of the entry for which searching is allowed is implementation specific. If no searching is supported, always return 0.
|
|
|
const CDesCArray& AddresseeList() const;
Gets the list of intended recipients for the current context, which must be a message.
In the case of protocols that allow different classes of recipient (such as To, Cc and Bcc), the list returned is whatever the protocol defines as the default recipient list.
Requirements:
The default implementation simply returns the value of the protected data member iAddresseeList. As a consequence, Client-side MTM implementations should update this member whenever the address list is modified.
|
virtual void AddAddresseeL(const TDesC& aRealAddress)=0;
virtual void AddAddresseeL(const TDesC& aRealAddress, const TDesC& aAlias)=0;
Adds an addressee for the current context, which must be a message-overloaded function.
Addresses are not validated by checking their format by this function. Usually that is performed by calling Validate().
The second overload of the function allows an alias to be also supplied, which may be useful for some protocols. For example, for fax, if the address is the fax number, the alias could supply the recipient’s name.
Requirements:
Implementations should append the address to the object’s address cache in the protected iAddresseeList data member. Some implementations may also wish to store addresses in an internal data structure appropriate for the protocol, for example, a class holding message header information.
|
|
virtual void RemoveAddressee(TInt aIndex)=0;
Removes an address from the current address list. The address is specified by a zero-based index into the address list. If the index is not known, applications can use AddresseeList() to retrieve the entire list to find the item.
Requirements:
Implementations should call iAddresseeList->Delete(aIndex) to remove the address from in the address list protected data member.
|
|
CRichText& Body() const;
const CRichText& Body() const;
Gets the body text of the context, which must be a message. For non-message contexts, an empty CRichText is returned.
|
virtual void SetSubjectL(const TDesC& aSubject);
Sets the subject text of the context, which must be a message.
Some Client-side MTMs may not support subject text, in which case the function leaves with KErrNotSupported.
Requirements:
If the message protocol supports subject text, implementations should maintain a private buffer to store this information, settable through this function.
Implementations should save the subject text to the appropriate place in the message store when the message is stored.
The default implementation leaves with KErrNotSupported.
|
|
virtual const TPtrC SubjectL() const;
Gets the subject text of the context, which must be a message.
Some Client-side MTMs may not support subject text, in which case the function leaves with KErrNotSupported.
Requirements:
If the message protocol supports subject text, implementations should maintain a private buffer to store this information, gettable through this function.
The default implementation leaves with KErrNotSupported.
|
|
CMsvSession& Session();
Gets a reference to the session object passed by the creator of the Client-side MTM.
|
TUid Type() const;
Gets the Type UID of the message type associated with the Client-side MTM.
|
CMsvEntry& Entry() const;
Gets a CMsvEntry for the current context. The message client application can then use this to manipulate the entry.
Implementers should note that this function returns the value of the protected data member iMsvEntry.
|
|
protected: void HandleEntryEventL(TMsvEntryEvent aEvent, TAny* aT1, TAny* aT2, TAny* aT3);
Supported from 5.1
Indicates that an event has occurred.
Client applications do not use this function. It is relevant only to implementers of derived classes.
The Client-side MTM object is automatically set as an observer, through CMsvEntry::AddObserverL(), for the context whenever the context changes (by SetCurrentEntryL() or SwitchCurrentEntryL()).
The default implementation is defined to do nothing.
Requirements:
Implementations can override this function to handle events concerning the current context.
In pre-Unicode versions no default implementation of the MMsvEntryObserver interface is provided, and it must be implemented by the derived class.
|
|
virtual TInt QueryCapability(TUid aCapability, TInt& aResponse);
Queries if the MTM supports a particular capability, specified by a UID.
For MTM-specific UIDs, see the documentation for the relevant MTM.
Requirements:
Implementations should check aCapability for the standard capability values, plus any MTM-specific capabilities, and if recognised, return a suitable response in aResponse. If aCapability is unknown, return KErrNotSupported.
The default implementation returns KErrNotSupported.
|
|
|
virtual CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TDes8& aParameter, TRequestStatus& aCompletionStatus)=0;
Invokes asynchronous protocol-specific operations. For synchronous operations, a similar function, InvokeSyncFunctionL(), is available.
aSelection and aParameter allow data to be passed to the operation. The TRequestStatus and CMsvOperation objects are used as normal to control and monitor the operation.
Requirements:
For functionality that requires message transport access, such as making a connection, the implementation should pass the request onto the corresponding Server-side MTM. This is done through calling CMsvSession::TransferCommandL(). Implementations may also provide protocol-specific functions themselves if this is useful.
InvokeAsyncFunctionL() should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation. If CMsvSession::TransferCommandL() is called, this should be the CMsvOperation object returned by that function.
|
|
|
virtual void InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TDes8& aParameter)=0;
Invokes synchronous protocol-specific operations. For asynchronous operations, a similar function, InvokeAsyncFunctionL(), is available.
aSelection and aParameter allow data to be passed to the operation.
Requirements:
For functionality that requires message transport access, such as making a connection, the implementation should pass the request onto the corresponding Server-side MTM. This is done through calling CMsvSession::TransferCommandL(). Implementations may also provide protocol-specific functions themselves if this is useful.
|
|
|
virtual void CreateAttachmentL(TMsvId& aAttachmentId, TFileName& aDirectory);
Supported from 6.0
Creates an entry for an attachment in the Message Server index.
The default implementation raises a panic if no message has been created.
|
|
virtual void DeleteAttachmentL(TMsvId aMessageId, TMsvId aAttachmentId);
Supported from 6.0
Deletes an attachment from the message.
The default implementation deletes the attachment directory and any files in it. It raises a panic if no message has been created.
|
|
|
protected: CParaFormatLayer* iParaFormatLayer
Paragraph formatting applied to the CRichText object for the body text, as returned by Body(). This is set to an empty CParaFormatLayer instance whenever the context is set.
Implementations can modify this if they wish to apply particular formatting to body text.
protected: CCharFormatLayer* iCharFormatLayer
Character formatting applied to the CRichText object for the body text, as returned by Body().
Implementations can modify this if they wish to apply particular formatting to body text.
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
![[Top]](../../../stock/arrow_up.gif){kind=icon}