Class RSyncMLDataSyncJob

class RSyncMLDataSyncJob : public RSyncMLJobBase;

Description

Handle to a data synchronisation job.

A job synchronises the data in one or more data stores, as defined by the list of tasks.

Derivation

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

• RSyncMLJobBase - Base class for a handle to a job.

• RSyncMLDataSyncJob - Handle to a data synchronisation job.

Members

Defined in RSyncMLDataSyncJob:

• CreateL(RSyncMLSession &,TSmlProfileId)Creates and queues a new data synchronisation job to synchronise all tasks belon...
• CreateL(RSyncMLSession &,TSmlProfileId,TSmlConnectionId)
• CreateL(RSyncMLSession &,TSmlProfileId,TSmlConnectionId,TSmlSyncType)
• CreateL(RSyncMLSession &,TSmlProfileId,TSmlConnectionId,TSmlSyncType,const RArray< TSmlTaskId > &)
• CreateL(RSyncMLSession &,TSmlProfileId,TSmlConnectionId,const RArray< TSmlTaskId > &)
• CreateL(RSyncMLSession &,TSmlProfileId,TSmlSyncType)Creates and queues a new data synchronisation job to synchronise all tasks belon...
• CreateL(RSyncMLSession &,TSmlProfileId,TSmlSyncType,const RArray< TSmlTaskId > &)Creates and queues a new data synchronisation job to synchronise all specified t...
• CreateL(RSyncMLSession &,TSmlProfileId,const RArray< TSmlTaskId > &)Creates and queues a new data synchronisation job to synchronise all specified t...
• IsSuspendedL()Checks to see if a job is in a suspended state.
• OpenL(RSyncMLSession &,TSmlJobId)Opens a handle to a queued data synchronisation job of the specified ID.
• RSyncMLDataSyncJob()Default constructor.
• StopL()Stop the Job represented by this handle from continuing to be processed by the S...
• SuspendL()Suspends the job that this handle refers to, suspending the synchonisation.
• TaskIDs()constGets the IDs of the tasks synchronised by the job to which this handle refers.

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 RSyncMLJobBase:

• Close()Closes the job handle. This has no effect on the actual job.
• Identifier()constReturns the ID of the job referred to by this handle.
• Profile()constReturns the ID of the profile referred to by this handle.

IMPORT_C RSyncMLDataSyncJob();

Description

Default constructor.

Capability:	LocalServices
Capability:	NetworkServices

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId);

Pre-Condition

The session is open.

Description

Creates and queues a new data synchronisation job to synchronise all tasks belonging to the specified profile.

This object is opened as a handle to the new job.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlProfileId The ID of the profile to synchronise.

Leave codes

System error codes. SyncMLError::KErrProfileNotFound The specified profile was not found. SyncMLError::KErrTransportNotFound The specified profile contains no connections, or a connection over an unknown transport. SyncMLError::KErrSuspended The SyncML framework is suspended pending a system backup or restore. KErrArgument The specified profile is not a Data Sync profile, or contains no enabled tasks.

See also:

• RSyncMLDataSyncJob::StopL()Stop the Job represented by this handle from continuing to be processed by the S...

Capability:	LocalServices
Capability:	NetworkServices

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, const RArray< TSmlTaskId > &);

Pre-Condition

The session is open.

Description

Creates and queues a new data synchronisation job to synchronise all specified tasks

All specified tasks must belong to the same profile.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlProfileId The ID of the profile to synchronise const RArray< TSmlTaskId > & A list of IDs of the tasks to synchronise.

Leave codes

System error codes.

See also:

• RSyncMLDataSyncJob::StopL()Stop the Job represented by this handle from continuing to be processed by the S...

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, TSmlConnectionId);

Description

Parameters

RSyncMLSession & TSmlProfileId TSmlConnectionId

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, TSmlConnectionId, TSmlSyncType);

Description

Parameters

RSyncMLSession & TSmlProfileId TSmlConnectionId TSmlSyncType

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, TSmlConnectionId, const RArray< TSmlTaskId > &);

Description

Parameters

RSyncMLSession & TSmlProfileId TSmlConnectionId const RArray< TSmlTaskId > &

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, TSmlConnectionId, TSmlSyncType, const RArray< TSmlTaskId > &);

Description

Parameters

RSyncMLSession & TSmlProfileId TSmlConnectionId TSmlSyncType const RArray< TSmlTaskId > &

Capability:	LocalServices
Capability:	NetworkServices

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, TSmlSyncType);

Pre-Condition

The session is open.

Description

Creates and queues a new data synchronisation job to synchronise all tasks belonging to the specified profile, using the specified Synchronisation type.

This object is opened as a handle to the new job.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlProfileId The ID of the profile to synchronise. TSmlSyncType The Synchronisation type required for all tasks in the specified profile for this job.

Leave codes

System error codes. SyncMLError::KErrProfileNotFound The specified profile was not found. SyncMLError::KErrTransportNotFound The specified profile contains no connections, or a connection over an unknown transport. SyncMLError::KErrSuspended The SyncML framework is suspended pending a system backup or restore. KErrArgument The specified profile is not a Data Sync profile, or contains no enabled tasks.

See also:

• RSyncMLDataSyncJob::StopL()Stop the Job represented by this handle from continuing to be processed by the S...

Capability:	LocalServices
Capability:	NetworkServices

IMPORT_C void CreateL(RSyncMLSession &, TSmlProfileId, TSmlSyncType, const RArray< TSmlTaskId > &);

Pre-Condition

The session is open.

Description

Creates and queues a new data synchronisation job to synchronise all specified tasks using the specified Synchronisation type. All specified tasks must belong to the same profile.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlProfileId The ID of the profile to synchronise TSmlSyncType The Synchronisation type required for all tasks in the specified profile for this job. const RArray< TSmlTaskId > & A list of IDs of the tasks to synchronise.

Leave codes

System error codes.

See also:

• RSyncMLDataSyncJob::StopL()Stop the Job represented by this handle from continuing to be processed by the S...

IMPORT_C void OpenL(RSyncMLSession &, TSmlJobId);

Pre-Condition

The session is open.

Description

Opens a handle to a queued data synchronisation job of the specified ID.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlJobId The ID of the job to open.

Leave codes

System error codes.

Capability:

Security policy note:

Policed on SecureID, to ensure that the Job creator is the process trying to call this method), or TrustedUI if the Job was created as a result of a received Server Alert Notification (SAN) message

IMPORT_C void StopL();

Pre-Condition

The handle is open.

Description

Stop the Job represented by this handle from continuing to be processed by the Sync Framework. This call will fail unless either the caller is the process that originally started this Job or, in the instance that this Job was created as a result of a remotely received Server Alert Notification (SAN), the caller has been granted the TrustedUI Platform Security capability.

Leave codes

KErrPermissionDenied If the caller is not the process that created the Job, or the Job was created by SAN and the caller doesn't have the TrustedUI capability System error codes.

IMPORT_C void SuspendL();

Description

Suspends the job that this handle refers to, suspending the synchonisation.

IMPORT_C TBool IsSuspendedL();

Description

Checks to see if a job is in a suspended state.

Return value

TBool ETrue if the job is suspended, otherwise EFalse.

IMPORT_C const RArray< TSmlTaskId >& TaskIDs() const;

Pre-Condition

The handle is open.

Description

Gets the IDs of the tasks synchronised by the job to which this handle refers.

Return value

const RArray< TSmlTaskId > & The list of task IDs.