CSenHttpTransportProperties Class Reference

#include <mw/SenHttpTransportProperties.h>

class CSenHttpTransportProperties : public CSenTransportProperties

Inherits from

Public Member Enumerations
enumTSenHttpMethod { ESenHttpPut, ESenHttpDelete, ESenHttpGet, ESenHttpPost }
enumTSenHttpVersion { ESenHttp10, ESenHttp11 }
Public Member Functions
virtual ~CSenHttpTransportProperties()
virtual TInt AcceptL(TPtrC8 &)
virtual voidApplyBindingL(TSOAPVersion)
virtual HBufC8 *AsUtf8L()
virtual HBufC8 *AsUtf8LC()
virtual TInt BoolPropertyL(const TDesC8 &, TBool &)
virtual MSenProperties *CloneL()
virtual TInt ContentTypeL(TPtrC8 &)
virtual TInt DeviceIDL(TPtrC8 &)
virtual TInt DownloadFolderL(TPtrC8 &)
virtual TInt FileAttachmentL(const TDesC8 &, HBufC8 *&)
virtual TInt HttpHeaderL(const TDesC8 &, TPtrC8 &)
virtual TInt HttpMethodL(TSenHttpMethod &)
virtual TInt HttpVersionL(TSenHttpVersion &)
virtual TInt IapIdL(TUint32 &)
virtual TInt IntPropertyL(const TDesC8 &, TInt &)
virtual TBool IsSafeToCast(TSenPropertiesClassType)
virtual TInt MwsNamespaceL(TPtrC8 &)
IMPORT_C CSenHttpTransportProperties *NewL()
IMPORT_C CSenHttpTransportProperties *NewL(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenHttpTransportProperties *NewL(const CSenElement &)
IMPORT_C CSenHttpTransportProperties *NewLC()
IMPORT_C CSenHttpTransportProperties *NewLC(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenHttpTransportProperties *NewLC(const CSenElement &)
virtual TSenPropertiesClassTypePropertiesClassType()
virtual TInt PropertyL(const TDesC8 &, TPtrC8 &)
virtual TInt PropertyL(const TDesC8 &, TPtrC8 &, TPtrC8 &)
virtual TInt ProxyHostL(TPtrC8 &)
virtual TInt ProxyPortL(TInt &)
virtual TInt ProxyUsageL(TBool &)
virtual voidReadFromL(const TDesC8 &)
virtual TInt RemovePropertyL(const TDesC8 &)
virtual TInt SecureDialogL(TBool &)
virtual voidSetAcceptL(const TDesC8 &)
virtual TInt SetBoolPropertyL(const TDesC8 &, const TBool)
virtual voidSetContentTypeL(const TDesC8 &)
virtual voidSetDeviceIDL(const TDesC8 &)
virtual voidSetDownloadFolderL(const TDesC8 &)
virtual TInt SetFileAttachmentL(const TDesC8 &, const TDesC8 &)
virtual voidSetHttpHeaderL(const TDesC8 &, const TDesC8 &)
virtual voidSetHttpMethodL(TSenHttpMethod)
virtual voidSetHttpVersionL(TSenHttpVersion)
virtual voidSetIapIdL(TUint32)
virtual TInt SetIntPropertyL(const TDesC8 &, const TInt)
virtual voidSetMwsNamespaceL(const TDesC8 &)
virtual TInt SetOmittedL(const TDesC8 &, TBool)
virtual TInt SetPropertyL(const TDesC8 &, const TDesC8 &)
virtual TInt SetPropertyL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
virtual voidSetProxyHostL(const TDesC8 &)
virtual voidSetProxyPortL(TInt)
virtual voidSetProxyUsageL(TBool)
virtual voidSetReader(CSenXmlReader &)
virtual voidSetSecureDialogL(TBool)
virtual voidSetSnapIdL(TUint32)
virtual voidSetSoapActionL(const TDesC8 &)
virtual voidSetUserAgentL(const TDesC8 &)
virtual TInt SnapIdL(TUint32 &)
virtual TInt SoapActionL(TPtrC8 &)
virtual TInt UserAgentL(TPtrC8 &)
virtual voidWriteToL(RWriteStream &)
Protected Member Functions
CSenHttpTransportProperties()
virtual voidBaseConstructL(const TDesC8 &, const TDesC8 &, CSenXmlReader *)
virtual voidBaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
virtual voidBaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
virtual voidBaseConstructL(const CSenElement &)
Inherited Attributes
CSenXmlProperties::ipFragment
CSenXmlProperties::ipReader
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()
CSenTransportProperties::CSenTransportProperties()
CSenTransportProperties::Clone(TInt &)const
CSenTransportProperties::EndpointResourceL(TPtrC8 &)
CSenTransportProperties::HeartbeatL(TInt &)
CSenTransportProperties::MaxTimeToLiveL(TInt &)
CSenTransportProperties::MessageIdL(TPtrC8 &)
CSenTransportProperties::MinTimeToLiveL(TInt &)
CSenTransportProperties::OnewayMessageOnOffL(TBool &)
CSenTransportProperties::SetEndpointResourceL(const TDesC8 &)
CSenTransportProperties::SetHeartbeatL(TInt)
CSenTransportProperties::SetMaxTimeToLiveL(TInt)
CSenTransportProperties::SetMessageIdL(const TDesC8 &)
CSenTransportProperties::SetMinTimeToLiveL(TInt)
CSenTransportProperties::SetOnewayMessageOnOffL(TBool)
CSenTransportProperties::~CSenTransportProperties()
CSenXmlProperties::CSenXmlProperties()
CSenXmlProperties::~CSenXmlProperties()

Detailed Description

In SendL(CSenSoapEnvelope& aMessage, const TDesC8& aProperties) or SubmitL(CSenSoapEnvelope& aMessage, const TDesC8& aProperties, HBufc8*& aResponseTO) aProperties could be "HTTP GET" or "HTTP DELETE" aMessage is a soap message or serialized XML. This scenario is not supported.

These are the function calls get called during this scenario iHttpProperties->SetHttpHeaderL(const TDesC8& aHeaderName, const TDesC8& aValue); iHttpProperties->SetHttpMethodL(CSenHttpTransportProperties::ESenHttpGet); SendL(CSenSoapEnvelope& aMessage, const TDesC8& aProperties);

Member Enumeration Documentation

Enum TSenHttpMethod

HttpMethod Enumeration

Enum TSenHttpVersion

HttpVersion Enumeration

EnumeratorValueDescription
ESenHttp10
ESenHttp11

Constructor & Destructor Documentation

CSenHttpTransportProperties ( )

CSenHttpTransportProperties()[protected]

Constructor.

~CSenHttpTransportProperties ( )

~CSenHttpTransportProperties()[virtual]

Destructor.

Member Function Documentation

AcceptL ( TPtrC8 & )

TInt AcceptL(TPtrC8 &aAccept)[virtual]

Gets the Accept.

ParameterDescription
aAcceptA TPtrC8 reference to be filled in with the value of the Accept.

Returns: KErrNone if no error, or some of the system wide error codes.

ApplyBindingL ( TSOAPVersion )

voidApplyBindingL(TSOAPVersionaSoapVersion)[virtual]

Reimplemented from CSenTransportProperties::ApplyBindingL(TSOAPVersion)

Apply binding.

ParameterDescription
aSoapVersionis a soap1.2 or soap1.1.

AsUtf8L ( )

HBufC8 *AsUtf8L()[virtual]

Reimplemented from CSenTransportProperties::AsUtf8L()

AsUtf8LC ( )

HBufC8 *AsUtf8LC()[virtual]

BaseConstructL ( const TDesC8 &, const TDesC8 &, CSenXmlReader * )

voidBaseConstructL(const TDesC8 &aLocalname,
const TDesC8 &aXml,
CSenXmlReader *aParser = NULL
)[protected, virtual]

BaseConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader * )

voidBaseConstructL(const TDesC8 &aNamespace,
const TDesC8 &aLocalname,
const TDesC8 &aXml,
CSenXmlReader *aParser = NULL
)[protected, virtual]

BaseConstructL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader * )

