Class RSyncMLTask

class RSyncMLTask : public RSubSessionBase;

Description

Represents a mapping between a local data store and a remote data store on a SyncML server in the context of a profile.

Derivation

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

• RSyncMLTask - Represents a mapping between a local data store and a remote data store on a Syn...

Members

Defined in RSyncMLTask:

• AddServerFilterL(const CSyncMLFilter &)Enables the filter passed in. It has to be a filter that is already stored.
• ClientDataSource()constGets the name of the local data store that is synchronised by this task.
• Close()Closes this handle.
• CreateL(RSyncMLDataSyncProfile &,TSmlDataProviderId,const TDesC &,const TDesC &)Creates a new, blank, task in the specified profile and opens this object as a h...
• CreatorId()constGets the ID of the creator of the task referenced by this handle.
• DataProvider()constGets the ID of the data provider used to synchronise this task.
• DefaultSyncType()constGets the default synchronisation type of this task.
• DeleteAllServerFiltersL()Disables all the filters of the task
• DeleteServerFilterL(TSmlFilterId)Disables a stored filter
• DisplayName()constGets the human readable display name of the task referenced by this handle.
• Enabled()constTests if this task is enabled.
• FilterMatchType()constSpecifies if the filters of the current task get treated as having AND or OR rel...
• GetServerFilterIdsL(RArray< TSmlFilterId > &)constGets an array of all the filter IDs that are stored for this task
• Identifier()constGets the ID of the task referenced by this handle.
• IsReadOnly()constTests if the parent profile is open for read and write access.
• OpenL(RSyncMLDataSyncProfile &,TSmlTaskId)Opens a handle to an existing task of the specified ID within the specified prof...
• OutsideInclusionType()constSpecifies if new sync with changed filters will be inclusive or exclusive to the...
• Profile()constGets the ID of the parent profile of this task.
• RSyncMLTask()Default constructor.
• ServerDataSource()constGets the name of the server data store that is synchronised by this task.
• ServerFilterLC(TSmlFilterId)Retrieves the filter with the given ID and returns an instantance of CSyncMLFilt...
• SetCreatorId(TSmlCreatorId)Sets the client creator ID of the task referenced by this handle.
• SetDefaultSyncTypeL(TSmlSyncType)Sets the default synchonisation type of the task referenced by this handle.
• SetDisplayNameL(const TDesC &)Sets the human-readable display name of the task referenced by this handle.
• SetEnabledL(TBool)Enables or disables the task referenced by this handle.
• SetFilterMatchTypeL(TSyncMLFilterMatchType)Sets if the filters of the current task get treated as having AND or OR relation...
• SetFilterOutsideInclusionTypeL(TSyncMLFilterOutsideInclusionType)Specifies if new sync with changed filters will be inclusive or exclusive to the...
• SupportedServerFiltersL(RPointerArray< CSyncMLFilter > &)constReturns an array of pointers to the filters that are supported by the server
• SupportsUserSelectableMatchTypeL()constSpecifies if the task allows for the user to select the matching type
• UpdateL()Transfers any changes made to the task data to the Sync Agent.
• UpdateServerFilterL(const CSyncMLFilter &)Updates in the data store the filter that is passed in. The update is done accor...

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.

IMPORT_C RSyncMLTask();

Description

Default constructor.

IMPORT_C void CreateL(RSyncMLDataSyncProfile &, TSmlDataProviderId, const TDesC &aServerDataSource, const TDesC &aClientDataSource);

Description

Creates a new, blank, task in the specified profile and opens this object as a handle to it. The new task will contain all the filters supported by the associated data provider.

The parent profile must be open for read/write access. The new task will not be saved until RSyncMLProfile::UpdateL() is called on the parent profile.

Parameters

Leave codes

IMPORT_C void OpenL(RSyncMLDataSyncProfile &, TSmlTaskId);

Description

Opens a handle to an existing task of the specified ID within the specified profile.

The access mode (read or read/write) is inherited from the parent profile.

Parameters

Leave codes

IMPORT_C TSmlTaskId Identifier() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the task referenced by this handle.

Return value

IMPORT_C TSmlProfileId Profile() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the parent profile of this task.

Return value

IMPORT_C TSmlCreatorId CreatorId() const;

Pre-Condition

The handle is open.

Description

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

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

Return value

IMPORT_C const TDesC& DisplayName() const;

Pre-Condition

The handle is open.

Description

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

Return value

