Collapse all Symbian^3 Application Developer Library

CSmlAlertInfo Class Reference

class CSmlAlertInfo : public CBase

Information about an alert notification.

Push message parsers are responsible for generating one (or more) of these objects as a result of parsing a message, whether the parse is successful or not.

Not all details will be applicable to all alerts.

If parsing is successful, and a profile ID is specified, the Agent uses this information to generate a job (based upon the 'job control' value specified), prompting the user first if neccessary If parsing fails, parsers should try to fill in as much information as they can.

KUidSyncMLPushMsgConfirmNotifier KUidSyncMLPushMsgInformNotifier

Inherits from

CSmlAlertInfo
- CBase

Public Member Functions
	CSmlAlertInfo ()
	~CSmlAlertInfo ()
IMPORT_C TSmlConnectionId	Connection ()
IMPORT_C TBool	CreateSession ()
IMPORT_C TInt	ErrorCode ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C TInt	GetUimode ()
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TJobControl	JobControl ()
IMPORT_C CSmlAlertInfo *	NewLC ()
IMPORT_C TSmlProfileId	Profile ()
IMPORT_C TSmlUsageType	Protocol ()
IMPORT_C void	Reset ()
IMPORT_C TInt	SessionId ()
IMPORT_C void	SetConfirmation ( TBool )
IMPORT_C void	SetConnectionId ( TSmlConnectionId )
IMPORT_C void	SetErrorCode ( TInt )
IMPORT_C void	SetJobControl ( TJobControl )
IMPORT_C void	SetProfileId ( TSmlProfileId )
IMPORT_C void	SetProtocolType ( TSmlUsageType )
IMPORT_C void	SetSessionId ( TInt )
IMPORT_C void	SetTransportId ( TSmlTransportId )
IMPORT_C void	SetUimode ( TInt )
IMPORT_C void	SetVendorSpecificInfoL (const TDesC8 &)
IMPORT_C const RArray < TInt > &	TaskIds ()
IMPORT_C RArray < TInt > &	TaskIds ()
IMPORT_C const RArray < TSmlSyncType > &	TaskSyncTypes ()
IMPORT_C RArray < TSmlSyncType > &	TaskSyncTypes ()
IMPORT_C TSmlTransportId	Transport ()
IMPORT_C const TDesC8 &	VendorSpecificInfo ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TJobControl { EDoNotCreateJob , ECreateJob , EInformJob , EConfirmJob }

Private Attributes
TSmlConnectionId	iConnection
TInt	iErrorCode
TUint	iFlags
TJobControl	iJobControl
TSmlProfileId	iProfile
TSmlUsageType	iProtocol
TInt	iSessionId
RArray < TInt >	iTaskIds
RArray < TSmlSyncType >	iTaskSyncTypes
TSmlTransportId	iTransport
TInt	iUimode
HBufC8 *	iVendorSpecificInfo

Constructor & Destructor Documentation

CSmlAlertInfo()

IMPORT_C

CSmlAlertInfo

(

)

~CSmlAlertInfo()

IMPORT_C

~CSmlAlertInfo

(

)

[virtual]

Member Functions Documentation

Connection()

IMPORT_C TSmlConnectionId

Connection

(

)

const

CreateSession()

IMPORT_C TBool

CreateSession

(

)

const

ErrorCode()

IMPORT_C TInt

ErrorCode

(

)

const

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

)

const

Parameters

RWriteStream &

GetUimode()

IMPORT_C TInt

GetUimode

(

)

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

)

Parameters

RReadStream &

JobControl()

IMPORT_C TJobControl

JobControl

(

)

const

NewLC()

IMPORT_C CSmlAlertInfo *

NewLC

(

)

[static]

Profile()

IMPORT_C TSmlProfileId

Profile

(

)

const

Protocol()

IMPORT_C TSmlUsageType

Protocol

(

)

const

Reset()

IMPORT_C void

Reset

(

)

SessionId()

IMPORT_C TInt

SessionId

(

)

const

SetConfirmation(TBool)

IMPORT_C void

SetConfirmation

(

TBool

)

Parameters

TBool

SetConnectionId(TSmlConnectionId)

IMPORT_C void

SetConnectionId

(

TSmlConnectionId

)

Parameters

TSmlConnectionId

SetErrorCode(TInt)

IMPORT_C void

SetErrorCode

(

TInt

aError

)

Parameters

TInt aError

SetJobControl(TJobControl)

IMPORT_C void

SetJobControl

(

TJobControl

)

Parameters

TJobControl

SetProfileId(TSmlProfileId)

IMPORT_C void

SetProfileId

(

TSmlProfileId

)

Parameters

TSmlProfileId

SetProtocolType(TSmlUsageType)

IMPORT_C void

SetProtocolType

(

TSmlUsageType

)

Parameters

TSmlUsageType

SetSessionId(TInt)

IMPORT_C void

SetSessionId

(

TInt

aId

)

Parameters

TInt aId

SetTransportId(TSmlTransportId)

IMPORT_C void

SetTransportId

(

TSmlTransportId

)

Parameters

TSmlTransportId

SetUimode(TInt)

IMPORT_C void

SetUimode

(

TInt

aUimode

)

Parameters

TInt aUimode

SetVendorSpecificInfoL(const TDesC8 &)

IMPORT_C void

SetVendorSpecificInfoL

(

const TDesC8 &

)

Parameters

const TDesC8 &

TaskIds()

IMPORT_C const RArray < TInt > &

TaskIds

(

)

const

TaskIds()

IMPORT_C RArray < TInt > &

TaskIds

(

)

TaskSyncTypes()

IMPORT_C const RArray < TSmlSyncType > &

TaskSyncTypes

(

)

const

TaskSyncTypes()

IMPORT_C RArray < TSmlSyncType > &

TaskSyncTypes

(

)

Transport()

IMPORT_C TSmlTransportId

Transport

(

)

const

VendorSpecificInfo()

IMPORT_C const TDesC8 &

VendorSpecificInfo

(

)

const

Member Enumerations Documentation

Enum TJobControl

Specifies whether a job should be created for an alert.

Enumerators

EDoNotCreateJob	Do not create a job.
ECreateJob	Create a job.
EInformJob	Inform the user that a job is being created.
EConfirmJob	Get confirmation from the user that a job should be created.