Collapse all Symbian^3 Product Developer Library

TMsvSmsEntry Class Reference

class TMsvSmsEntry : public TMsvEntry

A specialisation of the message server index class for SMS message entries.

It provides accessers for SMS message specific data, for instance the class type of the SMS message.

Inherits from

TMsvSmsEntry
- TMsvEntry

Public Member Functions
	TMsvSmsEntry()
	TMsvSmsEntry(const TMsvEntry &)
IMPORT_C TMsvSmsEntryAckSummary	AckSummary(TSmsAckType)
TBool	Class(TSmsDataCodingScheme::TSmsClass &)
IMPORT_C TBool	MessageId(TInt32 &)
TUint8	ProtocolIdentifier()
IMPORT_C void	SetAckSummary(TSmsAckType, TMsvSmsEntryAckSummary)
void	SetClass(TBool, TSmsDataCodingScheme::TSmsClass)
IMPORT_C void	SetMessageId(TInt32, TBool)
void	SetProtocolIdentifier(TSmsProtocolIdentifier)
void	SetProtocolIdentifier(TUint8)
void	SetUserPromptIndicator(TBool)
TBool	UserPromptIndicator()

Inherited Functions
	TMsvEntry::Attachment()const
	TMsvEntry::Complete()const
	TMsvEntry::Connected()const
	TMsvEntry::DecPcSyncCount()
	TMsvEntry::DeleteProtected()const
	TMsvEntry::Deleted()const
	TMsvEntry::ExternalizeL(RWriteStream &)const
	TMsvEntry::Failed()const
	TMsvEntry::Forwarded()const
	TMsvEntry::Id()const
	TMsvEntry::InPreparation()const
	TMsvEntry::IncPcSyncCount()
	TMsvEntry::InternalizeL(RReadStream &)
	TMsvEntry::LocallyDeleted()const
	TMsvEntry::MtmData1()const
	TMsvEntry::MtmData2()const
	TMsvEntry::MtmData3()const
	TMsvEntry::MultipleRecipients()const
	TMsvEntry::New()const
	TMsvEntry::OffPeak()const
	TMsvEntry::Operation()const
	TMsvEntry::Owner()const
	TMsvEntry::Parent()const
	TMsvEntry::PcSyncCount()const
	TMsvEntry::PendingConditions()const
	TMsvEntry::PendingDelete()const
	TMsvEntry::PermanentDataUnchanged(const TMsvEntry &)const
	TMsvEntry::PersistedFlags()const
	TMsvEntry::Priority()const
	TMsvEntry::ReadOnly()const
	TMsvEntry::Scheduled()const
	TMsvEntry::SendingState()const
	TMsvEntry::SetAttachment(TBool)
	TMsvEntry::SetComplete(TBool)
	TMsvEntry::SetConnected(TBool)
	TMsvEntry::SetDeleteProtected(TBool)
	TMsvEntry::SetDeleted(TBool)
	TMsvEntry::SetFailed(TBool)
	TMsvEntry::SetForwarded(TBool)
	TMsvEntry::SetId(TMsvId)
	TMsvEntry::SetInPreparation(TBool)
	TMsvEntry::SetLocallyDeleted(TBool)
	TMsvEntry::SetMtmData1(TInt32)
	TMsvEntry::SetMtmData2(TInt32)
	TMsvEntry::SetMtmData3(TInt32)
	TMsvEntry::SetMultipleRecipients(TBool)
	TMsvEntry::SetNew(TBool)
	TMsvEntry::SetOffPeak(TBool)
	TMsvEntry::SetOperation(TBool)
	TMsvEntry::SetOwner(TBool)
	TMsvEntry::SetParent(TMsvId)
	TMsvEntry::SetPendingConditions(TBool)
	TMsvEntry::SetPendingDelete(TBool)
	TMsvEntry::SetPriority(TMsvPriority)
	TMsvEntry::SetReadOnly(TBool)
	TMsvEntry::SetScheduled(TBool)
	TMsvEntry::SetSendingState(TUint)
	TMsvEntry::SetStandardFolder(TBool)
	TMsvEntry::SetUnread(TBool)
	TMsvEntry::SetVisible(TBool)
	TMsvEntry::SetVisibleFolderFlag(TBool)
	TMsvEntry::StandardFolder()const
	TMsvEntry::TMsvEntry()
	TMsvEntry::TMsvEntry(const TMsvEntry &)
	TMsvEntry::TemporaryFlags()const
	TMsvEntry::Unread()const
	TMsvEntry::Visible()const
	TMsvEntry::VisibleFolderFlag()const
	TMsvEntry::operator=(const TMsvEntry &)
	TMsvEntry::operator==(const TMsvEntry &)const

