Class CSIPManagedProfileRegistry

class CSIPManagedProfileRegistry : public CSIPProfileRegistryBase;

Description

The class for managing SIP profiles. This class provides the functions for adding/updating/removing profiles.

sipprofilecli.lib

Derivation

• MSIPConcreteProfileObserver - Observer class to be implemented by users of CSIPConcreteProfile It provides event notifications related to profiles
• CBase - Base class for all classes to be instantiated on the heap

• CSIPProfileRegistryBase - The class functions for retrieving SIP profiles from permanent storage

• CSIPManagedProfileRegistry - The class for managing SIP profiles

Members

Defined in CSIPManagedProfileRegistry:
CreateL(), DestroyL(), IsInUseL(), NewInstanceL(), NewL(), NewLC(), SaveL(), ~CSIPManagedProfileRegistry()

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

Inherited from CSIPProfileRegistryBase:
DefaultProfileL(), LastRegistrationError(), ProfileL(), ProfilesL(), SupportedProfileTypesL()

Inherited from MSIPConcreteProfileObserver:
AddedL(), ErrorOccurredL(), RegistrationStatusChangedL(), RemovedL(), UpdatedL()

static IMPORT_C CSIPManagedProfileRegistry *NewL(MSIPProfileRegistryObserver &aObserver);

Description

Two-phased constructor.

Parameters

MSIPProfileRegistryObserver &aObserver a observer for SIP profile change events.

Return value

CSIPManagedProfileRegistry *

static IMPORT_C CSIPManagedProfileRegistry *NewLC(MSIPProfileRegistryObserver &aObserver);

Description

Two-phased constructor. Constructs an object and adds the pointer to the cleanup stack;

Parameters

MSIPProfileRegistryObserver &aObserver a observer for SIP profile change events.

Return value

CSIPManagedProfileRegistry *

IMPORT_C ~CSIPManagedProfileRegistry();

Description

Destructor

IMPORT_C CSIPManagedProfile *CreateL(const TSIPProfileTypeInfo &aType);

Description

Instantiates new profile with default values for given type.

Parameters

const TSIPProfileTypeInfo &aType a SIP profile type to be created

Return value

CSIPManagedProfile * pre-filled instance of given type profile type; the ownership is transferred

Capability:

ReadUserData

IMPORT_C TBool IsInUseL(const CSIPProfile &aSIPProfile) const;

Description

Checks if profile is not used by other applications. If no other application is using the profile, profile can be updated.

Parameters

const CSIPProfile &aSIPProfile a SIP profile

Return value

TBool ETrue if available for update, EFalse otherwise

Capability:	NetworkServices
Capability:	WriteDeviceData

IMPORT_C void SaveL(CSIPProfile &aSIPProfile);

Pre-Condition

IsInUse(aSIPProfile)==EFalse

Description

Saves new profile or changes to a profile to the persistent storage. This function must be called after desired values are set or updated in the SIP profile. If the profile is marked for auto-registration and the profile is updated the profile will be re-registered. Function leaves on failure.

Parameters

CSIPProfile &aSIPProfile a sip profile to save

Capability:	NetworkServices
Capability:	WriteDeviceData

IMPORT_C void DestroyL(CSIPProfile &aSIPProfile);

Description

Removes and deletes SIP profile from the persistent storage. Function leaves on failure. If the profile is registered it will be de-registered before the removal from the persistent storage.

Parameters

CSIPProfile &aSIPProfile a sip profile to delete

private: virtual CSIPProfile *NewInstanceL();

Description

Creates a new instance of type CSIPManagedProfile

Return value

CSIPProfile * new instance