#include <SyncMLClient.h>
Link against: smlclient.lib

This item is not part of the S60 5th Edition SDK

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()Closes this handle.
CreatorId()constGets the ID of the creator of the profile referenced by this handle.
DeleteAllowed()constTests if the user is allowed to delete the profile
DeleteConnectionL(TSmlConnectionId)Deletes the connection identified by aId from this profile.
DisplayName()constGets the human-readable display name of the profile referenced by this handle.
Identifier()constGets the ID of the profile referenced by this handle.
IsCancellable()constTests if the profile is 'cancellable' or not. Any attempt to cancel a job belong...
IsLocked()constTests if the profile is 'locked' or can be modified.
IsReadOnly()constTests if the profile is open for read and write access.
IsSilent()constTests if the profile is 'silent' or not. Any jobs associated with a 'silent' pro...
ListConnectionsL(RArray< TSmlConnectionId > &)constGets a list of IDs of connections defined for this profile.
Password()constGets the password for the account on the remote server.
ProtocolVersionL()constGets the protocol version used by the remote server.
SanUserInteraction()constReturns status of server alert notification processing for this profile.
ServerId()constGets the id for the remote server.
ServerPassword()constGets the password for the remote server.
SetCreatorId(TSmlCreatorId)Sets the client creator ID of the profile referenced by this handle.
SetDisplayNameL(const TDesC &)Sets the human-readable display name of the profile referenced by this handle.
SetPasswordL(const TDesC8 &)Sets the password for the account on the remote server.
SetProtocolVersionL(TSmlProtocolVersion)Set the protocol version of the profile
SetSanUserInteraction(TSmlServerAlertedAction)Sets server alert notification processing action for this profile.
SetServerIdL(const TDesC8 &)Sets the ID for the remote server.
SetServerPasswordL(const TDesC8 &)Sets the password for the remote server.
SetSilentL(TBool)Sets a profile to be 'silent' or not. Any jobs associated with a 'silent' profil...
SetUserNameL(const TDesC8 &)Sets the user name for the account on the remote server.
Type()constGets the type of the profile referenced by this handle.
UpdateL()Stores any changes made to the profile data, including tasks and connections.
UserName()constGets the user name for the account on the remote server.

Inherited from RSubSessionBase:

