| class CMmsSettings : public CBase |
CMmsSettings contains all Mms Engine's settings. Loading and Saving methods are offered as well as accessors for all setting values. Mutators are offered to most of the settings, but there are a few 'read-only' settings. mmsserversettings.lib 3.0
| Private Member Functions | |
|---|---|
| CMmsSettings() | |
| CRepository * | ConnectCenRepL(const TUid) |
| void | ConstructL() |
| void | SaveAccesspointArrayL() |
| void | SaveSetting(TUint32, TInt) |
| TBool | AcceptAdvertisementMessages | ( | ) | const [inline] |
Get accept advertisement messages flag. ETrue if advertisements accepted
| TBool | AcceptAnonymousMessages | ( | ) | const [inline] |
Get accept anonymous messages flag (anonymous message == message without From: field). ETrue if anonymous messages accepted.
| TBool | AcceptInformationalMessages | ( | ) | const [inline] |
Get accept informational messages flag. ETrue if informational messages accepted
| TBool | AcceptPersonalMessages | ( | ) | const [inline] |
Get accept personal messages flag. ETrue if personal messages accepted
| IMPORT_C TInt32 | AccessPoint | ( | TInt | aIndex | ) | const |
AccessPoint is accessor for accesspoint array accesspoint reference to commdb or KErrNotFound if given index is incorrect
| TInt aIndex |
| TInt | AccessPointCount | ( | ) | const [inline] |
AccessPointCount number of accesspoints in the accesspoint array
| IMPORT_C void | AddAccessPointL | ( | TUint32 | aAccessPointId, |
| TInt | aIndex | |||
| ) | ||||
Adds an accesspoint id to a specific index in the array
| TMsvId | ApplicationFolder | ( | ) | const [inline] |
Gets application folder id TMsvId of the application folder
| CRepository * | ConnectCenRepL | ( | const TUid | aRepositoryId | ) | [private] |
Utility to connect to a particular CenRep
| const TUid aRepositoryId |
| IMPORT_C void | CopyL | ( | const CMmsSettings & | aMmsSettings | ) |
CopyL copies the contents (member values) from aMmsSettings.
| const CMmsSettings & aMmsSettings | refernce to another CMmsSettings object |
| IMPORT_C TInt | CreateFolderEntryL | ( | CMsvSession & | aSession, |
| TMsvId | aParentFolder, | |||
| const TDesC & | aFolderName, | |||
| TMsvId & | aFolderId | |||
| ) | ||||
CreateFolderEntryL creates a new folder entry under a given folder with 'aFolderName' name. KErrNone if successful. KErrAlreadyExists, if a folder with same name exists under aParentFoder
| CMsvSession & aSession | messageserver session |
| TMsvId aParentFolder | a folder, under which the new folder is created. |
| const TDesC & aFolderName | |
| TMsvId & aFolderId | entry id of the new folder or if the folder already exists, the folder id of the existing folder |
| IMPORT_C void | CreateNewServiceL | ( | CMsvSession & | aSession | ) |
Creates a new service entry into messagestore and saves the entryid into CenRep. The invisible Notification folder and MMBox folder will also be created. Before creating new entries, MessageStore is first searched for old entries. If old entries are found, they will be used. Note that the method can be called only from client side of the Messaging architecture.
| CMsvSession & aSession |
| IMPORT_C void | DeleteAccessPointL | ( | TInt | aIndex | ) |
Deletes an accesspoint id from a specific index in the array
| TInt aIndex | specifies the array index |
| TInt32 | DeliveryReportSendingAllowed | ( | ) | const [inline] |
Get Delivery report sending allowed delivery report sending allowed code
| TInt32 | DeliveryReportWanted | ( | ) | const [inline] |
Get delivery report wanted code. delivery report code
| TInt32 | ExpiryInterval | ( | ) | const [inline] |
ExpiryInterval refers to messages expiration interval in the network. message expiration interval in seconds
| TInt | ExpiryOvershoot | ( | ) | const [inline] |
Get the value (in seconds) that the expiry interval can be exceeded and message fetching will still be attempted. expiry overshoot value in seconds
| TBool | FetchOverride | ( | ) | const [inline] |
FetchOverride specifies whether message should be retrieved regardless of what has been set to receiving mode value. This setting is not saved in Central Repository, but instead it is handled "on the fly". ETrue if messages are to be fetched even if receivingmode is off or deferred. Default value EFalse.
| IMPORT_C TMsvId | FolderEntryL | ( | CMsvSession & | aSession, |
| TMsvId | aParentFolder, | |||
| const TDesC & | aFolderName | |||
| ) | ||||
Gets a folder entry id under a given folder id with 'aFolderName' name. entry id of the folder
| CMsvSession & aSession | messageserver session |
| TMsvId aParentFolder | a folder, under where the folder is searched |
| const TDesC & aFolderName | name of folder entry |
| IMPORT_C void | LoadSettingsL | ( | ) |
LoadSettingsL loads the settings from Central Repository
| TBool | LocalMode | ( | ) | const [inline] |
Get MMS local mode (Localmode is for test purposes only) MMS creation mode
| const TDesC & | LocalModeIn | ( | ) | [inline] |
LocalModeIn returns the directory path for incoming localmode messages
| const TDesC & | LocalModeOut | ( | ) | [inline] |
LocalModeOut returns the directory path for outgoing localmode messages
| TBool | LogEmailRecipients | ( | ) | const [inline] |
Get logging state of messages to Email recipients ETrue: if sent messages to email recipients are logged EFalse: if messages only to phone numbers are logged
| TInt32 | MaximumReceiveSize | ( | ) | const [inline] |
Get maximum size of messages that can be received in bytes. maximum message size (0 = any size)
| TInt32 | MaximumSendSize | ( | ) | const [inline] |
Get maximum size of messages that can be sent in bytes. maximum message size (0 = any size)
| TInt32 | MessagePriority | ( | ) | const [inline] |
Get message priority. message priority code
| TInt16 | MmsVersion | ( | ) | const [inline] |
Get the current MMS encapsulation versio 3.2
MMS encapsulation version as hex. Value in low byte, low half is minor version, high half is major version 0x10 = 1.0 0x11 = 1.1 0x12 = 1.2 etc.
| TBool | MoveToSent | ( | ) | const [inline] |
MoveToSent returns a boolean specifying whether messages are moved to sent folder after they have been successfully sent. If not, the message will be deleted. This setting is common to all messaging types. ETrue, if messages are moved, EFalse, if they are deleted.
| TMsvId | NotificationFolder | ( | ) | const [inline] |
Gets notification folder id TMsvId of the notification folder
| TBool | ReadReplyReportSendingAllowed | ( | ) | const [inline] |
Get read report sending allowed value. Specifies if the terminal is allowed to send a read report when the message is opened the first time and the sender has requested a read report read reply report allowed value. Possible values: ETrue EFalse (default)
| TInt32 | ReadReplyReportWanted | ( | ) | const [inline] |
Get Read report wanted setting. Specifies if the user wants a report for each message when the recipient opens the message the first time read report wanted value. Possible values: KMmsYes KMmsNo (default)
| TMmsReceivingMode | ReceivingModeForeign | ( | ) | const [inline] |
ReceivingModeForeign enumerated value representing receiving mode in foreign network Possible values as in ReceivingModeHome
| TMmsReceivingMode | ReceivingModeHome | ( | ) | const [inline] |
ReceivingModeHome enumerated value representing receiving mode in home network Possible values: EMmsReceivingAutomatic (default), EMmsReceivingManual, EMmsReceivingPostpone, EMmsReceivingReject
| IMPORT_C void | Reset | ( | ) |
Reset clears the member variables representing Mms settings (the method does not modify data in CenRep).
| IMPORT_C void | RestoreFactorySettingsL | ( | CMsvSession & | aSession, |
| TMmsFactorySettingsLevel | aLevel | |||
| ) | ||||
| CMsvSession & aSession | |
| TMmsFactorySettingsLevel aLevel |
| void | SaveAccesspointArrayL | ( | ) | [private] |
Handles saving of AP array The method assumes that connection to CenRep has been already created.
| void | SaveSetting | ( | TUint32 | aKey, |
| TInt | aValue | |||
| ) | [private] | |||
Handles saving of one integer value to CenRep. First, settings tried to be set normally, but if it turns out that such key does not exist, it will be created. The method assumes that connection to CenRep has been already created.
| TMsvId | Service | ( | ) | const [inline] |
Gets default service for MMS TMsvId of the default MMS service entry. If no service defined KMsvNullIndexEntryId is returned.
| void | SetAcceptAdvertisementMessages | ( | TBool | aAdvertisementsAllowed = ETrue | ) | [inline] |
Set acceptance flag for advertisement messages.
| TBool aAdvertisementsAllowed = ETrue |
| void | SetAcceptAnonymousMessages | ( | TBool | aAnonymousAllowed = ETrue | ) | [inline] |
Set acceptance flag for anonymous messages
| TBool aAnonymousAllowed = ETrue |
| void | SetAcceptInformationalMessages | ( | TBool | aInformationalAllowed = ETrue | ) | [inline] |
Set acceptance flag for informational messages
| TBool aInformationalAllowed = ETrue |
| void | SetAcceptPersonalMessages | ( | TBool | aPersonalAllowed = ETrue | ) | [inline] |
Set acceptance flag for personal messages.
| TBool aPersonalAllowed = ETrue |
| void | SetCreationMode | ( | TMmsCreationMode | aCreationMode | ) | [inline] |
Set MMS Creation Mode
| TMmsCreationMode aCreationMode | Possible values: EMmsCreationModeRestricted, EMmsCreationModeWarning (default), EMmsCreationModeFree |
| void | SetDeliveryReportSendingAllowed | ( | TInt32 | aDeliveryReportSendingAllowed | ) | [inline] |
Set Delivery report sending allowed
| TInt32 aDeliveryReportSendingAllowed |
| void | SetDeliveryReportWanted | ( | TInt32 | aDeliveryReportWanted | ) | [inline] |
Set delivery report wanted
| TInt32 aDeliveryReportWanted |
| void | SetExpiryInterval | ( | TInt32 | aExpiryInterval | ) | [inline] |
SetExpiryInterval
| TInt32 aExpiryInterval | message expiration interval in seconds Recommended values: 0 ( = maximum allowed by MMSC ) 1 * 3600( 1 hour ) 6 * 3600( 6 hours ) 24 * 3600( 24 hours ) 72 * 3600( 3 days = 72 hours ) 168 * 3600 ( 1 week = 168 hours ) Default value 0 |
| void | SetFetchOverride | ( | TBool | aOverride | ) | [inline] |
SetFetchOverride
| TBool aOverride |
| void | SetImageHeight | ( | TInt32 | aImageHeight | ) | [inline] |
Set image height.
| TInt32 aImageHeight | image height in pixels |
| void | SetImageWidth | ( | TInt32 | aImageWidth | ) | [inline] |
Set image width.
| TInt32 aImageWidth | image width in pixels |
| void | SetLocalMode | ( | TBool | aLocalMode | ) | [inline] |
Set MMS local mode (Localmode is for test purposes only)
| TBool aLocalMode | specifying whether normal or local mode is in use. |
| void | SetLocalModeIn | ( | const TDesC & | aPath | ) | [inline] |
SetLocalModeIn sets the directory path for incoming localmode messages
| const TDesC & aPath |
| void | SetLocalModeOut | ( | const TDesC & | aPath | ) | [inline] |
SetLocalModeOut sets the directory path for incoming localmode messages
| const TDesC & aPath |
| void | SetLogEmailRecipients | ( | TBool | aEmailLogging | ) | [inline] |
Set logging state of messages to Email recipients
| TBool aEmailLogging |
| void | SetMessageClass | ( | TMmsMessageClass | aMessageClass | ) | [inline] |
Set default message class.
| TMmsMessageClass aMessageClass | message class code Possible values: EMmsClassPersonal (default), EMmsClassAdvertisement, EMmsClassInformational |
| void | SetMessagePriority | ( | TMmsMessagePriority | aMessagePriority | ) | [inline] |
Set message priority
| TMmsMessagePriority aMessagePriority |
| void | SetReadReplyReportSendingAllowed | ( | TBool | aReadReplyReportSendingAllowed | ) | [inline] |
Set read report sending allowed code. Specifies if the terminal is allowed to send a read report when the message is opened the first time and the sender has requested a read report
| TBool aReadReplyReportSendingAllowed | read report sending allowed value (ETrue or EFalse). |
| void | SetReadReplyReportWanted | ( | TInt32 | aReadReplyReportWanted | ) | [inline] |
Set Read report wanted setting. Specifies if the user wants a report for each message when the recipient opens the message the first time
| TInt32 aReadReplyReportWanted | read report wanted code Possible values: KMmsYes, KMmsNo |
| void | SetReceivingModeForeign | ( | TMmsReceivingMode | aMode | ) | [inline] |
SetReceivingModeForeign sets the receiving mode in foreign network
| TMmsReceivingMode aMode | Possible values as in ReceivingModeHome |
| void | SetReceivingModeHome | ( | TMmsReceivingMode | aMode | ) | [inline] |
SetReceivingModeHome sets the receiving mode in home network
| TMmsReceivingMode aMode | Possible values as in ReceivingModeHome |
| void | SetSenderVisibility | ( | TMmsMessageSenderVisibility | aSenderVisibility | ) | [inline] |
Set sender visibility code
| TMmsMessageSenderVisibility aSenderVisibility |
| TInt32 | SettingsVersion | ( | ) | const [inline] |
SettingsVersion returns the version information of the settings.
| TBool | ShowSentTime | ( | ) | const [inline] |
ShowSentTime returns the value that tells if sending time or receiving time should be shown for incoming messages This value is stored in iDate member in TMsvEntry ETrue = show sending time EFalse = show time the message arrived at the terminal (default)
| IMPORT_C TInt | ValidateSettings | ( | ) |
Validate current MMS settings Checks that access points point to valid entries in commsdb error code