Class CSIPProfileRegistryBase

class CSIPProfileRegistryBase : public CBase, public MSIPConcreteProfileObserver;

Description

The class functions for retrieving SIP profiles from permanent storage. It enables retrieval of single or more profiles from permanent storage located in profile server.

The class enables also the query of supported profile types.

This class is an abstract class and cannot be instantiated.

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

Members

Defined in CSIPProfileRegistryBase:
DefaultProfileL(), LastRegistrationError(), ProfileL(), ProfilesL(), ProfilesL(), ProfilesL(), SupportedProfileTypesL(), ~CSIPProfileRegistryBase()

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

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

IMPORT_C ~CSIPProfileRegistryBase();

Description

Capability:

ReadUserData

IMPORT_C void ProfilesL(RPointerArray< CSIPProfile > &aProfiles);

Pre-Condition

aProfiles.Count() == 0

Description

Gets all SIP profiles

Parameters

RPointerArray< CSIPProfile > &aProfiles a reference to a client-owned array, which on return is filled with all existing SIP profiles

Leave codes

KErrNoMemory if out of memory

Capability:

ReadUserData

IMPORT_C void ProfilesL(const TSIPProfileTypeInfo &aType, RPointerArray< CSIPProfile > &aProfiles);

Pre-Condition

aProfiles.Count() == 0

Description

Gets all SIP profiles of particular type The owneship of profiles are transferred.

Parameters

const TSIPProfileTypeInfo &aType a SIP profile type that is used for a query RPointerArray< CSIPProfile > &aProfiles a reference to a client-owned array, which on return is filled with profiles of the given type.

Leave codes

KErrNoMemory if out of memory

Capability:

ReadUserData

IMPORT_C void ProfilesL(const TDesC8 &aAOR, RPointerArray< CSIPProfile > &aProfiles);

Pre-Condition

aProfiles.Count() == 0

Description

Gets SIP profile for a particular SIP AOR The owneship of profiles are transferred.

Parameters

const TDesC8 &aAOR a SIP AOR e.g. RPointerArray< CSIPProfile > &aProfiles a reference to a client-owned array, which on return is filled with profiles of the given type.

Leave codes

KErrNoMemory if out memory

Capability:

ReadUserData

IMPORT_C CSIPProfile *ProfileL(TUint32 aId);

Description

Gets SIP profile identified by the Id The owneship of profile is transferred.

Parameters

TUint32 aId a SIP profile Id

Return value

CSIPProfile * SIP profile

Leave codes

KErrNotFound if profile is not found

Capability:

ReadUserData

IMPORT_C CSIPProfile *DefaultProfileL();

Description

Gets the default profile

Return value

CSIPProfile * default profile; the owneship is transfered

Leave codes

KErrNotFound if profile not found KErrNoMemory if out of memory

IMPORT_C void SupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &aSupportedProfileTypes);

Pre-Condition

aSupportedProfileTypes.Count() == 0

Description

Gets supported profile types The owneship of returned objects are transferred.

Parameters

RArray< TSIPProfileTypeInfo > &aSupportedProfileTypes a reference to client-owned array, which on return is filled with supported profile types. Any existing data in the array is destroyed.

Leave codes

KErrNoMemory if out of memory

IMPORT_C TInt LastRegistrationError(const CSIPProfile &aProfile) const;

Description

Gets the last occurred error during registration

Parameters

const CSIPProfile &aProfile

Return value

TInt last occurred registration error, KErrNone if no error