CloseSubSession(TInt)Closes the sub-session.
CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session. The new sub-session takes ...
CreateSubSession(const RSessionBase &,TInt)Creates a new sub-session within an existing session.
CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session.
Send(TInt)constSends a blind message to the server - no reply is expected.
Send(TInt,const TIpcArgs &)constSends a blind message to the server - no reply is expected.
SendReceive(TInt)constSends a message to the server and waits synchronously for a reply.
SendReceive(TInt,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
SendReceive(TInt,const TIpcArgs &)constSends a message to the server and waits synchronously for a reply.
SendReceive(TInt,const TIpcArgs &,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
Session()constReturns a copy of the session associated with this sub-session.
SubSessionHandle()constGets the sub-session handle number.

Member functions

`SetCreatorId(TSmlCreatorId)`

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.

`SetDisplayNameL(const TDesC &)`

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 TDesC16 &

The new name for the profile.

Leave codes

KErrNoMemory

Insufficient system memory.

`SetUserNameL(const TDesC8 &)`

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.

`SetPasswordL(const TDesC8 &)`

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.

`SetServerIdL(const TDesC8 &)`

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.

`SetServerPasswordL(const TDesC8 &)`

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.

`SetProtocolVersionL(TSmlProtocolVersion)`

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.

`DeleteConnectionL(TSmlConnectionId)`

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.

`Identifier()const`

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.

`Type()const`

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.

`CreatorId()const`

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.

`DisplayName()const`

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 TDesC16 &

The name of the profile.

`UserName()const`

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.

`Password()const`

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.

`ServerId()const`

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.

`ServerPassword()const`

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.

`ProtocolVersionL()const`

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.

`ListConnectionsL(RArray< TSmlConnectionId > &)const`

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.

`IsReadOnly()const`

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.

`DeleteAllowed()const`

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.

`UpdateL()`

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.

Leave codes

SyncMLError::KErrProfileAccessDenied

Profile is locked

`Close()`

IMPORT_C void Close();

Description

Closes this handle.

`SanUserInteraction()const`

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

`SetSanUserInteraction(TSmlServerAlertedAction)`

IMPORT_C void SetSanUserInteraction(TSmlServerAlertedAction aAction);

Description

Sets server alert notification processing action for this profile.

Parameters


                                 						TSmlServerAlertedAction aAction

[in] SAN alert processing action

`IsLocked()const`

IMPORT_C TBool IsLocked() const;

Description

Tests if the profile is 'locked' or can be modified.

Return value

TBool

EFalse if the profile is locked and can not be modified or deleted, EFalse if it can be modified or deleted.

`IsCancellable()const`

IMPORT_C TBool IsCancellable() const;

Description

Tests if the profile is 'cancellable' or not. Any attempt to cancel a job belonging to a 'non-cancellable' profile will fail.

Return value

TBool

ETrue if the profile is cancellable, EFalse if it is not.

`SetSilentL(TBool)`

IMPORT_C void SetSilentL(TBool aSilent);

Description

Sets a profile to be 'silent' or not. Any jobs associated with a 'silent' profile will not generate normal progress events.

Parameters


                                 						TBool aSilent

ETrue if the profile is to be set 'silent'.

Leave codes

SyncMLError::KErrProfileAccessDenied

Profile is locked

`IsSilent()const`

IMPORT_C TBool IsSilent() const;

Description

Tests if the profile is 'silent' or not. Any jobs associated with a 'silent' profile will not generate normal progress events.

Return value

TBool

ETrue if the profile is silent, EFalse if it is not.

Class RSyncMLProfileBase

Description

Derivation

Members

See also:

Member functions

SetCreatorId(TSmlCreatorId)

Pre-Condition

Description

Parameters

SetDisplayNameL(const TDesC &)

Pre-Condition

Description

Parameters

Leave codes

SetUserNameL(const TDesC8 &)

Pre-Condition

Description

Parameters

Leave codes

SetPasswordL(const TDesC8 &)

Pre-Condition

Description

Parameters

Leave codes

SetServerIdL(const TDesC8 &)

Pre-Condition

Description

Parameters

Leave codes

SetServerPasswordL(const TDesC8 &)

Pre-Condition

Description

Parameters

Leave codes

SetProtocolVersionL(TSmlProtocolVersion)

Pre-Condition

Description

Parameters

Leave codes

DeleteConnectionL(TSmlConnectionId)

Pre-Condition

Description

Parameters

Leave codes

Identifier()const

Pre-Condition

Description

Return value

Type()const

Pre-Condition

Description

Return value

CreatorId()const

Pre-Condition

Description

Return value

DisplayName()const

Pre-Condition

Description

Return value

UserName()const

Pre-Condition

Description

Return value

Password()const

Pre-Condition

Description

Return value

ServerId()const

Pre-Condition

Description

Return value

ServerPassword()const

Pre-Condition

Description

Return value

ProtocolVersionL()const

Pre-Condition

Description

Class `RSyncMLProfileBase`

`SetCreatorId(TSmlCreatorId)`

`SetDisplayNameL(const TDesC &)`

`SetUserNameL(const TDesC8 &)`

`SetPasswordL(const TDesC8 &)`

`SetServerIdL(const TDesC8 &)`

`SetServerPasswordL(const TDesC8 &)`

`SetProtocolVersionL(TSmlProtocolVersion)`

`DeleteConnectionL(TSmlConnectionId)`

`Identifier()const`

`Type()const`

`CreatorId()const`

`DisplayName()const`

`UserName()const`

`Password()const`

`ServerId()const`

`ServerPassword()const`

`ProtocolVersionL()const`

`ListConnectionsL(RArray< TSmlConnectionId > &)const`

`IsReadOnly()const`

`DeleteAllowed()const`

`UpdateL()`

`Close()`

`SanUserInteraction()const`

`SetSanUserInteraction(TSmlServerAlertedAction)`

`IsLocked()const`

`IsCancellable()const`

`SetSilentL(TBool)`

`IsSilent()const`