voidBaseConstructL(const TDesC8 &aNamespace,
const TDesC8 &aLocalname,
const TDesC8 &aQualifiedName,
const TDesC8 &aXml,
CSenXmlReader *aParser = NULL
)[protected, virtual]

BaseConstructL ( const CSenElement & )

voidBaseConstructL(const CSenElement &aElement)[protected, virtual]

BoolPropertyL ( const TDesC8 &, TBool & )

TInt BoolPropertyL(const TDesC8 &aName,
TBool &aValue
)[virtual]

CloneL ( )

MSenProperties *CloneL()const [virtual]

ContentTypeL ( TPtrC8 & )

TInt ContentTypeL(TPtrC8 &aContentType)[virtual]

Gets the information if IAPDialog is shown or not.

ParameterDescription
aContentTypeA TPtrC8 reference to be filled in with the value of the Content Type.

Returns: KErrNone if no error, or some of the system wide error codes. Sets the flag which controls showing of IAPDialog. KErrNone if no error, or some of the system wide error codes.

DeviceIDL ( TPtrC8 & )

TInt DeviceIDL(TPtrC8 &aDeviceID)[virtual]

Gets the device ID

ParameterDescription
aDeviceIDA TPtrC8 reference to be filled in with the value of the Device ID.

Returns: KErrNone if no error, or some of the system wide error codes.

