Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: SyncMLClientDM.h
Link against: smlclient.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class RSyncMLDevMan

class RSyncMLDevMan : public RSubSessionBase;

Description

Handle to a RSyncMLDevMan session.

Derivation

Members

Defined in RSyncMLDevMan:
ClearRootAclL(), Close(), OpenL(), RSyncMLDevMan(), SetUserInteractionNotifierTimeoutL(), SubmitGenericAlertL(), UserInteractionNotifierTimeout()

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


Construction and destruction


RSyncMLDevMan()

IMPORT_C RSyncMLDevMan();

Description

Default constructor.

[Top]


Member functions


OpenL()

IMPORT_C void OpenL(RSyncMLSession &);

Description

Opens a handle on the Device Management sub-system.

Parameters

RSyncMLSession &

An open session with the Sync Agent.

Leave codes

KErrNoMemory

Insufficient system memory to complete the operation.

System

error codes.


ClearRootAclL()

Capability: WriteDeviceData

IMPORT_C void ClearRootAclL();

Pre-Condition

The handle is open.

Description

Causes the DevMan subsytem to modify the ACL on the DM Tree's root node, resetting it to the device's factory default value.

Leave codes

KErrNoMemory

Insufficient system memory to complete the operation.

System

error codes.


SetUserInteractionNotifierTimeoutL()

IMPORT_C void SetUserInteractionNotifierTimeoutL(TUint aSeconds);

Pre-Condition

The handle is open.

Description

Sets a maximum time-out value for notifiers raised as a result of DevMan user interaction alerts. If set, this time-out value will override the one supplied by the DM Server. If not set, the DM Server's specified time-out will be used.

Parameters

TUint aSeconds

The time-out value in seconds. The default value suggested by the server is used if set to 0.

Leave codes

KErrNoMemory

Insufficient system memory to complete the operation.

System

error codes.


UserInteractionNotifierTimeout()

IMPORT_C TUint UserInteractionNotifierTimeout() const;

Pre-Condition

The handle is open.

Description

Obtain the maximum time-out value for notifiers raised as a result of DevMan user interaction alerts. A value of zero indicates that the DM Server's suggested time-outs are used.

Return value

TUint

The time-out value in seconds. The default value suggested by the server is used if set to 0.


Close()

IMPORT_C void Close();

Description

Closes this handle.


SubmitGenericAlertL()

IMPORT_C void SubmitGenericAlertL(const TDesC8 &aServerId, const TDesC8 &aDmTreeUri, const TDesC8 &aMediaType, const TDesC8 &aFormat, const TDesC8 &aPayload, const TDesC8 &aCorrelator, TSmlDmGenericAlertImportance aSeverity=ESmlDmGenericAlert_SevInformational);

Description

Queues a Generic Alert to the SyncMLClient to be processed by the DM framework

Parameters

const TDesC8 &aServerId

- the server id the Generic Alert will be raised on

const TDesC8 &aDmTreeUri

- the source URI from the DM tree of the object that generated the alert

const TDesC8 &aMediaType

- the media type

const TDesC8 &aFormat

- the format of the data

const TDesC8 &aPayload

- the payload data

const TDesC8 &aCorrelator

- correlator data

TSmlDmGenericAlertImportance aSeverity

- the importance of the Generic Alert

Leave codes

KErrNoMemory

Insufficient system memory to complete the operation.

System

error codes.