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(), AddProxyL(), Address(), AllowDeliveryNotification(), ApplicationID(), AutomaticDownload(), CopyL(), CreationMode(), CreationModeReadOnly(), DeliveryReport(), DeviceContentClass(), DisplayNotification(), DownloadRetryInterval(), FilterAdvertisements(), FullScreenPreview(), GetNapId(), GetProxy(), HideNumber(), MaxDownloadRetries(), MaxDownloadSize(), MaxImageHeight(), MaxImageWidth(), MaxSendMsgSize(), NapIdCount(), NewL(), NewLC(), Priority(), ProxyCount(), ReadReport(), RemoveNapId(), RemoveProxy(), ReplyWithHistory(), SetAddressL(), SetAllowDeliveryNotification(), SetApplicationID(), SetAutomaticDownload(), SetCreationModeL(), SetCreationModeReadOnly(), SetDeliveryReport(), SetDeviceContentClass(), SetDisplayNotification(), SetDownloadRetryInterval(), SetFilterAdvertisements(), SetFullScreenPreview(), SetHideNumber(), SetMaxDownloadRetries(), SetMaxDownloadSize(), SetMaxImageHeight(), SetMaxImageWidth(), SetMaxSendMsgSize(), SetPriority(), SetReadReport(), SetReplyWithHistory(), SetValidityPeriod(), ValidityPeriod(), ~CMmsSettings()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• CMmsAccounts

static IMPORT_C CMmsSettings *NewL();

Description

Allocates and constructs an MMS settings object.

Initialises all member data to their default values.

Return value

CMmsSettings * The newly constructed MMS settings object.

static IMPORT_C CMmsSettings *NewLC();

Description

Allocates and constructs an MMS settings object.

Initialises all member data to their default values.

Return value

CMmsSettings * The newly constructed MMS settings object.

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

const CMmsSettings &aMmsSettings The MMS Settings to be copied.

IMPORT_C TInt ApplicationID() const;

Description

Returns the Application Id.

Return value

TInt Application Id

IMPORT_C void SetApplicationID(const TInt aAppID);

Description

Sets the Application Id.

Parameters

const TInt aAppID Application Id

IMPORT_C TPtrC Address() const;

Description

Returns the absolute MMS Proxy-Relay URL

Return value

TPtrC The absolute MMS Proxy-Relay URL

IMPORT_C void SetAddressL(const TDesC &aAddress);

Description

Sets the absolute MMS Proxy-Relay URL

Parameters

const TDesC &aAddress The absolute MMS Proxy-Relay URL

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

TCreationMode The Creation Mode.

See also:

• TCreationMode

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

TCreationMode aCreationMode The Creation Mode.

See also:

• TCreationMode

IMPORT_C TInt ProxyCount() const;

Description

Gets the number of Proxies stored in this object.

Return value

TInt The number of Proxies stored.

IMPORT_C TUid GetProxy(TInt aIndex) const;

Description

Gets the Proxy at the specified index.

Parameters

TInt aIndex Index

Return value

TUid Proxy

IMPORT_C void AddProxyL(const TUid aProxy);

Description

Appends a Proxy to the list.

Parameters

const TUid aProxy Proxy to be added to the list

IMPORT_C void RemoveProxy(TInt aIndex);

Description

Removes a Proxy from the list.

Parameters

TInt aIndex Index

IMPORT_C TInt NapIdCount() const;

Description

Gets the number of Nap Ids stored in this object.

Return value

TInt The number of Nap Ids stored.

IMPORT_C TUid GetNapId(TInt aIndex) const;

Description

Gets the Nap Id at the specified index.

Parameters

TInt aIndex Index

Return value

TUid Nap Id

IMPORT_C void AddNapIdL(const TUid aNapId);

Description

Appends a Nap Id to the list.

Parameters

const TUid aNapId Nap Id to be added to the list

IMPORT_C void RemoveNapId(TInt aIndex);

Description

Removes a Nap Id from the list.

Parameters

TInt aIndex Index

IMPORT_C TBool DisplayNotification() const;

Description

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

Return value

TBool Returns ETrue if the Notification Receipt should be displayed to the user.

IMPORT_C void SetDisplayNotification(TBool aFlag);

Description

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

Parameters

TBool aFlag Specify ETrue if the Notification Receipt should be displayed to the user.

IMPORT_C TAutomaticDownloadOptions AutomaticDownload() const;

Description

Returns whether the message should be downloaded automatically.

Return value

TAutomaticDownloadOptions The automatic download option

See also:

• TAutomaticDownloadOptions

IMPORT_C void SetAutomaticDownload(TAutomaticDownloadOptions aDownloadOptions);

Description

Sets the automatic download option

Parameters

TAutomaticDownloadOptions aDownloadOptions Automatic download option to be set

See also:

• TAutomaticDownloadOptions

IMPORT_C TBool CreationModeReadOnly() const;

Description

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

Return value

TBool Returns ETrue if the user is allowed to modify the creation mode.

