Class CMmsSettings

class CMmsSettings : public CBase;

Description

Run-time MMS configuration settings.

Messaging clients should use an instance of this class to specify and retrieve configuration settings.

This class should be used with CMmsAccounts to store and restore settings.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CMmsSettings - Run-time MMS configuration settings.

Members

Defined in CMmsSettings:

• AddNapIdL(const TUid)Appends a Nap Id to the list.
• AddProxyL(const TUid)Appends a Proxy to the list.
• Address()constReturns the absolute MMS Proxy-Relay URL
• AllowDeliveryNotification()constReturns the Allow Delivery Notification value
• ApplicationID()constReturns the Application Id.
• AutomaticDownload()constReturns whether the message should be downloaded automatically.
• CopyL(const CMmsSettings &)Copies the MMS settings stored in the specified object into this object.
• CreationMode()constReturns the Creation Mode. Creation Mode specifies how an MMS client should allo...
• CreationModeReadOnly()constReturns whether the user allowed to modify the creation mode or not.
• DeliveryReport()constReturns whether the Delivery Reports should be sent back to the network when the...
• DeviceContentClass()constReturns the content class of the device
• DisplayNotification()constReturns whether the Notification Receipt should be displayed immediately to the ...
• DownloadRetryInterval()constReturns the download retry interval
• FilterAdvertisements()constReturns whether to filter advertisment MMS messages when downloading automatical...
• FullScreenPreview()constReturns whether to display MMS messages in full screen.
• GetNapId(TInt)constGets the Nap Id at the specified index.
• GetProxy(TInt)constGets the Proxy at the specified index.
• HideNumber()constReturns whether the user's number should be hidden when sending an MMS.
• MaxDownloadRetries()constReturns the maximum download retries of an MMS message
• MaxDownloadSize()constReturns the maximum size of the MMS message that can be downloaded automatically...
• MaxImageHeight()constReturns the maximum image height to be used when sending an MMS message
• MaxImageWidth()constReturns the maximum image width to be used when sending an MMS message
• MaxSendMsgSize()constReturns the maximum MMS message size that can be sent
• NapIdCount()constGets the number of Nap Ids stored in this object.
• NewL()Allocates and constructs an MMS settings object.
• NewLC()Allocates and constructs an MMS settings object.
• Priority()constReturns the Priority value of the MMS message.
• ProxyCount()constGets the number of Proxies stored in this object.
• ReadReport()constReturns whether the Read Reports should be sent back to the network when the use...
• RemoveNapId(TInt)Removes a Nap Id from the list.
• RemoveProxy(TInt)Removes a Proxy from the list.
• ReplyWithHistory()constReturns whether the original MMS should be included when replying to an MMS
• SetAddressL(const TDesC &)Sets the absolute MMS Proxy-Relay URL
• SetAllowDeliveryNotification(TBool)Sets the Allow Delivery Notification value
• SetApplicationID(const TInt)Sets the Application Id.
• SetAutomaticDownload(TAutomaticDownloadOptions)Sets the automatic download option
• SetCreationModeL(TCreationMode)Sets the Creation Mode. Creation Mode specifies how an MMS client should allow i...
• SetCreationModeReadOnly(TBool)Specifies whether the user allowed to modify the creation mode or not.
• SetDeliveryReport(TBool)Specifies whether the Delivery Reports should be sent back to the network when t...
• SetDeviceContentClass(const TInt)Sets the content class of the device
• SetDisplayNotification(TBool)Specifies whether the Notification Receipt should be displayed immediately to th...
• SetDownloadRetryInterval(const TInt)Sets the download retry interval
• SetFilterAdvertisements(TBool)Specifies whether to filter advertisment MMS messages when downloading automatic...
• SetFullScreenPreview(TBool)Specifies whether to display MMS messages using full screen.
• SetHideNumber(TBool)Specifies whether the user's number should be hidden when sending an MMS.
• SetMaxDownloadRetries(const TInt)Sets the maximum download retries of an MMS message
• SetMaxDownloadSize(const TInt)Sets the maximum size of the MMS message that can be downloaded automatically.
• SetMaxImageHeight(const TInt)Sets the maximum image height to be used when sending an MMS message
• SetMaxImageWidth(const TInt)Sets the maximum image width to be used when sending an MMS message
• SetMaxSendMsgSize(const TInt)Sets the maximum MMS message size that can be sent
• SetPriority(TBool)Sets the Priority value of the MMS message.
• SetReadReport(TBool)Specifies whether the Read Reports should be sent back to the network when the u...
• SetReplyWithHistory(TBool)Specifies whether the original MMS should be included when replying to an MMS
• SetValidityPeriod(const TInt)Sets the Validity Period of the MMS message.
• ValidityPeriod()constReturns the Validity Period of the MMS message.
• ~CMmsSettings()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CMmsAccountsStores MMS settings.