Public Member Enumerations
enum	TMsvSmsEntryAckSummary { ENoAckSummary = 0, EPendingAcks, EAllSuccessful, EAllFailed, EMixed }
enum	TMsvSmsEntryFlags { EMsvSmsEntryClearFlag = 0x00000000, EMsvSmsEntryProtocolIdentifier = 0x000000FF, EMsvSmsEntryUserPromptIndicator = 0x00000100, EMsvSmsEntryClass = 0x00000E00, EMsvSmsEntryClassDefined = 0x00001000, EMsvSmsMessageValid = 0x00002000, EMsvSmsEntryDeliveryAckSummary = 0x0001C000, EMsvSmsEntryClassShift = 9, EMsvSmsEntryDeliveryAckSummaryShift = 14 }

Inherited Attributes
	TMsvEntry::iBioType
	TMsvEntry::iDate
	TMsvEntry::iDescription
	TMsvEntry::iDetails
	TMsvEntry::iError
	TMsvEntry::iMtm
	TMsvEntry::iMtmData1
	TMsvEntry::iMtmData2
	TMsvEntry::iMtmData3
	TMsvEntry::iRelatedId
	TMsvEntry::iServiceId
	TMsvEntry::iSize
	TMsvEntry::iType

Constructor & Destructor Documentation

TMsvSmsEntry()

TMsvSmsEntry

(

)

[inline]

Constructor.

TMsvSmsEntry(const TMsvEntry &)

TMsvSmsEntry

(

const TMsvEntry &

aEntry

)

[inline]

Copy constuctor.

Parameters

const TMsvEntry & aEntry

The index entry to copy.

Member Functions Documentation

AckSummary(TSmsAckType)

IMPORT_C TMsvSmsEntryAckSummary

AckSummary

(

TSmsAckType

aAckType

)

const

Gets the summary information for the specified acknowledgement.

If the specified acknowledgement is not recognised, then this function returns the default value of TMsvSmsEntryAckSummary::ENoAckSummary. nothing.

TMsvSmsEntry::TMsvSmsEntryAckSummary

Parameters

TSmsAckType aAckType

The requested acknowledgement summary.

Class(TSmsDataCodingScheme::TSmsClass &)

TBool

Class

(

TSmsDataCodingScheme::TSmsClass &

aClass

)

const [inline]

Gets the SMS class data and defined flag.

Parameters

TSmsDataCodingScheme::TSmsClass & aClass

An output argument with the SMS class data.

MessageId(TInt32 &)

IMPORT_C TBool

MessageId

(

TInt32 &

aMessageId

)

const

Gets the message log ID and a flag indicating if it is valid.

The returned flag indicates whether the message log ID is valid. If it is valid then the message has only a single recipient that is pending a status report. In this case the returned message log ID refers to the recipient that is pending.

If it is not valid then the message has more than one recipient that is pending a status report. The message log ID should is not valid and should not be used.

Parameters

TInt32 & aMessageId

An output argument for the message log ID.

ProtocolIdentifier()

TUint8

ProtocolIdentifier

(

)

const [inline]

Gets the Protocol Identifier data.

SetAckSummary(TSmsAckType, TMsvSmsEntryAckSummary)

IMPORT_C void	SetAckSummary	(	TSmsAckType	aAckType,
			TMsvSmsEntryAckSummary	aAckSummary
		)

Sets the summary information for the specified acknowlwdgement.

If the specified acknowledgement is not recognised, then this function does nothing.

TMsvSmsEntry::TMsvSmsEntryAckSummary

Parameters

TSmsAckType aAckType	The acknowledgement summary to be set.
TMsvSmsEntryAckSummary aAckSummary	The summary information.

SetClass(TBool, TSmsDataCodingScheme::TSmsClass)