IMPORT_C void SetCreationModeReadOnly(TBool aFlag);

Description

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

Parameters

TBool aFlag Specify ETrue if the user is allowed to modify the creation mode.

IMPORT_C TInt ValidityPeriod() const;

Description

Returns the Validity Period of the MMS message.

Return value

TInt Validity Period of the message

IMPORT_C void SetValidityPeriod(const TInt aValidityPeriod);

Description

Sets the Validity Period of the MMS message.

Parameters

const TInt aValidityPeriod Validity Period of the message

IMPORT_C TInt MaxDownloadSize() const;

Description

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

Return value

TInt Maximum size of the message that can be downloaded automatically

IMPORT_C void SetMaxDownloadSize(const TInt aSize);

Description

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

Parameters

const TInt aSize Maximum size of the message that can be downloaded automatically

IMPORT_C TBool Priority() const;

Description

Returns the Priority value of the MMS message.

Return value

TBool Priority value

IMPORT_C void SetPriority(TBool aFlag);

Description

Sets the Priority value of the MMS message.

Parameters

TBool aFlag Priority value

IMPORT_C TBool HideNumber() const;

Description

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

Return value

TBool Returns ETrue if the user's number should be hidden.

IMPORT_C void SetHideNumber(TBool aFlag);

Description

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

Parameters

TBool aFlag Specify ETrue if the user's number should be hidden.

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

TBool Returns ETrue if the Read Reports should be sent back to the network

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

TBool aFlag Specify ETrue if the Read Reports should be sent back to the network

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

TBool Returns ETrue if the Delivery Reports should be sent back to the network

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

TBool aFlag Specify ETrue if the Delivery Reports should be sent back to the network

IMPORT_C TBool ReplyWithHistory() const;

Description

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

Return value

TBool Returns ETrue if the original MMS should be included when replying to an MMS

IMPORT_C void SetReplyWithHistory(TBool aFlag);

Description

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

Parameters

TBool aFlag Specify ETrue if the original MMS should be included when replying to an MMS

IMPORT_C TBool AllowDeliveryNotification() const;

Description

Returns the Allow Delivery Notification value

Return value

TBool Allow Delivery Notification value

IMPORT_C void SetAllowDeliveryNotification(TBool aFlag);

Description

Sets the Allow Delivery Notification value

Parameters

TBool aFlag Allow Delivery Notification value

IMPORT_C TBool FilterAdvertisements() const;

Description

Returns whether to filter advertisment MMS messages when downloading automatically.

Return value

TBool Returns ETrue if advertisments should be filtered when downloading automatically.

IMPORT_C void SetFilterAdvertisements(TBool aFlag);

Description

Specifies whether to filter advertisment MMS messages when downloading automatically.

Parameters

TBool aFlag Specify ETrue if advertisments should be filtered when downloading automatically.

IMPORT_C TInt MaxDownloadRetries() const;

Description

Returns the maximum download retries of an MMS message

Return value

TInt Maximum download retries

IMPORT_C void SetMaxDownloadRetries(const TInt aRetries);

Description

Sets the maximum download retries of an MMS message

Parameters

const TInt aRetries Maximum download retries

IMPORT_C TInt DownloadRetryInterval() const;

Description

Returns the download retry interval

Return value

TInt Download retry interval

IMPORT_C void SetDownloadRetryInterval(const TInt aInterval);

Description

Sets the download retry interval

Parameters

const TInt aInterval Download retry interval

IMPORT_C TInt MaxSendMsgSize() const;

Description

Returns the maximum MMS message size that can be sent

Return value

TInt The maximum MMS message size that can be sent

IMPORT_C void SetMaxSendMsgSize(const TInt aSize);

Description

Sets the maximum MMS message size that can be sent

Parameters

const TInt aSize The maximum MMS message size that can be sent

IMPORT_C TBool FullScreenPreview() const;

Description

Returns whether to display MMS messages in full screen.

Return value

TBool Returns ETrue if MMS messages should be displayed in full screen.

IMPORT_C void SetFullScreenPreview(TBool aFlag);

Description

Specifies whether to display MMS messages using full screen.

Parameters

TBool aFlag Specify ETrue if MMS messages should be displayed in full screen.

IMPORT_C TInt DeviceContentClass() const;

Description

Returns the content class of the device

Return value

TInt The content class of the device

IMPORT_C void SetDeviceContentClass(const TInt aClass);

Description

Sets the content class of the device

Parameters

const TInt aClass The content class of the device

IMPORT_C TInt MaxImageHeight() const;

Description

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

Return value

TInt The maximum image height

IMPORT_C void SetMaxImageHeight(const TInt aHeight);

Description

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

Parameters

const TInt aHeight The maximum image height

IMPORT_C TInt MaxImageWidth() const;

Description

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

Return value

TInt The maximum image width

IMPORT_C void SetMaxImageWidth(const TInt aWidth);

Description

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

Parameters

const TInt aWidth The maximum image width