CSmlAlertInfo Class Reference

#include <SyncMLAlertInfo.h>

class CSmlAlertInfo : public CBase

Inherits from

  • CSmlAlertInfo
    Public Member Enumerations
    enumTJobControl { EDoNotCreateJob, ECreateJob, EInformJob, EConfirmJob }
    Public Member Functions
    CSmlAlertInfo()
    virtual ~CSmlAlertInfo()
    IMPORT_C TSmlConnectionIdConnection()
    IMPORT_C TBoolCreateSession()
    IMPORT_C TIntErrorCode()
    IMPORT_C voidExternalizeL(RWriteStream &)
    IMPORT_C TIntGetUimode()
    IMPORT_C voidInternalizeL(RReadStream &)
    IMPORT_C TJobControlJobControl()
    IMPORT_C CSmlAlertInfo *NewLC()
    IMPORT_C TSmlProfileIdProfile()
    IMPORT_C TSmlUsageTypeProtocol()
    IMPORT_C voidReset()
    IMPORT_C TIntSessionId()
    IMPORT_C voidSetConfirmation(TBool)
    IMPORT_C voidSetConnectionId(TSmlConnectionId)
    IMPORT_C voidSetErrorCode(TInt)
    IMPORT_C voidSetJobControl(TJobControl)
    IMPORT_C voidSetProfileId(TSmlProfileId)
    IMPORT_C voidSetProtocolType(TSmlUsageType)
    IMPORT_C voidSetSessionId(TInt)
    IMPORT_C voidSetTransportId(TSmlTransportId)
    IMPORT_C voidSetUimode(TInt)
    IMPORT_C voidSetVendorSpecificInfoL(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 TSmlTransportIdTransport()
    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()

    Detailed Description

    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.

    See also: KUidSyncMLPushMsgConfirmNotifier KUidSyncMLPushMsgInformNotifier

    Member Enumeration Documentation

    Enum TJobControl

    Specifies whether a job should be created for an alert.

    EnumeratorValueDescription
    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.

    Constructor & Destructor Documentation

    CSmlAlertInfo ( )

    IMPORT_CCSmlAlertInfo()

    ~CSmlAlertInfo ( )

    IMPORT_C~CSmlAlertInfo()[virtual]

    Member Function Documentation

    Connection ( )

    IMPORT_C TSmlConnectionIdConnection()const

    CreateSession ( )

    IMPORT_C TBoolCreateSession()const

    ErrorCode ( )

    IMPORT_C TIntErrorCode()const

    ExternalizeL ( RWriteStream & )

    IMPORT_C voidExternalizeL(RWriteStream &)const

    GetUimode ( )

    IMPORT_C TIntGetUimode()

    InternalizeL ( RReadStream & )

    IMPORT_C voidInternalizeL(RReadStream &)

    JobControl ( )

    IMPORT_C TJobControlJobControl()const

    NewLC ( )

    IMPORT_C CSmlAlertInfo *NewLC()[static]

    Profile ( )

    IMPORT_C TSmlProfileIdProfile()const

    Protocol ( )

    IMPORT_C TSmlUsageTypeProtocol()const

    Reset ( )

    IMPORT_C voidReset()

    SessionId ( )

    IMPORT_C TIntSessionId()const

    SetConfirmation ( TBool )

    IMPORT_C voidSetConfirmation(TBool)

    SetConnectionId ( TSmlConnectionId )

    IMPORT_C voidSetConnectionId(TSmlConnectionId)

    SetErrorCode ( TInt )

    IMPORT_C voidSetErrorCode(TIntaError)

    SetJobControl ( TJobControl )

    IMPORT_C voidSetJobControl(TJobControl)

    SetProfileId ( TSmlProfileId )

    IMPORT_C voidSetProfileId(TSmlProfileId)

    SetProtocolType ( TSmlUsageType )

    IMPORT_C voidSetProtocolType(TSmlUsageType)

    SetSessionId ( TInt )

    IMPORT_C voidSetSessionId(TIntaId)

    SetTransportId ( TSmlTransportId )

    IMPORT_C voidSetTransportId(TSmlTransportId)

    SetUimode ( TInt )

    IMPORT_C voidSetUimode(TIntaUimode)

    SetVendorSpecificInfoL ( const TDesC8 & )

    IMPORT_C voidSetVendorSpecificInfoL(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 TSmlTransportIdTransport()const

    VendorSpecificInfo ( )

    IMPORT_C const TDesC8 &VendorSpecificInfo()const
    © Nokia 2011.