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(), CreateL(), CreateL(), CreateL(), CreateL(), CreateL(), CreateL(), CreateL(), IsSuspendedL(), OpenL(), RSyncMLDataSyncJob(), StopL(), SuspendL(), TaskIDs()

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

Inherited from RSyncMLJobBase:
Close(), Identifier(), Profile()

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()

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()

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()

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()

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 LocalServices or NetworkServices depending on the bearer used for the job. HTTP/TCPIP NetworkServices WSP/UDP NetworkServices OBEX/BT LocalServices OBEX/IrDA LocalServices OBEX/USB LocalServices

IMPORT_C void StopL();

Pre-Condition

The handle is open.

Description

Aborts the job that this handle refers to, stopping the synchonisation if it is in progress, and removing it from the queue.

Leave codes

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.