IMPORT_C static CMmsSettings* NewL();

Description

Allocates and constructs an MMS settings object.

Initialises all member data to their default values.

Return value

IMPORT_C static CMmsSettings* NewLC();

Description

Allocates and constructs an MMS settings object.

Initialises all member data to their default values.

Return value

IMPORT_C ~CMmsSettings();

Description

Destructor.

IMPORT_C void CopyL(const CMmsSettings &aMmsSettings);

Description

Copies the MMS settings stored in the specified object into this object.

Parameters

IMPORT_C TInt ApplicationID() const;

Description

Returns the Application Id.

Return value

IMPORT_C void SetApplicationID(const TInt aAppID);

Description

Sets the Application Id.

Parameters

IMPORT_C TPtrC Address() const;

Description

Returns the absolute MMS Proxy-Relay URL

Return value

IMPORT_C void SetAddressL(const TDesC &aAddress);

Description

Sets the absolute MMS Proxy-Relay URL

Parameters

IMPORT_C TCreationMode CreationMode() const;

Description

Returns the Creation Mode. Creation Mode specifies how an MMS client should allow insertion of media items in an MMS.

Return value

See also:

• TCreationModeCreation Mode Options.

IMPORT_C void SetCreationModeL(TCreationMode aCreationMode);

Description

Sets the Creation Mode. Creation Mode specifies how an MMS client should allow insertion of media items in an MMS.

Parameters

See also:

• TCreationModeCreation Mode Options.

IMPORT_C TInt ProxyCount() const;

Description

Gets the number of Proxies stored in this object.

Return value

IMPORT_C TUid GetProxy(TInt aIndex) const;

Description

Gets the Proxy at the specified index.

Parameters

Return value

IMPORT_C void AddProxyL(const TUid aProxy);

Description

Appends a Proxy to the list.

Parameters

IMPORT_C void RemoveProxy(TInt aIndex);

Description

Removes a Proxy from the list.

Parameters

IMPORT_C TInt NapIdCount() const;

Description

Gets the number of Nap Ids stored in this object.

Return value

IMPORT_C TUid GetNapId(TInt aIndex) const;

Description

Gets the Nap Id at the specified index.

Parameters

Return value

IMPORT_C void AddNapIdL(const TUid aNapId);

Description

Appends a Nap Id to the list.

Parameters

IMPORT_C void RemoveNapId(TInt aIndex);

Description

Removes a Nap Id from the list.

Parameters

IMPORT_C TBool DisplayNotification() const;

Description

Returns whether the Notification Receipt should be displayed immediately to the user.

Return value

IMPORT_C void SetDisplayNotification(TBool aFlag);

Description

Specifies whether the Notification Receipt should be displayed immediately to the user.

Parameters

IMPORT_C TAutomaticDownloadOptions AutomaticDownload() const;

Description

Returns whether the message should be downloaded automatically.

Return value

See also:

• TAutomaticDownloadOptionsAutomatic Download Options.

IMPORT_C void SetAutomaticDownload(TAutomaticDownloadOptions aDownloadOptions);

Description

Sets the automatic download option

Parameters

See also:

• TAutomaticDownloadOptionsAutomatic Download Options.

IMPORT_C TBool CreationModeReadOnly() const;

Description

Returns whether the user allowed to modify the creation mode or not.

Return value

IMPORT_C void SetCreationModeReadOnly(TBool aFlag);

Description

Specifies whether the user allowed to modify the creation mode or not.

Parameters

IMPORT_C TInt ValidityPeriod() const;

Description