IMPORT_C const TDesC& ServerDataSource() const;

Pre-Condition

The handle is open.

Description

Gets the name of the server data store that is synchronised by this task.

Return value

IMPORT_C const TDesC& ClientDataSource() const;

Pre-Condition

The handle is open.

Description

Gets the name of the local data store that is synchronised by this task.

Return value

IMPORT_C TSmlDataProviderId DataProvider() const;

Pre-Condition

The handle is open.

Description

Gets the ID of the data provider used to synchronise this task.

Return value

IMPORT_C TSmlSyncType DefaultSyncType() const;

Pre-Condition

The handle is open.

Description

Gets the default synchronisation type of this task.

Return value

IMPORT_C void GetServerFilterIdsL(RArray< TSmlFilterId > &aFilterIds) const;

Pre-Condition

aFilterIds has to be empty

Description

Gets an array of all the filter IDs that are stored for this task

Parameters

Leave codes

Panic codes

IMPORT_C CSyncMLFilter* ServerFilterLC(TSmlFilterId aId);

Description

Retrieves the filter with the given ID and returns an instantance of CSyncMLFilter class which is also left on the cleanup stack.

Parameters

Return value

Leave codes

IMPORT_C TSyncMLFilterMatchType FilterMatchType() const;

Description

Specifies if the filters of the current task get treated as having AND or OR relationship between them.

Return value

IMPORT_C TSyncMLFilterOutsideInclusionType OutsideInclusionType() const;

Description

Specifies if new sync with changed filters will be inclusive or exclusive to the previous sync

Return value

IMPORT_C TBool Enabled() const;

Pre-Condition

The handle is open.

Description

Tests if this task is enabled.

Disabled tasks will not be synchronised.

Return value

IMPORT_C void SetCreatorId(TSmlCreatorId);

Pre-Condition

The handle is open.

Description

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

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

Parameters

Leave codes

IMPORT_C void SetDisplayNameL(const TDesC &);

Pre-Condition

The handle is open.

Description

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

Parameters

Leave codes

IMPORT_C void SetDefaultSyncTypeL(TSmlSyncType);

Pre-Condition

The handle is open.

Description

Sets the default synchonisation type of the task referenced by this handle.

Parameters

Leave codes

IMPORT_C void UpdateServerFilterL(const CSyncMLFilter &aFilter);

Description

Updates in the data store the filter that is passed in. The update is done according to the information contained in the CSyncMLFilter object passed in. Leaves if filter with the ID of the one passed in doesn't exist.

Parameters

Leave codes

IMPORT_C void AddServerFilterL(const CSyncMLFilter &aFilter);

Description

Enables the filter passed in. It has to be a filter that is already stored.

Parameters

Leave codes

IMPORT_C void DeleteServerFilterL(TSmlFilterId aId);

Description

Disables a stored filter

Parameters

Leave codes

IMPORT_C void DeleteAllServerFiltersL();

Description

Disables all the filters of the task

Leave codes

IMPORT_C void SetFilterMatchTypeL(TSyncMLFilterMatchType);

Description

Sets if the filters of the current task get treated as having AND or OR relationship between them.

Parameters

Leave codes

IMPORT_C void SetFilterOutsideInclusionTypeL(TSyncMLFilterOutsideInclusionType);

Description

Specifies if new sync with changed filters will be inclusive or exclusive to the previous sync

Parameters

Leave codes

IMPORT_C void SetEnabledL(TBool);

Pre-Condition

The handle is open.

Description

Enables or disables the task referenced by this handle.

Disabled tasks are not synchronised.

Parameters

Leave codes

IMPORT_C void SupportedServerFiltersL(RPointerArray< CSyncMLFilter > &aFilterArray) const;

Pre-Condition

aFilterArray has to be empty

Description

Returns an array of pointers to the filters that are supported by the server

Parameters

Leave codes

Panic codes

IMPORT_C TBool SupportsUserSelectableMatchTypeL() const;

Description

Specifies if the task allows for the user to select the matching type

Return value

IMPORT_C TBool IsReadOnly() const;

Pre-Condition

The handle is open.

Description

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

Return value

IMPORT_C void UpdateL();

Pre-Condition

The handle is open for read and write access.

Description

Transfers any changes made to the task data to the Sync Agent.

The new data will be persisted when RSyncMLProfile::UpdateL() is called on the parent profile.

IMPORT_C void Close();

Description

Closes this handle.