void	SetClass	(	TBool	aClassDefined,
			TSmsDataCodingScheme::TSmsClass	aClass = TSmsDataCodingScheme::ESmsClass0
		)	[inline]

Sets the SMS class data and defined flag.

Parameters

TBool aClassDefined	A value of True to set the SMS class data defined flag.
TSmsDataCodingScheme::TSmsClass aClass = TSmsDataCodingScheme::ESmsClass0	The SMS class data.

SetMessageId(TInt32, TBool)

IMPORT_C void	SetMessageId	(	TInt32	aMessageId,
			TBool	aIsValid
		)

Sets the message log ID and a flag indicating if it is valid.

If the message has only a single recipient that is pending a status report then the message log ID for that recipient can be set in the index. The flag must be set to true.

If the message has more than one recipient that is pending a status report then the message log ID must not be used. The flag must be set to false.

This functionality cannot be used with bio-messages. This function will panic if used with a bio-message.

panic: USER 0 This message is a bio-message and therefore the message ID field cannot be used.

Parameters

TInt32 aMessageId	The message log ID. Should only be used if aIsValid is true. It has a default value of zero.
TBool aIsValid	A flag indicating if the message log ID is valid. This should have a value or true if the message has only a single recipient pending a status report.

SetProtocolIdentifier(TSmsProtocolIdentifier)

void

SetProtocolIdentifier

(

TSmsProtocolIdentifier

aPID

)

[inline]

Sets the Protocol Identifier data.

Parameters

TSmsProtocolIdentifier aPID

The Protocol Identifier data.

SetProtocolIdentifier(TUint8)

void

SetProtocolIdentifier

(

TUint8

aPID

)

[inline]

Sets the Protocol Identifier data.

Parameters

TUint8 aPID

The Protocol Identifier data.

SetUserPromptIndicator(TBool)

void

SetUserPromptIndicator

(

TBool

aUPI

)

[inline]

Sets the User Prompt Indicator flag.

Parameters

TBool aUPI

A value of True to set the flag.

UserPromptIndicator()

TBool

UserPromptIndicator

(

)

const [inline]

Gets the User Prompt Indicator flag.

Member Enumerations Documentation

Enum TMsvSmsEntryAckSummary

Defines the summary acknowledgement information.

This information indicates whether the SMS message is not supplying a summary for an acknowledgement, is still expecting acknowledgments or it has received all expected acknowledgements.

If all acknowledgements have been received the summary indicates whether all the recipients have successfully acknowledged the message, all failed or there was a mixture of successful and failed acknowledgements from the recipients.

Enumerators

ENoAckSummary = 0	No summary information is being formed.
EPendingAcks	The message is waiting for acknowledgements to be received for all recipients of this message. Some recipients may have received their acknowledgements but there are still some recipients that have not.
EAllSuccessful	The summary indicates that the message was successfully acknowledged by all recipients.
EAllFailed	The summary indicates that the message failed to be acknowledged by all recipients.
EMixed	The summary indicates a mixture of successful and failed acknowledgements from the recipients of the message. All recipients of this message have received their acknowledgements.

Enum TMsvSmsEntryFlags

Defines a set flags used to access message entry data specific to an SMS message.

Enumerators

EMsvSmsEntryClearFlag = 0x00000000	Clears the entire set of SMS flags.
EMsvSmsEntryProtocolIdentifier = 0x000000FF	Mask for the protocol identifier data.
EMsvSmsEntryUserPromptIndicator = 0x00000100	Mask for the User Prompt Indicator flag.
EMsvSmsEntryClass = 0x00000E00	Mask for the SMS class data.
EMsvSmsEntryClassDefined = 0x00001000	Mask for the flag indicating whether the class data has been defined.
EMsvSmsMessageValid = 0x00002000	Mask for the flag indicating whether the message ID is valid.
EMsvSmsEntryDeliveryAckSummary = 0x0001C000	Mask for the delivery acknowledgement information.
EMsvSmsEntryClassShift = 9	Parameter defining the number of bits to be shifted in order for the SMS class data to be at the LSB of the data block.
EMsvSmsEntryDeliveryAckSummaryShift = 14	Parameter defining the number of bits to be shifted in order for the delivery acknowlwdgement information to be at the LSB of the data block.