DownloadFolderL ( TPtrC8 & )

TInt DownloadFolderL(TPtrC8 &aDownloadFolder)[virtual]

Gets download folder for incoming BLOB (binary large objects)

ParameterDescription
aDownloadFolder- A TPtrC8 reference to be filled in with the value of the shared, public folder for downloaded content

Returns: KErrNone if no error, or some of the system wide error codes.

FileAttachmentL ( const TDesC8 &, HBufC8 *& )

TInt FileAttachmentL(const TDesC8 &aCid,
HBufC8 *&aFileName
)[virtual]

Gets filename of file attachment

ParameterDescription
aCid- cid for filename
aFileName- filename of file attachment with current cid

Returns: KErrNone if no error, or some of the system wide error codes.

HttpHeaderL ( const TDesC8 &, TPtrC8 & )

TInt HttpHeaderL(const TDesC8 &aHeaderName,
TPtrC8 &aValue
)[virtual]

Gets the Http header.

ParameterDescription
aHeaderNameName of the Http header.
aValueA TPtrC8 reference to be filled in with the value of the Http header.

Returns: KErrNone if no error, or some of the system wide error codes.

HttpMethodL ( TSenHttpMethod & )

TInt HttpMethodL(TSenHttpMethod &aHttpMethod)[virtual]

Gets the Http method.

ParameterDescription
aHttpMethodA TSenHttpMethod reference to be filled in with the value of the Http method.

Returns: KErrNone if no error, or some of the system wide error codes.

HttpVersionL ( TSenHttpVersion & )

TInt HttpVersionL(TSenHttpVersion &aHttpVersion)[virtual]

Gets the Http version.

ParameterDescription
aHttpVersionA TSenHttpVersion reference to be filled in with the value of the Http version.

Returns: KErrNone if no error, or some of the system wide error codes.

IapIdL ( TUint32 & )

TInt IapIdL(TUint32 &aCurrentIapId)[virtual]

Gets the IAP ID.

ParameterDescription
aCurrentIapIdA TUint32 reference to be filled in with the value of the IAP ID.

Returns: KErrNone if no error, or some of the system wide error codes.

IntPropertyL ( const TDesC8 &, TInt & )

TInt IntPropertyL(const TDesC8 &aName,
TInt &aValue
)[virtual]

IsSafeToCast ( TSenPropertiesClassType )

TBool IsSafeToCast(TSenPropertiesClassTypeaClass)[virtual]

MwsNamespaceL ( TPtrC8 & )

TInt MwsNamespaceL(TPtrC8 &aMwsNamespace)[virtual]

Gets namespace of Microsoft schema

ParameterDescription
aMwsNamespace- namespace

Returns: KErrNone if no error, or some of the system wide error codes.

NewL ( )

IMPORT_C CSenHttpTransportProperties *NewL()[static]

Basic constructor.

Returns: a pointer to new CSenHttpTransportProperties class instance.

NewL ( const TDesC8 &, CSenXmlReader & )

IMPORT_C CSenHttpTransportProperties *NewL(const TDesC8 &aXmlUtf8,
CSenXmlReader &aParser
)[static]

Basic constructor.

ParameterDescription
aParserIt is a XML reader

Returns: a pointer to new CSenHttpTransportProperties class instance.

NewL ( const CSenElement & )

IMPORT_C CSenHttpTransportProperties *NewL(const CSenElement &aElement)[static]

Basic constructor.

Returns: a pointer to new CSenHttpTransportProperties class instance.

NewLC ( )

IMPORT_C CSenHttpTransportProperties *NewLC()[static]

Basic constructor.

Returns: a pointer to new CSenHttpTransportProperties class instance.

NewLC ( const TDesC8 &, CSenXmlReader & )

IMPORT_C CSenHttpTransportProperties *NewLC(const TDesC8 &aXmlUtf8,
CSenXmlReader &aParser
)[static]

