CObexClientMtm Class Reference
| class CObexClientMtm : public CBaseMtm |
CObexClientMtm
Abstract base class for Client Mtms that send obex objects
The functionality missing is an implementation of InvokeAsyncFunctionL() which should return a messaging operation for a specific transport, InitialiseHeaderL() which is used to create a CObexMtmHeader derived object of the appropriate type, and TestInvariant() which is used to perform invariant testing of the derived types (in debug only). These pure-virtual functions are the transport specific aspects of the MTM.
Nested Classes and Structures
| 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::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::InvokeAsyncFunctionL(TInt,const CMsvEntrySelection &,TDes8 &,TRequestStatus &) |
| | CBaseMtm::RemoveDefaultServiceL() |
| | CBaseMtm::RestoreBodyL(CMsvStore &) |
| | CBaseMtm::Session() |
| | CBaseMtm::SetCurrentEntryL(CMsvEntry *) |
| | CBaseMtm::SetExtensionData(TAny *) |
| | CBaseMtm::SetMessageCharacterSet(TUint) |
| | CBaseMtm::StoreBodyL(CMsvStore &) |
| | CBaseMtm::SwitchCurrentEntryL(TMsvId) |
| | CBaseMtm::Type()const |
| | CBaseMtm::~CBaseMtm() |
Constructor & Destructor Documentation
CObexClientMtm(CRegisteredMtmDll &, CMsvSession &, TUid)
Constructor. Initialises iMsgTypeUid with Uid provided by the derived class.
Parameters
| CRegisteredMtmDll & aRegisteredMtmDll | Registration data for MTM DLL. |
| CMsvSession & aMsvSession | CMsvSession of the client requesting the object. |
| TUid aMsgTypeUid | Uid of the message |
~CObexClientMtm()
| IMPORT_C | ~CObexClientMtm | ( | ) | |
Destructor deletes FileNameExternaliser and Header
Member Functions Documentation
AddAddresseeL(const TDesC &)
| IMPORT_C void | AddAddresseeL | ( | const TDesC & | aRealAddress | ) | [virtual] |
Adds addressee to the addressee "list". Note that this MUST be a TDesC containing binary data representing the TSockAddress of the addressee, usually as a TDesC16. This function will then package the data directly into 8 bit data. NB: Only ONE addressee is supported
-
leave
- KErrXXX if address cannot be appended
-
leave
- KErrAlreadyExists if the Addressee "list" already contains an entry
Parameters
| const TDesC & aRealAddress | Reference to the address of the recipient |
AddAddresseeL(const TDesC &, const TDesC &)
| IMPORT_C void | AddAddresseeL | ( | const TDesC & | aRealAddress, |
| | const TDesC & | aAlias |
| | ) | [virtual] |
Adds addressee to the addressee "list". Note that this MUST be a TDesC containing binary data representing the TSockAddress of the addressee, usually as a TDesC16. This function will then package the data directly into 8 bit data. NB: Only ONE addressee is supported
-
leave
- KErrXXX if address cannot be appended
-
leave
- KErrAlreadyExists if the Addressee "list" already contains an entry
Parameters
| const TDesC & aRealAddress | Reference to the address of the recipient |
| const TDesC & aAlias | Reference to the alias of the recipient--ignored in this implementation |
CommitChangesL()
| IMPORT_C void | CommitChangesL | ( | ) | |
Commits cached changes to the message store.
-
leave
- KErrXxx System-wide error codes if changes cannot be committed.
ConstructL()
| IMPORT_C void | ConstructL | ( | ) | [protected] |
Empty implementation provided for future-proofing.
ContextEntrySwitched()
| IMPORT_C void | ContextEntrySwitched | ( | ) | [protected, virtual] |
Resets the MTM when the context is switched. Must be called by the derived class's ContextEntrySwitched prior to constructing a new header.
CreateMessageAttachmentL(TMsvId)
| IMPORT_C void | CreateMessageAttachmentL | ( | TMsvId | aAttachmentId | ) | |
Obex based MTMs do not support message entry attachments. This method will leave with KErrNotSupported.
- leave
- KErrNotSupported This method is not supported.
Parameters
| TMsvId aAttachmentId | This is not supported. |
CreateMessageL(TMsvId)
| IMPORT_C void | CreateMessageL | ( | TMsvId | | ) | [virtual] |
Create a new message for this MTM. This creates a new messaging entry, then re-initialises the MTM's CObexMtmHeader object.
-
leave
- KErrXxx Standard EPOC error codes if construction of new objects fails
Find(const TDesC &, TMsvPartList)
Finds the given text within the specified parts of the current message context. NOT IMPLEMENTED!
Parameters
| const TDesC & aTextToFind | Reference to the text to search for in the specified message parts |
| TMsvPartList aPartList | Bitmask indicating parts of message to be searched for the text |
ForwardL(TMsvId, TMsvPartList, TRequestStatus &)
Unsupported
-
leave
- Leaves always with KErrNotSupported
GetAttachmentSizeL()
| IMPORT_C TInt32 | GetAttachmentSizeL | ( | ) | |
This function calculates the size of all attachments to the message by either:
-
summing the sizes of each of the children or;
-
reading in all of the filenames from the store, and summing their sizes.*
-
leave
- KErrXXX system-wide error codes
InitialiseHeaderL()
| void | InitialiseHeaderL | ( | ) | [protected, pure virtual] |
InvokeSyncFunctionL(TInt, const CMsvEntrySelection &, TDes8 &)
No functionality is provided by this method. Leaves with KErrNotSupported.
- leave
- KErrNotSupported
LoadMessageL()
| IMPORT_C void | LoadMessageL | ( | ) | [virtual] |
This function loads the header from the message store
-
leave
- KErrXXX system-wide error codes
QueryCapability(TUid, TInt &)
| IMPORT_C TInt | QueryCapability | ( | TUid | aCapability, |
| | TInt & | aResponse |
| | ) | [virtual] |
Gives the capability of the MTM.
Parameters
| TUid aCapability | capability to be queried |
| TInt & aResponse | capability dependent return value. |
RemoveAddressee(TInt)
| IMPORT_C void | RemoveAddressee | ( | TInt | aIndex | ) | [virtual] |
Removes addressee at index aIndex from the addressee "list".
Parameters
| TInt aIndex | zero-based index of the addressee (ignored since "there can be only one"). |
ReplyL(TMsvId, TMsvPartList, TRequestStatus &)
Unsupported
-
leave
- Leaves always with KErrNotSupported
SaveMessageL()
| IMPORT_C void | SaveMessageL | ( | ) | [virtual] |
Commits cached changes to the message store, by calling CommitChangesL.
-
leave
- KErrXxx System-wide error codes if message cannot be saved.
SetSubjectL(const TDesC &)
| IMPORT_C void | SetSubjectL | ( | const TDesC & | aSubject | ) | [virtual] |
Sets the subject of the current message context
-
leave
- Leaves if creation of new HBufC fails
Parameters
| const TDesC & aSubject | Reference to the new message subject text |
SubjectL()
| IMPORT_C const TPtrC | SubjectL | ( | ) | const [virtual] |
Returns the subject of the current message context. Will not leave.
ValidateMessage(TMsvPartList)
Ensure that the current message context part indicated is valid. Currently only works on KMsvMessagePartRecipient--all other parts are assumed to be valid
Parameters
| TMsvPartList aPartList | Bitmask indicating parts of message to be validated |
Member Data Documentation
const TUid iMsgTypeUid
| const TUid | iMsgTypeUid | [private] |
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.