Class RSyncMLProfileBase

class RSyncMLProfileBase : public RSubSessionBase;

Description

Base class for a handle to a SyncML profile.

A profile encapsulates a relationship with a single SyncML remote server for either Device Management or Data Synchronisation.

Not intended for user derivation. Derived classes:

Derivation

• RSubSessionBase - Client-side handle to a sub-session

• RSyncMLProfileBase - Base class for a handle to a SyncML profile

Members

Defined in RSyncMLProfileBase:
Close(), CreatorId(), DeleteAllowed(), DeleteConnectionL(), DisplayName(), Identifier(), IsReadOnly(), ListConnectionsL(), Password(), ProtocolVersionL(), SanUserInteraction(), ServerId(), ServerPassword(), SetCreatorId(), SetDisplayNameL(), SetPasswordL(), SetProtocolVersionL(), SetSanUserInteraction(), SetServerIdL(), SetServerPasswordL(), SetUserNameL(), Type(), UpdateL(), UserName()

Inherited from RSubSessionBase:
CloseSubSession(), CreateAutoCloseSubSession(), CreateSubSession(), Send(), SendReceive(), Session(), SubSessionHandle()

See also:

• RSyncMLDataSyncProfile
• RSyncMLDevManProfile

IMPORT_C void SetCreatorId(TSmlCreatorId);

Pre-Condition

The handle is open.

Description

Sets the client creator ID of the profile referenced by this handle.

This ID is for use by clients that wish to be able to identify specific profiles. The ID is typically the application UID, which ensures uniqueness.

Parameters

TSmlCreatorId The new creator ID for the profile.

IMPORT_C void SetDisplayNameL(const TDesC &);

Pre-Condition

The handle is open.

Description

Sets the human-readable display name of the profile referenced by this handle.

Parameters

const TDesC & The new name for the profile.

Leave codes

KErrNoMemory Insufficient system memory.

IMPORT_C void SetUserNameL(const TDesC8 &);

Pre-Condition

The handle is open.

Description

Sets the user name for the account on the remote server.

Parameters

const TDesC8 & The account user name.

Leave codes

KErrNoMemory Insufficient system memory.

IMPORT_C void SetPasswordL(const TDesC8 &);

Pre-Condition

The handle is open.

Description

Sets the password for the account on the remote server.

Parameters

const TDesC8 & The account password.

Leave codes

KErrNoMemory Insufficient system memory.

IMPORT_C void SetServerIdL(const TDesC8 &);

Pre-Condition

The handle is open.

Description

Sets the ID for the remote server.

Parameters

const TDesC8 & The server id.

Leave codes

KErrNoMemory Insufficient system memory.

IMPORT_C void SetServerPasswordL(const TDesC8 &);

Pre-Condition

The handle is open.

Description

Sets the password for the remote server.

Parameters

const TDesC8 & The server password.

Leave codes

KErrNoMemory Insufficient system memory.

IMPORT_C void SetProtocolVersionL(TSmlProtocolVersion);

Pre-Condition

The handle is open.

Description

Set the protocol version of the profile

Parameters

TSmlProtocolVersion

Leave codes

KErrNoMemory Insufficient system memory.

IMPORT_C void DeleteConnectionL(TSmlConnectionId);

Pre-Condition

The handle is open for read and write access.

Description

Deletes the connection identified by aId from this profile.

Parameters

TSmlConnectionId The ID of the connection to delete.

Leave codes

System error codes.

IMPORT_C TSmlProfileId Identifier() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the profile referenced by this handle.

Return value

TSmlProfileId The profile ID.

IMPORT_C TSmlUsageType Type() const;

Pre-Condition

The handle is open.

Description

Gets the type of the profile referenced by this handle.

Return value

TSmlUsageType The profile type.

IMPORT_C TSmlCreatorId CreatorId() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the creator of the profile referenced by this handle.

This ID is for use by clients that wish to be able to identify specific profiles.

Return value

TSmlCreatorId An identifier that has meaning to the client.

IMPORT_C const TDesC &DisplayName() const;

Pre-Condition

The handle is open.

Description

Gets the human-readable display name of the profile referenced by this handle.

Return value

const TDesC & The name of the profile.

IMPORT_C const TDesC8 &UserName() const;

Pre-Condition

The handle is open.

Description

Gets the user name for the account on the remote server.

Return value

const TDesC8 & The account user name.

IMPORT_C const TDesC8 &Password() const;

Pre-Condition

The handle is open.

Description

Gets the password for the account on the remote server.

Return value

const TDesC8 & The account password.

IMPORT_C const TDesC8 &ServerId() const;

Pre-Condition

The handle is open.

Description

Gets the id for the remote server.

Return value

const TDesC8 & The server id.

IMPORT_C const TDesC8 &ServerPassword() const;

Pre-Condition

The handle is open.

Description

Gets the password for the remote server.

Return value

const TDesC8 & The server password.

IMPORT_C TSmlProtocolVersion ProtocolVersionL() const;

Pre-Condition

The handle is open.

Description

Gets the protocol version used by the remote server.

Return value

TSmlProtocolVersion The protocol version.

IMPORT_C void ListConnectionsL(RArray< TSmlConnectionId > &) const;

Pre-Condition

The handle is open.

Description

Gets a list of IDs of connections defined for this profile.

Parameters

RArray< TSmlConnectionId > & An array to populate with IDs.

Leave codes

System error codes.

IMPORT_C TBool IsReadOnly() const;

Pre-Condition

The handle is open.

Description

Tests if the profile is open for read and write access.

Return value

TBool True if the profile is open for read and write access.

IMPORT_C TBool DeleteAllowed() const;

Pre-Condition

The handle is open.

Description

Tests if the user is allowed to delete the profile

Return value

TBool True if the user is able to delete the profile.

IMPORT_C void UpdateL();

Pre-Condition

The handle is open for read and write access.

Description

Stores any changes made to the profile data, including tasks and connections.

If creating a profile, this creates and assigns a valid ID for this profile.

IMPORT_C void Close();

Description

Closes this handle.

IMPORT_C TSmlServerAlertedAction SanUserInteraction() const;

Description

Returns status of server alert notification processing for this profile.

Return value

TSmlServerAlertedAction Value telling how to process server alert notification (SAN) messages

IMPORT_C void SetSanUserInteraction(TSmlServerAlertedAction aAction);

Description

Sets server alert notification processing action for this profile.

Parameters

TSmlServerAlertedAction aAction [in] SAN alert processing action