Basic constructor.

ParameterDescription
aParserIt is a XML reader

Returns: a pointer to new CSenHttpTransportProperties class instance.

NewLC ( const CSenElement & )

IMPORT_C CSenHttpTransportProperties *NewLC(const CSenElement &aElement)[static]

Basic constructor.

Returns: a pointer to new CSenHttpTransportProperties class instance.

PropertiesClassType ( )

TSenPropertiesClassTypePropertiesClassType()[virtual]

PropertyL ( const TDesC8 &, TPtrC8 & )

TInt PropertyL(const TDesC8 &aName,
TPtrC8 &aValue
)[virtual]

PropertyL ( const TDesC8 &, TPtrC8 &, TPtrC8 & )

TInt PropertyL(const TDesC8 &aName,
TPtrC8 &aValue,
TPtrC8 &aType
)[virtual]
Gets the value of the property behind certain name.
Since
Series60
ParameterDescription
aNameThe name identifying this property.
aValueA TPtrC8 reference to be filled in with the value of the property.
aTypeA TPtrC8 reference to be filled in with the type of the property.

Returns: KErrNone if no error, or some of the system wide error codes.

ProxyHostL ( TPtrC8 & )

TInt ProxyHostL(TPtrC8 &aProxyHost)[virtual]

Gets the Proxy Host.

ParameterDescription
aProxyHostA TPtrC8 reference to be filled in with the value of the Proxy Host.

Returns: KErrNone if no error, or some of the system wide error codes.

ProxyPortL ( TInt & )

TInt ProxyPortL(TInt &aProxyPort)[virtual]

Gets the Proxy Port.

ParameterDescription
aProxyPortA TInt reference to be filled in with the value of the Proxy Port.

Returns: KErrNone if no error, or some of the system wide error codes.

ProxyUsageL ( TBool & )

TInt ProxyUsageL(TBool &aProxyUsage)[virtual]

Gets the Proxy Usage flag.

ParameterDescription
aProxyUsageA TBool reference to be filled in with the value of the Proxy Usage.

Returns: KErrNone if no error, or some of the system wide error codes.

ReadFromL ( const TDesC8 & )

voidReadFromL(const TDesC8 &aBuffer)[virtual]

RemovePropertyL ( const TDesC8 & )

TInt RemovePropertyL(const TDesC8 &aName)[virtual]

SecureDialogL ( TBool & )

TInt SecureDialogL(TBool &aSecureDialog)[virtual]

Gets the information if SecureDialog is shown or not.

Returns: KErrNone if no error, or some of the system wide error codes.

SetAcceptL ( const TDesC8 & )

voidSetAcceptL(const TDesC8 &aAccept)[virtual]

Sets the Accept.

ParameterDescription
aAcceptis the new Accept value.

SetBoolPropertyL ( const TDesC8 &, const TBool )

TInt SetBoolPropertyL(const TDesC8 &aName,
const TBoolaValue
)[virtual]

See also: MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

SetContentTypeL ( const TDesC8 & )

voidSetContentTypeL(const TDesC8 &aContentType)[virtual]

Sets the Content Type.

ParameterDescription
aContentTypeis the new Content Type.

SetDeviceIDL ( const TDesC8 & )

voidSetDeviceIDL(const TDesC8 &aDeviceID)[virtual]

Sets the Device ID.

ParameterDescription
aDeviceIDis the new Device ID.

SetDownloadFolderL ( const TDesC8 & )

voidSetDownloadFolderL(const TDesC8 &aDownloadFolder)[virtual]

Sets download folder for incoming BLOB (binary large objects)

ParameterDescription
aDownloadFolder- shared, public folder for downloaded content

SetFileAttachmentL ( const TDesC8 &, const TDesC8 & )

TInt SetFileAttachmentL(const TDesC8 &aCid,
const TDesC8 &aFileName
)[virtual]

Sets filename of file attachment

ParameterDescription
aCid- cid for filename
aFileName- filename of file attachment with current cid

Returns: KErrNone if no error, or some of the system wide error codes.

SetHttpHeaderL ( const TDesC8 &, const TDesC8 & )

voidSetHttpHeaderL(const TDesC8 &aHeaderName,
const TDesC8 &aValue
)[virtual]

Sets the Http header.

ParameterDescription
aHeaderNameName of the Http header.
aValueValue of the Http header

SetHttpMethodL ( TSenHttpMethod )

voidSetHttpMethodL(TSenHttpMethodaHttpMethod)[virtual]

