Class CSIPAcceptLanguageHeader

class CSIPAcceptLanguageHeader : public CSIPParameterHeaderBase;

Description

Class provides functions for setting and getting media types and parameters in SIP "Accept-Language" header.

sipcodec.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPHeaderBase - Class provides a generic interface for all the SIP headers

• CSIPParameterHeaderBase - A base class for SIP headers that have structure "mandatory part"delimiter"parameters"

• CSIPAcceptLanguageHeader - Class provides functions for setting and getting media types and parameters in SIP "Accept-Language" header

Members

Defined in CSIPAcceptLanguageHeader:
CloneL(), DecodeL(), InternalizeValueL(), LanguageRange(), Name(), NewL(), NewLC(), QParameter(), SetLanguageRangeL(), SetQParameterL(), ~CSIPAcceptLanguageHeader()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPHeaderBase:
ExternalizeL(), ExternalizeSupported(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

Inherited from CSIPParameterHeaderBase:
DeleteParam(), HasParam(), Param(), ParamCount(), ParamValue(), SetParamL(), ToTextValueL()

static IMPORT_C CSIPAcceptLanguageHeader *NewL(const TDesC8 &aLanguageRange);

Description

Creates a new instance of CSIPAcceptLanguageHeader

Parameters

const TDesC8 &aLanguageRange a language-range to set

Return value

CSIPAcceptLanguageHeader * a new instance of CSIPAcceptLanguageHeader

static IMPORT_C CSIPAcceptLanguageHeader *NewLC(const TDesC8 &aLanguageRange);

Description

Creates a new instance of CSIPAcceptLanguageHeader and puts it onto the cleanup stack

Parameters

const TDesC8 &aLanguageRange a language-range to set

Return value

CSIPAcceptLanguageHeader * a new instance of CSIPAcceptLanguageHeader

IMPORT_C ~CSIPAcceptLanguageHeader();

Description

Destructor, deletes the resources of CSIPAcceptLanguageHeader.

static IMPORT_C RPointerArray< CSIPAcceptLanguageHeader > DecodeL(const TDesC8 &aValue);

Description

Constructs a CSIPAcceptLanguageHeader from textual representation of the header's value part.

Parameters

const TDesC8 &aValue a value part of a "Accept-Language"-header

Return value

RPointerArray< CSIPAcceptLanguageHeader > an array containing one to many instances of CSIPAcceptLanguageHeader.

IMPORT_C const TDesC8 &LanguageRange() const;

Description

Gets the language-range from the "Accept-Language" header

Return value

const TDesC8 & a language-range

IMPORT_C void SetLanguageRangeL(const TDesC8 &aLanguageRange);

Description

Sets the language-range in the "Accept-Language" header

Parameters

const TDesC8 &aLanguageRange a language-range

IMPORT_C TReal QParameter() const;

Description

Gets the value of "q"-parameter

Return value

TReal the "q"-parameter value

IMPORT_C void SetQParameterL(TReal aQValue);

Description

Sets the "q"-parameter value

Parameters

TReal aQValue a "q"-parameter value to set

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPAcceptLanguageHeader from a RReadStream

Parameters

RReadStream &aReadStream a stream containing the value of the externalized header object (header name not included).

Return value

CSIPHeaderBase * an instance of a CSIPAcceptLanguageHeader

virtual IMPORT_C CSIPHeaderBase *CloneL() const;

Description

From CSIPHeaderBase CloneL

Return value

CSIPHeaderBase *

virtual IMPORT_C RStringF Name() const;

Description

From CSIPHeaderBase Name

Return value

RStringF