Returns the Validity Period of the MMS message.

Return value

IMPORT_C void SetValidityPeriod(const TInt aValidityPeriod);

Description

Sets the Validity Period of the MMS message.

Parameters

IMPORT_C TInt MaxDownloadSize() const;

Description

Returns the maximum size of the MMS message that can be downloaded automatically.

Return value

IMPORT_C void SetMaxDownloadSize(const TInt aSize);

Description

Sets the maximum size of the MMS message that can be downloaded automatically.

Parameters

IMPORT_C TBool Priority() const;

Description

Returns the Priority value of the MMS message.

Return value

IMPORT_C void SetPriority(TBool aFlag);

Description

Sets the Priority value of the MMS message.

Parameters

IMPORT_C TBool HideNumber() const;

Description

Returns whether the user's number should be hidden when sending an MMS.

Return value

IMPORT_C void SetHideNumber(TBool aFlag);

Description

Specifies whether the user's number should be hidden when sending an MMS.

Parameters

IMPORT_C TBool ReadReport() const;

Description

Returns whether the Read Reports should be sent back to the network when the user receives an MMS.

Return value

IMPORT_C void SetReadReport(TBool aFlag);

Description

Specifies whether the Read Reports should be sent back to the network when the user receives an MMS.

Parameters

IMPORT_C TBool DeliveryReport() const;

Description

Returns whether the Delivery Reports should be sent back to the network when the user receives an MMS.

Return value

IMPORT_C void SetDeliveryReport(TBool aFlag);

Description

Specifies whether the Delivery Reports should be sent back to the network when the user receives an MMS.

Parameters

IMPORT_C TBool ReplyWithHistory() const;

Description

Returns whether the original MMS should be included when replying to an MMS

Return value

IMPORT_C void SetReplyWithHistory(TBool aFlag);

Description

Specifies whether the original MMS should be included when replying to an MMS

Parameters

IMPORT_C TBool AllowDeliveryNotification() const;

Description

Returns the Allow Delivery Notification value

Return value

IMPORT_C void SetAllowDeliveryNotification(TBool aFlag);

Description

Sets the Allow Delivery Notification value

Parameters

IMPORT_C TBool FilterAdvertisements() const;

Description

Returns whether to filter advertisment MMS messages when downloading automatically.

Return value

IMPORT_C void SetFilterAdvertisements(TBool aFlag);

Description

Specifies whether to filter advertisment MMS messages when downloading automatically.

Parameters

IMPORT_C TInt MaxDownloadRetries() const;

Description

Returns the maximum download retries of an MMS message

Return value

IMPORT_C void SetMaxDownloadRetries(const TInt aRetries);

Description

Sets the maximum download retries of an MMS message

Parameters

IMPORT_C TInt DownloadRetryInterval() const;

Description

Returns the download retry interval

Return value

IMPORT_C void SetDownloadRetryInterval(const TInt aInterval);

Description

Sets the download retry interval

Parameters

IMPORT_C TInt MaxSendMsgSize() const;

Description

Returns the maximum MMS message size that can be sent

Return value

IMPORT_C void SetMaxSendMsgSize(const TInt aSize);

Description

Sets the maximum MMS message size that can be sent

Parameters

IMPORT_C TBool FullScreenPreview() const;

Description

Returns whether to display MMS messages in full screen.

Return value

IMPORT_C void SetFullScreenPreview(TBool aFlag);

Description

Specifies whether to display MMS messages using full screen.

Parameters

IMPORT_C TInt DeviceContentClass() const;

Description

Returns the content class of the device

Return value

IMPORT_C void SetDeviceContentClass(const TInt aClass);

Description

Sets the content class of the device

Parameters

IMPORT_C TInt MaxImageHeight() const;

Description

Returns the maximum image height to be used when sending an MMS message

Return value

IMPORT_C void SetMaxImageHeight(const TInt aHeight);

Description

Sets the maximum image height to be used when sending an MMS message

Parameters

IMPORT_C TInt MaxImageWidth() const;

Description

Returns the maximum image width to be used when sending an MMS message

Return value

IMPORT_C void SetMaxImageWidth(const TInt aWidth);

Description

Sets the maximum image width to be used when sending an MMS message

Parameters