![Symbian Developer Library](../../../../a_stock/images/mainheading.gif)
![]() |
![]() |
|
class RSyncMLTask : public RSubSessionBase;
Represents a mapping between a local data store and a remote data store on a SyncML
server in the context of a profile.
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...
Defined in RSyncMLTask
:
AddServerFilterL(const CSyncMLFilter &)
Enables the filter passed in. It has to be a filter that is already stored.ClientDataSource()const
Gets 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()const
Gets the ID of the creator of the task referenced by this handle.DataProvider()const
Gets the ID of the data provider used to synchronise this task.DefaultSyncType()const
Gets the default synchronisation type of this task.DeleteAllServerFiltersL()
Disables all the filters of the taskDeleteServerFilterL(TSmlFilterId)
Disables a stored filterDisplayName()const
Gets the human readable display name of the task referenced by this handle.Enabled()const
Tests if this task is enabled.FilterMatchType()const
Specifies if the filters of the current task get treated as having AND or OR rel...GetServerFilterIdsL(RArray< TSmlFilterId > &)const
Gets an array of all the filter IDs that are stored for this taskIdentifier()const
Gets the ID of the task referenced by this handle.IsReadOnly()const
Tests 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()const
Specifies if new sync with changed filters will be inclusive or exclusive to the...Profile()const
Gets the ID of the parent profile of this task.RSyncMLTask()
Default constructor.ServerDataSource()const
Gets 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 > &)const
Returns an array of pointers to the filters that are supported by the serverSupportsUserSelectableMatchTypeL()const
Specifies if the task allows for the user to select the matching typeUpdateL()
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)const
Sends a blind message to the server - no reply is expected.Send(TInt,const TIpcArgs &)const
Sends a blind message to the server - no reply is expected.SendReceive(TInt)const
Sends a message to the server and waits synchronously for a reply.SendReceive(TInt,TRequestStatus &)const
Sends a message to the server and waits asynchronously for the reply.SendReceive(TInt,const TIpcArgs &)const
Sends a message to the server and waits synchronously for a reply.SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
Sends a message to the server and waits asynchronously for the reply.Session()const
Returns a copy of the session associated with this sub-session.SubSessionHandle()const
Gets the sub-session handle number.IMPORT_C void CreateL(RSyncMLDataSyncProfile &, TSmlDataProviderId, const TDesC &aServerDataSource, const TDesC &aClientDataSource);
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.
|
|
IMPORT_C void OpenL(RSyncMLDataSyncProfile &, TSmlTaskId);
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.
|
|
IMPORT_C TSmlTaskId Identifier() const;
The handle is open.
Gets the ID of the task referenced by this handle.
|
IMPORT_C TSmlProfileId Profile() const;
The handle is open.
Gets the ID of the parent profile of this task.
|
IMPORT_C TSmlCreatorId CreatorId() const;
The handle is open.
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.
|
IMPORT_C const TDesC& DisplayName() const;
The handle is open.
Gets the human readable display name of the task referenced by this handle.
|
IMPORT_C const TDesC& ServerDataSource() const;
The handle is open.
Gets the name of the server data store that is synchronised by this task.
|
IMPORT_C const TDesC& ClientDataSource() const;
The handle is open.
Gets the name of the local data store that is synchronised by this task.
|
IMPORT_C TSmlDataProviderId DataProvider() const;
The handle is open.
Gets the ID of the data provider used to synchronise this task.
|
IMPORT_C TSmlSyncType DefaultSyncType() const;
The handle is open.
Gets the default synchronisation type of this task.
|
IMPORT_C void GetServerFilterIdsL(RArray< TSmlFilterId > &aFilterIds) const;
aFilterIds has to be empty
Gets an array of all the filter IDs that are stored for this task
|
|
|
IMPORT_C CSyncMLFilter* ServerFilterLC(TSmlFilterId aId);
Retrieves the filter with the given ID and returns an instantance of CSyncMLFilter
class which is also left on the cleanup stack.
|
|
|
IMPORT_C TSyncMLFilterMatchType FilterMatchType() const;
Specifies if the filters of the current task get treated as having AND or OR relationship between them.
|
IMPORT_C TSyncMLFilterOutsideInclusionType OutsideInclusionType() const;
Specifies if new sync with changed filters will be inclusive or exclusive to the previous sync
|
IMPORT_C TBool Enabled() const;
The handle is open.
Tests if this task is enabled.
Disabled tasks will not be synchronised.
|
IMPORT_C void SetCreatorId(TSmlCreatorId);
The handle is open.
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.
|
|
IMPORT_C void SetDisplayNameL(const TDesC &);
The handle is open.
Sets the human-readable display name of the task referenced by this handle.
|
|
IMPORT_C void SetDefaultSyncTypeL(TSmlSyncType);
The handle is open.
Sets the default synchonisation type of the task referenced by this handle.
|
|
IMPORT_C void UpdateServerFilterL(const CSyncMLFilter &aFilter);
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.
|
|
IMPORT_C void AddServerFilterL(const CSyncMLFilter &aFilter);
Enables the filter passed in. It has to be a filter that is already stored.
|
|
IMPORT_C void DeleteServerFilterL(TSmlFilterId aId);
Disables a stored filter
|
|
IMPORT_C void DeleteAllServerFiltersL();
Disables all the filters of the task
|
IMPORT_C void SetFilterMatchTypeL(TSyncMLFilterMatchType);
Sets if the filters of the current task get treated as having AND or OR relationship between them.
|
|
IMPORT_C void SetFilterOutsideInclusionTypeL(TSyncMLFilterOutsideInclusionType);
Specifies if new sync with changed filters will be inclusive or exclusive to the previous sync
|
|
IMPORT_C void SetEnabledL(TBool);
The handle is open.
Enables or disables the task referenced by this handle.
Disabled tasks are not synchronised.
|
|
IMPORT_C void SupportedServerFiltersL(RPointerArray< CSyncMLFilter > &aFilterArray) const;
aFilterArray has to be empty
Returns an array of pointers to the filters that are supported by the server
|
|
|
IMPORT_C TBool SupportsUserSelectableMatchTypeL() const;
Specifies if the task allows for the user to select the matching type
|
IMPORT_C TBool IsReadOnly() const;
The handle is open.
Tests if the parent profile is open for read and write access.
|
IMPORT_C void UpdateL();
The handle is open for read and write access.
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();
Closes this handle.