S60 3rd Edition API Reference: CSIPAcceptLanguageHeader Class Reference

CSIPAcceptLanguageHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipacceptlanguageheader.h>

Inherits CSIPParameterHeaderBase.

Detailed Description

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

Public Member Functions

IMPORT_C ~CSIPAcceptLanguageHeader ()
 Destructor, deletes the resources of CSIPAcceptLanguageHeader.
IMPORT_C const TDesC8 & LanguageRange () const
 Gets the language-range from the "Accept-Language" header.
IMPORT_C void SetLanguageRangeL (const TDesC8 &aLanguageRange)
 Sets the language-range in the "Accept-Language" header.
IMPORT_C TReal QParameter () const
 Gets the value of "q"-parameter.
IMPORT_C void SetQParameterL (TReal aQValue)
 Sets the "q"-parameter value.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
TBool MoreThanOneAllowed () const
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C RPointerArray<
CSIPAcceptLanguageHeader > 		DecodeL (const TDesC8 &aValue)
 Constructs a CSIPAcceptLanguageHeader from textual representation of the header's value part.
static IMPORT_C CSIPAcceptLanguageHeader * NewL (const TDesC8 &aLanguageRange)
 Creates a new instance of CSIPAcceptLanguageHeader.
static IMPORT_C CSIPAcceptLanguageHeader * NewLC (const TDesC8 &aLanguageRange)
 Creates a new instance of CSIPAcceptLanguageHeader and puts it onto the cleanup stack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPAcceptLanguageHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPAcceptLanguageHeader::~CSIPAcceptLanguageHeader (   ) 
 

Destructor, deletes the resources of CSIPAcceptLanguageHeader.

Member Function Documentation

static RPointerArray<CSIPHeaderBase> CSIPAcceptLanguageHeader::BaseDecodeL ( const TDesC8 &  aValue  )  [static]
 
IMPORT_C CSIPHeaderBase* CSIPAcceptLanguageHeader::CloneL (   )  const [virtual]
 

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

static IMPORT_C RPointerArray<CSIPAcceptLanguageHeader> CSIPAcceptLanguageHeader::DecodeL ( const TDesC8 &  aValue  )  [static]
 

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

Parameters:
aValue a value part of a "Accept-Language"-header
Returns:
an array containing one to many instances of CSIPAcceptLanguageHeader.
static IMPORT_C CSIPHeaderBase* CSIPAcceptLanguageHeader::InternalizeValueL ( RReadStream &  aReadStream  )  [static]
 

Constructs an instance of a CSIPAcceptLanguageHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized header object (header name not included).
Returns:
an instance of a CSIPAcceptLanguageHeader
IMPORT_C const TDesC8& CSIPAcceptLanguageHeader::LanguageRange (   )  const
 

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

Returns:
a language-range
TBool CSIPAcceptLanguageHeader::MoreThanOneAllowed (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

IMPORT_C RStringF CSIPAcceptLanguageHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPAcceptLanguageHeader* CSIPAcceptLanguageHeader::NewL ( const TDesC8 &  aLanguageRange  )  [static]
 

Creates a new instance of CSIPAcceptLanguageHeader.

Parameters:
aLanguageRange a language-range to set
Returns:
a new instance of CSIPAcceptLanguageHeader
static IMPORT_C CSIPAcceptLanguageHeader* CSIPAcceptLanguageHeader::NewLC ( const TDesC8 &  aLanguageRange  )  [static]
 

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

Parameters:
aLanguageRange a language-range to set
Returns:
a new instance of CSIPAcceptLanguageHeader
TPreferredPlace CSIPAcceptLanguageHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C TReal CSIPAcceptLanguageHeader::QParameter (   )  const
 

Gets the value of "q"-parameter.

Returns:
the "q"-parameter value
IMPORT_C void CSIPAcceptLanguageHeader::SetLanguageRangeL ( const TDesC8 &  aLanguageRange  ) 
 

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

Parameters:
aLanguageRange a language-range
IMPORT_C void CSIPAcceptLanguageHeader::SetQParameterL ( TReal  aQValue  ) 
 

Sets the "q"-parameter value.

Parameters:
aQValue a "q"-parameter value to set
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top