Collapse all Symbian^3 Product Developer Library

RNSmlPrivateAPI Class Reference

class RNSmlPrivateAPI : public RSessionBase

RNSmlPrivateAPI class Used to transfer Alert messages and DM Auth info to SyncML Symbian OS Server

NSmlPrivateApi.lib

Inherits from

RNSmlPrivateAPI
- RSessionBase
  - RHandleBase

Public Member Functions
	RNSmlPrivateAPI()
IMPORT_C TInt	AddDMGenericAlertRequestL(const TDesC8 &, const TDesC8 &, const TDesC8 &, TInt, const TDesC8 &)
IMPORT_C TInt	AddDMGenericAlertRequestL(const TDesC8 &, RArray< CNSmlDMAlertItem > &)
IMPORT_C void	Close()
IMPORT_C void	GetDMAuthInfoL(CNSmlDMAuthInfo &)
IMPORT_C void	OpenL()
IMPORT_C void	SendL(const TDesC8 &, TSmlUsageType, TSmlProtocolVersion, TUid)
IMPORT_C void	SetDMAuthInfoL(const CNSmlDMAuthInfo &)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RNSmlPrivateAPI()

IMPORT_C

RNSmlPrivateAPI

(

)

C++ default constructor.

Member Functions Documentation

AddDMGenericAlertRequestL(const TDesC8 &, const TDesC8 &, const TDesC8 &, TInt, const TDesC8 &)

IMPORT_C TInt	AddDMGenericAlertRequestL	(	const TDesC8 &	aMgmtUri,
			const TDesC8 &	aMetaType,
			const TDesC8 &	aMetaFormat,
			TInt	aFinalResult,
			const TDesC8 &	aCorrelator
		)	const

Adds a Generic Alert to DM Agent if it is found.

Parameters

const TDesC8 & aMgmtUri	The uri which has been used in the exe command whose final result is about to be reported.
const TDesC8 & aMetaType	Meta/Type that should be used in the alert.
const TDesC8 & aMetaFormat	Meta/Format that should be used in the alert.
TInt aFinalResult	The final result value which is reported to remote server.
const TDesC8 & aCorrelator	Correlator value used in the original exec command.

AddDMGenericAlertRequestL(const TDesC8 &, RArray< CNSmlDMAlertItem > &)

IMPORT_C TInt	AddDMGenericAlertRequestL	(	const TDesC8 &	aCorrelator,
			RArray< CNSmlDMAlertItem > &	aItemList
		)	const

Adds a Generic Alert to DM Agent if it is found.

Parameters

const TDesC8 & aCorrelator	Correlator value used in the original exec command.
RArray< CNSmlDMAlertItem > & aItemList	Array of CNSmlDMAlertItem.

Close()

IMPORT_C void

(

)

Closes the connection with SyncML SOS Server

GetDMAuthInfoL(CNSmlDMAuthInfo &)

IMPORT_C void

GetDMAuthInfoL

(

CNSmlDMAuthInfo &

aAuthInfo

)

Retrieves the DM authentication data from server.

Parameters

CNSmlDMAuthInfo & aAuthInfo

Reference to authentication data container.

OpenL()

IMPORT_C void

OpenL

(

)

Creates new session to SyncML SOS Server. Server is launched if not already running.

SendL(const TDesC8 &, TSmlUsageType, TSmlProtocolVersion, TUid)

IMPORT_C void	SendL	(	const TDesC8 &	aData,
			TSmlUsageType	aType,
			TSmlProtocolVersion	aVersion,
			TUid	aTransportId = KUidNSmlMediumTypeInternet
		)

Transfer message to SyncML SOS Server.

Parameters

const TDesC8 & aData	message to be transferred.
TSmlUsageType aType	Specifies the usage type (DS/DM).
TSmlProtocolVersion aVersion	specifies the protocol of the message
TUid aTransportId = KUidNSmlMediumTypeInternet

SetDMAuthInfoL(const CNSmlDMAuthInfo &)

IMPORT_C void

SetDMAuthInfoL

(

const CNSmlDMAuthInfo &

aAuthInfo

)

Sends DM authetication info to server for saving.

Parameters

const CNSmlDMAuthInfo & aAuthInfo

Reference to authentication data container.