Sets the Http method.

ParameterDescription
aHttpMethodis the new Http method.

SetHttpVersionL ( TSenHttpVersion )

voidSetHttpVersionL(TSenHttpVersionaHttpVersion)[virtual]

Sets the Http version.

ParameterDescription
aHttpVersionis the new Http version.

SetIapIdL ( TUint32 )

voidSetIapIdL(TUint32aIapId)[virtual]

Sets the IAP ID.

ParameterDescription
aIapIdis the new IAP ID.

SetIntPropertyL ( const TDesC8 &, const TInt )

TInt SetIntPropertyL(const TDesC8 &aName,
const TIntaValue
)[virtual]

See also: MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

SetMwsNamespaceL ( const TDesC8 & )

voidSetMwsNamespaceL(const TDesC8 &aMwsNamespace)[virtual]

Sets namespace of Microsoft schema

ParameterDescription
aMwsNamespace- namespace

Returns: KErrNone if no error, or some of the system wide error codes.

SetOmittedL ( const TDesC8 &, TBool )

TInt SetOmittedL(const TDesC8 &aName,
TBoolaValue
)[virtual]

SetPropertyL ( const TDesC8 &, const TDesC8 & )

TInt SetPropertyL(const TDesC8 &aName,
const TDesC8 &aValue
)[virtual]

See also: MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

SetPropertyL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

TInt SetPropertyL(const TDesC8 &aName,
const TDesC8 &aValue,
const TDesC8 &aType
)[virtual]

Sets new property.

If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.

Since
Series60
ParameterDescription
aNameName of the property, which can be later used to refer the given value.
aValueIs the value of this property.
aTypeIs the type of this property.

Returns: KErrNone if no error, or some of the system wide error codes.

SetProxyHostL ( const TDesC8 & )

voidSetProxyHostL(const TDesC8 &aProxyHost)[virtual]

Sets the Proxy Host.

ParameterDescription
aProxyHostis the new Proxy Host.

SetProxyPortL ( TInt )

voidSetProxyPortL(TIntaProxyPort)[virtual]

Sets the Proxy Port.

ParameterDescription
aProxyPortis the new Proxy Port.

SetProxyUsageL ( TBool )

voidSetProxyUsageL(TBoolaProxyUsage)[virtual]

Sets the Proxy Usage flag.

ParameterDescription
aProxyUsageis the new value for Proxy Usage.

SetReader ( CSenXmlReader & )

voidSetReader(CSenXmlReader &aReader)[virtual]

SetSecureDialogL ( TBool )

voidSetSecureDialogL(TBoolaSecureDialog)[virtual]

Sets the flag which controls showing of SecureDialog.

ParameterDescription
aSecureDialogis the new value for SecureDialog flag.

SetSnapIdL ( TUint32 )

voidSetSnapIdL(TUint32aSnapId)[virtual]

Sets the SNAP ID.

ParameterDescription
aSnapIdis the new SNAP ID.

SetSoapActionL ( const TDesC8 & )

voidSetSoapActionL(const TDesC8 &aSoapAction)[virtual]

Sets the Soap Action.

ParameterDescription
aSoapActionis the new Soap Action.

SetUserAgentL ( const TDesC8 & )

voidSetUserAgentL(const TDesC8 &aUserAgent)[virtual]

Sets the UserAgent.

ParameterDescription
aUserAgentis the new User Agent.

SnapIdL ( TUint32 & )

TInt SnapIdL(TUint32 &aCurrentSnapId)[virtual]

Gets the SNAP ID.

ParameterDescription
aCurrentSnapIdA TUint32 reference to be filled in with the value of the SNAP ID.

Returns: KErrNone if no error, or some of the system wide error codes.

SoapActionL ( TPtrC8 & )

TInt SoapActionL(TPtrC8 &aSoapAction)[virtual]

Gets the SoapAction.

ParameterDescription
aSoapActionA TPtrC8 reference to be filled in with the value of the SoapAction.

Returns: KErrNone if no error, or some of the system wide error codes.

UserAgentL ( TPtrC8 & )

TInt UserAgentL(TPtrC8 &aUserAgent)[virtual]

Gets the UserAgent.

ParameterDescription
aUserAgentA TPtrC8 reference to be filled in with the value of the UserAgent.

Returns: KErrNone if no error, or some of the system wide error codes.

WriteToL ( RWriteStream & )

voidWriteToL(RWriteStream &aWriteStream)[virtual]