Class RSyncMLDataSyncProfile

class RSyncMLDataSyncProfile : public RSyncMLProfileBase;

Description

Handle to a SyncML Data Synchronisation profile.

A profile encapsulates a relationship with a single SyncML remote server, and contains a number of 'tasks' and 'connections'.

Derivation

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

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

• RSyncMLDataSyncProfile - Handle to a SyncML Data Synchronisation profile.

Members

Defined in RSyncMLDataSyncProfile:

• CreateL(RSyncMLSession &)Creates a new, blank, profile for Data Synchronisation and opens this object as ...
• DeleteTaskL(TSmlTaskId)Deletes the task identified by aId from this profile.
• ListTasksL(RArray< TSmlTaskId > &)constGets a list of IDs of tasks defined for this profile.
• OpenL(RSyncMLSession &,TSmlProfileId,TSmlOpenMode)Opens a handle to an existing Data Synchronisation profile of the specified ID.
• RSyncMLDataSyncProfile()Default constructor.

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.

Inherited from 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.

IMPORT_C RSyncMLDataSyncProfile();

Description

Default constructor.

Capability:

WriteDeviceData

IMPORT_C void CreateL(RSyncMLSession &);

Description

Creates a new, blank, profile for Data Synchronisation and opens this object as a handle to it.

The new profile will not be saved until UpdateL is called.

Parameters

RSyncMLSession & An open session with the Sync Agent.

Leave codes

System error codes.

Capability:

Dependent

See enum TSmlOpenMode for required capabilities.

IMPORT_C void OpenL(RSyncMLSession &, TSmlProfileId, TSmlOpenMode);

Description

Opens a handle to an existing Data Synchronisation profile of the specified ID.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlProfileId The ID of the profile to open. TSmlOpenMode The access mode to open the profile in, read-only, or read and write.

Leave codes

System error codes. SyncMLError::KErrProfileNotFound The specified profile ID does not represent a valid profile.

IMPORT_C void ListTasksL(RArray< TSmlTaskId > &) const;

Pre-Condition

The handle is open.

Description

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

Parameters

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

Leave codes

System error codes.

IMPORT_C void DeleteTaskL(TSmlTaskId);

Pre-Condition

The handle is open for read and write access.

Description

Deletes the task identified by aId from this profile.

Parameters

TSmlTaskId The ID of the connection to delete.

Leave codes

System error codes.