CSMSExampleMtmsEngine Class Reference

List of all members.

Public Member Functions
	~CSMSExampleMtmsEngine ()
void	MoveToFolderL (TMsvId aMessageId, TMsvId aFolder)
void	DeleteMessageL (TMsvId aMessageId)
void	CopyMessageL (TMsvId aMessageId, TMsvId aFolder)
void	GetMessageAddressL (TMsvId aMessageId, TDes &aAddress)
TBool	GetMessageL (TMsvId aMessageId, TDes &aMessage)
TBool	GetMessageIndexBodyTextL (TMsvId aMessageId, TDes &aMessage)
void	GetFolderSMSMessageInformationL (TMsvId aFolderID, CDesCArrayFlat *&aAddresses, CDesCArrayFlat *&aMessages)
RArray< TMsvId > *	GetMessageIds ()
Static Public Member Functions
static CSMSExampleMtmsEngine *	NewL (MSMSExampleMtmsEngineObserver &aObserver)

---

Detailed Description

SMS engine handles SMS message handling (i.e moving, deleting, copying, retrieving message data).

Definition at line 24 of file SMSExampleMtmsEngine.h.

---

Constructor & Destructor Documentation

CSMSExampleMtmsEngine::~CSMSExampleMtmsEngine

(

)

Destructor.

Definition at line 73 of file SMSExampleMtmsEngine.cpp.

---

Member Function Documentation

CSMSExampleMtmsEngine * CSMSExampleMtmsEngine::NewL

(

MSMSExampleMtmsEngineObserver &

aObserver

)

[static]

Create new CSMSExampleMtmsEngine object

Parameters:

aObserver

a reference to MSMSExampleMtmsEngineObserver.

Returns:

a pointer to the created instance of CSMSExampleMtmsEngine

Definition at line 27 of file SMSExampleMtmsEngine.cpp.

void CSMSExampleMtmsEngine::MoveToFolderL	(	TMsvId	aMessageId,
		TMsvId	aFolder
	)

Move an SMS message to folder.

Parameters:

	aMessageID	id of an SMS message.
	aFolder	target folder id.

Definition at line 101 of file SMSExampleMtmsEngine.cpp.

void CSMSExampleMtmsEngine::DeleteMessageL

(

TMsvId

aMessageId

)

Delete an SMS message.

Parameters:

aMessageID

id of an SMS message.

Definition at line 116 of file SMSExampleMtmsEngine.cpp.

void CSMSExampleMtmsEngine::CopyMessageL	(	TMsvId	aMessageId,
		TMsvId	aFolder
	)

Copy an SMS message to folder.

Parameters:

	aMessageID	id of an SMS message.
	aFolder	target folder id.

Definition at line 203 of file SMSExampleMtmsEngine.cpp.

void CSMSExampleMtmsEngine::GetMessageAddressL	(	TMsvId	aMessageId,
		TDes &	aAddress
	)

Gets the originator address.

Parameters:

	aMessageID	id of an SMS message.
	aAddress	originator address.

Definition at line 126 of file SMSExampleMtmsEngine.cpp.

TBool CSMSExampleMtmsEngine::GetMessageL	(	TMsvId	aMessageId,
		TDes &	aMessage
	)

Gets the message body from the messaging store.

Parameters:

	aMessageID	id of an SMS message.
	aMessage	the message.

Returns:

ETrue if message correspongin aMessageId is valid SMS (.sis files / settings are filtered out), EFalse otherwise.

Definition at line 143 of file SMSExampleMtmsEngine.cpp.

TBool CSMSExampleMtmsEngine::GetMessageIndexBodyTextL	(	TMsvId	aMessageId,
		TDes &	aMessage
	)

Gets the message body summary information(just the beginning of body)

Parameters:

	aMessageID	id of an SMS message.
	aMessage	the beginning of message.

Returns:

ETrue if message correspongin aMessageId is valid SMS (.sis files / settings are filtered out), EFalse otherwise.

Definition at line 192 of file SMSExampleMtmsEngine.cpp.

void CSMSExampleMtmsEngine::GetFolderSMSMessageInformationL	(	TMsvId	aFolderID,
		CDesCArrayFlat *&	aAddresses,
		CDesCArrayFlat *&	aMessages
	)

Retrieve one folder's SMS messages (their address+message body).

Parameters:

	aAddresses	Array of recipient addresses
	aMessages	Array of message bodys.

Definition at line 226 of file SMSExampleMtmsEngine.cpp.

RArray< TMsvId > * CSMSExampleMtmsEngine::GetMessageIds

(

)

All ids of messages that has been got with GetFolderSMSMessageInformationL.

Returns:

array of ids.

Definition at line 217 of file SMSExampleMtmsEngine.cpp.