Class RSyncMLDevManJob

class RSyncMLDevManJob : public RSyncMLJobBase;

Description

Handle to a device management job.

A device management job is used to create, access, modify or remove device settings stored in the device repository.

Derivation

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

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

• RSyncMLDevManJob - Handle to a device management job.

Members

Defined in RSyncMLDevManJob:

• CreateL(RSyncMLSession &,TSmlProfileId)Creates and queues a new device management job based on the specified device man...
• CreateL(RSyncMLSession &,TSmlProfileId,TSmlConnectionId)Creates and queues a new device management job based on the specified device man...
• OpenL(RSyncMLSession &,TSmlJobId)Open a handle to a queued device management job of the specified ID.
• RSyncMLDevManJob()Default constructor.
• StopL()Stop the Job represented by this handle from continuing to be processed by the S...

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

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 device management job based on the specified device management 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.

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 DevMan profile.

Capability:	LocalServices
Capability:	NetworkServices

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

Pre-Condition

The session is open.

Description

Creates and queues a new device management job based on the specified device management profile, using the specified connection method.

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. TSmlConnectionId The ID of the connection method to use.

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 DevMan profile.

IMPORT_C void OpenL(RSyncMLSession &, TSmlJobId);

Pre-Condition

The session is open.

Description

Open a handle to a queued device management 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.